pluck_all 2.0.0 → 2.1.0

data/.travis.yml

@@ -1,27 +1,68 @@
 sudo: false
-env:
-  global:
-    - CC_TEST_REPORTER_ID=db72eba1ff8fb1329dae5fb9b9dcd234243899d7a464ceb374e14a05ead27b7c
 language: ruby
 rvm:
   - 2.2
-  - 2.3
+  - 2.6
+  - 2.7
 services:
   - mongodb
+env:
+  global:
+    - CC_TEST_REPORTER_ID=db72eba1ff8fb1329dae5fb9b9dcd234243899d7a464ceb374e14a05ead27b7c
+  matrix:
+    - ORM_TYPE=ACTIVE_RECORD
+    - ORM_TYPE=MONGOID
 gemfile:
-  - gemfiles/3.2.gemfile
-  - gemfiles/4.2.gemfile
-  - gemfiles/5.0.gemfile
-  - gemfiles/5.1.gemfile
-  - gemfiles/5.2.gemfile
+  - gemfiles/active_record_32.gemfile
+  - gemfiles/active_record_42.gemfile
+  - gemfiles/active_record_50.gemfile
+  - gemfiles/active_record_51.gemfile
+  - gemfiles/active_record_52.gemfile
+  - gemfiles/active_record_60.gemfile
+  - gemfiles/mongoid_54.gemfile
+  - gemfiles/mongoid_64.gemfile
+  - gemfiles/mongoid_70.gemfile
+matrix:
+  exclude:
+    - gemfile: gemfiles/active_record_32.gemfile
+      rvm: 2.6
+    - gemfile: gemfiles/active_record_32.gemfile
+      rvm: 2.7
+    - gemfile: gemfiles/active_record_32.gemfile
+      env: ORM_TYPE=MONGOID
+    - gemfile: gemfiles/active_record_42.gemfile
+      rvm: 2.7
+    - gemfile: gemfiles/active_record_42.gemfile
+      env: ORM_TYPE=MONGOID
+    - gemfile: gemfiles/active_record_50.gemfile
+      env: ORM_TYPE=MONGOID
+    - gemfile: gemfiles/active_record_51.gemfile
+      env: ORM_TYPE=MONGOID
+    - gemfile: gemfiles/active_record_52.gemfile
+      env: ORM_TYPE=MONGOID
+    - gemfile: gemfiles/active_record_60.gemfile
+      rvm: 2.2
+    - gemfile: gemfiles/active_record_60.gemfile
+      env: ORM_TYPE=MONGOID
+    - gemfile: gemfiles/mongoid_54.gemfile
+      rvm: 2.7
+    - gemfile: gemfiles/mongoid_54.gemfile
+      env: ORM_TYPE=ACTIVE_RECORD
+    - gemfile: gemfiles/mongoid_64.gemfile
+      env: ORM_TYPE=ACTIVE_RECORD
+    - gemfile: gemfiles/mongoid_70.gemfile
+      env: ORM_TYPE=ACTIVE_RECORD
 before_install:
-  - gem install bundler
-  - gem update --system
+  - if `ruby -e 'exit(RUBY_VERSION.to_f < 2.7)'`; then
+      gem i rubygems-update -v '< 3' && update_rubygems;
+      gem install bundler -v '< 2';
+    fi
   - 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
+  - if [ "$ORM_TYPE" = "ACTIVE_RECORD" ]; then bundle exec rake test_active_record; fi
+  - if [ "$ORM_TYPE" = "MONGOID" ]; then bundle exec rake test_mongoid; fi
 after_script:
   - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -1,6 +1,34 @@
 ## Change Log
 
-### [upcoming](https://github.com/khiav223577/pluck_all/compare/v1.2.4...HEAD) 2018/04/05
+### [upcoming](https://github.com/khiav223577/pluck_all/compare/v2.0.4...HEAD) 2019/12/19
+- [#43](https://github.com/khiav223577/pluck_all/pull/43) Use rails_compatibility to get attribute_types for better compatibility (@khiav223577)
+- [#41](https://github.com/khiav223577/pluck_all/pull/41) Support Rails 6.0 (@khiav223577)
+
+### [v2.0.4](https://github.com/khiav223577/pluck_all/compare/v2.0.3...v2.0.4) 2019/04/04
+- [#40](https://github.com/khiav223577/pluck_all/pull/40) Fix: inconsistent with pluck when having `select` on relation (@khiav223577)
+- [#39](https://github.com/khiav223577/pluck_all/pull/39) Fix issue#38 (@MasashiYokota)
+- [#36](https://github.com/khiav223577/pluck_all/pull/36) Fix: broken test cases after bundler 2.0 was released (@khiav223577)
+- [#35](https://github.com/khiav223577/pluck_all/pull/35) refactor #test_pluck_with_includes (@khiav223577)
+- [#34](https://github.com/khiav223577/pluck_all/pull/34) Provide Arel support as well (@snkashis)
+- [#33](https://github.com/khiav223577/pluck_all/pull/33) Fix gemfile path in bin/setup (@snkashis)
+- [#32](https://github.com/khiav223577/pluck_all/pull/32) Move patches into separate files (@khiav223577)
+
+### [v2.0.3](https://github.com/khiav223577/pluck_all/compare/v2.0.2...v2.0.3) 2018/07/19
+- [#30](https://github.com/khiav223577/pluck_all/pull/30) Fix: includes + pluck_all results in strange output (@khiav223577)
+
+### [v2.0.2](https://github.com/khiav223577/pluck_all/compare/v2.0.1...v2.0.2) 2018/06/29
+- [#28](https://github.com/khiav223577/pluck_all/pull/28) Fix test cases and the result format may be wrong when plucking multiple columns with nil value may (@khiav223577)
+- [#27](https://github.com/khiav223577/pluck_all/pull/27) [Feature] Mongoid Hooks And Tests Separation (@berniechiu)
+- [#26](https://github.com/khiav223577/pluck_all/pull/26) [FIX] Wrong Module Skipped (@berniechiu)
+
+### [v2.0.1](https://github.com/khiav223577/pluck_all/compare/v2.0.0...v2.0.1) 2018/05/27
+- [#25](https://github.com/khiav223577/pluck_all/pull/25) Fix that project without mongoid will raise LoadError (@khiav223577)
+
+### [v2.0.0](https://github.com/khiav223577/pluck_all/compare/v1.2.4...v2.0.0) 2018/05/27
+- [#24](https://github.com/khiav223577/pluck_all/pull/24) Support Mongoid! (@khiav223577)
+- [#23](https://github.com/khiav223577/pluck_all/pull/23) Refactoring Coding Style (@khiav223577)
+- [#22](https://github.com/khiav223577/pluck_all/pull/22) test Rails 5.2 (@khiav223577)
+- [#21](https://github.com/khiav223577/pluck_all/pull/21) should test both 5.0.x and 5.1.x (@khiav223577)
 - [#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)
 
@@ -34,6 +62,6 @@
 ### [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
+### [v1.0.1](https://github.com/khiav223577/pluck_all/compare/v1.0.0...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

@@ -6,15 +6,17 @@
 [![Code Climate](https://codeclimate.com/github/khiav223577/pluck_all/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/pluck_all)
 [![Test Coverage](https://codeclimate.com/github/khiav223577/pluck_all/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/pluck_all/coverage)
 
-Pluck multiple columns/attributes in Rails 3, 4, 5, and can return data as hash instead of only array.
+Pluck multiple columns/attributes in Rails 3, 4, 5, 6, and can return data as hash instead of only array. Also supports `Mongoid`.
 
-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/).
+This Gem stands on the shoulders of this article: [Plucking Multiple Columns in Rails 3](https://meltingice.dev/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,
-feel free to use this gem and no need to worry about upgrading to Rails 4, 5 in the future will break this.
-
+feel free to use this gem and no need to worry about upgrading to Rails 4, 5, 6 in the future will break this.
 
+## Supports
+- Ruby 2.2 ~ 2.7
+- Rails 3.2, 4.2, 5.0, 5.1, 5.2, 6.0
 
 ## Installation
 
@@ -36,7 +38,7 @@ Or install it yourself as:
 
 ### pluck to array
 
-Behaves the same as the Rails 4 pluck, but you can use it in Rails 3
+Behaves the same as `#pluck` method, but you can use it to pluck multiple columns in Rails 3
 
 ```rb
 User.where('id < 3').pluck_array(:id, :account)
@@ -45,12 +47,15 @@ User.where('id < 3').pluck_array(:id, :account)
 
 ### pluck to hash
 
-Similar to `pluck_array`, but return hash instead.
+Similar to `#pluck` method, but return array of hashes instead.
 
 ```rb
 User.where('id < 3').pluck_all(:id, :account)
 # => [{"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"}]
+
 User.where('id < 3').pluck_all('id, account AS name')
 # => [{"id"=>1, "name"=>"account1"}, {"id"=>2, "name"=>"account2"}]
 ```
@@ -85,18 +90,50 @@ 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 by `benchmark-ips` and `limit 100` in each iteration:
+```
+Warming up --------------------------------------
+                 map     1.000  i/100ms
+        select + map    28.000  i/100ms
+    select + as_json     7.000  i/100ms
+           pluck_all    54.000  i/100ms
+Calculating -------------------------------------
+                 map     14.230  (± 0.0%) i/s -     72.000  in   5.065349s
+        select + map    281.638  (± 4.6%) i/s -      1.428k in   5.081216s
+    select + as_json     73.241  (± 4.1%) i/s -    371.000  in   5.076235s
+           pluck_all    539.057  (± 6.7%) i/s -      2.700k in   5.034858s
+
+Comparison:
+           pluck_all:      539.1 i/s
+        select + map:      281.6 i/s - 1.91x  slower
+    select + as_json:       73.2 i/s - 7.36x  slower
+                 map:       14.2 i/s - 37.88x  slower
+```
 [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.
+`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 shows the performance difference:
 
 ```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)
+Tested by `benchmark-ips` and `limit 1000` in each iteration:
+```
+Warming up --------------------------------------
+       pluck_to_hash     7.000  i/100ms
+           pluck_all     9.000  i/100ms
+Calculating -------------------------------------
+       pluck_to_hash     84.526  (± 4.7%) i/s -    427.000  in   5.065792s
+           pluck_all     95.133  (± 4.2%) i/s -    477.000  in   5.021555s
+
+Comparison:
+           pluck_all:       95.1 i/s
+       pluck_to_hash:       84.5 i/s - 1.13x  slower
+```
+See the [test script](https://github.com/khiav223577/pluck_all/issues/18#issuecomment-325407080) for more details.
 
 ## Other Support
 ### Support Pluck Carrierwave Uploader (if you use carrierwave)
@@ -110,12 +147,12 @@ User.where(xxx).map(&:profile_pic)
 If the uploader use something like: `model.id`, `model.name`
 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'] }
+User.where(xxx).cast_need_columns(%i[id name]).pluck_all(:id, :name, :profile_pic).map{|s| s['profile_pic'] }
 ```
 
 ## 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test_active_record` or `rake test_mongoid` 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](https://rubygems.org).
 

data/Rakefile

@@ -1,10 +1,22 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
+  t.libs << 'test'
+  t.libs << 'lib'
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+Rake::TestTask.new(:test_active_record) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/active_record/**/*_test.rb']
+end
+
+Rake::TestTask.new(:test_mongoid) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/mongoid/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "pluck_all"
+require 'bundler/setup'
+require 'pluck_all'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "pluck_all"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/bin/setup

@@ -3,6 +3,6 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
-bundle install --gemfile=gemfiles/4.2.gemfile
+bundle install --gemfile=gemfiles/active_record_42.gemfile
 
 # Do any other automated setup that you need to do here

data/gemfiles/active_record_32.gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'sqlite3',      '~> 1.3.0'
+gem 'activerecord', '~> 3.2.0'
+gem 'carrierwave',  '~> 0.11.0'
+
+group :test do
+  gem 'simplecov'
+end
+
+gemspec path: '../'

data/gemfiles/active_record_42.gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'sqlite3',      '~> 1.3.0'
+gem 'activerecord', '~> 4.2.0'
+gem 'carrierwave',  '~> 0.11.0'
+
+group :test do
+  gem 'simplecov'
+end
+
+gemspec path: '../'

data/gemfiles/active_record_50.gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'sqlite3',      '~> 1.3.0'
+gem 'activerecord', '~> 5.0.0'
+gem 'carrierwave',  '~> 0.11.0'
+
+group :test do
+  gem 'simplecov'
+end
+
+gemspec path: '../'

data/gemfiles/active_record_51.gemfile

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

data/gemfiles/active_record_52.gemfile

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

data/gemfiles/active_record_60.gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'sqlite3',      '~> 1.4.1'
+gem 'activerecord', '~> 6.0.0'
+gem 'carrierwave',  '~> 0.11.0'
+
+group :test do
+  gem 'simplecov'
+end
+
+gemspec path: '../'

data/gemfiles/mongoid_54.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'mongoid', '~> 5.4.0'
+
+group :test do
+  gem 'simplecov'
+end
+
+gemspec path: '../'

data/gemfiles/mongoid_64.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'mongoid', '~> 6.4.0'
+
+group :test do
+  gem 'simplecov'
+end
+
+gemspec path: '../'

data/gemfiles/mongoid_70.gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'mongoid', '~> 7.0.0'
+
+group :test do
+  gem 'simplecov'
+end
+
+gemspec path: '../'

data/lib/pluck_all.rb

@@ -1,131 +1,3 @@
 # 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
-      # 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)),
-    *([Enum::EnumType] if defined?(Enum::EnumType)),
-  ].each do |s|
-    s.class_eval do
-      if !method_defined?(:deserialize) && method_defined?(:type_cast_from_database)
-        # 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!
-        initialized_attributes = klass.initialize_attributes(attributes)
-        attributes.each do |key, attribute|
-          attributes[key] = klass.type_cast_attribute(key, initialized_attributes) #TODO 現在AS過後的type cast會有一點問題
-        end
-        cast_carrier_wave_uploader_url(attributes)
-      end
-    end
-  else
-    def pluck_all(*args)
-      result = select_all(*args)
-      attribute_types = klass.attribute_types
-      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
-        cast_carrier_wave_uploader_url(attributes)
-      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
-
-  def select_all(*args)
-    args.map! do |column_name|
-      if column_name.is_a?(Symbol) && column_names.include?(column_name.to_s)
-        "#{connection.quote_table_name(table_name)}.#{connection.quote_column_name(column_name)}"
-      else
-        column_name.to_s
-      end
-    end
-    relation = clone
-    return klass.connection.select_all(relation.select(args).to_sql)
-    #return klass.connection.select_all(relation.arel)
-  end
-
-  # ----------------------------------------------------------------
-  # ● Support casting CarrierWave url
-  # ----------------------------------------------------------------
-  def cast_carrier_wave_uploader_url(attributes)
-    if defined?(CarrierWave) && klass.respond_to?(:uploaders)
-      @pluck_all_cast_klass ||= klass
-      @pluck_all_uploaders ||= @pluck_all_cast_klass.uploaders.select{|key, uploader| attributes.key?(key.to_s) }
-      @pluck_all_uploaders.each do |key, uploader|
-        hash = {}
-        @pluck_all_cast_need_columns.each{|k| hash[k] = attributes[k] } if @pluck_all_cast_need_columns
-        obj = @pluck_all_cast_klass.new(hash)
-        obj[key] = attributes[key_s = key.to_s]
-        #https://github.com/carrierwaveuploader/carrierwave/blob/87c37b706c560de6d01816f9ebaa15ce1c51ed58/lib/carrierwave/mount.rb#L142
-        attributes[key_s] = obj.send(key)
-      end
-    end
-    return attributes
-  end
-end
-
-class ActiveRecord::Relation
-  if Gem::Version.new(ActiveRecord::VERSION::STRING) < Gem::Version.new('4.0.2')
-    def pluck_array(*args)
-      return pluck_all(*args).map{|hash|
-        result = hash.values #P.S. 這裡是相信ruby 1.9以後，hash.values的順序跟insert的順序一樣。
-        next (result.one? ? result.first : result)
-      }
-    end
-  else
-    alias_method :pluck_array, :pluck if not method_defined?(:pluck_array)
-  end
-end
-
-
-class << ActiveRecord::Base
-  def cast_need_columns(*args)
-    where(nil).cast_need_columns(*args)
-  end
-
-  def pluck_all(*args)
-    where(nil).pluck_all(*args)
-  end
-
-  def pluck_array(*args)
-    where(nil).pluck_array(*args)
-  end
-end
-
-module ActiveRecord::NullRelation
-  def pluck_all(*args)
-    []
-  end
-end
+require 'pluck_all/hooks'