pluck_to_hash 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8a7cad98ab4502a9b3836f0a5d769d334fa99b0
-  data.tar.gz: 5eb006f187a81d71311c3a019154fb9b21fbf2ad
+  metadata.gz: df4cd9672a0e574e5521ce4715ff26824ce4cd10
+  data.tar.gz: 4f3f7812b3e1fbb7765c66d50788035643aca3ca
 SHA512:
-  metadata.gz: 760b2cb5d06226b6e8def38a999452471b53b9a1fda35e7aec89c6c8d20cbfb3d3410ad43442e4f6da2e6b9d32363f428f40dee807d95384025c5c9e12d70c84
-  data.tar.gz: 778887f19c45dd8b929b2979ba0566730faf38fa0655d9dcef07cca08f7fde3b22a1ce36024e9a3076157fe0ca95f4731c459896e2d6c786d0f6d6db562abf3b
+  metadata.gz: 1b4d6fdafb153d7d83c5897de79a55994bd0e7bbd65ab94ce45699c28706374a9957917bbfdd6ebad8310e2f7440c434ef803cc6469ed6c044ca535de4dbb78e
+  data.tar.gz: c6605c8f62008cbd7364d57f7c4d34c77d23049b0176f0962cee967e782159f9f08ec6fc6754e6329dd35efaa9877ebda3f73da7a0e671cf89e0150446cf730d

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
-  - "1.9.3"
   - "2.2.0"
 # uncomment this line if your project needs to run something other than `rake`:
 script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 1.0 - 2016-06-10 
+
+* Hash keys are now strings instead of symbols to match behavior with `HashWithIndifferentAccess` [[#15](https://github.com/girishso/pluck_to_hash/pull/15)] @MrEmelianenko
+* Now accepts a block, which will return an array of whatever the block returns [[#15](https://github.com/girishso/pluck_to_hash/pull/15#issue-157198216)] @MrEmelianenko
+* Hash and Struct return types can be overridden (defaults are `HashWithIndifferentAccess`/`Struct`) [[#16](https://github.com/girishso/pluck_to_hash/pull/16)] @offthecuff

data/Gemfile

@@ -6,4 +6,6 @@ gemspec
 group :test do
   gem 'rspec'
   gem 'sqlite3'
+  gem 'activesupport', '4.2.6'
+  gem 'pg'
 end

data/README.md

@@ -106,9 +106,9 @@ Post.limit(2).pluck_to_struct(:id, :title) do |post_struct|
 end
 ```
 
-Allows specifying the type of struct. Defaults to statndard Struct.
+Allows specifying the type of struct. Defaults to standard Struct.
 ```ruby
-Post.limit(2).pluck_to_struct(:id, :title,struct_type: OtherStructType) do |post_struct|
+Post.limit(2).pluck_to_struct(:id, :title, struct_type: OtherStructType) do |post_struct|
   puts post_struct.title
 end
 ```

data/lib/pluck_to_hash.rb

@@ -5,8 +5,9 @@ module PluckToHash
 
   module ClassMethods
     def pluck_to_hash(*keys)
-      hash_type = keys[-1].is_a?(Hash) ? keys.pop.fetch(:hash_type,HashWithIndifferentAccess) : HashWithIndifferentAccess
       block_given = block_given?
+      hash_type = keys[-1].is_a?(Hash) ? keys.pop.fetch(:hash_type,HashWithIndifferentAccess) : HashWithIndifferentAccess
+
       keys, formatted_keys = format_keys(keys)
       keys_one = keys.size == 1
 
@@ -29,23 +30,29 @@ module PluckToHash
       end
     end
 
-    def format_keys(keys)
-      if keys.blank?
-        [column_names, column_names]
-      else
-        [
-          keys,
-          keys.map do |k|
-            case k
-            when String
-              k.split(/\bas\b/i)[-1].strip.to_sym
-            when Symbol
-              k
+    private
+      def get_correct_hash_type(hash, hash_type)
+        hash_type == HashWithIndifferentAccess ? hash.with_indifferent_access : hash
+      end
+
+      def format_keys(keys)
+        if keys.blank?
+          [column_names, column_names]
+        else
+          ks = keys.map{|k| k.instance_of?(String) ? k.split(",") : k}.flatten
+          [
+            ks,
+            ks.map do |k|
+              case k
+              when String
+                k.split(/\bas\b/i)[-1].strip.to_sym
+              when Symbol
+                k
+              end
             end
-          end
-        ]
+          ]
+        end
       end
-    end
 
     alias_method :pluck_h, :pluck_to_hash
     alias_method :pluck_s, :pluck_to_struct

data/lib/pluck_to_hash/version.rb

@@ -1,3 +1,3 @@
 module PluckToHash
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/pluck_to_hash.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "pg", "~> 0.19.0"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "values", "~> 1.8"
 

data/spec/migrations.rb

@@ -0,0 +1,25 @@
+require 'active_record'
+
+def run_migrations
+  # Turns off messaging during spec running of table creation
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Schema.define do
+    create_table :test_models do |t|
+      t.string :test_attribute
+      t.string :serialized_attribute
+    end
+    create_table :test_model_children do |t|
+      t.integer :test_model_id
+      t.string :children_name
+    end
+  end
+end
+
+class TestModel < ActiveRecord::Base
+  serialize :serialized_attribute, Array
+  has_many :test_model_children
+end
+
+class TestModelChild < ActiveRecord::Base
+  belongs_to :test_model
+end

data/spec/pluck_to_hash_spec.rb

@@ -2,73 +2,11 @@ require_relative './spec_helper'
 
 describe 'PluckToHash' do
   before { TestModel.delete_all }
+  include_context 'making sure alias is fine'
 
   describe '.pluck_to_hash' do
-    before do
-      3.times.each do
-        TestModel.create!
-      end
-    end
-
-    it 'plucks the ids of the objects to a hash correctly' do
-      TestModel.all.pluck_to_hash(:id).each do |hash|
-        expect(hash.class).to eq(HashWithIndifferentAccess)
-        expect(hash).to have_key(:id)
-      end
-    end
-
-    it 'pluck field with lowercase alias' do
-      TestModel.all.pluck_to_hash('id as Something').each do |hash|
-        expect(hash).to have_key(:Something)
-      end
-    end
-
-    it 'pluck field with uppercase alias' do
-      TestModel.all.pluck_to_hash('id AS otherfield').each do |hash|
-        expect(hash).to have_key(:otherfield)
-      end
-    end
-
-    it 'pluck field with mixedcase alias' do
-      TestModel.all.pluck_to_hash('id As anotherfield').each do |hash|
-        expect(hash).to have_key(:anotherfield)
-      end
-    end
-
-    context 'the model does not have the attribute specified' do
-      it 'raises an error' do
-        expect do
-          TestModel.all.pluck_to_hash(:foo)
-        end.to raise_error(ActiveRecord::StatementInvalid)
-      end
-    end
-
-    context 'no models exist for the given criteria' do
-      it 'returns an empty relation' do
-        result = TestModel.where(id: -1).pluck_to_hash(:id)
-        expect(result).to be_empty
-      end
-    end
-
-    context 'specifying multiple attributes' do
-      it 'returns a hash with both attributes' do
-        TestModel.all.pluck_to_hash(:id, :test_attribute).each do |hash|
-          expect(hash.class).to eq(HashWithIndifferentAccess)
-          expect(hash).to have_key(:id)
-          expect(hash).to have_key(:test_attribute)
-        end
-      end
-    end
-
-    context 'when using a different hash type' do
-      it 'returns a hash of the correct type with all attributes' do
-        TestModel.all.pluck_to_hash(:id, :test_attribute,hash_type: Hash).each do |hash|
-          expect(hash.class).to eq(Hash)
-          expect(hash).to have_key(:id)
-          expect(hash).to have_key(:test_attribute)
-        end
-      end
-    end
+    include_context 'essentials'
+    include_context 'when using a different hash type'
   end
 
   context 'when serialize attributes used' do
@@ -78,7 +16,7 @@ describe 'PluckToHash' do
         TestModel.create!(serialized_attribute: ['Zygohistomorpic', 'Prepromorphism'])
         TestModel.create!(serialized_attribute: ['Comonad'])
       end
-      
+
       it 'plucks the hash correctly' do
         result = TestModel.pluck_to_hash(:serialized_attribute)
         expect(result).to eq [
@@ -98,46 +36,4 @@ describe 'PluckToHash' do
       end
     end
   end
-
-  context 'making sure alias is fine' do
-    describe '.pluck_h' do
-      before do
-        3.times.each do
-          TestModel.create!
-        end
-      end
-
-      it 'plucks the ids of the objects to a hash correctly' do
-        TestModel.all.pluck_h(:id).each do |hash|
-          expect(hash.class).to eq(HashWithIndifferentAccess)
-          expect(hash).to have_key(:id)
-        end
-      end
-
-      context 'the model does not have the attribute specified' do
-        it 'raises an error' do
-          expect do
-            TestModel.all.pluck_h(:foo)
-          end.to raise_error(ActiveRecord::StatementInvalid)
-        end
-      end
-
-      context 'no models exist for the given criteria' do
-        it 'returns an empty relation' do
-          result = TestModel.where(id: -1).pluck_h(:id)
-          expect(result).to be_empty
-        end
-      end
-
-      context 'specifying multiple attributes' do
-        it 'returns a hash with both attributes' do
-          TestModel.all.pluck_h(:id, :test_attribute).each do |hash|
-            expect(hash.class).to eq(HashWithIndifferentAccess)
-            expect(hash).to have_key(:id)
-            expect(hash).to have_key(:test_attribute)
-          end
-        end
-      end
-    end
-  end
 end

data/spec/postgresql_spec.rb

@@ -0,0 +1,32 @@
+require 'active_record'
+require_relative '../lib/pluck_to_hash'
+require_relative './migrations'
+require_relative './support/shared_examples'
+
+describe 'PluckToHash with Postgres' do
+
+  before(:all) do
+    ActiveRecord::Base.remove_connection
+    @db_name = "pluck_to_hash_test"
+    %x( createdb -E UTF8 -T template0 #{@db_name} )
+    ActiveRecord::Base.establish_connection(
+      "adapter"  => "postgresql",
+      "database" => @db_name
+    )
+    run_migrations()
+  end
+
+  after(:all) do
+    ActiveRecord::Base.remove_connection
+    %x( dropdb #{@db_name})
+  end
+
+  before { TestModel.delete_all }
+  include_context 'making sure alias is fine'
+
+  describe '.pluck_to_hash' do
+    include_context 'essentials'
+    include_context 'when using a different hash type'
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,20 +1,11 @@
 require 'active_record'
 require_relative '../lib/pluck_to_hash'
+require_relative './migrations'
+require_relative './support/shared_examples'
 
 ActiveRecord::Base.establish_connection(
   "adapter"  => "sqlite3",
   "database" => ":memory:"
 )
 
-# Turns off messaging during spec running of table creation
-ActiveRecord::Migration.verbose = false
-ActiveRecord::Schema.define do
-  create_table :test_models do |t|
-    t.string :test_attribute
-    t.string :serialized_attribute
-  end
-end
-
-class TestModel < ActiveRecord::Base
-  serialize :serialized_attribute, Array
-end
+run_migrations()

data/spec/support/shared_examples.rb

@@ -0,0 +1,126 @@
+
+shared_context 'essentials' do
+  before do
+    3.times.each do
+      test_model = TestModel.create!
+      2.times do
+        TestModelChild.create!(test_model_id: test_model.id)
+      end
+    end
+  end
+
+  it 'plucks the ids of the objects to a hash correctly' do
+    TestModel.all.pluck_to_hash(:id).each do |hash|
+      expect(hash.class).to eq(HashWithIndifferentAccess)
+      expect(hash).to have_key(:id)
+    end
+  end
+
+  it 'pluck field with lowercase alias' do
+    TestModel.all.pluck_to_hash('id as something').each do |hash|
+      expect(hash).to have_key(:something)
+    end
+  end
+
+  it 'pluck field with uppercase alias' do
+    TestModel.all.pluck_to_hash('id AS otherfield').each do |hash|
+      expect(hash).to have_key(:otherfield)
+    end
+  end
+
+  it 'pluck field with mixedcase alias' do
+    TestModel.all.pluck_to_hash('id As anotherfield').each do |hash|
+      expect(hash).to have_key(:anotherfield)
+    end
+  end
+
+  it 'works with block parameter' do
+    TestModel.pluck_to_hash(:id) do |hash|
+      expect(hash).to have_key(:id)
+    end
+  end
+
+  it 'works with join' do
+    TestModel.joins(:test_model_children).pluck_to_hash('test_models.id, test_model_children.id').each do |hash|
+      expect(hash).to have_key('test_models.id')
+      expect(hash).to have_key('test_model_children.id')
+    end
+  end
+
+  context 'the model does not have the attribute specified' do
+    it 'raises an error' do
+      expect do
+        TestModel.all.pluck_to_hash(:foo)
+      end.to raise_error(ActiveRecord::StatementInvalid)
+    end
+  end
+
+  context 'no models exist for the given criteria' do
+    it 'returns an empty relation' do
+      result = TestModel.where(id: -1).pluck_to_hash(:id)
+      expect(result).to be_empty
+    end
+  end
+
+  context 'specifying multiple attributes' do
+    it 'returns a hash with both attributes' do
+      TestModel.all.pluck_to_hash(:id, :test_attribute).each do |hash|
+        expect(hash.class).to eq(HashWithIndifferentAccess)
+        expect(hash).to have_key('id')
+        expect(hash).to have_key(:test_attribute)
+      end
+    end
+  end
+end
+
+shared_context 'making sure alias is fine' do
+  describe '.pluck_h' do
+    before do
+      3.times.each do
+        TestModel.create!
+      end
+    end
+
+    it 'plucks the ids of the objects to a hash correctly' do
+      TestModel.all.pluck_h(:id).each do |hash|
+        expect(hash.class).to eq(HashWithIndifferentAccess)
+        expect(hash).to have_key(:id)
+      end
+    end
+
+    context 'the model does not have the attribute specified' do
+      it 'raises an error' do
+        expect do
+          TestModel.all.pluck_h(:foo)
+        end.to raise_error(ActiveRecord::StatementInvalid)
+      end
+    end
+
+    context 'no models exist for the given criteria' do
+      it 'returns an empty relation' do
+        result = TestModel.where(id: -1).pluck_h(:id)
+        expect(result).to be_empty
+      end
+    end
+
+    context 'specifying multiple attributes' do
+      it 'returns a hash with both attributes' do
+        TestModel.all.pluck_h(:id, :test_attribute).each do |hash|
+          expect(hash.class).to eq(HashWithIndifferentAccess)
+          expect(hash).to have_key(:id)
+          expect(hash).to have_key(:test_attribute)
+        end
+      end
+    end
+  end
+end
+
+shared_context 'when using a different hash type' do
+  it 'returns a hash of the correct type with all attributes' do
+    TestModel.all.pluck_to_hash(:id, :test_attribute, hash_type: Hash).each do |hash|
+      expect(hash.class).to eq(Hash)
+      expect(hash.with_indifferent_access).to have_key(:id)
+      expect(hash.with_indifferent_access).to have_key(:test_attribute)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluck_to_hash
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Girish S
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-10 00:00:00.000000000 Z
+date: 2017-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +132,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -125,9 +140,12 @@ files:
 - lib/pluck_to_hash.rb
 - lib/pluck_to_hash/version.rb
 - pluck_to_hash.gemspec
+- spec/migrations.rb
 - spec/pluck_to_hash_spec.rb
 - spec/pluck_to_struct_spec.rb
+- spec/postgresql_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples.rb
 homepage: https://github.com/girishso/pluck_to_hash
 licenses:
 - MIT
@@ -148,11 +166,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Extend ActiveRecord pluck to return hash
 test_files:
+- spec/migrations.rb
 - spec/pluck_to_hash_spec.rb
 - spec/pluck_to_struct_spec.rb
+- spec/postgresql_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples.rb