pluck_all 1.2.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a259d571e328a2a0e9fb65aeadddc4f42c12fdeb
-  data.tar.gz: 79892f45b6c365e0eaeb9f649d6357099a3fecb6
+SHA256:
+  metadata.gz: aa1aa7d453681e40416df834c94c2b53a062ac7e8a6bf49274ea4b672ecbca42
+  data.tar.gz: 3c993741218094a58a85636ed87346164791ff4d041a0f0d8c9fb0cfbf3b158b
 SHA512:
-  metadata.gz: 357e8d27cc5a04eb64c3132df314a0c6b98d5091bf1ceb3c0c0d94c42c05851728243bfad479eeab31d02c93bb2f075fabe49eda88a44f473ba2560e7c6cad2a
-  data.tar.gz: 6876425a096c43cc63d339f24ec40ea875cf92828fac4c8b3746e4c84c8884cc5bc49d70857572ea0f9acce48246088d6bc8783f5b89913ec48873535e39fc7c
+  metadata.gz: 8bbec73a952c75b7d7dbdeb4ecc5f15ad4e83e4c22a7dc171cc92f1061798e00c35581d4d68f47aabcb889218bda0f1668c28dcbc8fc06969378e9c416cfec8b
+  data.tar.gz: 5063080302396865c965a5b3c187934c74097db57abb07ada6c80c2ca491faa6e1ef7c390234f9267677d813bc1dfc0af52505202095c9fcb9bb1bb265f2c65b

data/.travis.yml

@@ -1,20 +1,27 @@
+sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=db72eba1ff8fb1329dae5fb9b9dcd234243899d7a464ceb374e14a05ead27b7c
 language: ruby
 rvm:
   - 2.2
   - 2.3
-sudo: required
-dist: trusty
-before_install: 
-  - gem install bundler
-  - gem update --system
-  - gem --version
+services:
+  - mongodb
 gemfile:
   - gemfiles/3.2.gemfile
   - gemfiles/4.2.gemfile
   - gemfiles/5.0.gemfile
-addons:
-    code_climate:
-        repo_token: db72eba1ff8fb1329dae5fb9b9dcd234243899d7a464ceb374e14a05ead27b7c
-after_success:
-  - bundle exec codeclimate-test-reporter
-
+  - gemfiles/5.1.gemfile
+  - gemfiles/5.2.gemfile
+before_install:
+  - gem install bundler
+  - gem update --system
+  - gem --version
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake test
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -0,0 +1,39 @@
+## Change Log
+
+### [upcoming](https://github.com/khiav223577/pluck_all/compare/v1.2.4...HEAD) 2018/04/05
+- [#20](https://github.com/khiav223577/pluck_all/pull/20) test pluck_all in rails 5.1.x (@khiav223577)
+- [#19](https://github.com/khiav223577/pluck_all/pull/19) add test cases to test `join` with table name and `alias` (@khiav223577)
+
+### [v1.2.4](https://github.com/khiav223577/pluck_all/compare/v1.2.3...v1.2.4) 2017/04/11
+- [#17](https://github.com/khiav223577/pluck_all/pull/17) supports carrierwave 1.0.0 (@khiav223577)
+
+### [v1.2.3](https://github.com/khiav223577/pluck_all/compare/v1.2.2...v1.2.3) 2017/04/03
+- [#14](https://github.com/khiav223577/pluck_all/pull/14) use mass assign to assign values (@khiav223577)
+- [#16](https://github.com/khiav223577/pluck_all/pull/16) Checking if Class has CarrierWave loaded (@basex)
+- [#15](https://github.com/khiav223577/pluck_all/pull/15) Restrict dependency to activerecord (@basex)
+
+### [v1.2.2](https://github.com/khiav223577/pluck_all/compare/v1.2.1...v1.2.2) 2017/03/14
+- [#13](https://github.com/khiav223577/pluck_all/pull/13) Model.none.pluck_all(..) should return empty array instead of raising exception (@khiav223577)
+- [#12](https://github.com/khiav223577/pluck_all/pull/12) test other ruby version (@khiav223577)
+
+### [v1.2.1](https://github.com/khiav223577/pluck_all/compare/v1.2.0...v1.2.1) 2017/01/24
+- [#11](https://github.com/khiav223577/pluck_all/pull/11) always return carrierwave uploader if possible (@khiav223577)
+- [#10](https://github.com/khiav223577/pluck_all/pull/10) change pluck_all return value of carrierwave column (@khiav223577)
+
+### [v1.2.0](https://github.com/khiav223577/pluck_all/compare/v1.1.2...v1.2.0) 2017/01/24
+- [#5](https://github.com/khiav223577/pluck_all/pull/5) Support casting CarrierWave url (@khiav223577)
+- [#9](https://github.com/khiav223577/pluck_all/pull/9) need ActiveRecord version not Rails version (@khiav223577)
+- [#8](https://github.com/khiav223577/pluck_all/pull/8) Upgrade rake version in development (@khiav223577)
+
+### [v1.1.2](https://github.com/khiav223577/pluck_all/compare/v1.1.1...v1.1.2) 2017/01/06
+- [#7](https://github.com/khiav223577/pluck_all/pull/7) fix pluck_all with join (@khiav223577)
+
+### [v1.1.1](https://github.com/khiav223577/pluck_all/compare/v1.1.0...v1.1.1) 2017/01/01
+- [#4](https://github.com/khiav223577/pluck_all/pull/4) add code climate (@khiav223577)
+
+### [v1.1.0](https://github.com/khiav223577/pluck_all/compare/v1.0.1...v1.1.0) 2016/12/21
+- [#3](https://github.com/khiav223577/pluck_all/pull/3) Feature/pluck array (@khiav223577)
+
+### v1.0.1 2016/12/20
+- [#2](https://github.com/khiav223577/pluck_all/pull/2) test with multiple rails version (@khiav223577)
+- [#1](https://github.com/khiav223577/pluck_all/pull/1) add basic test cases (@khiav223577)

data/README.md

@@ -8,10 +8,10 @@
 
 Pluck multiple columns/attributes in Rails 3, 4, 5, and can return data as hash instead of only array.
 
-This Gem standing on the shoulders of this [article](http://meltingice.net/2013/06/11/pluck-multiple-columns-rails/).
-And modify it to support not only Rail 3.
+This Gem stands on the shoulders of this article: [Plucking Multiple Columns in Rails 3](http://meltingice.net/2013/06/11/pluck-multiple-columns-rails/).
+And modified to support not only Rail 3.
 
-If you have a Rails 3 project, and want to pluck not only one column, 
+If you have a Rails 3 project, and want to pluck not only one column,
 feel free to use this gem and no need to worry about upgrading to Rails 4, 5 in the future will break this.
 
 
@@ -33,22 +33,72 @@ Or install it yourself as:
     $ gem install pluck_all
 
 ## Usage
+
 ### pluck to array
+
 Behaves the same as the Rails 4 pluck, but you can use it in Rails 3
+
 ```rb
 User.where('id < 3').pluck_array(:id, :account)
 # => [[1, 'account1'], [2, 'account2']]
 ```
+
 ### pluck to hash
+
 Similar to `pluck_array`, but return hash instead.
+
 ```rb
 User.where('id < 3').pluck_all(:id, :account)
-# => [{"id"=>1, "account"=>"account1"}, {"id"=>2, "account"=>"account2"}] 
+# => [{"id"=>1, "account"=>"account1"}, {"id"=>2, "account"=>"account2"}]
 
 User.where('id < 3').pluck_all('id, account AS name')
-# => [{"id"=>1, "name"=>"account1"}, {"id"=>2, "name"=>"account2"}] 
+# => [{"id"=>1, "name"=>"account1"}, {"id"=>2, "name"=>"account2"}]
+```
+
+## Support Mongoid
+```rb
+class User
+  include Mongoid::Document
+
+  field :name, type: String
+  field :age, type: Integer
+end
+
+User.pluck_all(:name, :age)
+# => [
+#      {'name' => 'Pearl Shi'   , 'age' => 18},
+#      {'name' => 'Rumble Huang', 'age' => 20},
+#      {'name' => 'Khiav Reoy'  , 'age' => 20},
+#    ]
+```
+
+
+## Benchmark
+### Compare with `map` and `as_json`
+
+`pluck_all` return raw `hash` data without loading a bunch of records, in that having better performace than using `map` and `as_json`. The following is the benchmark test on 191,093 users, where `users` table have 51 columns.
+
+```rb
+                                       user     system      total        real
+map                               36.110000  61.200000  97.310000 ( 99.535375)
+select + map                      10.530000   0.660000  11.190000 ( 12.550974)
+select + as_json                  49.040000   1.120000  50.160000 ( 55.417534)
+pluck_all                          3.310000   0.100000   3.410000 (  3.527775)
+```
+[test script](https://github.com/khiav223577/pluck_all/issues/18)
+
+### Compare with [pluck_to_hash](https://github.com/girishso/pluck_to_hash) gem
+
+`pluck_all` has better performace since it uses raw `hash` data from `ActiveRecord::Base.connection.select_all`, while `pluck_to_hash` uses `pluck` method, which calls `ActiveRecord::Base.connection.select_all` and transfers the raw `hash` data to `array` format, and then transfer the data to `hash` format again. The following benchmark test uses same datebase as above.
+
+```rb
+                                       user     system      total        real
+pluck_to_hash                      2.960000   0.130000   3.090000 (  3.421640)
+pluck_all                          2.160000   0.120000   2.280000 (  2.605118)
 ```
+[test script](https://github.com/khiav223577/pluck_all/issues/18#issuecomment-325407080)
 
+## Other Support
 ### Support Pluck Carrierwave Uploader (if you use carrierwave)
 ```rb
 User.where(xxx).pluck_all(:profile_pic).map{|s| s['profile_pic'] }
@@ -58,7 +108,7 @@ is the same as
 User.where(xxx).map(&:profile_pic)
 ```
 If the uploader use something like: `model.id`, `model.name`
-You should send these columns manually:
+You may have to send these columns manually:
 ```rb
 User.where(xxx).cast_need_columns(%i(id, name)).pluck_all(:id, :name, :profile_pic).map{|s| s['profile_pic'] }
 ```

data/gemfiles/3.2.gemfile

@@ -2,11 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pluck_all.gemspec
 
-gem "activerecord", "~> 3.2"
+gem "activerecord", "~> 3.2.0"
 
 group :test do
   gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem 'mongoid', '~> 3.1.7'
   gem 'carrierwave', '~> 0.11.0'
 end
 

data/gemfiles/4.2.gemfile

@@ -2,11 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pluck_all.gemspec
 
-gem "activerecord", "~> 4.2"
+gem "activerecord", "~> 4.2.0"
 
 group :test do
   gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem 'mongoid', '~> 5.4.0'
   gem 'carrierwave', '~> 0.11.0'
 end
 

data/gemfiles/5.0.gemfile

@@ -2,11 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in pluck_all.gemspec
 
-gem "activerecord", "~> 5.0"
+gem "activerecord", "~> 5.0.0"
 
 group :test do
   gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
+  gem 'mongoid', '~> 6.0.3'
   gem 'carrierwave', '~> 0.11.0'
 end
 

data/gemfiles/5.1.gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem "activerecord", "~> 5.1.0"
+
+group :test do
+  gem "simplecov"
+  gem 'mongoid', '~> 7.0.1'
+  gem 'carrierwave', '~> 0.11.0'
+end
+
+gemspec :path => "../"
+

data/gemfiles/5.2.gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem "activerecord", "~> 5.2.0"
+
+group :test do
+  gem "simplecov"
+  gem 'mongoid', '~> 7.0.1'
+  gem 'carrierwave', '~> 0.11.0'
+end
+
+gemspec :path => "../"
+

data/lib/pluck_all.rb

@@ -1,14 +1,21 @@
-require "pluck_all/version"
+# frozen_string_literal: true
+require 'pluck_all/version'
 require 'active_record'
+begin
+  require 'mongoid'
+  require 'pluck_all/mongoid_pluck_all'
+rescue Gem::LoadError
+end
 
 class ActiveRecord::Base
   if !defined?(attribute_types) && defined?(column_types)
     class << self
-      #Rails 5 把column_types改成attribute_types
+      # column_types was changed to attribute_types in Rails 5
       alias_method :attribute_types, :column_types
     end
   end
 end
+
 module ActiveRecord
   [
     *([Type::Value, Type::Integer, Type::Serialized] if defined?(Type::Value)),
@@ -16,17 +23,18 @@ module ActiveRecord
   ].each do |s|
     s.class_eval do
       if !method_defined?(:deserialize) && method_defined?(:type_cast_from_database)
-        #Rails 5 把 type_cast_from_database 改成 deserialize
+        # column_types was changed to attribute_types in Rails 5
         alias deserialize type_cast_from_database
       end
     end
   end
 end
+
 class ActiveRecord::Relation
   if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('4.0.0')
     def pluck_all(*args)
       result = select_all(*args)
-      result.map! do |attributes| #This map! behaves different to array#map!
+      result.map! do |attributes| # This map! behaves different to array#map!
         initialized_attributes = klass.initialize_attributes(attributes)
         attributes.each do |key, attribute|
           attributes[key] = klass.type_cast_attribute(key, initialized_attributes) #TODO 現在AS過後的type cast會有一點問題
@@ -38,7 +46,7 @@ class ActiveRecord::Relation
     def pluck_all(*args)
       result = select_all(*args)
       attribute_types = klass.attribute_types
-      result.map! do |attributes| #This map! behaves different to array#map!
+      result.map! do |attributes| # This map! behaves different to array#map!
         attributes.each do |key, attribute|
           attributes[key] = result.send(:column_type, key, attribute_types).deserialize(attribute) #TODO 現在AS過後的type cast會有一點問題，但似乎原生的pluck也有此問題
         end
@@ -46,12 +54,15 @@ class ActiveRecord::Relation
       end
     end
   end
+
   def cast_need_columns(column_names, _klass = nil)
     @pluck_all_cast_need_columns = column_names.map(&:to_s)
     @pluck_all_cast_klass = _klass
     return self
   end
-private
+
+  private
+
   def select_all(*args)
     args.map! do |column_name|
       if column_name.is_a?(Symbol) && column_names.include?(column_name.to_s)
@@ -64,9 +75,10 @@ private
     return klass.connection.select_all(relation.select(args).to_sql)
     #return klass.connection.select_all(relation.arel)
   end
-#----------------------------------
-#  Support casting CarrierWave url
-#----------------------------------
+
+  # ----------------------------------------------------------------
+  # ● Support casting CarrierWave url
+  # ----------------------------------------------------------------
   def cast_carrier_wave_uploader_url(attributes)
     if defined?(CarrierWave) && klass.respond_to?(:uploaders)
       @pluck_all_cast_klass ||= klass
@@ -98,15 +110,17 @@ class ActiveRecord::Relation
 end
 
 
-class ActiveRecord::Base
-  def self.cast_need_columns(*args)
-    self.where('').cast_need_columns(*args)
+class << ActiveRecord::Base
+  def cast_need_columns(*args)
+    where(nil).cast_need_columns(*args)
   end
-  def self.pluck_all(*args)
-    self.where('').pluck_all(*args)
+
+  def pluck_all(*args)
+    where(nil).pluck_all(*args)
   end
-  def self.pluck_array(*args)
-    self.where('').pluck_array(*args)
+
+  def pluck_array(*args)
+    where(nil).pluck_array(*args)
   end
 end
 

data/lib/pluck_all/mongoid_pluck_all.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+module Mongoid
+  module Findable
+    delegate :pluck_all, :pluck_array, to: :with_default_scope
+  end
+
+  module Contextual
+    delegate :pluck_all, :pluck_array, to: :context
+
+    class None
+      def pluck_array(*)
+        []
+      end
+
+      def pluck_all(*)
+        []
+      end
+    end
+
+    class Mongo
+      def pluck_array(*fields)
+        normalized_select = get_normalized_select(fields)
+        get_query_data(normalized_select).reduce([]) do |plucked, doc|
+          values = normalized_select.keys.map do |n|
+            n =~ /\./ ? doc[n.partition('.')[0]] : doc[n]
+          end
+          plucked << (values.size == 1 ? values.first : values)
+        end
+      end
+
+      def pluck_all(*fields)
+        normalized_select = get_normalized_select(fields)
+        get_query_data(normalized_select).reduce([]) do |plucked, doc|
+          values = normalized_select.keys.map do |n|
+            [n, n =~ /\./ ? doc[n.partition('.')[0]] : doc[n]]
+          end.to_h
+          plucked << values
+        end
+      end
+
+      private
+
+      def get_query_data(normalized_select)
+        return (@view ? @view.projection(normalized_select) : query.dup.select(normalized_select))
+      end
+
+      def get_normalized_select(fields)
+        normalized_select = fields.inject({}) do |hash, f|
+          hash[klass.database_field_name(f)] = 1
+          hash
+        end
+      end
+    end
+  end
+end

data/lib/pluck_all/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module PluckAll
-  VERSION = "1.2.4"
+  VERSION = '2.0.0'
 end

data/pluck_all.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["khiav reoy"]
   spec.email         = ["mrtmrt15xn@yahoo.com.tw"]
 
-  spec.summary       = %q{Pluck multiple columns/attributes in Rails 3, 4, 5, and can return data as hash instead of only array.}
-  spec.description   = %q{Pluck multiple columns/attributes in Rails 3, 4, 5, and can return data as hash instead of only array. If you have a Rails 3 project, and want to pluck not only one column, feel free to use this gem and no need to worry about upgrading to Rails 4, 5 in the future will break this.}
+  spec.summary       = %q{Pluck multiple columns/attributes and return array of hashes. Support Rails 3, 4, 5.}
+  spec.description   = %q{Pluck multiple columns/attributes and return array of hashes. Support Rails 3, 4, 5. If you have a Rails 3 project, and want to pluck not only one column, feel free to use this gem and no need to worry about upgrading to Rails 4, 5 in the future will break this.}
   spec.homepage      = "https://github.com/khiav223577/pluck_all"
   spec.license       = "MIT"
 
@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "sqlite3", "~> 1.3"
   spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "mongoid", ">= 3.1.7"
 
   spec.add_dependency "activerecord", ">= 3"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluck_all
 version: !ruby/object:Gem::Version
-  version: 1.2.4
+  version: 2.0.0
 platform: ruby
 authors:
 - khiav reoy
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-11 00:00:00.000000000 Z
+date: 2018-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.7
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -80,10 +94,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3'
-description: Pluck multiple columns/attributes in Rails 3, 4, 5, and can return data
-  as hash instead of only array. If you have a Rails 3 project, and want to pluck
-  not only one column, feel free to use this gem and no need to worry about upgrading
-  to Rails 4, 5 in the future will break this.
+description: Pluck multiple columns/attributes and return array of hashes. Support
+  Rails 3, 4, 5. If you have a Rails 3 project, and want to pluck not only one column,
+  feel free to use this gem and no need to worry about upgrading to Rails 4, 5 in
+  the future will break this.
 email:
 - mrtmrt15xn@yahoo.com.tw
 executables: []
@@ -92,6 +106,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
@@ -101,7 +116,10 @@ files:
 - gemfiles/3.2.gemfile
 - gemfiles/4.2.gemfile
 - gemfiles/5.0.gemfile
+- gemfiles/5.1.gemfile
+- gemfiles/5.2.gemfile
 - lib/pluck_all.rb
+- lib/pluck_all/mongoid_pluck_all.rb
 - lib/pluck_all/version.rb
 - pluck_all.gemspec
 homepage: https://github.com/khiav223577/pluck_all
@@ -124,9 +142,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Pluck multiple columns/attributes in Rails 3, 4, 5, and can return data as
-  hash instead of only array.
+summary: Pluck multiple columns/attributes and return array of hashes. Support Rails
+  3, 4, 5.
 test_files: []