refinements 8.1.1 → 8.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c04df598103624b71b08d5b175c319d21c9fa5ff773976c5956f6e1aa0acdb70
-  data.tar.gz: d6b9d57e2a23a74d1bed6e98146590e1bdc4f4a843ea9ed72747b6ccd3d847bc
+  metadata.gz: d389fcb07d681440a24f0b368c81a76948e15b71287a850e857f8e018fc973da
+  data.tar.gz: 3f7a815dbc49376aad77ab549e77bf9e607bec74ff136b537dfccc371649fe4a
 SHA512:
-  metadata.gz: 996ac02a62679e6cd2bd083863ee587d9915a65bee40883bb21875a196d79126eacae345458f4e5f784203e9d26af17a8735c46a6c3e2eacf77adecacea07d08
-  data.tar.gz: 5a4d11cb1010fbe61137b5e0382568bec9bdb4812d169f68d749e2e9809a033109102631a1568030eef53b6372e5bda4a23d93b3ceb7cef0f164f6b5e9b6a91d
+  metadata.gz: d7269907e701c6917bb5c096af4bbf1650d03b8ffb752b56c37baa895e8eff649359246b79e0a19b3b790d6dde60711a06aeb0a37b3da0c080a64bbcc54e96bf
+  data.tar.gz: 5cbd5fd8f553c47fa5f77e4145c48af1ac3467927fb09aae8db48639a92c6000c255b75d66d90824474c7dbffd10ef19ee5581e3d5da83f4bb0526d0d8d1a2e1

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::[]
 
@@ -135,6 +137,23 @@ Removes given array or elements without mutating itself.
 [1, 2, 3, 4, 5].excluding 4, 5    # => [1, 2, 3]
 ----
 
+===== #filter_find
+
+Answers the first truthy and filtered result from a collection.
+
+[source,ruby]
+----
+handlers = [
+  ->(object) { object if object == :b },
+  proc { false },
+  ->(object) { object if object == :a }
+]
+
+handlers.filter_find                                # => Enumerator::Lazy
+handlers.filter_find { |handler| handler.call :a }  # => :a
+handlers.filter_find { |handler| handler.call :x }  # => nil
+----
+
 ===== #including
 
 Adds given array or elements without mutating itself.
@@ -156,6 +175,19 @@ Inserts additional elements or array between all members of given array.
 [1, 2, 3].intersperse %i[a b c]  # => [1, :a, :b, :c, 2, :a, :b, :c, 3]
 ----
 
+===== #maximum
+
+Answers the maximum extracted value from a collection of objects.
+
+[source,ruby]
+----
+Point = Struct.new :x, :y, keyword_init: true
+points = [Point[x: 1, y: 2], Point[x: 0, y: 1], Point[x: 2, y: 3]]
+
+points.maximum(:x)  # => 2
+points.maximum(:y)  # => 3
+----
+
 ===== #mean
 
 Answers mean/average all elements within an array.
@@ -168,6 +200,19 @@ Answers mean/average all elements within an array.
 [1.25, 1.5, 1.75].mean  # => 1.5
 ----
 
+===== #minimum
+
+Answers the minimum extracted value from a collection of objects.
+
+[source,ruby]
+----
+Point = Struct.new :x, :y, keyword_init: true
+points = [Point[x: 1, y: 2], Point[x: 0, y: 1], Point[x: 2, y: 3]]
+
+points.minimum(:x)  # => 0
+points.minimum(:y)  # => 1
+----
+
 ===== #pad
 
 Answers new array padded with given value up to a maximum size. Useful in situations where an array
@@ -243,6 +288,30 @@ example = Hash.with_default []
 example[:b]  # => []
 ----
 
+===== #compress
+
+Removes 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 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.
@@ -492,7 +561,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

data/lib/refinements/arrays.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Refinements
+  # Provides additional enhancements to the Array primitive.
   module Arrays
     refine Array do
       def compress = compact.reject(&:empty?)
@@ -9,11 +10,17 @@ module Refinements
 
       def excluding(*elements) = self - elements.flatten
 
+      def filter_find(&block) = block ? lazy.map(&block).find(&:itself) : lazy
+
       def including(*elements) = self + elements.flatten
 
       def intersperse(*elements) = product([elements]).tap(&:pop).flatten.push(last)
 
-      def mean = size.zero? ? 0 : sum(0) / size
+      def maximum(key) = map(&key).max
+
+      def mean = size.zero? ? 0 : sum(0.0) / size
+
+      def minimum(key) = map(&key).min
 
       def pad(value, max: size) = dup.fill(value, size..(max - 1))
 

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,12 @@ module Refinements
     end
 
     refine Hash do
+      def compress = dup.compress!
+
+      def compress!
+        compact!.delete_if { |_key, value| value.respond_to?(:empty?) && value.empty? }
+      end
+
       def deep_merge other
         clazz = self.class
 
@@ -62,13 +69,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.1.1"
-    VERSION_LABEL = "#{LABEL} #{VERSION}"
+    VERSION = "8.3.0"
+    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
 

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")
@@ -21,9 +22,7 @@ module Refinements
       def revalue attributes = each_pair
         return self unless block_given?
 
-        dup.tap do |copy|
-          attributes.each { |key, value| copy[key] = yield self[key], value }
-        end
+        dup.tap { |copy| attributes.each { |key, value| copy[key] = yield self[key], value } }
       end
 
       def revalue! attributes = each_pair

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 8.1.1
+  version: 8.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-04-18 00:00:00.000000000 Z
+date: 2021-09-26 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.16
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: A collection of refinements to core Ruby objects.