deep_pluck 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02455f382f53378da4401571796aa5f0d200327e
-  data.tar.gz: a7ae7dcc3a2e5b38416766ae1ac0564574375660
+  metadata.gz: 51c4e3a56a22aaf35ded1d2614e87d76f5b52283
+  data.tar.gz: 5638b67af223f0c2c34009abdcfa7d7fe75c1186
 SHA512:
-  metadata.gz: db336700568010031bf5a22f4eb98dcee584b5f631d2d74c78d251a811ac4f857f5b3b09093df3350b0d74732ecf19fa54c0b012de3fbd8a6503ef9c7f9f0573
-  data.tar.gz: 9c273df567114544e2b356dbc67d80bf1839e41dd0617983bcde494ed98b8cbabf547057970997a58a5fc63b61b7db0bf7f9c0a9d8217260326f717aad7eb46d
+  metadata.gz: 76a4685fbe45190c0da0c75175dcc0769da3a43007be9791bf78f06208cf701534f997f946b72f095916cda4e8971bf1583de2758166a6ded366849d2c1dd814
+  data.tar.gz: 57c237f957442f8b04c915808f1f3e58491000e78ec0aae54a312dd8c2d9f051886269fcc6e323dfaa942c42b5cb8c12afe88a447405d4ba483f90e12fd99b2b

data/README.md

@@ -27,6 +27,71 @@ Or install it yourself as:
 
 ## Usage
 
+### Similar to #pluck method
+```rb
+User.deep_pluck(:id, :name)
+# SELECT `users`.`id`, `users`.`name` FROM `users` 
+# => [{'id' => 1, 'name' => 'David'}, {'id' => 2, 'name' => 'Jeremy'}]
+```
+
+### Pluck deep into associations
+```rb
+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'}]}
+# ]
+```
+
+### DRY up Rails/ActiveRecord includes when using as_json
+
+Assume the following relations:
+
+> User has_many Posts.<br>
+> Post has_many PostComments.<br>
+> User has_one Contact.<br>
+
+And the following #as_json example:
+```rb
+User.where(:name => %w(Pearl Kathenrie)).includes([{:posts => :post_comments}, :contact]).as_json({
+  :root => false,
+  :only => [:name, :email], 
+  :include => {
+    'posts' => {
+      :only => :name, 
+      :include => {
+        'post_comments' => {
+          :only => :comment,
+        },
+      },
+    },
+    'contact' => {
+      :only => :address,
+    },
+  },
+})
+
+```
+You could refactor it with #deep_pluck like:
+```rb
+User.where(:name => %w(Pearl Kathenrie)).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.
+
+In that faster than #as_json, or #select.
+
+Will add some benchmarks soon :)
+
 
 ## Development
 

data/lib/deep_pluck/model.rb

@@ -14,7 +14,8 @@ module DeepPluck
   #  Reader
   #---------------------------------------
     def get_reflect(association_key)
-      @relation.klass.reflect_on_association(association_key.to_sym) #add to_sym since rails 3 only support symbol
+      @relation.klass.reflect_on_association(association_key.to_sym) || #add to_sym since rails 3 only support symbol
+        raise(ActiveRecord::ConfigurationError, "ActiveRecord::ConfigurationError: Association named '#{association_key}' was not found on #{@relation.klass.name}; perhaps you misspelled it?")
     end
     def get_foreign_key(reflect, reverse: false, with_table_name: false)
       if reflect.options[:through] and reverse #reverse = parent
@@ -104,12 +105,12 @@ module DeepPluck
     def load_data
       prev_need_columns = @parent_model.get_foreign_key(@parent_model.get_reflect(@parent_association_key), reverse: true, with_table_name: true) if @parent_model
       next_need_columns = @associations.map{|key, _| get_foreign_key(get_reflect(key), with_table_name: true) }.uniq
-      all_need_columns = [*prev_need_columns, *next_need_columns, *@need_columns].uniq
+      all_need_columns = [*prev_need_columns, *next_need_columns, *@need_columns].uniq(&Helper::TO_KEY_PROC)
       @relation = yield(@relation) if block_given?
       @data = @relation.pluck_all(*all_need_columns)
       if @data.size != 0
-        @extra_columns = all_need_columns - @need_columns #for delete_extra_column_data!
-        @extra_columns.map!{|s| s.gsub(/\w*[^\w]/, '')} #user_achievements.user_id => user_id
+        #for delete_extra_column_data!
+        @extra_columns = all_need_columns.map(&Helper::TO_KEY_PROC) - @need_columns.map(&Helper::TO_KEY_PROC)
         @associations.each do |key, model|
           set_includes_data(@data, key, model)
         end
@@ -126,5 +127,16 @@ module DeepPluck
       @data.each{|s| s.except!(*@extra_columns) }
       @associations.each{|_, model| model.delete_extra_column_data! }
     end
+  #---------------------------------------
+  #  Helper methods
+  #---------------------------------------
+    module Helper
+      TO_KEY_PROC = proc{|s| Helper.column_to_key(s) }
+      def self.column_to_key(key) #user_achievements.user_id => user_id
+        key = key[/(\w+)[^\w]*\z/]
+        key.gsub!(/[^\w]+/, '')
+        return key
+      end
+    end
   end
 end

data/lib/deep_pluck/version.rb

@@ -1,3 +1,3 @@
 module DeepPluck
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deep_pluck
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-16 00:00:00.000000000 Z
+date: 2017-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Use deep_pluck as a shortcut to select one or more attributes and include