• Stars
    star
    412
  • Rank 105,024 (Top 3 %)
  • Language
    Ruby
  • License
    MIT License
  • Created over 7 years ago
  • Updated over 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Allow you to pluck attributes from nested associations without loading a bunch of records.

DeepPluck

Gem Version Build Status RubyGems Code Climate Test Coverage

Allow you to pluck deeply into nested associations without loading a bunch of records.

Supports

  • Ruby 2.3 ~ 2.7, 3.0 ~ 3.1
  • Rails 3.2, 4.2, 5.0, 5.1, 5.2, 6.0, 7.0, 7.1

Installation

Add this line to your application's Gemfile:

gem 'deep_pluck'

And then execute:

$ bundle

Or install it yourself as:

$ gem install deep_pluck

Usage

Similar to #pluck method

User.deep_pluck(:id, :name)
# SELECT `users`.`id`, `users`.`name` FROM `users`
# =>
# [
#   {'id' => 1, 'name' => 'David'},
#   {'id' => 2, 'name' => 'Jeremy'},
# ]

Pluck attributes from nested associations

User.deep_pluck(:name, 'posts' => :title)
# SELECT `users`.`id`, `users`.`name` FROM `users`
# SELECT `posts`.`user_id`, `posts`.`title` FROM `posts` WHERE `posts`.`user_id` IN (1, 2)
# =>
# [
#  {
#    'name' => 'David' ,
#    'posts' => [
#      {'title' => 'post1'},
#      {'title' => 'post2'},
#    ],
#  },
#  {
#    'name' => 'Jeremy',
#    'posts' => [
#      {'title' => 'post3'},
#    ],
#  },
# ]

Pluck at models

user = User.find_by(name: 'David')
user.deep_pluck(:name, :posts => :title)
# =>
# {
#   'name' => 'David' ,
#   :posts => [
#     {'title' => 'post1'},
#     {'title' => 'post2'},
#   ],
# }

Compare with using #as_json

Assume the following relations:

User has_many Posts.
Post has_many PostComments.
User has_one Contact.

And the following #as_json example:

User.where(:name => %w(Pearl Doggy)).includes([{:posts => :post_comments}, :contact]).as_json({
  :root => false,
  :only => [:name, :email],
  :include => {
    'posts' => {
      :only => :name,
      :include => {
        'post_comments' => {
          :only => :comment,
        },
      },
    },
    'contact' => {
      :only => :address,
    },
  },
})

It works as expected, but is not very DRY, repeat writing include, posts, post_comments so many times.

Not to mention the huge performace improvement by using #deep_pluck.

You could refactor the example with #deep_pluck:

User.where(:name => %w(Pearl Doggy)).deep_pluck(
  :name,
  :email,
  'posts' => [:name, 'post_comments' => :comment],
  'contact' => :address,
)

Better Performance

#deep_pluck return raw hash data without loading a bunch of records, so that faster than #as_json, or #select.

The following is the benchmark test on 3 users, 6 posts, where users table have 14 columns and posts have 6 columns. As it shows, deep_pluck is 4x faster than as_json.

# Repeat 500 times
# User.includes(:posts).as_json(:only => :email, :include => {:posts => {:only => :title}})
# User.deep_pluck(:email, {'posts' => :title})

                       user     system      total        real
as_json            1.740000   1.230000   2.970000 (  3.231465)
deep_pluck         0.660000   0.030000   0.690000 (  0.880018)

The following is the benchmark test on 10000 users, where users table have 46 columns. As it shows, deep_pluck is 40x faster than as_json and 4x faster than map.

# Repeat 1 times
# User.select('account, email').map{|s| {'account' => s.account, 'email' => s.email}}
# User.select('account, email').as_json(:only => [:account, :email])
# User.deep_pluck(:account, :email)

                       user     system      total        real
map                0.210000   0.000000   0.210000 (  0.225421)
as_json            1.980000   0.060000   2.040000 (  2.042205)
deep_pluck         0.040000   0.000000   0.040000 (  0.051673)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/khiav223577/deep_pluck. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

More Repositories

1

pluck_all

A more efficient way to get data from database. Like #pluck method but return array of hashes instead.
Ruby
99
star
2

rails_or

Cleaner syntax for writing OR Query in Rails 5, 6. And also add #or support to Rails 3 and 4.
Ruby
93
star
3

active_model_cachers

Simply cache whatever you want by using cachers which will help you maintain cached objects and expire them when they are changed.
Ruby
63
star
4

find_with_order

Provides a simple way to find records in the same order of input array. Has better performance than manually sorting. (Support both PostgreSQL and MySQL)
Ruby
38
star
5

atomically

An ActiveRecord extension for writing commonly useful atomic SQL statements to avoid race condition.
Ruby
26
star
6

multi_range

Allow you to manipulate a group of ranges. Such as merging overlapping ranges, doing ranges union, intersection, difference, and so on.
Ruby
16
star
7

left_joins

Backport left_joins method from Rails 5 for Rails 3 and 4
Ruby
7
star
8

case_register

Provide a design pattern to manage switch statements by mapping each case to a method which is dynamically defined in advance.
Ruby
6
star
9

Easy-Rent

It's a chrome extension to help people rent houses easier.
JavaScript
3
star
10

max_exchange_api

MAX Exchange API Ruby SDK
Ruby
2
star
11

adaptive_alias

Extend attribute_alias and make it be adaptive with realtime database schema
Ruby
2
star
12

ftx_exchange_api

FTX Exchange API Ruby SDK
Ruby
2
star
13

texture_packer

Ruby
2
star
14

Emerald-Forests-Jumping-Wolf

Various monsters suddenly showed up in the Emerald Forest! The wolf is faced with lots of difficulties on its way home. Please help the wolf defeat those scary monsters by your magical voice.
JavaScript
2
star
15

roulette-wheel-selection

Provide an algorithm allowing you to do weighted sampling.
Ruby
1
star
16

in_batches

Backport in_batches from Rails 5 for Rails 3 and 4.
Ruby
1
star
17

elegant-date

Provides elegant ways to manipulate JS Date objects.
JavaScript
1
star
18

rmxp-map_screenshot

ζˆͺεœ°εœ–θ…³ζœ¬
Ruby
1
star
19

ot_text_editor

Realtime Collaborative Text Editing demo based on Operational Transformation (OT), Rails and React
Ruby
1
star
20

ChineseCheckersBot

A Chinese checkers game which can be played by two, three, four, or six players. Or choose to play with AI instead of real players!
Ruby
1
star