hash_selectors 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 530d9c99cacfe3b9c855797115355cad2d52a709
-  data.tar.gz: d04d9f82a1d9f289ee0af9aeb86cbff729289bf6
+  metadata.gz: b54f7f8b25b1ed4b3916fc65153e3126d63813ea
+  data.tar.gz: 750f16927853a5e0e67bdaf9f201acecec13ae74
 SHA512:
-  metadata.gz: a1682fc0cbb6edb9e3e454be01db2768adea2c16c8fe5db36a050caea97e437bf59ca9c6c2d7212042cc3684e77180946655ad4c5f3f6e517cc7247d528053b3
-  data.tar.gz: 42e0ca17a6f1dc52739db63cacde137f8ac7364ddb8915f86d566e4c49760b66113f1eec51d4293e7c4017b0cbf9a3b5f7cb6a26c1f551c243e69da8d50bb201
+  metadata.gz: 32ec80d8259e884168654271782a4abff1d62bd405812c1607b477d868936be712ba075d96f7a2d6b3be39ea8134d099b9ee60fef5e23327c279960d06a146a6
+  data.tar.gz: 44bb7d92ef2c2976c907ddd6d4fbb9b1c69e260f01ab0332d5b49f9eca61a40a6d174ea841ef5d91c676579797d6dd00c3574df3c8e15da40a6c0eb40b072cf5

data/README.md

@@ -3,9 +3,11 @@ hash-selectors
 
 A small set of select methods for Ruby Hashes
 
-# select_by...
+# select_by... (or filter_by...)
+{a: 1, b: 2, c: 3}.filter_by_keys :a, :b # returns {a: 1, b: 2}
 {a: 1, b: 2, c: 3}.select_by_keys :a, :b # returns {a: 1, b: 2}
 
+{a: 1, b: 2, c: 3}.filter_by_values 1, 3 # returns {a: 1, c: 3}
 {a: 1, b: 2, c: 3}.select_by_values 1, 3 # returns {a: 1, c: 3}
 
 # reject_by...

data/lib/hash_selectors.rb

@@ -2,11 +2,22 @@
 # Automatically mixed-in to Hash on load.
 module HashSelectors
 
+  # @example
+  #   {a: {ak: :av}, b: 2, c: 3}.merge_into(:a, {new_k: :new_v}) # returns {a: {ak: :av, new_k: :new_v}, b: 2, c: 3}
+  #
+  # @param [Any] Key to merge at
+  # @param [Hash] Hash of new pairs to merge at the Key
+  # @return [Hash] Merged results
+  def merge_into(the_key, hash_to_merge)
+    sub_hash = self[the_key] || {}
+    merge(the_key => sub_hash.merge(hash_to_merge))
+  end
+
   # @example
   #   {a: 1, b: 2, c: 3}.partition_by_keys :a, :b # returns [{a: 1, b: 2}, {c: 3}]
   #
   # @param [Glob of any type] ks
-  # @return [Hash] Partitioned results based on whether keys are included within the *ks* argument.
+  # @return [Array of Hashes] Partitioned results based on whether keys are included within the *ks* argument.
   def partition_by_keys(*ks)
     ### OPTIMIZE: Simple partition with the block results in nested Arrays. Investigate.
     blk = lambda { |k,v| ks.include?(k) }
@@ -17,7 +28,7 @@ module HashSelectors
   #   {a: 1, b: 2, c: 3}.partition_by_values 2, 3 # returns [{b: 2, c: 3}, {a: 1}]
   #
   # @param [Glob of any type] vs
-  # @return [Hash] Partitioned results based on whether values are included within the *vs* argument.
+  # @return [Array of Hashes] Partitioned results based on whether values are included within the *vs* argument.
   def partition_by_values(*vs)
     ### OPTIMIZE: Simple partition with the block results in nested Arrays. Investigate.
     blk = lambda { |k,v| vs.include?(v) }
@@ -50,6 +61,7 @@ module HashSelectors
   def select_by_keys(*ks)
     select { |k,v| ks.include?(k) }
   end
+  alias_method :filter_by_keys, :select_by_keys
 
   # @example
   #   {a: 1, b: 2, c: 3}.select_by_values 2, 3 # returns {b: 2, c: 3}
@@ -59,6 +71,7 @@ module HashSelectors
   def select_by_values(*vs)
     select { |k,v| vs.include?(v) }
   end
+  alias_method :filter_by_values, :select_by_values
 
   # @example
   #   {a: 1, b: 2, c: 3}.values_for_keys :a, :b # returns [1, 2]

data/spec/hash_selectors_spec.rb

@@ -7,6 +7,30 @@ RSpec.describe HashSelectors do
 
   ### INSTANCE METHODS
 
+  describe "#merge_into" do
+    context "assuming a Hash: {a: {}, b: 2, c: 3}}" do
+      let(:the_hash) { {a: {}, b: 2, c: 3} }
+      context "and given :a, {a1: :a2}" do
+        subject { the_hash.merge_into(:a, {a1: :a2}) }
+        it { is_expected.to eq({a: {a1: :a2}, b: 2, c: 3}) }
+      end
+    end
+    context "assuming a Hash: {a: {1 => 2}, b: 2, c: 3}}" do
+      let(:the_hash) { {a: {1 => 2}, b: 2, c: 3} }
+      context "and given :a, {a1: :a2}" do
+        subject { the_hash.merge_into(:a, {a1: :a2}) }
+        it { is_expected.to eq({a: {:a1 => :a2, 1 => 2}, b: 2, c: 3}) }
+      end
+    end
+    context "assuming a Hash: {a: {1 => 2}, b: 2, c: 3}}" do
+      let(:the_hash) { {a: {1 => 2}, b: 2, c: 3} }
+      context "and given :d, {d1: :d2}" do
+        subject { the_hash.merge_into(:d, {d1: :d2}) }
+        it { is_expected.to eq({a: {1 => 2}, b: 2, c: 3, d: {d1: :d2}}) }
+      end
+    end
+  end
+
   describe "#partition_by_keys" do
     context "assuming a Hash: {a: 1, b: 2, c: {c2: [:d, :e]}}" do
       let(:the_hash) { {a: 1, b: 2, c: {c2: [:d, :e]}} }
@@ -63,30 +87,35 @@ RSpec.describe HashSelectors do
     end
   end
 
-  describe "#select_by_keys" do
-    context "assuming a Hash: {a: 1, b: 2, c: {c2: [:d, :e]}}" do
-      let(:the_hash) { {a: 1, b: 2, c: {c2: [:d, :e]}} }
-      context "and given :a, :d" do
-        subject { the_hash.select_by_keys :a, :d }
-        it { is_expected.to eq({a: 1}) }
-      end
-      context "and given :a, :b" do
-        subject { the_hash.select_by_keys :a, :b }
-        it { is_expected.to eq({a: 1, b: 2}) }
-      end
-      context "and given :b, :c" do
-        subject { the_hash.select_by_keys :b, :c }
-        it { is_expected.to eq({b: 2, c: {c2: [:d, :e]}}) }
+  selection_prefixes = %w{ select filter }
+  selection_prefixes.each do |selection_prefix|
+    describe "##{selection_prefix}_by_keys" do
+      context "assuming a Hash: {a: 1, b: 2, c: {c2: [:d, :e]}}" do
+        let(:the_hash) { {a: 1, b: 2, c: {c2: [:d, :e]}} }
+        let(:the_meth) { "#{selection_prefix}_by_keys" }
+        context "and given :a, :d" do
+          subject { the_hash.send(the_meth, :a, :d) }
+          it { is_expected.to eq({a: 1}) }
+        end
+        context "and given :a, :b" do
+          subject { the_hash.send(the_meth, :a, :b) }
+          it { is_expected.to eq({a: 1, b: 2}) }
+        end
+        context "and given :b, :c" do
+          subject { the_hash.send(the_meth, :b, :c) }
+          it { is_expected.to eq({b: 2, c: {c2: [:d, :e]}}) }
+        end
       end
     end
-  end
 
-  describe "#select_by_values" do
-    context "assuming a Hash: {a: 1, b: 2, c: {c2: [:d, :e]}}" do
-      let(:the_hash) { {a: 1, b: 2, c: {c2: [:d, :e]}} }
-      context "and given 1, 2" do
-        subject { the_hash.select_by_values 1, 2 }
-        it { is_expected.to eq({a: 1, b: 2}) }
+    describe "##{selection_prefix}_by_values" do
+      let(:the_meth) { "#{selection_prefix}_by_values" }
+      context "assuming a Hash: {a: 1, b: 2, c: {c2: [:d, :e]}}" do
+        let(:the_hash) { {a: 1, b: 2, c: {c2: [:d, :e]}} }
+        context "and given 1, 2" do
+          subject { the_hash.send(the_meth, 1, 2) }
+          it { is_expected.to eq({a: 1, b: 2}) }
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_selectors
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kevin C. Baird
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-14 00:00:00.000000000 Z
+date: 2014-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec