refinements 9.7.1 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dbec0b903b2ce6a78545bf34285ab60d20fd1b511975c750829a883107de915
-  data.tar.gz: 14c0fa259be4dd70fcc3766bcf745b9c267af3b1a58c0f32fc0f1fdfbb9d6458
+  metadata.gz: 6886f2e81d621658654c24748db65834f2f0d6a1f37b9cd6f5f201dedc0d23e6
+  data.tar.gz: c047e00e34e10f9c4ed31561c5e64e4d247151dec65b1251a14f79d273e21d02
 SHA512:
-  metadata.gz: 0bdd1ea6074fd07ae02659c283a1a035da4695d5375150264eea4e88ca5eae7b041a41ea6a14384305143695752fd6c1397477be387a28e75d39f80c907c8f87
-  data.tar.gz: 0caa5d7b26ad27a5378daad28b9a0cc7c7bc6c6f0d5db5d3fc2f20cacc0a834ae902269b74432196df89b90510d918afa60a941ae19254cb6bf0eecc46fec8f8
+  metadata.gz: 771838c7e7fa1b044b861724ec99ab78a2f1393db0dc9f2906ebf9fd58d34aa2adee55dccf7c4cd045e9ac4b3b30a49fbc613b23628ca216ce47c271289038d4
+  data.tar.gz: 13c855b9fdc681ab75e008a61059bec785f8918f7fbfa44576100a5f014102ea806d6b0061eae89475106cb8cc55625026c536d5f6d55144d8cf06127604d7cb

data/README.adoc

@@ -128,28 +128,32 @@ example.combinatorial? []           # false
 
 ===== #compress
 
-Removes `nil` and empty objects without mutating itself.
+Removes `nil` and empty objects without mutating itself. Answers itself if there is nothing to remove.
 
 [source,ruby]
 ----
 object = Object.new
 example = [1, "blueberry", nil, "", [], {}, object]
 
+[].compress       # []
+[1, 2].compress   # [1, 2]
 example.compress  # [1, "blueberry", object]
 example           # [1, "blueberry", nil, "", [], {}, object]
 ----
 
 ===== #compress!
 
-Removes `nil` and empty values while mutating itself.
+Removes `nil` and empty values while mutating itself. Answers `nil` if there is nothing to remove.
 
 [source,ruby]
 ----
 object = Object.new
 example = [1, "blueberry", nil, "", [], {}, object]
 
-example.compress  # [1, "blueberry", object]
-example           # [1, "blueberry", object]
+[].compress!       # nil
+[1, 2].compress!   # nil
+example.compress!  # [1, "blueberry", object]
+example            # [1, "blueberry", object]
 ----
 
 ===== #excluding
@@ -219,7 +223,7 @@ Answers the maximum extracted value from a collection of objects.
 
 [source,ruby]
 ----
-Point = Struct.new :x, :y, keyword_init: true
+Point = Struct.new :x, :y
 points = [Point[x: 1, y: 2], Point[x: 0, y: 1], Point[x: 2, y: 3]]
 
 points.maximum(:x)  # 2
@@ -244,7 +248,7 @@ Answers the minimum extracted value from a collection of objects.
 
 [source,ruby]
 ----
-Point = Struct.new :x, :y, keyword_init: true
+Point = Struct.new :x, :y
 points = [Point[x: 1, y: 2], Point[x: 0, y: 1], Point[x: 2, y: 3]]
 
 points.minimum(:x)  # 0
@@ -367,28 +371,32 @@ example[:b]  # []
 
 ===== #compress
 
-Removes `nil` and empty objects without mutating itself.
+Removes `nil` and empty objects without mutating itself. Answers itself if there is nothing to remove.
 
 [source,ruby]
 ----
 object = Object.new
 example = {a: 1, b: "blueberry", c: nil, d: "", e: [], f: {}, g: object}
 
-example.compress  # {a: 1, b: "blueberry", g: object}
-example           # {a: 1, b: "blueberry", c: nil, d: "", e: [], f: {}, g: object}
+{}.compress            # {}
+{a: 1, b: 2}.compress  # {a: 1, b: 2}
+example.compress       # {a: 1, b: "blueberry", g: object}
+example                # {a: 1, b: "blueberry", c: nil, d: "", e: [], f: {}, g: object}
 ----
 
 ===== #compress!
 
-Removes `nil` and empty objects while mutating itself.
+Removes `nil` and empty objects while mutating itself. Answers `nil` if there is nothing to remove.
 
 [source,ruby]
 ----
 object = Object.new
 example = {a: 1, b: "blueberry", c: nil, d: "", e: [], f: {}, g: object}
 
-example.compress!  # {a: 1, b: "blueberry", g: object}
-example            # {a: 1, b: "blueberry", g: object}
+{}.compress!            # nil
+{a: 1, b: 2}.compress!  # nil
+example.compress!       # {a: 1, b: "blueberry", g: object}
+example                 # {a: 1, b: "blueberry", g: object}
 ----
 
 ===== #deep_merge
@@ -485,9 +493,6 @@ though.
 {a: {b: 1}}.flatten_keys prefix: :test          # {test_a_b: 1}
 {a: {b: 1}}.flatten_keys delimiter: :|          # {:"a|b" => 1}
 
-{a: {b: 1}}.flatten_keys cast: :to_s            # {"a_b" => 1}
-{"a" => {"b" => 1}}.flatten_keys cast: :to_sym  # {a_b: 1}
-
 example = {a: {b: 1}}
 example.flatten_keys                            # {a_b: 1}
 example                                         # {a: {b: 1}}
@@ -500,6 +505,9 @@ though.
 
 [source,ruby]
 ----
+{a: {b: 1}}.flatten_keys! prefix: :test          # {test_a_b: 1}
+{a: {b: 1}}.flatten_keys! delimiter: :|          # {:"a|b" => 1}
+
 example = {a: {b: 1}}
 example.flatten_keys!  # {a_b: 1}
 example                # {a_b: 1}
@@ -574,6 +582,66 @@ example.symbolize_keys!  # {a: 1, b: 2}
 example                  # {a: 1, b: 2}
 ----
 
+===== #transform_with
+
+Transforms key/value pairs based on specific operations where each operation (i.e. function that responds to the `call` message). Does not mutate itself.
+
+You can transform multiple values at once:
+
+[source,ruby]
+----
+example = {name: "Jayne Doe", email: "<jd@example.com>"}
+
+example.transform_with name: -> value { value.delete_suffix " Doe" },
+                       email: -> value { value.tr "<>", "" }
+# {name: "Jayne", email: "jd@example.com"}
+----
+
+Invalid keys are ignored:
+
+[source,ruby]
+----
+example.transform_with bogus: -> value { value.tr "<>", "" }
+# {email: "<jd@example.com>"}
+----
+
+The original object will not be mutated:
+
+[source,ruby]
+----
+example  # {name: "Jayne Doe", email: "<jd@example.com>"}
+----
+
+===== #transform_with!
+
+Transforms key/value pairs based on specific operations where each operation (i.e. function that responds to the `call` message). Mutates itself.
+
+You can transform multiple values at once:
+
+[source,ruby]
+----
+example = {name: "Jayne Doe", email: "<jd@example.com>"}
+
+example.transform_with! name: -> value { value.delete_suffix " Doe" },
+                        email: -> value { value.tr "<>", "" }
+# {name: "Jayne", email: "jd@example.com"}
+----
+
+Invalid keys are ignored:
+
+[source,ruby]
+----
+example.transform_with! bogus: -> value { value.tr "<>", "" }
+# {email: "<jd@example.com>"}
+----
+
+The original object will be mutated:
+
+[source,ruby]
+----
+example  # {name: "Jayne", email: "jd@example.com"}
+----
+
 ===== #use
 
 Passes each hash value as a block argument for further processing.
@@ -1135,6 +1203,16 @@ Answers a snake cased string.
 "ThisIsAnExample".snakecase  # "this_is_an_example"
 ----
 
+===== #squish
+
+Removes leading, in body, and trailing whitespace, including any tabs or newlines, without mutating itself. Processes ASCII and unicode whitespace as well.
+
+[source,ruby]
+----
+"one two three".squish                  # "one two three"
+" one  two   \n    \t   three ".squish  # "one two three"
+----
+
 ===== #titleize
 
 Answers a title string with proper capitalization of each word.
@@ -1187,36 +1265,6 @@ buffer                     # "This is a test."
 
 ==== Struct
 
-===== .keyworded?
-
-⚠️ Will be removed in the next major version. Use `.keyword_init?` instead.
-
-Answers whether a struct was constructed with keyword or positional arguments.
-
-[source,ruby]
-----
-Struct.new(:a, keyword_init: true).keyworded?  # true
-Struct.new(:a).keyworded?                      # false
-----
-
-===== .with_keywords
-
-Answers a struct instance with given keyword arguments regardless of
-whether the struct was constructed with positional or keyword arguments.
-
-[source,ruby]
-----
-Example = Struct.new :a, :b, :c
-Example.with_keywords a: 1, b: 2, c: 3  # #<struct a=1, b=2, c=3>
-Example.with_keywords a: 1              # #<struct a=1, b=nil, c=nil>
-Example.with_keywords c: 1              # #<struct a=nil, b=nil, c=1>
-
-Example = Struct.new :a, :b, :c, keyword_init: true
-Example.with_keywords a: 1, b: 2, c: 3  # #<struct a=1, b=2, c=3>
-Example.with_keywords a: 1              # #<struct a=1, b=nil, c=nil>
-Example.with_keywords c: 1              # #<struct a=nil, b=nil, c=1>
-----
-
 ===== .with_positions
 
 Answers a struct instance with given positional arguments regardless of

data/lib/refinements/arrays.rb

@@ -10,11 +10,11 @@ module Refinements
 
       def combinatorial?(other) = !other.empty? && size == union(other).size
 
-      def compress = dup.compress!
+      def compress = compact.delete_if { |element| element.respond_to?(:empty?) && element.empty? }
 
       def compress!
-        compact!
         delete_if { |element| element.respond_to?(:empty?) && element.empty? }
+        compact!
       end
 
       def excluding(*elements) = self - elements.flatten

data/lib/refinements/hashes.rb

@@ -16,13 +16,11 @@ module Refinements
     refine Hash do
       import_methods Shared::Enumerables::Many
 
-      def compress = dup.compress!
+      def compress = compact.delete_if { |_key, value| value.respond_to?(:empty?) && value.empty? }
 
       def compress!
-        return self if empty?
-
-        compact!
         delete_if { |_key, value| value.respond_to?(:empty?) && value.empty? }
+        compact!
       end
 
       def deep_merge other
@@ -47,37 +45,25 @@ module Refinements
 
       def deep_symbolize_keys! = replace(deep_symbolize_keys)
 
-      def fetch_value(key, *default_value, &)
-        fetch(key, *default_value, &) || default_value.first
-      end
-
-      # :reek:TooManyStatements
-      def flatten_keys prefix: nil, delimiter: "_", cast: :to_sym
-        fail StandardError, "Unknown cast: #{cast}." unless %i[to_sym to_s].include? cast
+      def fetch_value(key, *default_value, &) = fetch(key, *default_value, &) || default_value.first
 
-        reduce({}) do |flat, (key, value)|
-          flat_key = prefix ? "#{prefix}#{delimiter}#{key}" : key
+      def flatten_keys prefix: nil, delimiter: "_"
+        reduce({}) do |accumulator, (key, value)|
+          flat_key = prefix ? "#{prefix}#{delimiter}#{key}".to_sym : key
 
-          next flat.merge flat_key.public_send(cast) => value unless value.is_a? self.class
+          next accumulator.merge flat_key => value unless value in Hash
 
-          flat.merge(
-            recurse { value.flatten_keys prefix: flat_key, delimiter:, cast: }
-          )
+          accumulator.merge(recurse { value.flatten_keys prefix: flat_key, delimiter: })
         end
       end
 
-      def flatten_keys! prefix: nil, delimiter: "_", cast: :to_sym
-        replace flatten_keys(prefix:, delimiter:, cast:)
-      end
+      def flatten_keys!(prefix: nil, delimiter: "_") = replace flatten_keys(prefix:, delimiter:)
 
       def recurse &block
         return self unless block
 
         transform = yield self
-
-        transform.each do |key, value|
-          transform[key] = value.recurse(&block) if value.is_a? self.class
-        end
+        transform.each { |key, value| transform[key] = value.recurse(&block) if value in Hash }
       end
 
       def stringify_keys = transform_keys(&:to_s)
@@ -88,6 +74,13 @@ module Refinements
 
       def symbolize_keys! = transform_keys!(&:to_sym)
 
+      def transform_with(operations) = dup.transform_with! operations
+
+      def transform_with! operations
+        operations.each { |key, function| self[key] = function.call self[key] if key? key }
+        self
+      end
+
       def use &block
         return [] unless block
 

data/lib/refinements/string_ios.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require "stringio"
 require "refinements/shared/ios/reread"
+require "stringio"
 
 module Refinements
   # Provides additional enhancements to the StringIO primitive.

data/lib/refinements/strings.rb

@@ -50,6 +50,8 @@ module Refinements
                                            .then { |parts| combine parts, :down, "_" }
       end
 
+      def squish = gsub(/[[:space:]]+/, " ").tap(&:strip!)
+
       def titleize
         return capitalize unless match? DELIMITERS
 

data/lib/refinements/structs.rb

@@ -4,13 +4,6 @@ module Refinements
   # Provides additional enhancements to the Struct primitive.
   module Structs
     refine Struct.singleton_class do
-      def keyworded?
-        warn "[DEPRECATION]: .keyworded? is deprecated, use .keyword_init? instead."
-        inspect.include? "keyword_init: true"
-      end
-
-      def with_keywords(**arguments) = keyword_init? ? new(**arguments) : new.merge!(**arguments)
-
       def with_positions(*values) = keyword_init? ? new(**members.zip(values).to_h) : new(*values)
     end
 

data/lib/refinements.rb

@@ -5,10 +5,10 @@ require "refinements/big_decimals"
 require "refinements/date_times"
 require "refinements/hashes"
 require "refinements/ios"
+require "refinements/log_devices"
+require "refinements/loggers"
 require "refinements/pathnames"
-require "refinements/strings"
 require "refinements/string_ios"
+require "refinements/strings"
 require "refinements/structs"
 require "refinements/symbols"
-require "refinements/log_devices"
-require "refinements/loggers"

data/refinements.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "refinements"
-  spec.version = "9.7.1"
+  spec.version = "10.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/refinements"
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
 
-  spec.required_ruby_version = "~> 3.1"
+  spec.required_ruby_version = "~> 3.2"
 
   spec.files = Dir["*.gemspec", "lib/**/*"]
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 9.7.1
+  version: 10.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2022-10-22 00:00:00.000000000 Z
+date: 2022-12-25 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -76,14 +76,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.24
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: A collection of refinements to core Ruby objects.