refinements 7.9.0 → 7.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba7c2934d38986ae19d3a41bdc1305164ebe2355bb30afa925eebbeb9746f962
-  data.tar.gz: 1945d2226c6ca304aa9958635aab6a87880b66e43566691c3ab509f5b2e77f6b
+  metadata.gz: 2b7b36399c299675bc98b26334acc2466c5c506849e34b36534f21d2eed72e57
+  data.tar.gz: 0d00c8e399a0d43c21dafef5985e9d0eb51fe7d544fbe93f4d184eafa75018a8
 SHA512:
-  metadata.gz: 34e601f3bfe0ebe6b35ddf54dea67ef9c33d7436fae5103a2ce03106a34026f1920a6f06369ba2516ceb0a550bb6868fcd5491084cca5b6dd20ed746b4772a39
-  data.tar.gz: 8e4d5de5f29f28df044333dbaa34fb0a6d9b34911e3e911bd5593caf4dfeb52c0c0767f5a01d164542c54a4d936453b14f6131c055234a5911d73c80673c7d14
+  metadata.gz: 558191fc552ba160302b9189b8bd2e3ed17ceaee226426cf9453c0c65b8ca0e771b9e85be1e5453c8c1438bc52511a45afc218c72329c17570a6036b65e9f91f
+  data.tar.gz: 69436b5353f1541b644f9ca72346da713bd8bb1c0f9595983392881727f06ea46ecacdea1412a929981ee24e0243865c6ac9274e747f04d3584c85216e7e300b

data/README.adoc

@@ -9,7 +9,7 @@ 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.
+A collection of refinements (enhancements) to primitive Ruby objects.
 
 toc::[]
 
@@ -95,7 +95,8 @@ require "refinements/string_ios"
 
 === Using
 
-Much like including/extending a module, you’ll need modify your object(s) to use the refinement(s):
+Much like including/extending a module, you’ll need to modify your object(s) to use the
+refinement(s):
 
 [source,ruby]
 ----
@@ -119,7 +120,7 @@ The following sections demonstrate how each refinement enriches your objects wit
 
 ===== #compress
 
-Removes `nil` and empty values without modifying itself.
+Removes `nil` and empty values without mutating itself.
 
 [source,ruby]
 ----
@@ -130,7 +131,7 @@ example           # => ["An", nil, "", "Example"]
 
 ===== #compress!
 
-Removes `nil` and empty values while modifying itself.
+Removes `nil` and empty values while mutating itself.
 
 [source,ruby]
 ----
@@ -141,7 +142,7 @@ example            # => ["An", "Example"]
 
 ===== #include
 
-Adds given array or elements without modifying itself.
+Adds given array or elements without mutating itself.
 
 [source,ruby]
 ----
@@ -151,7 +152,7 @@ Adds given array or elements without modifying itself.
 
 ===== #exclude
 
-Removes given array or elements without modifying itself.
+Removes given array or elements without mutating itself.
 
 [source,ruby]
 ----
@@ -236,7 +237,7 @@ example[:b] # => []
 
 ===== #except
 
-Answers new hash with given keys removed without modifying itself.
+Answers new hash with given keys removed without mutating itself.
 
 [source,ruby]
 ----
@@ -247,7 +248,7 @@ example                # => {a: 1, b: 2, c: 3}
 
 ===== #except!
 
-Answers new hash with given keys removed while modifying itself.
+Answers new hash with given keys removed while mutating itself.
 
 [source,ruby]
 ----
@@ -258,7 +259,7 @@ example                 # => {c: 3}
 
 ===== #flatten_keys
 
-Flattens nested keys as top-level keys without modifying itself. Does not handle nested arrays,
+Flattens nested keys as top-level keys without mutating itself. Does not handle nested arrays,
 though.
 
 [source,ruby]
@@ -276,7 +277,7 @@ example               # => {a: {b: 1}}
 
 ===== #flatten_keys!
 
-Flattens nested keys as top-level keys while modifying itself. Does not handle nested arrays,
+Flattens nested keys as top-level keys while mutating itself. Does not handle nested arrays,
 though.
 
 [source,ruby]
@@ -286,9 +287,31 @@ example.flatten_keys!  # => {a_b: 1}
 example                # => {a_b: 1}
 ----
 
+===== #stringify_keys
+
+Converts keys to strings without mutating itself.
+
+[source,ruby]
+----
+example = {a: 1, b: 2}
+example.stringify_keys  # => {"a" => 1, "b" => 2}
+example                 # => {a: 1, b: 2}
+----
+
+===== #stringify_keys!
+
+Converts keys to strings while mutating itself.
+
+[source,ruby]
+----
+example = {a: 1, b: 2}
+example.stringify_keys!  # => {"a" => 1, "b" => 2}
+example                  # => {"a" => 1, "b" => 2}
+----
+
 ===== #symbolize_keys
 
-Converts keys to symbols without modifying itself.
+Converts keys to symbols without mutating itself.
 
 [source,ruby]
 ----
@@ -299,7 +322,7 @@ example                 # => {"a" => 1, "b" => 2}
 
 ===== #symbolize_keys!
 
-Converts keys to symbols while modifying itself.
+Converts keys to symbols while mutating itself.
 
 [source,ruby]
 ----
@@ -310,7 +333,7 @@ example                  # => {a: 1, b: 2}
 
 ===== #deep_merge
 
-Merges deeply nested hashes together without modifying itself.
+Merges deeply nested hashes together without mutating itself.
 
 [source,ruby]
 ----
@@ -321,7 +344,7 @@ example                         # => {a: "A", b: {one: "One", two: "Two"}}
 
 ===== #deep_merge!
 
-Merges deeply nested hashes together while modifying itself.
+Merges deeply nested hashes together while mutating itself.
 
 [source,ruby]
 ----
@@ -330,9 +353,31 @@ example.deep_merge! b: {one: 1}  # => {a: "A", b: {one: 1, two: "Two"}}
 example                          # => {a: "A", b: {one: 1, two: "Two"}}
 ----
 
+===== #deep_stringify_keys
+
+Stringifies keys of nested hash without mutating itself. Does not handle nested arrays, though.
+
+[source,ruby]
+----
+example = {a: {b: 2}}
+example.deep_stringify_keys  # => {"a" => {"b" => 1}}
+example                      # => {a: {b: 2}}
+----
+
+===== #deep_stringify_keys!
+
+Stringifies keys of nested hash while mutating itself. Does not handle nested arrays, though.
+
+[source,ruby]
+----
+example = {a: {b: 2}}
+example.deep_stringify_keys!  # => {"a" => {"b" => 1}}
+example                       # => {"a" => {"b" => 1}}
+----
+
 ===== #deep_symbolize_keys
 
-Symbolizes keys of nested hash without modifying itself. Does not handle nested arrays, though.
+Symbolizes keys of nested hash without mutating itself. Does not handle nested arrays, though.
 
 [source,ruby]
 ----
@@ -343,7 +388,7 @@ example                      # => {"a" => {"b" => 2}}
 
 ===== #deep_symbolize_keys!
 
-Symbolizes keys of nested hash while modifying itself. Does not handle nested arrays, though.
+Symbolizes keys of nested hash while mutating itself. Does not handle nested arrays, though.
 
 [source,ruby]
 ----
@@ -354,7 +399,8 @@ example                       # => {a: {b: 1}}
 
 ===== #recurse
 
-Applies block to nested hash. Does not handle nested arrays, though.
+Recursively iterates over the hash and any hash value by applying the given block to it. Does not
+handle nested arrays, though.
 
 [source,ruby]
 ----
@@ -365,7 +411,7 @@ example.recurse(&:invert)          # => {{"b" => 1} => "a"}
 
 ===== #rekey
 
-Transforms keys per mapping (size of mapping can vary) without modifying itself.
+Transforms keys per mapping (size of mapping can vary) without mutating itself.
 
 [source,ruby]
 ----
@@ -376,7 +422,7 @@ example                            # => {a: 1, b: 2, c: 3}
 
 ===== #rekey!
 
-Transforms keys per mapping (size of mapping can vary) while modifying itself.
+Transforms keys per mapping (size of mapping can vary) while mutating itself.
 
 [source,ruby]
 ----
@@ -387,7 +433,7 @@ example                             # => {amber: 1, blue: 2, c: 3}
 
 ===== #reverse_merge
 
-Merges calling hash into passed in hash without modifying itself.
+Merges calling hash into passed in hash without mutating itself.
 
 [source,ruby]
 ----
@@ -398,7 +444,7 @@ example                           # => {a: 1, b: 2}
 
 ===== #reverse_merge!
 
-Merges calling hash into passed in hash while modifying itself.
+Merges calling hash into passed in hash while mutating itself.
 
 [source,ruby]
 ----
@@ -421,7 +467,10 @@ example.use { |unit, street| "#{unit} #{street}" } # => "221B Baker Street"
 
 ===== Pathname
 
-Conversion function (refined from `Kernel`) which can cast `nil` into a pathname.
+Enhances the conversion function -- refined from `Kernel` -- which casts `nil` into a pathname in
+order to avoid: `TypeError (no implicit conversion of nil into String)`. The pathname is still
+invalid but at least you have an instance of `Pathname`, which behaves like a _Null Object_, that
+can still be used to construct a valid path.
 
 [source,ruby]
 ----
@@ -579,6 +628,19 @@ Answers string with only first letter downcased.
 "EXAMPLE".down # => "eXAMPLE"
 ----
 
+===== #indent
+
+Answers string indented by two spaces by default.
+
+[source,ruby]
+----
+"example".indent                  # => "  example"
+"example".indent 0                # => "example"
+"example".indent -1               # => "example"
+"example".indent 2                # => "    example"
+"example".indent 3, padding: " "  # => "   example"
+----
+
 ===== #camelcase
 
 Answers a camelcased string.

data/lib/refinements/hashes.rb

@@ -40,6 +40,14 @@ module Refinements
         replace flatten_keys(prefix: prefix, delimiter: delimiter, cast: cast)
       end
 
+      def stringify_keys
+        reduce({}) { |hash, (key, value)| hash.merge key.to_s => value }
+      end
+
+      def stringify_keys!
+        replace stringify_keys
+      end
+
       def symbolize_keys
         reduce({}) { |hash, (key, value)| hash.merge key.to_sym => value }
       end
@@ -64,6 +72,14 @@ module Refinements
         replace deep_merge(other)
       end
 
+      def deep_stringify_keys
+        recurse(&:stringify_keys)
+      end
+
+      def deep_stringify_keys!
+        replace deep_stringify_keys
+      end
+
       def deep_symbolize_keys
         recurse(&:symbolize_keys)
       end

data/lib/refinements/identity.rb

@@ -5,7 +5,7 @@ module Refinements
   module Identity
     NAME = "refinements"
     LABEL = "Refinements"
-    VERSION = "7.9.0"
+    VERSION = "7.10.0"
     VERSION_LABEL = "#{LABEL} #{VERSION}"
   end
 end

data/lib/refinements/strings.rb

@@ -50,6 +50,12 @@ module Refinements
         first.downcase + self[1, size]
       end
 
+      def indent multiplier = 1, padding: "  "
+        return self if multiplier.negative?
+
+        padding * multiplier + self
+      end
+
       def camelcase
         return up unless match? DELIMITERS
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 7.9.0
+  version: 7.10.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-09-19 00:00:00.000000000 Z
+date: 2020-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit