refinements 7.1.0 → 7.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33305a79040d956270249e8e69d221e18144754a754c768a4c5dbd46f52672aa
-  data.tar.gz: c8d64fe7e0be077ae13e3dda3bf65baa0b4f0bd5690d30ff4fc5cf75df08772b
+  metadata.gz: b33464363d548d0cc888f7f3b1efac924eb2490a3846353589d892900d03de0d
+  data.tar.gz: da1d401505c092c0b2e8850f476affb1932b79db770b4f11c263300e208f3457
 SHA512:
-  metadata.gz: fc20aa5a6d29ddf5d184d54054e76ba44f1b0b092fecb67b98c8ba4bbe53ee3004f9e7418feeadce99243367070791a2c6064b4667b306cfbf8f4c40421e5e27
-  data.tar.gz: ed26803b0ed30ea0fc82cf89781c15604946db6ad0826b3a452b51b97f9b868dabc1d9b547a32385b5dcf7bc03a3269e999654ba30dd9d350696b188bdbb09c5
+  metadata.gz: 6c8072c3a3d8348e871ed72c7519295fb4ade95e2463bf56424f42689909dc7113805fbc817012196a395442af811f4d215a5bc89cf8952bd4506b0a4cd49536
+  data.tar.gz: 7797a5f506eb95d5999234c6e506ef9b0f4b949cfa41f831fcf883425fea7cb3da3b3ff3ef72f5c218236c006c38aeb2a957127ccf5177748fc3cac4291498ba

data/{LICENSE.md → LICENSE.adoc}

@@ -1,4 +1,4 @@
-# Apache License
+= Apache License
 
 Version 2.0, January 2004
 
@@ -6,7 +6,7 @@ http://www.apache.org/licenses
 
 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-## 1. Definitions
+== 1. Definitions
 
 "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
 Sections 1 through 9 of this document.
@@ -54,14 +54,14 @@ Contribution."
 "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
 Contribution has been received by Licensor and subsequently incorporated within the Work.
 
-## 2. Grant of Copyright License
+== 2. Grant of Copyright License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
 reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
 distribute the Work and such Derivative Works in Source or Object form.
 
-## 3. Grant of Patent License
+== 3. Grant of Patent License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
@@ -74,39 +74,38 @@ a Contribution incorporated within the Work constitutes direct or contributory p
 then any patent licenses granted to You under this License for that Work shall terminate as of the
 date such litigation is filed.
 
-## 4. Redistribution
+== 4. Redistribution
 
 You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
 or without modifications, and in Source or Object form, provided that You meet the following
 conditions:
 
-1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+. You must give any other recipients of the Work or Derivative Works a copy of this License; and
 
-2. You must cause any modified files to carry prominent notices stating that You changed the
-   files; and
+. You must cause any modified files to carry prominent notices stating that You changed the files;
+  and
 
-3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
-   patent, trademark, and attribution notices from the Source form of the Work, excluding those
-   notices that do not pertain to any part of the Derivative Works; and
+. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
+  patent, trademark, and attribution notices from the Source form of the Work, excluding those
+  notices that do not pertain to any part of the Derivative Works; and
 
-4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative
-   Works that You distribute must include a readable copy of the attribution notices contained
-   within such NOTICE file, excluding those notices that do not pertain to any part of the
-   Derivative Works, in at least one of the following places: within a NOTICE text file
-   distributed as part of the Derivative Works; within the Source form or documentation, if
-   provided along with the Derivative Works; or, within a display generated by the Derivative
-   Works, if and wherever such third-party notices normally appear. The contents of the NOTICE
-   file are for informational purposes only and do not modify the License. You may add Your own
-   attribution notices within Derivative Works that You distribute, alongside or as an addendum to
-   the NOTICE text from the Work, provided that such additional attribution notices cannot be
-   construed as modifying the License.
+. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
+  that You distribute must include a readable copy of the attribution notices contained within such
+  NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
+  at least one of the following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along with the Derivative
+  Works; or, within a display generated by the Derivative Works, if and wherever such third-party
+  notices normally appear. The contents of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
+  additional attribution notices cannot be construed as modifying the License.
 
 You may add Your own copyright statement to Your modifications and may provide additional or
 different license terms and conditions for use, reproduction, or distribution of Your modifications,
 or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
 the Work otherwise complies with the conditions stated in this License.
 
-## 5. Submission of Contributions
+== 5. Submission of Contributions
 
 Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
 Work by You to the Licensor shall be under the terms and conditions of this License, without any
@@ -114,13 +113,13 @@ additional terms or conditions. Notwithstanding the above, nothing herein shall
 the terms of any separate license agreement you may have executed with Licensor regarding such
 Contributions.
 
-## 6. Trademarks
+== 6. Trademarks
 
 This License does not grant permission to use the trade names, trademarks, service marks, or product
 names of the Licensor, except as required for reasonable and customary use in describing the origin
 of the Work and reproducing the content of the NOTICE file.
 
-## 7. Disclaimer of Warranty
+== 7. Disclaimer of Warranty
 
 Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
 Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -129,7 +128,7 @@ TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. Y
 responsible for determining the appropriateness of using or redistributing the Work and assume any
 risks associated with Your exercise of permissions under this License.
 
-## 8. Limitation of Liability
+== 8. Limitation of Liability
 
 In no event and under no legal theory, whether in tort (including negligence), contract, or
 otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
@@ -139,7 +138,7 @@ License or out of the use or inability to use the Work (including but not limite
 loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
 damages or losses), even if such Contributor has been advised of the possibility of such damages.
 
-## 9. Accepting Warranty or Additional Liability
+== 9. Accepting Warranty or Additional Liability
 
 While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
 for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
@@ -151,11 +150,11 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright 2015 [Alchemists](https://www.alchemists.io).
+Copyright link:https://www.alchemists.io[Alchemists].
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
-compliance with the License. You may obtain a [copy](http://www.apache.org/licenses/LICENSE-2.0) of
-the License.
+compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
+of the License.
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is
 distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

data/README.adoc

@@ -0,0 +1,373 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= Refinements
+
+[link=http://badge.fury.io/rb/refinements]
+image::https://badge.fury.io/rb/refinements.svg[Gem Version]
+[link=https://circleci.com/gh/bkuhlmann/refinements]
+image::https://circleci.com/gh/bkuhlmann/refinements.svg?style=svg[Circle CI Status]
+
+A collection of refinements (enhancements) to core Ruby objects.
+
+toc::[]
+
+== Features
+
+* *Arrays*:
+** `#compress` - Removes `nil` and empty values without modifying itself.
+** `#compress!` - Removes `nil` and empty values while modifying itself.
+** `#ring` - Answers a circular array which can enumerate before, current, after elements.
+* *BigDecimals*:
+** `#inspect` - Allows one to inspect a big decimal with numeric representation.
+* *DateTimes*:
+** `.utc` - Answers new DateTime object for current UTC date/time.
+* *Files*:
+** `#rewrite` - When given a file path and a block, it provides the contents of the recently read
+file for manipulation and immediate writing back to the same file.
+* *Hashes*:
+** `.infinite` - Answers new hash where missing keys, even deeply nested, answer an empty hash.
+** `.with_default` - Answers new hash where every top-level missing key has the same default value.
+** `#except` - Answers new hash with given keys removed without modifying itself.
+** `#except!` - Answers new hash with given keys removed while modifying itself.
+** `#symbolize_keys` - Converts keys to symbols without modifying itself.
+** `#symbolize_keys!` - Converts keys to symbols while modifying itself.
+** `#deep_merge` - Merges deeply nested hashes together without modifying itself.
+** `#deep_merge!` - Merges deeply nested hashes together while modifying itself.
+** `#deep_symbolize_keys` - Symbolizes keys of nested hash without modifying itself. Does not handle
+   nested arrays, though.
+** `#deep_symbolize_keys!` - Symbolizes keys of nested hash while modifying itself. Does not handle
+   nested arrays, though.
+** `#recurse` - Applies block to nested hash. Does not handle nested arrays, though.
+** `#rekey` - Transforms keys per mapping (size of mapping can vary) without modifying itself.
+** `#rekey!` - Transforms keys per mapping (size of mapping can vary) while modifying itself.
+** `#reverse_merge` - Merges calling hash into passed in hash without modifying itself.
+** `#reverse_merge!` - Merges calling hash into passed in hash while modifying itself.
+** `#use` - Passes each hash value as a block argument for further processing.
+* *Pathnames*:
+** `Pathname` - Conversion function (refined from `Kernel`) which can cast `nil` into a pathname.
+** `#name` - Answers file name without extension.
+** `#copy` - Copies file from current location to new location.
+** `#directories` - Answers all or filtered directories for current path.
+** `#extensions` - Answers file extensions as an array.
+** `#files` - Answers all or filtered files for current path.
+** `#relative_parent_from` - Answers relative path from parent directory. This is a complement to
+   `#relative_path_from`.
+** `#make_ancestors` - Ensures all ancestor directories are created for a path.
+** `#rewrite` - When given a block, it provides the contents of the recently read file for
+manipulation and immediate writing back to the same file.
+** `#touch` - Updates access and modification times for path. Defaults to current time.
+* *Strings*:
+** `#first` - Answers first character of a string or first set of characters if given a number.
+** `#last` - Answers last character of a string or last set of characters if given a number.
+** `#blank?` - Answers `true`/`false` based on whether string is blank or not
+(i.e. `<space>`, `\n`, `\t`, `\r`).
+** `#up` - Answers string with only first letter upcased.
+** `#down` - Answers string with only first letter downcased.
+** `#camelcase` - Answers a camelcased string.
+** `#snakecase` - Answers a snakecased string.
+** `#titleize` - Answers titleized string.
+** `#to_bool` - Answers string as a boolean.
+
+== Requirements
+
+. https://www.ruby-lang.org[Ruby].
+. A solid understanding of link:https://www.alchemists.io/articles/ruby_refinements[Ruby refinements
+  and lexical scope].
+
+== Setup
+
+=== Production
+
+To install, run:
+
+[source,bash]
+----
+gem install refinements
+----
+
+Add the following to your Gemfile file:
+
+[source,ruby]
+----
+gem "refinements"
+----
+
+=== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/refinements.git
+cd refinements
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Usage
+
+=== Requires
+
+If all refinements are not desired, add the following to your `+Gemfile+` instead:
+
+[source,ruby]
+----
+gem "refinements", require: false
+----
+
+…then require the specific refinement, as needed. Example:
+
+[source,ruby]
+----
+require "refinements/arrays"
+require "refinements/big_decimals"
+require "refinements/date_times"
+require "refinements/files"
+require "refinements/hashes"
+require "refinements/pathnames"
+require "refinements/strings"
+----
+
+=== Using
+
+Much like including/extending a module, you’ll need modify your object(s) to use the refinement(s):
+
+[source,ruby]
+----
+class Example
+  using Refinements::Arrays
+  using Refinements::BigDecimals
+  using Refinements::DateTimes
+  using Refinements::Files
+  using Refinements::Hashes
+  using Refinements::Pathnames
+  using Refinements::Strings
+end
+----
+
+=== Examples
+
+The following sections demonstrate how each refinement enriches your objects with new capabilities.
+
+==== Array
+
+[source,ruby]
+----
+example = ["An", nil, "", "Example"]
+example.compress # => ["An", "Example"]
+example # => ["An", nil, "", "Example"]
+
+example = ["An", nil, "", "Example"]
+example.compress! # => ["An", "Example"]
+example # => ["An", "Example"]
+
+example = [1, 2, 3]
+example.ring # => #<Enumerator: ...>
+example.ring { |(before, current, after)| puts "#{before} #{current} #{after}" }
+# [3 1 2]
+# [1 2 3]
+# [2 3 1]
+----
+
+==== Big Decimal
+
+[source,ruby]
+----
+BigDecimal.new("5.0E-10").inspect # => "#<BigDecimal:3fd3d458fe84 0.0000000005>"
+----
+
+==== DateTime
+
+[source,ruby]
+----
+DateTime.utc # => #<DateTime: 2019-12-31T18:17:00+00:00 ((2458849j,65820s,181867000n),+0s,2299161j)>
+----
+
+==== File
+
+[source,ruby]
+----
+File.rewrite("/test.txt") { |content| content.gsub "[placeholder]", "example" }
+----
+
+==== Hash
+
+[source,ruby]
+----
+example = Hash.infinite
+example[:a] # => {}
+example[:a][:b][:c] # => {}
+
+example = Hash.with_default ""
+example[:a] # => ""
+example = Hash.with_default []
+example[:b] # => []
+
+example = {a: 1, b: 2, c: 3}
+example.except :a, :b # => {c: 3}
+example # => {a: 1, b: 2, c: 3}
+
+example = {a: 1, b: 2, c: 3}
+example.except! :a, :b # => {c: 3}
+example # => {c: 3}
+
+example = {"a" => 1, "b" => 2}
+example.symbolize_keys # => {a: 1, b: 2}
+example # => {"a" => 1, "b" => 2}
+
+example = {"a" => 1, "b" => 2}
+example.symbolize_keys! # => {a: 1, b: 2}
+example # => {a: 1, b: 2}
+
+example = {a: 1, b: 2, c: 3}
+example.slice :a, :c # => {a: 1, c: 3}
+example # => {a: 1, b: 2, c: 3}
+
+example = {a: 1, b: 2, c: 3}
+example.slice! :a, :c # => {a: 1, c: 3}
+example # => {a: 1, c: 3}
+
+example = {a: "A", b: {one: "One", two: "Two"}}
+example.deep_merge b: {one: 1} # => {a: "A", b: {one: 1, two: "Two"}}
+example # => {a: "A", b: {one: "One", two: "Two"}}
+
+example = {a: "A", b: {one: "One", two: "Two"}}
+example.deep_merge! b: {one: 1} # => {a: "A", b: {one: 1, two: "Two"}}
+example # => {a: "A", b: {one: 1, two: "Two"}}
+
+example = {"a" => {"b" => 2}}
+example.deep_symbolize_keys # => {a: {b: 1}}
+example # => {"a" => {"b" => 2}}
+
+example = {"a" => {"b" => 2}}
+example.deep_symbolize_keys! # => {a: {b: 1}}
+example # => {a: {b: 1}}
+
+example = {"a" => {"b" => 1}}
+example.recurse(&:symbolize_keys) # => {a: {b: 1}}
+example.recurse(&:invert) # => {{"b" => 1} => "a"}
+
+example = {a: 1, b: 2, c: 3}
+example.rekey a: :amber, b: :blue # => {amber: 1, blue: 2, c: 3}
+example # => {a: 1, b: 2, c: 3}
+
+example = {a: 1, b: 2, c: 3}
+example.rekey! a: :amber, b: :blue # => {amber: 1, blue: 2, c: 3}
+example # => {amber: 1, blue: 2, c: 3}
+
+example = {a: 1, b: 2}
+example.reverse_merge a: 0, c: 3 # => {a: 1, b: 2, c: 3}
+example # => {a: 1, b: 2}
+
+example = {a: 1, b: 2}
+example.reverse_merge! a: 0, c: 3 # => {a: 1, b: 2, c: 3}
+example # => {a: 1, b: 2, c: 3}
+
+example = {unit: "221B", street: "Baker Street", city: "London", country: "UK"}
+example.use { |unit, street| "#{unit} #{street}" } # => "221B Baker Street"
+----
+
+==== Pathname
+
+[source,ruby]
+----
+Pathname(nil) # => Pathname("")
+
+Pathname("example.txt").name # => Pathname("example")
+
+Pathname("input.txt").copy Pathname("output.txt")
+
+Pathname("/example").directories # => [Pathname("a"), Pathname("b")]
+Pathname("/example").directories "a*" # => [Pathname("a")]
+
+Pathname("example.txt.erb").extensions # => [".txt", ".erb"]
+
+Pathname("/example").files # => [Pathname("a.txt"), Pathname("a.png")]
+Pathname("/example").files "*.png" # => [Pathname("a.png")]
+
+Pathname("/one/two/three").relative_parent_from("/one") # => Pathname "two"
+
+Pathname("/one/two").make_ancestors
+Pathname("/one").exist? # => true
+Pathname("/one/two").exist? # => false
+
+Pathname("/test.txt").rewrite { |content| content.sub "[placeholder]", "example" }
+
+Pathname("example.txt").touch
+Pathname("example.txt").touch at: Time.now - 1
+----
+
+==== String
+
+[source,ruby]
+----
+"example".first # => "e"
+"example".first 4 # => "exam"
+
+"instant".last # => "t"
+"instant".last 3 # => "ant"
+
+" \n\t\r".blank? # => true
+
+"example".up # => "Example"
+
+"EXAMPLE".down # => "eXAMPLE"
+
+"this_is_an_example".camelcase # => "ThisIsAnExample"
+
+"ThisIsAnExample".snakecase # => "this_is_an_example"
+
+"ThisIsAnExample".titleize # => "This Is An Example"
+
+"true".to_bool # => true
+"yes".to_bool # => true
+"1".to_bool # => true
+"".to_bool # => false
+"example".to_bool # => false
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bundle exec rake
+----
+
+== Versioning
+
+Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
+
+* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+== Code of Conduct
+
+Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
+participating in this project you agree to abide by its terms.
+
+== Contributions
+
+Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
+
+== License
+
+Read link:LICENSE.adoc[LICENSE] for details.
+
+== History
+
+Read link:CHANGES.adoc[CHANGES] for details.
+
+== Credits
+
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/lib/refinements.rb

@@ -2,8 +2,8 @@
 
 require "refinements/identity"
 require "refinements/arrays"
-require "refinements/date_times"
 require "refinements/big_decimals"
+require "refinements/date_times"
 require "refinements/files"
 require "refinements/hashes"
 require "refinements/pathnames"

data/lib/refinements/arrays.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Refinements
-  # Refinements for arrays.
   module Arrays
     refine Array do
       def compress
@@ -11,6 +10,10 @@ module Refinements
       def compress!
         replace compress
       end
+
+      def ring &block
+        [last, *self, first].each_cons 3, &block
+      end
     end
   end
 end

data/lib/refinements/big_decimals.rb

@@ -3,7 +3,6 @@
 require "bigdecimal"
 
 module Refinements
-  # Refinements for big decimals.
   module BigDecimals
     refine BigDecimal do
       def inspect

data/lib/refinements/files.rb

@@ -4,6 +4,7 @@ module Refinements
   module Files
     refine File.singleton_class do
       def rewrite path
+        warn "[DEPRECATION]: File.rewrite is deprecated, use Pathname#rewrite instead."
         read(path).then { |content| write path, yield(content) }
       end
     end

data/lib/refinements/hashes.rb

@@ -1,8 +1,17 @@
 # frozen_string_literal: true
 
 module Refinements
-  # Refinements for hashes.
   module Hashes
+    refine Hash.singleton_class do
+      def infinite
+        new { |new_hash, missing_key| new_hash[missing_key] = new(&new_hash.default_proc) }
+      end
+
+      def with_default value
+        new { |new_hash, missing_key| new_hash[missing_key] = value }
+      end
+    end
+
     refine Hash do
       def except *keys
         reject { |key, _value| keys.include? key }
@@ -13,22 +22,22 @@ module Refinements
       end
 
       def symbolize_keys
-        dup.symbolize_keys!
+        reduce({}) { |hash, (key, value)| hash.merge key.to_sym => value }
       end
 
       def symbolize_keys!
-        keys.each { |key| self[key.to_sym] = delete key }
-        self
+        replace symbolize_keys
       end
 
       def deep_merge other
         dup.deep_merge! other
       end
 
-      # :reek:FeatureEnvy
       def deep_merge! other
+        clazz = self.class
+
         merge! other do |_key, this_value, other_value|
-          if this_value.is_a?(Hash) && other_value.is_a?(Hash)
+          if this_value.is_a?(clazz) && other_value.is_a?(clazz)
             this_value.deep_merge other_value
           else
             other_value
@@ -36,11 +45,41 @@ module Refinements
         end
       end
 
+      def deep_symbolize_keys
+        recurse(&:symbolize_keys)
+      end
+
+      def deep_symbolize_keys!
+        recurse(&:symbolize_keys!)
+      end
+
+      def recurse &block
+        return self unless block_given?
+
+        transform = yield self
+
+        transform.each do |key, value|
+          transform[key] = value.recurse(&block) if value.is_a? self.class
+        end
+      end
+
+      def rekey mapping = {}
+        return self if mapping.empty?
+
+        transform_keys { |key| mapping[key] || key }
+      end
+
+      def rekey! mapping = {}
+        replace rekey(mapping)
+      end
+
       def reverse_merge other
+        warn "[DEPRECATION]: #reverse_merge is deprecated, use #merge instead."
         other.merge self
       end
 
       def reverse_merge! other
+        warn "[DEPRECATION]: #reverse_merge! is deprecated, use #merge! instead."
         merge!(other) { |_key, old_value, _new_value| old_value }
       end
 

data/lib/refinements/identity.rb

@@ -3,20 +3,9 @@
 module Refinements
   # Gem identity information.
   module Identity
-    def self.name
-      "refinements"
-    end
-
-    def self.label
-      "Refinements"
-    end
-
-    def self.version
-      "7.1.0"
-    end
-
-    def self.version_label
-      "#{label} #{version}"
-    end
+    NAME = "refinements"
+    LABEL = "Refinements"
+    VERSION = "7.6.0"
+    VERSION_LABEL = "#{LABEL} #{VERSION}"
   end
 end

data/lib/refinements/pathnames.rb

@@ -4,6 +4,14 @@ require "pathname"
 
 module Refinements
   module Pathnames
+    refine Kernel do
+      def Pathname object
+        return super(String(object)) unless object
+
+        super
+      end
+    end
+
     refine Pathname do
       def name
         basename extname
@@ -15,6 +23,27 @@ module Refinements
         self
       end
 
+      def directories pattern = "*"
+        glob(pattern).select(&:directory?).sort
+      end
+
+      def extensions
+        basename.to_s.split(/(?=\.)+/).tap(&:shift)
+      end
+
+      def files pattern = "*"
+        glob(pattern).select(&:file?).sort
+      end
+
+      def relative_parent_from root
+        relative_path_from(root).parent
+      end
+
+      def make_ancestors
+        dirname.mkpath
+        self
+      end
+
       def rewrite
         read.then { |content| write yield(content) if block_given? }
         self

data/lib/refinements/strings.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
 module Refinements
-  # Refinements for strings.
   module Strings
     refine String.singleton_class do
       def delimiters
-        %r([a-z][A-Z]|\s*\-\s*|\s*\/\s*|\s*\:+\s*|\s*\_\s*|\s+)
+        %r([a-z][A-Z]|\s*-\s*|\s*/\s*|\s*:+\s*|\s*_\s*|\s+)
       end
     end
 
@@ -18,20 +17,18 @@ module Refinements
         return self[0] if max.zero?
         return "" if max.negative?
 
-        self[0..(max - 1)]
+        self[..(max - 1)]
       end
 
-      # :reek:TooManyStatements
       def last number = 0
         return self if empty?
 
         min = Integer number
-        max = size - 1
 
-        return self[max] if min.zero?
+        return self[size - 1] if min.zero?
         return "" if min.negative?
 
-        self[(min + 1)..max]
+        self[(min + 1)..]
       end
 
       def blank?
@@ -51,33 +48,31 @@ module Refinements
       end
 
       def camelcase
-        if match? self.class.delimiters
-          split(%r(\s*\-\s*|\s*\/\s*|\s*\:+\s*)).then { |parts| combine parts, :up, "::" }
-                                                .then { |text| text.split(/\s*\_\s*|\s+/) }
-                                                .then { |parts| combine parts, :up }
-        else
-          up
-        end
+        return up unless match? self.class.delimiters
+
+        split(%r(\s*-\s*|\s*/\s*|\s*:+\s*)).then { |parts| combine parts, :up, "::" }
+                                           .then { |text| text.split(/\s*_\s*|\s+/) }
+                                           .then { |parts| combine parts, :up }
       end
 
       def snakecase
-        if match? self.class.delimiters
-          split(%r(\s*\-\s*|\s*\/\s*|\s*\:+\s*)).then { |parts| combine parts, :down, "/" }
-                                                .then { |txt| txt.split(/(?=[A-Z])|\s*\_\s*|\s+/) }
-                                                .then { |parts| combine parts, :down, "_" }
-        else
-          downcase
-        end
+        return downcase unless match? self.class.delimiters
+
+        split(%r(\s*-\s*|\s*/\s*|\s*:+\s*)).then { |parts| combine parts, :down, "/" }
+                                           .then { |text| text.split(/(?=[A-Z])|\s*_\s*|\s+/) }
+                                           .then { |parts| combine parts, :down, "_" }
       end
 
       def titleize
-        if match? self.class.delimiters
-          split(/(?=[A-Z])|\s*\_\s*|\s*\-\s*|\s+/).then { |parts| combine parts, :up, " " }
-                                                  .then { |text| text.split %r(\s*\/\s*|\s*\:+\s*) }
-                                                  .then { |parts| combine parts, :up, "/" }
-        else
-          capitalize
-        end
+        return capitalize unless match? self.class.delimiters
+
+        split(/(?=[A-Z])|\s*_\s*|\s*-\s*|\s+/).then { |parts| combine parts, :up, " " }
+                                              .then { |text| text.split %r(\s*/\s*|\s*:+\s*) }
+                                              .then { |parts| combine parts, :up, "/" }
+      end
+
+      def to_bool
+        %w[true yes on t y 1].include? downcase.strip
       end
 
       private

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.6.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIC/jCCAeagAwIBAgIBAjANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
-  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0xOTAyMTcxNjAxMTFaFw0yMDAyMTcx
-  NjAxMTFaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
+  MIIC/jCCAeagAwIBAgIBAzANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpicm9v
+  a2UvREM9YWxjaGVtaXN0cy9EQz1pbzAeFw0yMDAzMTUxNDQ1MzJaFw0yMTAzMTUx
+  NDQ1MzJaMCUxIzAhBgNVBAMMGmJyb29rZS9EQz1hbGNoZW1pc3RzL0RDPWlvMIIB
   IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6l1qpXTiomH1RfMRloyw7MiE
   xyVx/x8Yc3EupdH7uhNaTXQGyORN6aOY//1QXXMHIZ9tW74nZLhesWMSUMYy0XhB
   brs+KkurHnc9FnEJAbG7ebGvl/ncqZt72nQvaxpDxvuCBHgJAz+8i5wl6FhLw+oT
@@ -20,15 +20,15 @@ cert_chain:
   D5vkU0YlAm1r98BymuJlcQ1qdkVEI1d48ph4kcS0S0nv1RiuyVb6TCAR3Nu3VaVq
   3fPzZKJLZBx67UvXdbdicWPiUR75elI4PXpLIic3xytaF52ZJYyKZCNZJhNwfQID
   AQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQU0nzow9vc
-  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBANgfX7kPZkJvsbdWMvbe
-  DUUYxRTqTUzCDpLd2p3sQvgLMKjTNSKt6CFq/kh+98b6RCgO6DqiVfxvOEq02dvf
-  ebMN/ylQqan2FgiAs1rpP0/D4C0MlBjoDktsT+2IyLol1KmkDB20ExJ4Sf1GRNdA
-  hpWOtcgqHtmrc7xzgB6BuyoYufrKKUlCO3ewTM4C375D2qO7hIdKuMOO3CdPMtSk
-  OrWpbzCL+nbbXqeoqiHgZaUvcyyQrGj5sQRxMTzuMXzzQxtHnuTuKrcz16HMTX/O
-  dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
-  y84=
+  2CdikiiE3fJhP/gY4ggwDQYJKoZIhvcNAQELBQADggEBAIHhAlD3po4sTYqacXaQ
+  XI9jIhrfMy//2PgbHWcETtlJPBeNUbbSNBABcllUHKqYsVDlSvSmss034KSWNR8F
+  bF1GcloicyvcCC4y6IoW4it0COAcdeaaxkxiBSgKdQFpff9REnDlIKK4uQ9lLxIo
+  Y2G5xubiziKZkyfWFuSr67PIjW3Bu673D1JVBArhA1qbgQmYQcy1CkGOjo+iO8Nf
+  7u/QSfBHb+r/bXhKscDgPpnKwbUmvgO2+94zJG9KsrmIydlzYfsD09aXKx0t6Xy4
+  2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
+  QWc=
   -----END CERTIFICATE-----
-date: 2020-01-31 00:00:00.000000000 Z
+date: 2020-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -50,28 +50,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '14.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '14.0'
+        version: '14.2'
 - !ruby/object:Gem::Dependency
-  name: git-cop
+  name: git-lint
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -92,28 +92,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -134,14 +134,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.6'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -162,14 +162,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0.83'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0.83'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -204,14 +204,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: '1.39'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.37'
+        version: '1.39'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -226,17 +226,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
-description: 
+description:
 email:
 - brooke@alchemists.io
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.md
-- LICENSE.md
+- README.adoc
+- LICENSE.adoc
 files:
-- LICENSE.md
-- README.md
+- LICENSE.adoc
+- README.adoc
 - lib/refinements.rb
 - lib/refinements/arrays.rb
 - lib/refinements/big_decimals.rb
@@ -246,14 +246,15 @@ files:
 - lib/refinements/identity.rb
 - lib/refinements/pathnames.rb
 - lib/refinements/strings.rb
-homepage: https://github.com/bkuhlmann/refinements
+homepage: https://www.alchemists.io/projects/refinements
 licenses:
 - Apache-2.0
 metadata:
-  source_code_uri: https://github.com/bkuhlmann/refinements
-  changelog_uri: https://github.com/bkuhlmann/refinements/blob/master/CHANGES.md
   bug_tracker_uri: https://github.com/bkuhlmann/refinements/issues
-post_install_message: 
+  changelog_uri: https://www.alchemists.io/projects/refinements/changes.html
+  documentation_uri: https://www.alchemists.io/projects/refinements
+  source_code_uri: https://github.com/bkuhlmann/refinements
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -268,8 +269,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A collection of refinements to core Ruby objects.
 test_files: []

data/README.md

@@ -1,263 +0,0 @@
-<p align="center">
-  <img src="refinements.png" alt="Refinements Icon"/>
-</p>
-
-# Refinements
-
-[![Gem Version](https://badge.fury.io/rb/refinements.svg)](http://badge.fury.io/rb/refinements)
-[![Code Climate Maintainability](https://api.codeclimate.com/v1/badges/98be62123a95d5ac32d2/maintainability)](https://codeclimate.com/github/bkuhlmann/refinements/maintainability)
-[![Code Climate Test Coverage](https://api.codeclimate.com/v1/badges/98be62123a95d5ac32d2/test_coverage)](https://codeclimate.com/github/bkuhlmann/refinements/test_coverage)
-[![Circle CI Status](https://circleci.com/gh/bkuhlmann/refinements.svg?style=svg)](https://circleci.com/gh/bkuhlmann/refinements)
-
-A collection of refinements (enhancements) to core Ruby objects.
-
-<!-- Tocer[start]: Auto-generated, don't remove. -->
-
-## Table of Contents
-
-  - [Features](#features)
-  - [Requirements](#requirements)
-  - [Setup](#setup)
-  - [Usage](#usage)
-    - [Requires](#requires)
-    - [Using](#using)
-    - [Examples](#examples)
-      - [Array](#array)
-      - [DateTime](#datetime)
-      - [Big Decimal](#big-decimal)
-      - [File](#file)
-      - [Hash](#hash)
-      - [Pathname](#pathname)
-      - [String](#string)
-  - [Tests](#tests)
-  - [Versioning](#versioning)
-  - [Code of Conduct](#code-of-conduct)
-  - [Contributions](#contributions)
-  - [License](#license)
-  - [History](#history)
-  - [Credits](#credits)
-
-<!-- Tocer[finish]: Auto-generated, don't remove. -->
-
-## Features
-
-- Provides Array refinements:
-  - `#compress` - Removes `nil` and empty values without modifying itself.
-  - `#compress!` - Removes `nil` and empty values while modifying itself.
-- Provides DateTime refinements:
-  - `.utc` - Answers new DateTime object for current UTC date/time.
-- Provides BigDecimal refinements:
-  - `#inspect` - Allows one to inspect a big decimal with numeric representation.
-- Provides File refinements:
-  - `#name` - Answers the *name* of file without extension.
-  - `#copy` - Copies an existing file to new file. Both directory structures must exist.
-  - `#rewrite` - When given a file path and a block, it provides the contents of the recently read
-    file for manipulation and immediate writing back to the same file.
-  - `#touch` - Updates the access and modified times of an existing file or creates the file when
-    not existing.
-- Provides Hash refinements:
-  - `#except` - Answers new hash with given keys removed without modifying calling hash.
-  - `#except!` - Answers new hash with given keys removed while modifying calling hash.
-  - `#symbolize_keys` - Converts keys to symbols without modifying itself.
-  - `#symbolize_keys!` - Converts keys to symbols while modifying itself.
-  - `#deep_merge` - Merges deeply nested hashes together without modifying itself.
-  - `#deep_merge!` - Merges deeply nested hashes together while modifying itself.
-  - `#reverse_merge` - Merges calling hash into passed in hash without modifying calling hash.
-  - `#reverse_merge!` - Merges calling hash into passed in hash while modifying calling hash.
-- Provides Pathname refinements:
-  - `#rewrite` - When given a block, it provides the contents of the recently read file for
-    manipulation and immediate writing back to the same file.
-- Provides String refinements:
-  - `#first` - Answers first character of a string or first set of characters if given a number.
-  - `#last` - Answers last character of a string or last set of characters if given a number.
-  - `#blank?` - Answers `true`/`false` based on whether string is blank or not (i.e. `<space>`,
-    `\n`, `\t`, `\r`).
-  - `#up` - Answers string with only first letter upcased.
-  - `#down` - Answers string with only first letter downcased.
-  - `#camelcase` - Answers a camelcased string. Example: "ThisIsCamelcase".
-  - `#snakecase` - Answers a snakecased string. Example: "this_is_snakecase".
-  - `#titleize` - Answers titleized string. Example: "This Is Titleized".
-  - `#use` - Provides hash value computation, via a block, by using
-    only the keys as arguments to the block.
-
-## Requirements
-
-1. [Ruby 2.7.x](https://www.ruby-lang.org).
-1. A solid understanding of [Ruby refinements and lexical scope](https://www.youtube.com/watch?v=qXC9Gk4dCEw).
-
-## Setup
-
-Type the following to install:
-
-    gem install refinements
-
-Add the following to your Gemfile file:
-
-    gem "refinements"
-
-## Usage
-
-### Requires
-
-If all refinements are not desired, add the following to your `Gemfile` instead:
-
-    gem "refinements", require: false
-
-...then require the specific refinement, as needed. Example:
-
-    require "refinements/arrays"
-    require "refinements/date_times"
-    require "refinements/big_decimals"
-    require "refinements/files"
-    require "refinements/hashes"
-    require "refinements/pathnames"
-    require "refinements/strings"
-
-### Using
-
-Much like including/extending a module, you'll need modify your object(s) to use the refinement(s):
-
-    class Example
-      using Refinements::Arrays
-      using Refinements::DateTimes
-      using Refinements::BigDecimals
-      using Refinements::Files
-      using Refinements::Hashes
-      using Refinements::Pathnames
-      using Refinements::Strings
-    end
-
-### Examples
-
-The following sections demonstrate how each refinement enriches your objects with new capabilities.
-
-#### Array
-
-    example = ["An", nil, "", "Example"]
-    example.compress # => ["An", "Example"]
-    example # => ["An", nil, "", "Example"]
-
-    example = ["An", nil, "", "Example"]
-    example.compress! # => ["An", "Example"]
-    example # => ["An", "Example"]
-
-#### DateTime
-
-    DateTime.utc # => #<DateTime: 2019-12-31T18:17:00+00:00 ((2458849j,65820s,181867000n),+0s,2299161j)>
-
-#### Big Decimal
-
-    BigDecimal.new("5.0E-10").inspect # => "#<BigDecimal:3fd3d458fe84 0.0000000005>"
-
-#### File
-
-    File.rewrite("/test.txt") { |content| content.gsub "[placeholder]", "example" }
-
-#### Hash
-
-    example = {a: 1, b: 2, c: 3}
-    example.except :a, :b # => {c: 3}
-    example # => {a: 1, b: 2, c: 3}
-
-    example = {a: 1, b: 2, c: 3}
-    example.except! :a, :b # => {c: 3}
-    example # => {c: 3}
-
-    example = {"a" => 1, "b" => 2}
-    example.symbolize_keys # => {a: 1, b: 2}
-    example # => {"a" => 1, "b" => 2}
-
-    example = {"a" => 1, "b" => 2}
-    example.symbolize_keys! # => {a: 1, b: 2}
-    example # => {a: 1, b: 2}
-
-    example = {a: 1, b: 2, c: 3}
-    example.slice :a, :c # => {a: 1, c: 3}
-    example # => {a: 1, b: 2, c: 3}
-
-    example = {a: 1, b: 2, c: 3}
-    example.slice! :a, :c # => {a: 1, c: 3}
-    example # => {a: 1, c: 3}
-
-    example = {a: "A", b: {one: "One", two: "Two"}}
-    example.deep_merge b: {one: 1} # => {a: "A", b: {one: 1, two: "Two"}}
-    example # => {a: "A", b: {one: "One", two: "Two"}}
-
-    example = {a: "A", b: {one: "One", two: "Two"}}
-    example.deep_merge! b: {one: 1} # => {a: "A", b: {one: 1, two: "Two"}}
-    example # => {a: "A", b: {one: 1, two: "Two"}}
-
-    example = {a: 1, b: 2}
-    example.reverse_merge a: 0, c: 3 # => {a: 1, b: 2, c: 3}
-    example # => {a: 1, b: 2}
-
-    example = {a: 1, b: 2}
-    example.reverse_merge! a: 0, c: 3 # => {a: 1, b: 2, c: 3}
-    example # => {a: 1, b: 2, c: 3}
-
-    example = {unit: "221B", street: "Baker Street", city: "London", country: "UK"}
-    example.use { |unit, street| "#{unit} #{street}" } # => "221B Baker Street"
-
-#### Pathname
-
-    Pathname("test.txt").name # => Pathname("test")
-
-    Pathname("input.txt").copy Pathname("output.txt")
-
-    Pathname("/test.txt").rewrite { |content| content.sub "[placeholder]", "example" }
-
-    Pathname("test.txt").touch
-    Pathname("test.txt").touch accessed_at: Time.now - 1, modified_at: Time.now - 1
-
-#### String
-
-    "example".first # => "e"
-    "example".first 4 # => "exam"
-
-    "instant".last # => "t"
-    "instant".last 3 # => "ant"
-
-    " \n\t\r".blank? # => true
-    "example".up # => "Example"
-    "EXAMPLE".down # => "eXAMPLE"
-    "this_is_an_example".camelcase # => "ThisIsAnExample"
-    "ThisIsAnExample".snakecase # => "this_is_an_example"
-    "ThisIsAnExample".titleize # => "This Is An Example"
-
-## Tests
-
-To test, run:
-
-    bundle exec rake
-
-## Versioning
-
-Read [Semantic Versioning](https://semver.org) for details. Briefly, it means:
-
-- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
-- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
-- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
-
-## Code of Conduct
-
-Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
-participating in this project you agree to abide by its terms.
-
-## Contributions
-
-Read [CONTRIBUTING](CONTRIBUTING.md) for details.
-
-## License
-
-Copyright 2015 [Alchemists](https://www.alchemists.io).
-Read [LICENSE](LICENSE.md) for details.
-
-## History
-
-Read [CHANGES](CHANGES.md) for details.
-Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
-
-## Credits
-
-Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
-[Alchemists](https://www.alchemists.io).