pluck_all 2.0.4 → 2.3.2

data/README.md

@@ -1,20 +1,22 @@
 # PluckAll
 
 [![Gem Version](https://img.shields.io/gem/v/pluck_all.svg?style=flat)](http://rubygems.org/gems/pluck_all)
-[![Build Status](https://travis-ci.org/khiav223577/pluck_all.svg?branch=master)](https://travis-ci.org/khiav223577/pluck_all)
+[![Build Status](https://github.com/khiav223577/pluck_all/workflows/Ruby/badge.svg)](https://github.com/khiav223577/pluck_all/actions)
 [![RubyGems](http://img.shields.io/gem/dt/pluck_all.svg?style=flat)](http://rubygems.org/gems/pluck_all)
 [![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. Also supports Mongoid.
+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, 6.1
 
 ## 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,20 +90,72 @@ 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 globalize gem
+
+```rb
+class Post < ActiveRecord::Base
+  translates :title
+end
+```
+
+```rb
+I18n.locale = :en
+Post.pluck_all(:title)
+# => [{ 'title' => 'english' }, { 'title' => 'english' }, ...]
+
+I18n.locale = :'zh-TW'
+Post.pluck_all(:title)
+# => [{ 'title' => '中文' }, { 'title' => '中文' }, ...]
+```
+
+
 ### Support Pluck Carrierwave Uploader (if you use carrierwave)
 ```rb
 User.where(xxx).pluck_all(:profile_pic).map{|s| s['profile_pic'] }
@@ -110,7 +167,7 @@ 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

data/Rakefile

@@ -1,22 +1,22 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-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
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+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,14 +1,14 @@
-#!/usr/bin/env ruby
-
-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.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require 'irb'
-IRB.start
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/gemfiles/active_record_32.gemfile

@@ -1,13 +1,16 @@
-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: '../'
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'sqlite3',      '~> 1.3.0'
+gem 'activerecord', '~> 3.2.0'
+gem 'rails_compatibility', '~> 0.0.7'
+
+gem 'carrierwave',  '~> 0.11.0'
+gem 'mimemagic', '< 0.4.3' # Used by carrierwave gem
+
+group :test do
+  gem 'simplecov', '< 0.18'
+end
+
+gemspec path: '../'

data/gemfiles/active_record_42.gemfile

@@ -1,13 +1,18 @@
-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: '../'
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'sqlite3',      '~> 1.3.0'
+gem 'activerecord', '~> 4.2.0'
+gem 'rails_compatibility', '~> 0.0.7'
+
+gem 'carrierwave',  '~> 0.11.0'
+gem 'mimemagic', '< 0.4.3' # Used by carrierwave gem
+
+gem 'globalize'
+
+group :test do
+  gem 'simplecov', '< 0.18'
+end
+
+gemspec path: '../'

data/gemfiles/active_record_50.gemfile

@@ -1,13 +1,18 @@
-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: '../'
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'sqlite3',      '~> 1.3.0'
+gem 'activerecord', '~> 5.0.0'
+gem 'rails_compatibility', '~> 0.0.7'
+
+gem 'carrierwave',  '~> 0.11.0'
+gem 'mimemagic', '< 0.4.3' # Used by carrierwave gem
+
+gem 'globalize'
+
+group :test do
+  gem 'simplecov', '< 0.18'
+end
+
+gemspec path: '../'

data/gemfiles/active_record_51.gemfile

@@ -1,13 +1,18 @@
-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: '../'
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'sqlite3',      '~> 1.3.0'
+gem 'activerecord', '~> 5.1.0'
+gem 'rails_compatibility', '~> 0.0.7'
+
+gem 'carrierwave',  '~> 0.11.0'
+gem 'mimemagic', '< 0.4.3' # Used by carrierwave gem
+
+gem 'globalize'
+
+group :test do
+  gem 'simplecov', '< 0.18'
+end
+
+gemspec path: '../'

data/gemfiles/active_record_52.gemfile

@@ -1,13 +1,18 @@
-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: '../'
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'sqlite3',      '~> 1.3.0'
+gem 'activerecord', '~> 5.2.0'
+gem 'rails_compatibility', '~> 0.0.7'
+
+gem 'carrierwave',  '~> 0.11.0'
+gem 'mimemagic', '< 0.4.3' # Used by carrierwave gem
+
+gem 'globalize'
+
+group :test do
+  gem 'simplecov', '< 0.18'
+end
+
+gemspec path: '../'

data/gemfiles/active_record_60.gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'sqlite3',      '~> 1.4.1'
+gem 'activerecord', '~> 6.0.0'
+gem 'rails_compatibility', '~> 0.0.7'
+
+gem 'carrierwave',  '~> 0.11.0'
+gem 'mimemagic', '< 0.4.3' # Used by carrierwave gem
+
+gem 'globalize'
+
+group :test do
+  gem 'simplecov', '< 0.18'
+end
+
+gemspec path: '../'

data/gemfiles/active_record_61.gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pluck_all.gemspec
+
+gem 'sqlite3',      '~> 1.4.1'
+gem 'activerecord', '~> 6.1.0'
+gem 'rails_compatibility', '~> 0.0.7'
+
+gem 'carrierwave',  '~> 0.11.0'
+gem 'mimemagic', '< 0.4.3' # Used by carrierwave gem
+
+gem 'globalize'
+
+group :test do
+  gem 'simplecov', '< 0.18'
+end
+
+gemspec path: '../'

data/gemfiles/mongoid_54.gemfile

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

data/gemfiles/mongoid_64.gemfile

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