refinements 9.3.3 → 9.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45b1bdce43acf8214718786c93fea980981facaf122c63c146f8cf441bd83f43
-  data.tar.gz: e252fc216237d62623600447037dcaf1d35a52f5940119802472f20d736db9e8
+  metadata.gz: 5c0144180dd3a5cabe861b385cd0c766eaf54280ca6812dc6e82db4e564ce6c0
+  data.tar.gz: b339710c168c98fffbe5b1994031f033041c9f6c16b0df96555cb80fd5cd7269
 SHA512:
-  metadata.gz: 764a260bb45b9e7166d1e93f8403db75d0162604161b4a51fc95ced2eaa77f0fca8fbc5e2cc51f7b26bbf9212c3f5f3d56d7bdc0548b855886301d4272e3d409
-  data.tar.gz: 7671415d0c5a05a95835ac1b5f3ff6273df8a97c34b0d949d374eac1d928e1fbdaa9488243955ce055145901206c1426ea13de31d659818f6aaa4d6ab16d889d
+  metadata.gz: 926090205f29ac111494e00e7de37b59b8549c6f979c8a0d62d852e9d87193093073ac0f005564243fc472eacf4de68f62bea8b1d45f3f363e113805758f726d
+  data.tar.gz: 22a524d073a48922d6347119f01f4c059bbd2bba8f65a2e6573951b137b772dc3f7797a3596ccb850bb63159a9b2ab501bb334f7ac8a80f66ca93f55886bdb09

data/README.adoc

@@ -21,6 +21,8 @@ Enhances the following objects:
 * DateTime
 * Hash
 * IO
+* LogDevice
+* Logger
 * Pathname
 * String
 * StringIO
@@ -73,6 +75,8 @@ require "refinements/strings"
 require "refinements/string_ios"
 require "refinements/structs"
 require "refinements/symbols"
+require "refinements/log_devices"
+require "refinements/loggers"
 ----
 
 === Using
@@ -93,6 +97,8 @@ class Example
   using Refinements::StringIOs
   using Refinements::Structs
   using Refinements::Symbols
+  using Refinements::LogDevices
+  using Refinements::Loggers
 end
 ----
 
@@ -102,6 +108,24 @@ The following sections demonstrate how each refinement enriches your objects wit
 
 ==== Array
 
+===== #combinatorial?
+
+Answers if an array is equal to another array when the elements are equal but in any order and/or subset.
+
+[source,ruby]
+----
+example = %w[a b c]
+
+example.combinatorial? %w[a b c]    # true
+example.combinatorial? %w[c a b]    # true
+example.combinatorial? %w[c]        # true
+example.combinatorial? %w[c b]      # true
+example.combinatorial? %w[x]        # false
+example.combinatorial? %w[z b c]    # false
+example.combinatorial? %w[a b c d]  # false
+example.combinatorial? []           # false
+----
+
 ===== #compress
 
 Removes `nil` and empty objects without mutating itself.
@@ -254,6 +278,21 @@ example.ring { |(before, current, after)| puts "#{before} #{current} #{after}" }
 # [2 3 1]
 ----
 
+===== #to_sentence
+
+Answers a sentence using `", "` as the default delimiter and `"and"` as the default conjunction.
+Useful when building documentation, answering human readable error messages, etc.
+
+[source,ruby]
+----
+[].to_sentence                                                     # ""
+["test"].to_sentence                                               # "test"
+["a", :b].to_sentence                                              # "a and b"
+[1, "a", :b, 2.0, /\w+/].map(&:inspect).to_sentence                # 1, "a", :b, 2.0, and /\w+/
+%w[one two three].to_sentence                                      # "one, two, and three"
+%w[eins zwei drei].to_sentence delimiter: " ", conjunction: "und"  # "eins zwei und drei"
+----
+
 ==== Big Decimal
 
 ===== #inspect
@@ -581,6 +620,54 @@ io.squelch { io.write "Test" }  # "#<IO:fd 20>"
 io.reread                       # ""
 ----
 
+==== LogDevice
+
+===== #reread
+
+Answers previously written content by rewinding to beginning of device.
+
+[source,ruby]
+----
+# With File.
+device = Logger::LogDevice.new "test.log"
+device.write "Test."
+device.reread                                # "Test."
+
+# With StringIO.
+device = Logger::LogDevice.new StringIO.new
+device.write "Test."
+device.reread                                # "Test."
+
+# With STDOUT.
+device = Logger::LogDevice.new $stdout
+device.write "Test."
+device.reread                                # ""
+----
+
+==== Logger
+
+===== #reread
+
+Answers previously written content by rewinding to beginning of log.
+
+[source,ruby]
+----
+# With File.
+logger = Logger.new "test.log"
+logger.write "Test."
+logger.reread                     # "Test."
+
+# With StringIO.
+logger = Logger.new StringIO.new
+logger.write "Test."
+logger.reread                     # "Test."
+
+# With STDOUT.
+logger = Logger.new $stdout
+logger.write "Test."
+logger.reread                     # ""
+----
+
 ==== Pathname
 
 ===== Pathname

data/lib/refinements/arrays.rb

@@ -8,6 +8,8 @@ module Refinements
     refine Array do
       import_methods Shared::Enumerables::Many
 
+      def combinatorial?(other) = !other.empty? && size == union(other).size
+
       def compress = dup.compress!
 
       def compress!
@@ -32,6 +34,14 @@ module Refinements
       def pad(value, max: size) = dup.fill(value, size..(max - 1))
 
       def ring(&) = [last, *self, first].each_cons(3, &)
+
+      def to_sentence delimiter: ", ", conjunction: "and"
+        case length
+          when (3..) then "#{self[..-2].join delimiter}#{delimiter}#{conjunction} #{last}"
+          when 2 then join " #{conjunction} "
+          else join
+        end
+      end
     end
   end
 end

data/lib/refinements/hashes.rb

@@ -21,7 +21,8 @@ module Refinements
       def compress!
         return self if empty?
 
-        compact!.delete_if { |_key, value| value.respond_to?(:empty?) && value.empty? }
+        compact!
+        delete_if { |_key, value| value.respond_to?(:empty?) && value.empty? }
       end
 
       def deep_merge other

data/lib/refinements/ios.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "refinements/shared/ios/reread"
+
 module Refinements
   # Provides additional enhancements to the IO primitive.
   module IOs
@@ -15,6 +17,8 @@ module Refinements
     end
 
     refine IO do
+      import_methods Shared::IOs::Reread
+
       def redirect other
         return self unless block_given?
 
@@ -24,8 +28,6 @@ module Refinements
         reopen backup
       end
 
-      def reread(length = nil, buffer: nil) = tap(&:rewind).read(length, buffer)
-
       def squelch(&) = self.class.void.then { |void| redirect(void, &) }
     end
   end

data/lib/refinements/log_devices.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "logger"
+require "refinements/string_ios"
+
+module Refinements
+  # Provides additional enhancements to a log device.
+  module LogDevices
+    using StringIOs
+
+    refine Logger::LogDevice do
+      def reread
+        case dev
+          when File then dev.class.new(dev).read
+          when StringIO then dev.reread
+          else ""
+        end
+      end
+    end
+  end
+end

data/lib/refinements/loggers.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "refinements/log_devices"
+
+module Refinements
+  # Provides additional enhancements to a logger.
+  module Loggers
+    using LogDevices
+
+    refine Logger do
+      def reread = @logdev.reread
+    end
+  end
+end

data/lib/refinements/shared/ios/reread.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Refinements
+  module Shared
+    module IOs
+      # Provides shared functionality for I/O object rewinding.
+      module Reread
+        def reread(length = nil, buffer: nil) = tap(&:rewind).read(length, buffer)
+      end
+    end
+  end
+end

data/lib/refinements/string_ios.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
 require "stringio"
+require "refinements/shared/ios/reread"
 
 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)
+      import_methods Shared::IOs::Reread
     end
   end
 end

data/lib/refinements.rb

@@ -10,3 +10,5 @@ require "refinements/strings"
 require "refinements/string_ios"
 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.3.3"
+  spec.version = "9.6.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/refinements"
@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
     "bug_tracker_uri" => "https://github.com/bkuhlmann/refinements/issues",
     "changelog_uri" => "https://www.alchemists.io/projects/refinements/versions",
     "documentation_uri" => "https://www.alchemists.io/projects/refinements",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
     "label" => "Refinements",
     "rubygems_mfa_required" => "true",
     "source_code_uri" => "https://github.com/bkuhlmann/refinements"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 9.3.3
+  version: 9.6.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2022-04-23 00:00:00.000000000 Z
+date: 2022-07-17 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -47,8 +47,11 @@ files:
 - lib/refinements/date_times.rb
 - lib/refinements/hashes.rb
 - lib/refinements/ios.rb
+- lib/refinements/log_devices.rb
+- lib/refinements/loggers.rb
 - lib/refinements/pathnames.rb
 - lib/refinements/shared/enumerables/many.rb
+- lib/refinements/shared/ios/reread.rb
 - lib/refinements/string_ios.rb
 - lib/refinements/strings.rb
 - lib/refinements/structs.rb
@@ -61,6 +64,7 @@ metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/refinements/issues
   changelog_uri: https://www.alchemists.io/projects/refinements/versions
   documentation_uri: https://www.alchemists.io/projects/refinements
+  funding_uri: https://github.com/sponsors/bkuhlmann
   label: Refinements
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/refinements
@@ -79,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.3.18
 signing_key:
 specification_version: 4
 summary: A collection of refinements to core Ruby objects.