corefines 1.11.0 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: cc488d6deade84992853796d2e3e315e23a2bb32
-  data.tar.gz: 4f671bc5963d4002509d54a90dc41024a9efa676
+SHA256:
+  metadata.gz: e1786b22dad695d512f646e225334eeae9ecb2621a067461dc5c01151137ead0
+  data.tar.gz: 128135d2233f9b74976347ee1bbb4cae8b91327227aa4ed0e13432011f51d689
 SHA512:
-  metadata.gz: 96553f167a0dc42ce8c556ef92e3542940bd6093ab1b5e368c58e7627e3f83ed479368bc5b552be845ee84c68ee52e254781ab42eb44777ad53d75e20c19108f
-  data.tar.gz: 5ca6dc072b0ecf10503271b7d18ab2bee23efdf1663050f59a9c38e5c68409a19636ea9979986542848f11a960132361575e3b5142fdf225525b27e559ab3986
+  metadata.gz: 5159cba9976f0b56054472b43a3f0c28ce100eda5e6efe79896b97fdba42f078edc91327066b7dd99c3e9698b87c7ae643ad6989057ccf9d1b728f315bfd990d
+  data.tar.gz: a0158e47cc535f3e604a992ffac923812b1df13af300a2b91c56e77ab9a1983a374a5f630dfb11f005bbfd29926ca0504a17c976504b7feb0abf206a5b6f7b47

data/CHANGELOG.adoc

@@ -0,0 +1,78 @@
+= Corefines Changelog
+:repo-uri: https://github.com/jirutka/corefines
+: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].
+
+
+== 1.7.0 (2015-07-05)
+
+* Add new refinement {doc-base-url}/Enumerable/MapTo[Enumerable#map_to].
+* Add new refinement {doc-base-url}/Array/Wrap[Array#wrap].
+* Add new refinement {doc-base-url}/Enumerable/Many[Enumerable#many?].
+
+
+== 1.6.0 (2015-05-16)
+
+* Add new refinement {doc-base-url}/String/Camelcase[String#camelcase].
+* Add new refinement {doc-base-url}/String/SnakeCase[String#snake_case].
+
+
+== 1.5.0 (2015-05-03)
+
+* Rename String refinement `#to_regexp` to `#to_re` to avoid bug https://bugs.ruby-lang.org/issues/11117[#11117] in MRI.
+
+
+== 1.4.0 (2015-05-03)
+
+* Add new refinement {doc-base-url}/String/ForceUTF8[String#force_utf8].
+
+
+== 1.3.0 (2015-04-29)
+
+* Add new refinement {doc-base-url}/String/ToRegexp[String#to_regexp].
+* Add new refinement {doc-base-url}/String/RelativePathFrom[String#relative_path_from].
+* Add new refinement {doc-base-url}/Hash/Except[Hash#except].
+* Add new refinement {doc-base-url}/Hash/Only[Hash#only].
+
+
+== 1.2.0 (2015-04-27)
+
+* Add new refinement {doc-base-url}/String/Indent[String#indent].
+
+
+== 1.1.0 (2015-04-25)
+
+* Add new refinement {doc-base-url}/String/ToB[String#to_b].
+* Change alias for operator `+` from `OpPlus` to `OpAdd` and for operator `-` from `OpMinus` to `OpSub`.
+* Support operators `+@` (alias `OpPlus`) and `-@` (alias `OpMinus`).
+
+
+== 1.0.0 (2015-04-02)
+
+The first stable release.

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,215 @@
+= Corefines
+Jakub Jirutka <https://github.com/jirutka[@jirutka]>
+:source-language: ruby
+// custom
+:gem-name: corefines
+:gem-version: 1.11.1
+:gh-name: jirutka/{gem-name}
+:gh-branch: master
+:badge-style: flat
+:doc-base-url: http://www.rubydoc.info/github/{gh-name}/{gh-branch}/Corefines
+
+ifdef::env-github[]
+image:https://img.shields.io/travis/{gh-name}/{gh-branch}.svg?style={badge-style}[Build Status, link="https://travis-ci.org/{gh-name}"]
+image:https://img.shields.io/codeclimate/coverage/github/{gh-name}.svg?style={badge-style}[Test Coverage, link="https://codeclimate.com/github/{gh-name}"]
+image:https://img.shields.io/codeclimate/github/{gh-name}.svg?style={badge-style}[Code Climate, link="https://codeclimate.com/github/{gh-name}"]
+image:https://img.shields.io/gem/v/{gem-name}.svg?style={badge-style}[Gem Version, link="https://rubygems.org/gems/{gem-name}"]
+image:https://img.shields.io/badge/yard-docs-blue.svg?style={badge-style}[Yard Docs, link="http://www.rubydoc.info/github/{gh-name}/{gh-branch}"]
+endif::env-github[]
+
+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>> for older Ruby versions and alternative Ruby implementations that don’t support refinements (yet).
+
+
+== Why refinements?
+
+Extending core classes with so called monkey-paching pollutes the _global_ scope, so it affects all files on the `$LOAD_PATH`, i.e. whole application including used gems.
+It’s not usually so big deal when you’re doing it in your application, but it’s very dangerous when used in a gem (library).
+This can result in strange and hard to debug behaviour if another gem overrides a core class with the same method as your gem, but different implementation, and both gems are used together.
+
+Refinements basically allows you to put monkey patches in an isolated namespace, so that your changes to core classes don’t affect other code.
+
+TODO
+
+
+== Installation
+
+Add this line to your application’s Gemfile:
+
+[source, subs="+attributes"]
+gem '{gem-name}', '~> {gem-version}'
+
+or to your gemspec:
+
+[source, subs="+attributes"]
+s.add_runtime_dependency '{gem-name}', '~> {gem-version}'
+
+and then execute:
+
+[source, sh]
+$ bundle install
+
+
+== Using
+
+First, you must require `corefines` prior using:
+
+[source]
+require 'corefines'
+
+This will _not_ activate any extensions (just register them), even when running in compatibility mode.
+Extensions (refinements) are activated selectively with the method http://ruby-doc.org/core-2.2.0/Module.html#method-i-using[`using`].
+
+Refinements are organized into modules by class which they refine, and further into submodules for individual methods.
+When an extension refines multiple classes, then it’s included in a module named after their nearest common ancestor (superclass).
+
+[source, plain]
+Corefines::<CLASS>::<METHOD>
+
+A single extension can be imported into the current scope classically, e.g.:
+
+[source]
+using Corefines::Object::ThenIf
+
+or preferably using its “alias”:
+
+[source]
+using Corefines::Object::then_if
+
+If you want to include all extensions for the class, then you can just import the parent module, e.g.:
+
+[source]
+using Corefines::Object
+
+But more often you want to include multiple extensions for the class, but not all of them, e.g.:
+
+[source]
+using Corefines::Object::then_if
+using Corefines::Object::in?
+
+this can be abbreviated to:
+
+[source]
+using Corefines::Object[:then_if, :in?]
+
+If you feel that _Corefines_ is too long, then you can also use abbreviation _CF_ instead:
+
+[source]
+using CF::Object::then_if
+
+Refinements can be activated (with `using`) at top-level (per file), inside a class, module or a method.
+
+
+== Compatibility mode
+
+Refinements are still a young feature, so there’s a possibility that your gem or application will have to work on a Ruby platform that doesn’t fully support refinements yet.
+
+The main Ruby implementation, https://en.wikipedia.org/wiki/Ruby_MRI[MRI] (aka CRuby), supports refinements since version 2.1.0 (https://www.ruby-lang.org/en/news/2013/12/25/ruby-2-1-0-is-released/[released in 25 Dec 2013]).
+footnote:[Actually, refinements has been introduced to MRI in 2.0.0, as an experimental feature. However, its design and implementation has been changed then, so refinements in 2.0.x and 2.1+ behaves quite differently.]
+Version 2.0.0 (https://www.ruby-lang.org/en/news/2013/02/24/ruby-2-0-0-p0-is-released/[released in 24 Feb 2013]) is still supported though.
+http://www.jruby.org/[JRuby] doesn’t support refinements yet, it’s planned in the upcoming version 9.0.0.0 (https://github.com/jruby/jruby/issues/1062[#1062]).
+http://rubini.us/[Rubinius] also doesn’t support refinements yet.
+
+This gem is a collection of pure refinements, and yet, it works even on older Rubies that don’t support refinements.
+Wait… how?
+Well, when you use the gem with an older Ruby, it’s actually cheating.
+Instead of locally scoped changes, it falls back to global monkey-patching.
+
+The Corefines gem adds `refine` and `using` methods to the core classes, so you can define and use refinements just like in newer Rubies.
+But internally it works very differently.
+The `refine` method adds a given block to a collection of pending “refinements” inside its module.
+When `using` is called _first time_ for the module, it _evaluates_ module’s “refinements” in context of the target classes (i.e. do a monkey-patch).
+
+Not ideal indeed, but probably the best of what we can achieve.
+
+
+== List of refinements
+
+* {doc-base-url}/Array[Array]
+** {doc-base-url}/Array/Second[#second]
+** {doc-base-url}/Array/Third[#third]
+** {doc-base-url}/Array/Wrap[.wrap]
+* {doc-base-url}/Class[Class]
+** {doc-base-url}/Class/Descendants[#descendants]
+* {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]
+** {doc-base-url}/Hash/OpAdd[#+]
+** {doc-base-url}/Hash/Compact[#compact]
+** {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]
+** {doc-base-url}/Hash/SymbolizeKeys[#symbolize_keys!]
+* {doc-base-url}/Module[Module]
+** {doc-base-url}/Module/AliasClassMethod[#alias_class_method]
+** {doc-base-url}/Module/AliasMethodChain[#alias_method_chain]
+* {doc-base-url}/Object[Object]
+** {doc-base-url}/Object/Blank[#blank?]
+** {doc-base-url}/Object/DeepDup[#deep_dup]
+** {doc-base-url}/Object/Else[#else]
+** {doc-base-url}/Object/In[#in?]
+** {doc-base-url}/Object/InstanceValues[#instance_values]
+** {doc-base-url}/Object/Blank[#presence]
+** {doc-base-url}/Object/Then[#then]
+** {doc-base-url}/Object/ThenIf[#then_if]
+** {doc-base-url}/Object/Try[#try]
+** {doc-base-url}/Object/Try[#try!]
+* {doc-base-url}/String[String]
+** {doc-base-url}/String/Camelcase[#camelcase]
+** {doc-base-url}/String/Color[#color]
+** {doc-base-url}/String/Concat[#concat!]
+** {doc-base-url}/String/Decolor[#decolor]
+** {doc-base-url}/String/ForceUTF8[#force_utf8]
+** {doc-base-url}/String/ForceUTF8[#force_utf8!]
+** {doc-base-url}/String/Indent[#indent]
+** {doc-base-url}/String/RelativePathFrom[#relative_path_from]
+** {doc-base-url}/String/Remove[#remove]
+** {doc-base-url}/String/SnakeCase[#snake_case]
+** {doc-base-url}/String/ToB[#to_b]
+** {doc-base-url}/String/ToRe[#to_re]
+** {doc-base-url}/String/Unindent[#unindent] (alias `#strip_heredoc`)
+* {doc-base-url}/Symbol[Symbol]
+** {doc-base-url}/Symbol/Call[#call]
+
+
+== Acknowledgement
+
+Most of the extension methods are based on, or highly inspired from:
+
+* https://github.com/rails/rails/tree/master/activesupport[Active Support (Ruby extensions)]
+* https://github.com/rubyworks/facets[Ruby Facets]
+* https://github.com/gregwebs/methodchain[methodchain]
+* https://github.com/fazibear/colorize[colorize]
+* https://github.com/seamusabshere/to_regexp[to_regexp]
+
+Very useful articles about refinements and how to “trick” them:
+
+* https://www.new-bamboo.co.uk/blog/2014/02/05/refinements-under-the-knife/[
+Refinements under the knife] by https://github.com/leemachin[@leemachin]
+* http://qiita.com/joker1007/items/68d066a12bc763bd2cb4[Refinement関係の小技とできない事をまとめてみた] by https://github.com/joker1007[@joker1007]
+
+
+== Contributing
+
+. Fork it.
+. Create your feature branch (`git checkout -b my-new-feature`).
+. Commit your changes (`git commit -am 'Add some feature'`).
+. Push to the branch (`git push origin my-new-feature`).
+. Create a new Pull Request.
+
+
+== License
+
+This project is licensed under http://opensource.org/licenses/MIT/[MIT License].
+For the full text of the license, see the link:LICENSE[LICENSE] file.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :test => :spec
+  task :default => :spec
+
+rescue LoadError => e
+  warn "#{e.path} is not available"
+end
+
+begin
+  require 'yard'
+
+  # options are defined in .yardopts
+  YARD::Rake::YardocTask.new(:yard)
+
+rescue LoadError => e
+  warn "#{e.path} is not available"
+end

data/lib/corefines/hash.rb

@@ -179,7 +179,11 @@ module Corefines
     #
     #   @example
     #     hash = {"a" => 1, "b" => {"c" => {"e" => 5}, "d" => 4}}
-    #     hash.recurse!(&:symbolize_keys!)  # => {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).
@@ -243,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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: corefines
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.11.1
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -44,14 +44,14 @@ dependencies:
     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
@@ -104,6 +104,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.adoc
+- LICENSE
+- README.adoc
+- Rakefile
 - lib/corefines.rb
 - lib/corefines/array.rb
 - lib/corefines/class.rb
@@ -181,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
 summary: A collection of refinements for Ruby core classes.