pluck_to_hash 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a7fe060dfcbb892add553d800bd8575bd621487
-  data.tar.gz: cb03eada7845be91083740aa56668ad708ee95f7
+  metadata.gz: 6a3229df2da1185b057f0e9044706edf65e95c40
+  data.tar.gz: 6747bf279dc92fb4b16fb4e42a84186ee1b5e63b
 SHA512:
-  metadata.gz: ebddbc03cf70b455ea0f3194cbd028fb562f5f3bb058822c9ddb3981e90b7378985b781ba7d6ccf369db5e371724b3715f389f0321e6c95ebb0f9ba537eaa1c8
-  data.tar.gz: a932bd372a7733578182362ffc00c67d9add36000820518aeca94b8a244d4bd89e8566464023e907f96292dda83591e0c541ac488cf09efcb42f029c511c7629
+  metadata.gz: 9b8c27695035f0ff794a34d5fd153728eb872aa693fef0cb078bc0326c00523c9f9d912a473a41925c14dfe6f2e0a662f7c8c1de4992e0029a786be44e6bb936
+  data.tar.gz: b3f5d9d7e24ffea05bf52c579cc381cf88b51f8280d41f805efb567dceb4b94866bb99f09ab795a31450d2a17e06b6d720b0949d012409817518a917d93e4aac

data/README.md

@@ -2,6 +2,8 @@
 
 Extends ActiveRecord by adding `pluck_to_hash` method that returns array of hashes instead of array of arrays. Useful when plucking multiple columns for rendering json or you need to access individual fields in your view for example.
 
+Supports `pluck_to_struct` since version 0.3.0. `pluck_to_struct` returns an array of `struct`s.
+
 [![Gem Version](https://badge.fury.io/rb/pluck_to_hash.png)](http://badge.fury.io/rb/pluck_to_hash) [![Build Status](https://travis-ci.org/girishso/pluck_to_hash.svg?branch=master)](https://travis-ci.org/girishso/pluck_to_hash)
 
 ## Installation
@@ -55,6 +57,52 @@ User.pluck_to_hash(:id, 'created_at::date as my_date', 'created_at::time as my_t
 #
 ```
 
+Accepts `block` parameter
+
+```ruby
+User.pluck_to_hash(:id, :title) do |user_hash|
+  ...
+end
+```
+
+### Using `pluck_to_struct`
+
+```ruby
+posts = Post.limit(2).pluck_to_struct(:id, :title)
+#
+# [#<struct id=1, title="foo">, #<struct id=2, title="bar">]
+#
+
+posts.first.id
+# 1
+
+posts.first.title
+# "foo"
+
+```
+
+or use the shorter alias `pluck_s`
+
+```ruby
+posts = Post.limit(2).pluck_s(:id, :title)
+#
+# [#<struct id=1, title="foo">, #<struct id=2, title="bar">]
+#
+```
+
+Supports `block` parameter as well
+
+```ruby
+Post.limit(2).pluck_to_struct(:id, :title) do |post_struct|
+  puts post_struct.title
+end
+```
+
+
+## Using with Sinatra or other non-rails frameworks without ActiveSupport
+
+Use version `0.1.4` that removes ActiveSupport dependency. `HashWithIndifferentAccess` is not used in that case.
+
 ## Why not `ActiveRecord.select` or `ActiveRecord.as_json`?
 
 Here are results of "benchmark" tests performed on MacBook Air. Each method did 10 runs, rejected the 2 highest and 2 lowest times and average the remaining 6. Ran these tests on about 40,000 records. We notice that `pluck_to_hash` is almost 4x faster than `select` and about 8x faster than `as_json`. As with all the "benchmarks", you should take these results with a pinch of salt!
@@ -81,4 +129,4 @@ as_json         1.196667   0.010000   1.206667 (  1.222286)
 ## Licence
 MIT License
 
-Brought to you by: [Cube Root Software](http://www.cuberoot.in) &copy; 2015
+Brought to you by: [Cube Root Software](http://www.cuberoot.in) &copy; 2016

data/lib/pluck_to_hash.rb

@@ -7,7 +7,31 @@ module PluckToHash
     def pluck_to_hash(*keys)
       block_given = block_given?
       keys = column_names if keys.blank?
-      formatted_keys = keys.map do |k|
+      formatted_keys = format_keys(keys)
+      pluck(*keys).map do |row|
+        row = [row] if keys.size == 1
+        value = HashWithIndifferentAccess[formatted_keys.zip(row)]
+        yield(value) if block_given
+        value
+      end
+    end
+
+    def pluck_to_struct(*keys)
+      block_given = block_given?
+      keys = column_names if keys.blank?
+      formatted_keys = format_keys(keys)
+
+      struct = Struct.new(*formatted_keys)
+      pluck(*keys).map do |row|
+        row = [row] if keys.size == 1
+        value = struct.new(*row)
+        yield(value) if block_given
+        value
+      end
+    end
+
+    def format_keys(keys)
+      keys.map do |k|
         case k
         when String
           k.split(/ as /i)[-1].to_sym
@@ -15,15 +39,10 @@ module PluckToHash
           k
         end
       end
-      pluck(*keys).map do |row|
-        row = [row] if keys.size == 1
-        value = HashWithIndifferentAccess[formatted_keys.zip(row)]
-        yield(value) if block_given
-        value
-      end
     end
 
     alias_method :pluck_h, :pluck_to_hash
+    alias_method :pluck_s, :pluck_to_struct
   end
 end
 

data/lib/pluck_to_hash/version.rb

@@ -1,3 +1,3 @@
 module PluckToHash
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/pluck_to_struct_spec.rb

@@ -0,0 +1,80 @@
+require_relative './spec_helper'
+
+describe 'PluckToStruct' do
+  before { TestModel.delete_all }
+
+  context '.pluck_to_struct' do
+    before do
+      TestModel.create!(id: 1, test_attribute: "test1")
+      TestModel.create!(id: 2, test_attribute: "test2")
+      TestModel.create!(id: 3, test_attribute: "test3")
+    end
+
+    it 'plucks the ids, test_attributes of the objects to a struct correctly' do
+      TestModel.all.pluck_to_struct(:test_attribute, :id).each_with_index do |model, ix|
+        id = ix+1
+        expect(model).to be_a(Struct)
+        expect(model.test_attribute).to eq("test#{id}")
+        expect(model.id).to eq(id)
+      end
+    end
+
+    context 'alias pluck_s' do
+      it 'works correctly' do
+        struct = TestModel.where(id: 1).pluck_s(:test_attribute).first
+        expect(struct.test_attribute).to eq("test1")
+      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
+      end
+    end
+
+    context 'no models exist for the given criteria' do
+      it 'returns an empty relation' do
+        expect do
+          result = TestModel.where(id: -1).pluck_h(:id)
+          expect(result).to be_empty
+        end.to_not raise_error
+      end
+    end
+
+  end
+
+
+  context 'when serialize attributes used' do
+    describe '.pluck_to_struct' do
+      before do
+        TestModel.create!(id: 1, serialized_attribute: [])
+        TestModel.create!(id: 2, serialized_attribute: ['Zygohistomorpic', 'Prepromorphism'])
+        TestModel.create!(id: 3, serialized_attribute: ['Comonad'])
+      end
+      
+      it 'plucks to struct correctly' do
+        result = TestModel.pluck_to_struct(:serialized_attribute)
+
+        expect(result[0].serialized_attribute).to eq([])
+        expect(result[1].serialized_attribute).to eq(['Zygohistomorpic', 'Prepromorphism'])
+        expect(result[2].serialized_attribute).to eq(['Comonad'])
+      end
+
+      it 'plucks to struct with multiple attributes' do
+        result = TestModel.pluck_to_struct(:id, :serialized_attribute)
+
+        expect(result[0].serialized_attribute).to eq([])
+        expect(result[0].id).to eq(1)
+
+        expect(result[1].serialized_attribute).to eq(['Zygohistomorpic', 'Prepromorphism'])
+        expect(result[1].id).to eq(2)
+
+        expect(result[2].serialized_attribute).to eq(['Comonad'])
+        expect(result[2].id).to eq(3)
+      end
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pluck_to_hash
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Girish S
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-22 00:00:00.000000000 Z
+date: 2016-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -112,6 +112,7 @@ files:
 - lib/pluck_to_hash/version.rb
 - pluck_to_hash.gemspec
 - spec/pluck_to_hash_spec.rb
+- spec/pluck_to_struct_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/girishso/pluck_to_hash
 licenses:
@@ -139,4 +140,5 @@ specification_version: 4
 summary: Extend ActiveRecord pluck to return hash
 test_files:
 - spec/pluck_to_hash_spec.rb
+- spec/pluck_to_struct_spec.rb
 - spec/spec_helper.rb