corefines 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4f2aa64f58e3be7d11dc02d322111b762bfe5fc
-  data.tar.gz: 283d79fe43753535b16469e15bf2413055713698
+  metadata.gz: cc488d6deade84992853796d2e3e315e23a2bb32
+  data.tar.gz: 4f671bc5963d4002509d54a90dc41024a9efa676
 SHA512:
-  metadata.gz: 82a3e76586a5a45335a2838c11d108a875b2d5ff2ac9a7e92141017eac240c9c8c0e136c6c0e7fe007d889b6da92d3f78f73d878ba964cda665e714b0a101edc
-  data.tar.gz: a104e1756ebf9caa6621e4fc890238248e1a814dfc1ace32e36a725f3370809accb0b7fbf7354a356004af59b0b9da6a4fd4564f0c8077551274ecca1016fdd0
+  metadata.gz: 96553f167a0dc42ce8c556ef92e3542940bd6093ab1b5e368c58e7627e3f83ed479368bc5b552be845ee84c68ee52e254781ab42eb44777ad53d75e20c19108f
+  data.tar.gz: 5ca6dc072b0ecf10503271b7d18ab2bee23efdf1663050f59a9c38e5c68409a19636ea9979986542848f11a960132361575e3b5142fdf225525b27e559ab3986

data/lib/corefines/hash.rb

@@ -69,6 +69,43 @@ module Corefines
       end
     end
 
+    ##
+    # @!method flat_map(&block)
+    #   Returns a new hash with the merged results of running the _block_ once
+    #   for every entry in +self+.
+    #
+    #   @example
+    #     hash = { a: 1, b: 2, c: 3 }
+    #     hash.flat_map { |k, v| {k => v * 2, k.upcase => v} if v % 2 == 1 }
+    #     # => { a: 2, A: 1, c: 6, C: 3 }
+    #     hash.flat_map { |k, v| [[k, v * 2], [k.upcase => v]] if v % 2 == 1 }
+    #     # => { a: 2, A: 1, c: 6, C: 3 }
+    #
+    #   @yield [key, value] gives every key-value pair to the block.
+    #   @yieldreturn [#to_h, Array, nil] an object that will be interpreted as
+    #     a Hash and merged into the result, or nil to omit this key-value.
+    #   @return [Hash] a new hash.
+    module FlatMap
+      refine ::Hash do
+        def flat_map
+          each_with_object({}) do |(key, value), hash|
+            yielded = yield(key, value)
+
+            if yielded.is_a? ::Hash
+              hash.merge!(yielded)
+            elsif yielded.is_a? ::Array
+              # Array#to_h exists since Ruby 2.1.
+              yielded.each do |pair|
+                hash.store(*pair)
+              end
+            elsif yielded
+              hash.merge!(yielded.to_h)
+            end
+          end
+        end
+      end
+    end
+
     ##
     # @!method only(*keys)
     #   @example
@@ -132,6 +169,35 @@ module Corefines
       end
     end
 
+    ##
+    # @!method recurse(&block)
+    #   Transforms this hash and each of its sub-hashes recursively using the
+    #   given _block_.
+    #
+    #   It does not mutate the hash if the given _block_ is pure (i.e. does not
+    #   modify given hashes, but returns new ones).
+    #
+    #   @example
+    #     hash = {"a" => 1, "b" => {"c" => {"e" => 5}, "d" => 4}}
+    #     hash.recurse!(&:symbolize_keys!)  # => {a: 1, b: {c: {e: 5}, d: 4}}
+    #     hash  # => {a: 1, b: {c: {e: 5}, d: 4}}
+    #
+    #   @yield [Hash] gives this hash and every sub-hash (recursively).
+    #     The return value replaces the old value.
+    #   @return [Hash] a result of applying _block_ to this hash and each of
+    #     its sub-hashes (recursively).
+    #
+    module Recurse
+      refine ::Hash do
+        def recurse(&block)
+          h = yield(self)
+          h.each do |key, value|
+            h[key] = value.recurse(&block) if value.is_a? ::Hash
+          end
+        end
+      end
+    end
+
     ##
     # @!method rekey(key_map = nil, &block)
     #   Returns a new hash with keys transformed according to the given

data/lib/corefines/version.rb

@@ -1,3 +1,3 @@
 module Corefines
-  VERSION = '1.10.0'
+  VERSION = '1.11.0'.freeze
 end

data/spec/hash/flat_map_spec.rb

@@ -0,0 +1,61 @@
+require 'ostruct'
+
+describe Hash do
+  describe '#flat_map' do
+    using Corefines::Hash::flat_map
+
+    let(:hash) { {a: 1, b: 2, c: 3} }
+    let!(:original) { hash.dup }
+
+    context "with block" do
+      it "returns a new hash, does not mutate self" do
+        expect( hash.flat_map { |k, v| {k => v * 2} } ).to be_a Hash
+        expect( hash ).to eq original
+      end
+
+      context "that yields Hash" do
+        it "returns merged results of running block for each entry" do
+          expect( hash.flat_map { |k, v| {k => v * 2, k.upcase => v * 3} } )
+            .to eq({a: 2, A: 3, b: 4, B: 6, c: 6, C: 9})
+        end
+
+        it "does not flatten yielded hashes" do
+          expect( hash.flat_map { |k, v| {k => {k.upcase => v}} } )
+            .to eq({a: {A: 1}, b: {B: 2}, c: {C: 3}})
+        end
+
+        it "omits entries for which the block yielded nil" do
+          expect( hash.flat_map { |k, v| {k.upcase => v * 2} if k != :b } )
+            .to eq({A: 2, C: 6})
+        end
+
+        it "handles duplicated keys by method the last wins" do
+          expect( hash.flat_map { |k, v| {k => v * 2, b: v * 6} } )
+            .to eq({a: 2, b: 18, c: 6})
+        end
+      end
+
+      context "that yields Array" do
+        it "interprets array of pairs as Hash" do
+          expect( hash.flat_map { |k, v| [[k, v * 2], [k.upcase, v * 3]] } )
+            .to eq({a: 2, A: 3, b: 4, B: 6, c: 6, C: 9})
+        end
+
+        it "raises ArgumentError if nested array has more than 2 elements" do
+          expect { hash.flat_map { |k, v| [[k, v, v]] } }.to raise_error(ArgumentError)
+        end
+      end
+
+      # There's no usable class in 1.9.3 implementing #to_h and I'd like to
+      # keep this simple...
+      if RUBY_VERSION.to_f >= 2
+        context "that yields object responding to #to_h" do
+          it "calls #to_h on yielded value" do
+            expect( hash.flat_map { |k, v| OpenStruct.new(k => v * 2) } )
+              .to eq({a: 2, b: 4, c: 6})
+          end
+        end
+      end
+    end
+  end
+end

data/spec/hash/recurse_spec.rb

@@ -0,0 +1,36 @@
+describe Hash do
+  describe '#recurse' do
+    using Corefines::Hash::recurse
+
+    subject(:hash) { {a: 1, b: {d: {f: 6}, e: 5}, c: 3} }
+    let(:expected) { {a: 1, b: {d: {f: 6, x: 42}, e: 5, x: 42}, c: 3, x: 42} }
+    let!(:original) { Marshal.load(Marshal.dump(hash)) }  # deep clone
+
+    shared_examples :common do
+      it "returns a result of calling block on the hash and sub-hashes recursively" do
+        is_expected.to eq expected
+      end
+    end
+
+    context "with pure block" do
+      subject!(:result) { hash.recurse { |h| h.merge(x: 42) } }
+
+      include_examples :common
+
+      it "does not mutate the original hash" do
+        expect( hash ).to eq original
+      end
+    end
+
+    context "with impure block" do
+      subject!(:result) { hash.recurse { |h| h.merge!(x: 42) } }
+
+      include_examples :common
+
+      it "modifies the hash in-place" do
+        expect( hash ).to eq expected
+        expect( hash ).to_not eq original
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,3 @@
-require 'simplecov' unless RUBY_ENGINE == 'jruby'
-require 'corefines'
-
 RSpec.configure do |config|
 
   # rspec-expectations config
@@ -28,3 +25,13 @@ RSpec.configure do |config|
 
   config.color = true
 end
+
+unless RUBY_ENGINE == 'jruby'
+  require 'simplecov'
+
+  SimpleCov.start do
+    add_filter '/spec/'
+  end
+end
+
+require 'corefines'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: corefines
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-25 00:00:00.000000000 Z
+date: 2017-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -128,8 +128,10 @@ files:
 - spec/enumerable/map_to_spec.rb
 - spec/hash/compact_spec.rb
 - spec/hash/except_spec.rb
+- spec/hash/flat_map_spec.rb
 - spec/hash/only_spec.rb
 - spec/hash/op_add_spec.rb
+- spec/hash/recurse_spec.rb
 - spec/hash/rekey_spec.rb
 - spec/hash/symbolize_keys_spec.rb
 - spec/module/alias_class_method_spec.rb
@@ -179,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A collection of refinements for Ruby core classes.