refinements 8.2.0 → 8.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5706b329caaea4cbf42c9dd34d8da325d5e4b5628385a760de2ca4b4c5efaf06
-  data.tar.gz: c20a4aad691df3a683d3ea29d58ae0dbcef4475d297460a945874c2298972864
+  metadata.gz: 0b633f00ddb573cba22fcf647e293a7f4544fecc82ad3869d9c3528d0bd8e1aa
+  data.tar.gz: 00ef7df42687d801237b8b27563aaa028e19b75a4764c32a3c2220f58186dbe0
 SHA512:
-  metadata.gz: d14f810b454fe4e3116dc35b04a3701485b9ddad99889db58da96cec8e8556271ec53292447861748909add9d293a21a7c3c7a49fc16720fd61f7654dc2251a4
-  data.tar.gz: 61defc07d39c9de58db72ae0f937319694d156c6a0ed2896f6c2a9b645bfbb5fd829e01e96c242764cb4115dc030dbb5ffcb8010446cec34316b7666b62f8061
+  metadata.gz: edb16cbce2ab22b6b95303751e87f09037dd570b38ffb7e6620d91a3e8e7bc9293fdcf4a4378e091847b12ccb80bd5d57c5bab22b0d930507327e54c29c9c855
+  data.tar.gz: 5767133f63df1a255b0ac9d6f9ff1ab6c8dfc73d237968a3cea225e3d2be4964fd8aa2298c7047cb81a8594ba6a9f4a676738d485519b696efeee20ddfe4b51d

data/README.adoc

@@ -11,7 +11,9 @@ image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchem
 [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 primitive Ruby objects.
+Refinements is a collection of enhancements to primitive Ruby objects without needing to resort
+painful and hard to debug monkey patches. These refinements give you additional syntactic sugar to
+build clean and concise implementations all while using less code.
 
 toc::[]
 
@@ -105,13 +107,14 @@ The following sections demonstrate how each refinement enriches your objects wit
 
 ===== #compress
 
-Removes `nil` and empty values without mutating itself.
+Removes `nil` and empty objects without mutating itself.
 
 [source,ruby]
 ----
-example = ["An", nil, "", "Example"]
-example.compress  # => ["An", "Example"]
-example           # => ["An", nil, "", "Example"]
+object = Object.new
+example = [1, "blueberry", nil, "", [], {}, object]
+example.compress  # => [1, "blueberry", object]
+example           # => [1, "blueberry", nil, "", [], {}, object]
 ----
 
 ===== #compress!
@@ -120,9 +123,10 @@ Removes `nil` and empty values while mutating itself.
 
 [source,ruby]
 ----
-example = ["An", nil, "", "Example"]
-example.compress!  # => ["An", "Example"]
-example            # => ["An", "Example"]
+object = Object.new
+example = [1, "blueberry", nil, "", [], {}, object]
+example.compress  # => [1, "blueberry", object]
+example           # => [1, "blueberry", object]
 ----
 
 ===== #excluding
@@ -286,6 +290,30 @@ example = Hash.with_default []
 example[:b]  # => []
 ----
 
+===== #compress
+
+Removes `nil` and empty objects without mutating itself.
+
+[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!
+
+Removes `nil` and empty objects while mutating itself.
+
+[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}
+----
+
 ===== #deep_merge
 
 Merges deeply nested hashes together without mutating itself.
@@ -535,7 +563,7 @@ Wraps `Dir.mktmpdir` with the following behavior (see
 link:https://rubyapi.org/o/Dir.mktmpdir#method-c-mktmpdir[Dir.mktmpdir] for details):
 
 * *Without Block* - Answers a newly created Pathname instance which is not automatically cleaned up.
-* *With Block*  Yields a Pathname instance, answers result of given block, and automatidally cleans
+* *With Block*  Yields a Pathname instance, answers result of given block, and automatically cleans
   up temporary directory after block exits.
 
 The following examples use truncated temporary directories for illustration purposes only. In
@@ -614,6 +642,19 @@ Copies file from current location to new location while answering itself so it c
 Pathname("input.txt").copy Pathname("output.txt")  # => Pathname("input.txt")
 ----
 
+===== #delete
+
+Deletes file or directory and answers itself so it can be chained.
+
+[source,ruby]
+----
+# When path exists.
+Pathname("/example.txt").touch.delete  # => Pathname("/example")
+
+# When path doesn't exist.
+Pathname("/example.txt").delete        # => Errno::ENOENT
+----
+
 ===== #directories
 
 Answers all directories or filtered directories for current path.

data/lib/refinements/arrays.rb

@@ -1,11 +1,15 @@
 # frozen_string_literal: true
 
 module Refinements
+  # Provides additional enhancements to the Array primitive.
   module Arrays
     refine Array do
-      def compress = compact.reject(&:empty?)
+      def compress = dup.compress!
 
-      def compress! = replace(compress)
+      def compress!
+        compact!
+        delete_if { |element| element.respond_to?(:empty?) && element.empty? }
+      end
 
       def excluding(*elements) = self - elements.flatten
 
@@ -17,7 +21,7 @@ module Refinements
 
       def maximum(key) = map(&key).max
 
-      def mean = size.zero? ? 0 : sum(0) / size
+      def mean = size.zero? ? 0 : sum(0.0) / size
 
       def minimum(key) = map(&key).min
 

data/lib/refinements/big_decimals.rb

@@ -3,6 +3,7 @@
 require "bigdecimal"
 
 module Refinements
+  # Provides additional enhancements to the BigDecimal primitive.
   module BigDecimals
     refine BigDecimal do
       def inspect = format("#<BigDecimal:%{id} %{string}>", id: object_id, string: to_s("F"))

data/lib/refinements/date_times.rb

@@ -3,6 +3,7 @@
 require "date"
 
 module Refinements
+  # Provides additional enhancements to the DateTime primitive.
   module DateTimes
     refine DateTime.singleton_class do
       def utc = now.new_offset(0)

data/lib/refinements/hashes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Refinements
+  # Provides additional enhancements to the Hash primitive.
   module Hashes
     refine Hash.singleton_class do
       def infinite
@@ -11,6 +12,14 @@ module Refinements
     end
 
     refine Hash do
+      def compress = dup.compress!
+
+      def compress!
+        return self if empty?
+
+        compact!.delete_if { |_key, value| value.respond_to?(:empty?) && value.empty? }
+      end
+
       def deep_merge other
         clazz = self.class
 
@@ -62,13 +71,13 @@ module Refinements
         end
       end
 
-      def stringify_keys = reduce({}) { |hash, (key, value)| hash.merge key.to_s => value }
+      def stringify_keys = transform_keys(&:to_s)
 
-      def stringify_keys! = replace(stringify_keys)
+      def stringify_keys! = transform_keys!(&:to_s)
 
-      def symbolize_keys = reduce({}) { |hash, (key, value)| hash.merge key.to_sym => value }
+      def symbolize_keys = transform_keys(&:to_sym)
 
-      def symbolize_keys! = replace(symbolize_keys)
+      def symbolize_keys! = transform_keys!(&:to_sym)
 
       def use &block
         return [] unless block

data/lib/refinements/identity.rb

@@ -5,7 +5,7 @@ module Refinements
   module Identity
     NAME = "refinements"
     LABEL = "Refinements"
-    VERSION = "8.2.0"
-    VERSION_LABEL = "#{LABEL} #{VERSION}"
+    VERSION = "8.4.1"
+    VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
   end
 end

data/lib/refinements/ios.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Refinements
+  # Provides additional enhancements to the IO primitive.
   module IOs
     refine IO.singleton_class do
       def void

data/lib/refinements/pathnames.rb

@@ -3,9 +3,9 @@
 require "pathname"
 
 module Refinements
+  # Provides additional enhancements to the Pathname primitive.
   module Pathnames
     refine Kernel do
-      # :reek:UncommunicativeMethodName
       def Pathname object
         return super(String(object)) unless object
 
@@ -24,7 +24,7 @@ module Refinements
         new(root).files(pattern).each { |path| require path.to_s }
       end
 
-      def root = new("/")
+      def root = new(File::SEPARATOR)
     end
 
     refine Pathname do
@@ -38,6 +38,8 @@ module Refinements
         self
       end
 
+      def delete = super && self
+
       def directories pattern = "*", flag: File::FNM_SYSCASE
         glob(pattern, flag).select(&:directory?).sort
       end

data/lib/refinements/string_ios.rb

@@ -3,6 +3,7 @@
 require "stringio"
 
 module Refinements
+  # Provides additional enhancements to the StringIO primitive.
   module StringIOs
     refine StringIO do
       def reread(length = nil, buffer: nil) = tap(&:rewind).read(length, buffer)

data/lib/refinements/strings.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
 module Refinements
+  # Provides additional enhancements to the String primitive.
   module Strings
     DELIMITERS = %r([a-z][A-Z]|\s*-\s*|\s*/\s*|\s*:+\s*|\s*_\s*|\s+)
 
     refine String do
-      def blank? = match?(/\A\s*\z/)
+      def blank? = empty? || match?(/\A[[:space:]]*\z/)
 
       def camelcase
         return up unless match? DELIMITERS
@@ -35,7 +36,7 @@ module Refinements
       def indent multiplier = 1, padding: "  "
         return self if multiplier.negative?
 
-        padding * multiplier + self
+        (padding * multiplier) + self
       end
 
       def last number = 0

data/lib/refinements/structs.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Refinements
+  # Provides additional enhancements to the Struct primitive.
   module Structs
     refine Struct.singleton_class do
       def keyworded? = inspect.include?("keyword_init: true")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 8.2.0
+  version: 8.4.1
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-05-25 00:00:00.000000000 Z
+date: 2021-10-03 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: A collection of refinements to core Ruby objects.