corefines 1.8.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1470ef3188042ed178a8c0204e54046b3ea6a3d
-  data.tar.gz: 6a5e024a2f6e81e59aade31d49b09e59d3be57df
+SHA256:
+  metadata.gz: e1786b22dad695d512f646e225334eeae9ecb2621a067461dc5c01151137ead0
+  data.tar.gz: 128135d2233f9b74976347ee1bbb4cae8b91327227aa4ed0e13432011f51d689
 SHA512:
-  metadata.gz: 2d5d5921ebd1dcbd39cd5a499ef9f82a4c4847cfdabea32df8c302db256a20cc6c1a45bf62e2923e052136ebb375a7839c598b2094830da22f488e74846edf30
-  data.tar.gz: 66952a116b6e578b37745a5da4275e1f913c397265ae3f51ea0047bb2ed963fa2b94016cce45c4d976577bfa5b907688799644f25fc39b3a3bad1cb2082d0ed1
+  metadata.gz: 5159cba9976f0b56054472b43a3f0c28ce100eda5e6efe79896b97fdba42f078edc91327066b7dd99c3e9698b87c7ae643ad6989057ccf9d1b728f315bfd990d
+  data.tar.gz: a0158e47cc535f3e604a992ffac923812b1df13af300a2b91c56e77ab9a1983a374a5f630dfb11f005bbfd29926ca0504a17c976504b7feb0abf206a5b6f7b47

data/CHANGELOG.adoc

@@ -3,9 +3,31 @@
 :doc-base-url: http://www.rubydoc.info/github/jirutka/corefines/Corefines
 :issue-uri: {repo-uri}/issues
 
+
+== 1.11.1 (2021-07-21)
+
+* Fix String#rekey with symbol proc (e.g. `&:to_s`) failing on Ruby 3.0.
+
+
+== 1.11.0 (2017-09-15)
+
+* Add new refinement {doc-base-url}/Hash/Recurse[Hash#recurse].
+* Add new refinement {doc-base-url}/Hash/FlatMap[Hash#flat_map].
+
+
+== 1.10.0 (2017-07-26)
+
+* Replace deprecated `Fixnum` with `Integer`.
+
+
+== 1.9.0 (2016-02-03)
+
+* Add new refinement {doc-base-url}/Enumerable/MapBy[Enumerable#map_by].
+
+
 == 1.8.0 (2015-07-06)
 
-* Add new refinement {doc-base-url}/Class/descendants[Class#descendants].
+* Add new refinement {doc-base-url}/Class/Descendants[Class#descendants].
 
 
 == 1.7.0 (2015-07-05)

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright 2015 Jakub Jirutka <jakub@jirutka.cz>.
+Copyright 2015-2017 Jakub Jirutka <jakub@jirutka.cz>.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.adoc

@@ -1,13 +1,9 @@
 = Corefines
 Jakub Jirutka <https://github.com/jirutka[@jirutka]>
-:page-layout: base
-:idprefix:
-ifdef::env-github[:idprefix: user-content-]
-:idseparator: -
 :source-language: ruby
-:language: {source-language}
 // custom
 :gem-name: corefines
+:gem-version: 1.11.1
 :gh-name: jirutka/{gem-name}
 :gh-branch: master
 :badge-style: flat
@@ -40,13 +36,13 @@ TODO
 
 Add this line to your application’s Gemfile:
 
-[source]
-gem 'corefines', '~> 1.8'
+[source, subs="+attributes"]
+gem '{gem-name}', '~> {gem-version}'
 
 or to your gemspec:
 
-[source]
-s.add_runtime_dependency 'corefines', '~> 1.8'
+[source, subs="+attributes"]
+s.add_runtime_dependency '{gem-name}', '~> {gem-version}'
 
 and then execute:
 
@@ -138,6 +134,7 @@ Not ideal indeed, but probably the best of what we can achieve.
 * {doc-base-url}/Enumerable[Enumerable]
 ** {doc-base-url}/Enumerable/IndexBy[#index_by]
 ** {doc-base-url}/Enumerable/Many[#many?]
+** {doc-base-url}/Enumerable/MapBy[#map_by]
 ** {doc-base-url}/Enumerable/MapSend[#map_send]
 ** {doc-base-url}/Enumerable/MapTo[#map_to]
 * {doc-base-url}/Hash[Hash]
@@ -146,8 +143,10 @@ Not ideal indeed, but probably the best of what we can achieve.
 ** {doc-base-url}/Hash/Compact[#compact!]
 ** {doc-base-url}/Hash/Except[#except]
 ** {doc-base-url}/Hash/Except[#except!]
+** {doc-base-url}/Hash/FlatMap[#flat_map]
 ** {doc-base-url}/Hash/Only[#only]
 ** {doc-base-url}/Hash/Only[#only!]
+** {doc-base-url}/Hash/Recurse[#recurse]
 ** {doc-base-url}/Hash/Rekey[#rekey]
 ** {doc-base-url}/Hash/Rekey[#rekey!]
 ** {doc-base-url}/Hash/SymbolizeKeys[#symbolize_keys]

data/lib/corefines/enumerable.rb

@@ -77,6 +77,45 @@ module Corefines
       end
     end
 
+    ##
+    # @!method map_by(&block)
+    #   Converts enumerable into a Hash, iterating over each element where the
+    #   provided block must return an array of two elements: a key and a value
+    #   to be added into an array that corresponds to that key.
+    #
+    #   It's similar to {::Enumerable#group_by}, but allows to map the value
+    #   being added into a group.
+    #
+    #   @example
+    #     a = [1, 2, 3, 4, 5]
+    #     a.map_by { |e| [e % 2, e + 1] }
+    #     #=> { 0 => [3, 5], 1 => [2, 4, 6] }
+    #
+    #   @example
+    #     h = { "Lucy" => 86, "Ruby" => 98, "Drew" => 94, "Lisa" => 54 }
+    #     h.map_by { |k, v| [score(v), k] }
+    #     #=> { "A" => ["Ruby", "Drew"], "B" => ["Lucy"], "F" => ["Lisa"] }
+    #
+    #   @yield [obj] gives each element to the block.
+    #   @yieldreturn [Array] an array with the key and the value.
+    #   @return [Hash]
+    #
+    module MapBy
+      Support.classes_including_module(::Enumerable) do |klass|
+
+        refine klass do
+          def map_by
+            res = {}
+            each do |e|
+              k, v = yield(*e)
+              (res[k] ||= []) << v
+            end
+            res
+          end
+        end
+      end
+    end
+
     ##
     # @!method map_send(method_name, *args, &block)
     #   Sends a message to each element and collects the result.

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,39 @@ 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 { |h| h.symbolize_keys }  # => {a: 1, b: {c: {e: 5}, d: 4}}
+    #     hash  # => {"a" => 1, "b" => {"c" => {"e" => 5}, "d" => 4}}
+    #
+    #     hash.recurse { |h| h.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
@@ -177,20 +247,28 @@ module Corefines
       refine ::Hash do
         def rekey(key_map = nil, &block)
           fail ArgumentError, "provide key_map, or block, not both" if key_map && block
-          block = ->(k, _) { k.to_sym rescue k } if !key_map && !block
 
           # Note: self.dup is used to preserve the default_proc.
-          if block
-            # This is needed for "symbol procs" (e.g. &:to_s).
-            transform_key = block.arity.abs == 1 ? ->(k, _) { block[k] } : block
+          if key_map
+            key_map.each_with_object(dup) do |(from, to), hash|
+              hash[to] = hash.delete(from) if hash.key? from
+            end
+          else
+            transform_key = if !block
+              ->(k, _) { k.to_sym rescue k }
+            elsif block.arity.abs == 1 || block.lambda? && block.arity != 2
+              # This is needed for "symbol procs" (e.g. &:to_s). It behaves
+              # differently since Ruby 3.0!
+              # Ruby <3.0: block.arity => -1, block.lambda? => false
+              # Ruby 3.0: block.arity => -2, block.lambda? => true
+              ->(k, _) { block[k] }
+            else
+              block
+            end
 
             each_with_object(dup.clear) do |(key, value), hash|
               hash[ transform_key[key, value] ] = value
             end
-          else
-            key_map.each_with_object(dup) do |(from, to), hash|
-              hash[to] = hash.delete(from) if hash.key? from
-            end
           end
         end
 

data/lib/corefines/string.rb

@@ -75,15 +75,15 @@ module Corefines
     #     "Sugar is sweet".color(text: 7) # => "\e[0;37;49mSugar is sweet\e[0m"
     #
     #   @overload color(text_color)
-    #     @param text_color [#to_sym, Fixnum] text (foreground) color (see
+    #     @param text_color [#to_sym, Integer] text (foreground) color (see
     #            {COLOR_CODES}).
     #
     #   @overload color(opts)
-    #     @option opts [#to_sym, Fixnum] :mode text attributes (see
+    #     @option opts [#to_sym, Integer] :mode text attributes (see
     #             {MODE_CODES}).
-    #     @option opts [#to_sym, Fixnum] :text,:fg text (foreground) color (see
+    #     @option opts [#to_sym, Integer] :text,:fg text (foreground) color (see
     #             {COLOR_CODES}).
-    #     @option opts [#to_sym, Fixnum] :background,:bg background color (see
+    #     @option opts [#to_sym, Integer] :background,:bg background color (see
     #             {COLOR_CODES}).
     #
     #   @return [String] a copy of this string colored for command line output
@@ -133,12 +133,12 @@ module Corefines
       private
 
       def self.color_code(color, offset)
-        return color + offset if color.is_a? ::Fixnum
+        return color + offset if color.is_a? ::Integer
         COLOR_CODES[color.to_sym] + offset if color && COLOR_CODES[color.to_sym]
       end
 
       def self.mode_code(mode)
-        return mode if mode.is_a? ::Fixnum
+        return mode if mode.is_a? ::Integer
         MODE_CODES[mode.to_sym] if mode
       end
     end
@@ -248,7 +248,7 @@ module Corefines
     #     "foo\n\nbar".indent(2)    # => "  foo\n\n  bar"
     #     "foo\n\nbar".indent(2, nil, true)  # => "  foo\n  \n  bar"
     #
-    #   @param amount [Fixnum] the indent size.
+    #   @param amount [Integer] the indent size.
     #   @param indent_str [String, nil] the indent character to use.
     #          The default is +nil+, which tells the method to make a guess by
     #          peeking at the first indented line, and fallback to a space if

data/lib/corefines/version.rb

@@ -1,3 +1,3 @@
 module Corefines
-  VERSION = '1.8.0'
+  VERSION = '1.11.1'.freeze
 end

data/spec/enumerable/map_by_spec.rb

@@ -0,0 +1,28 @@
+describe Enumerable do
+  using Corefines::Enumerable::map_by
+
+  describe '#map_by' do
+
+    context Array do
+      let(:input) { [1, 2, 3, 4, 5] }
+      let(:expected) { { 0 => [3, 5], 1 => [2, 4, 6] } }
+
+      it "returns hash with the elements grouped and mapped by result of the block" do
+        expect(input.map_by { |e| [e % 2, e + 1] }).to eq expected
+      end
+    end
+
+    context Hash do
+      let(:input) { { "Lucy" => 86, "Ruby" => 98, "Drew" => 94, "Lisa" => 54 } }
+      let(:expected) {  { "A" => ["Ruby", "Drew"], "B" => ["Lucy"], "F" => ["Lisa"] } }
+
+      it "returns hash with the elements grouped and mapped by result of the block" do
+        expect(input.map_by { |k, v| [score(v), k] }).to eq expected
+      end
+
+      def score(n)
+        n < 70 ? 'F' : n < 80 ? 'C' : n < 90 ? 'B' : 'A'
+      end
+    end
+  end
+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'

data/spec/string/color_spec.rb

@@ -21,7 +21,7 @@ describe String do
       end
     end
 
-    context Fixnum do
+    context Integer do
       it "returns text with the specified foreground color" do
         expect(text.color(7)).to eq "\e[0;37;49m#{text}\e[0m"
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: corefines
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.11.1
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-06 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -30,28 +30,28 @@ 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 description: |
   Corefines is a collection of general purpose refinements for extending the core
   capabilities of Ruby's built-in classes. It also provides a compatibility mode
@@ -127,12 +127,15 @@ files:
 - spec/class/descendants_spec.rb
 - spec/enumerable/index_by_spec.rb
 - spec/enumerable/many_spec.rb
+- spec/enumerable/map_by_spec.rb
 - spec/enumerable/map_send_spec.rb
 - 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
@@ -182,9 +185,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A collection of refinements for Ruby core classes.
 test_files: []
-has_rdoc: yard