refinements 11.1.3 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3abadfec48a3ef48adc2130ab1e9a451fd27cacbb7e5c18c8332757e5db91937
-  data.tar.gz: fa754c6b2c1a19e214edce661a362e93f521381e1ab1fb8f1ebd99fbbca0b13f
+  metadata.gz: a497496f7842bab471ed5d7703054c050aad5d62dcdc317678d4d40d871dbefe
+  data.tar.gz: 117975da807b741ff3b9dff8d585dbba8d00243af81f7c8daf964cda0de6b7b9
 SHA512:
-  metadata.gz: 67c3fb92363ce57b335c74ad29f492eeb634504fb8ba3a97b1374c3fe4cf4a7fb9ed1b274273640e5dac6f9d146753c9df79b4cc90156c089b2e3fba3d005a16
-  data.tar.gz: 4a1d3d5533fe0c76efddd34120066a559835394cf471577b539ef9450a5557243de47647968be6dfb78f6cb19e44fd5cc05a4059be51881c7da6d6932575d9dc
+  metadata.gz: bf13a20ac2e6f6849ab0ae65929f0574c6569cf5840e8aada271f63749326c319531c1e6a572b9bad2526cfb5280df48d9f1ee638a4cff87105e2429edad2d23
+  data.tar.gz: 6b07855b0b39fe4d45509e9cbc11c8e7392a686cd485b73cab3c6134ad6d709f3355cb0b3f18bff81becbfb87058c8f3e0e872ad7db69a657a1c25e8d1390533

data/README.adoc

@@ -13,7 +13,6 @@ toc::[]
 Enhances the following objects:
 
 * Array
-* BigDecimal
 * Data
 * DateTime
 * Hash
@@ -23,7 +22,7 @@ Enhances the following objects:
 * Pathname
 * String
 * StringIO
-* Structs
+* Struct
 
 == Requirements
 
@@ -77,19 +76,18 @@ gem "refinements", require: false
 
 [source,ruby]
 ----
-require "refinements/arrays"
-require "refinements/big_decimals"
+require "refinements/array"
 require "refinements/data"
-require "refinements/date_times"
-require "refinements/hashes"
-require "refinements/ios"
-require "refinements/pathnames"
-require "refinements/strings"
-require "refinements/string_ios"
-require "refinements/structs"
-require "refinements/symbols"
-require "refinements/log_devices"
-require "refinements/loggers"
+require "refinements/date_time"
+require "refinements/hash"
+require "refinements/io"
+require "refinements/log_device"
+require "refinements/logger"
+require "refinements/pathname"
+require "refinements/string"
+require "refinements/string_io"
+require "refinements/struct"
+require "refinements/symbol"
 ----
 
 === Using
@@ -100,19 +98,18 @@ refinement(s):
 [source,ruby]
 ----
 class Example
-  using Refinements::Arrays
-  using Refinements::BigDecimals
+  using Refinements::Array
   using Refinements::Data
-  using Refinements::DateTimes
-  using Refinements::Hashes
-  using Refinements::IOs
-  using Refinements::Pathnames
-  using Refinements::Strings
-  using Refinements::StringIOs
-  using Refinements::Structs
-  using Refinements::Symbols
-  using Refinements::LogDevices
-  using Refinements::Loggers
+  using Refinements::DateTime
+  using Refinements::Hash
+  using Refinements::IO
+  using Refinements::LogDevice
+  using Refinements::Logger
+  using Refinements::Pathname
+  using Refinements::String
+  using Refinements::StringIO
+  using Refinements::Struct
+  using Refinements::Symbol
 end
 ----
 
@@ -280,9 +277,9 @@ needs to be a specific size with padded values.
 
 [source,ruby]
 ----
-[1].pad 0             # [1]
-[1].pad 0, max: 3     # [1, 0, 0]
-[1, 2].pad 3, max: 3  # [1, 2, 3]
+["a"].pad 0         # ["a"]
+["a"].pad "-", 3    # ["a", "-", "-"]
+%w[a b].pad "-", 3  # ["a", "b", "-"]
 ----
 
 ===== #pick
@@ -393,17 +390,6 @@ Builds upon and enhances `#to_sentence` further by answering a sentence which al
 %w[eins zwei drei].to_usage "und", delimiter: " "  # "\"eins\" \"zwei\" und \"drei\""
 ----
 
-==== Big Decimal
-
-===== #inspect
-
-Allows one to inspect a big decimal with numeric representation.
-
-[source,ruby]
-----
-BigDecimal.new("5.0E-10").inspect  # "#<BigDecimal:3fd3d458fe84 0.0000000005>"
-----
-
 ==== Data
 
 ===== #diff
@@ -1288,11 +1274,11 @@ well in other languages.
 [source,ruby]
 ----
 "apple".pluralize "s"                      # apples
-"apple".pluralize "s", count: 0            # apples
-"apple".pluralize "s", count: 1            # apple
-"apple".pluralize "s", count: -1           # apple
-"apple".pluralize "s", count: 2            # apples
-"apple".pluralize "s", count: -2           # apples
+"apple".pluralize "s", 0                   # apples
+"apple".pluralize "s", 1                   # apple
+"apple".pluralize "s", -1                  # apple
+"apple".pluralize "s", 2                   # apples
+"apple".pluralize "s", -2                  # apples
 "cactus".pluralize "i", replace: "us"      # cacti
 "cul-de-sac".pluralize "ls", replace: "l"  # culs-de-sac
 ----
@@ -1308,11 +1294,11 @@ well in other languages.
 [source,ruby]
 ----
 "apples".singularize "s"                      # apple
-"apples".singularize "s", count: 0            # apples
-"apples".singularize "s", count: 1            # apple
-"apples".singularize "s", count: -1           # apple
-"apples".singularize "s", count: 2            # apples
-"apples".singularize "s", count: -2           # apples
+"apples".singularize "s", 0                   # apples
+"apples".singularize "s", 1                   # apple
+"apples".singularize "s", -1                  # apple
+"apples".singularize "s", 2                   # apples
+"apples".singularize "s", -2                  # apples
 "cacti".singularize "i", replace: "us"        # cactus
 "culs-de-sac".singularize "ls", replace: "l"  # cul-de-sac
 ----
@@ -1345,6 +1331,30 @@ Answers a title string with proper capitalization of each word.
 "ThisIsAnExample".titleize  # "This Is An Example"
 ----
 
+===== #truncate
+
+Answers a truncated, non-mutated, string for given length with optional delimiter and/or overflow.
+
+The delimiter is the second positional parameter (optional) and is `nil` by default. A custom string or regular expression can be used to customize truncation behavior.
+
+The trailer is an optional keyword parameter that is an ellipsis (i.e. `"..."`) by default. The trailer can be a custom or empty string. The string length of the trailer is added to the length of the string being truncated, so keep this in mind when setting truncation length.
+
+[source,ruby]
+----
+demo = "It was the best of times"
+length = demo.length
+
+demo.truncate 9                          # "It was..."
+demo.truncate 12                         # "It was th..."
+demo.truncate length                     # "It was the best of times"
+demo.truncate Float::INFINITY            # "It was the best of times"
+demo.truncate 12, " "                    # "It was..."
+demo.truncate 12, /\s/                   # "It was..."
+demo.truncate 6, trailer: ""             # "It was"
+demo.truncate 16, trailer: "... (more)"  # "It was... (more)"
+"demo".truncate 3                        # "..."
+----
+
 ===== #to_bool
 
 Answers string as a boolean.
@@ -1551,7 +1561,7 @@ with public methods in order to not break encapsulation.
 ----
 
 ⚠️ Use of `#call` without any arguments or block should be avoided in order to not incur extra
-processing costs since the original symbol-to-proc call can used instead.
+processing costs since the original symbol-to-proc call can be used instead.
 
 == Development
 

data/lib/refinements/{arrays.rb → array.rb}

@@ -4,8 +4,8 @@ require "refinements/shared/enumerables/many"
 
 module Refinements
   # Provides additional enhancements to the Array primitive.
-  module Arrays
-    refine Array do
+  module Array
+    refine ::Array do
       import_methods Shared::Enumerables::Many
 
       def combinatorial?(other) = !other.empty? && size == union(other).size
@@ -31,7 +31,7 @@ module Refinements
 
       def minimum(key) = map(&key).min
 
-      def pad(value, max: size) = dup.fill(value, size..(max - 1))
+      def pad(value, max = size) = dup.fill(value, size..(max - 1))
 
       def pick(*keys)
         return if empty?

data/lib/refinements/{date_times.rb → date_time.rb}

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

data/lib/refinements/{hashes.rb → hash.rb}

@@ -4,8 +4,8 @@ require "refinements/shared/enumerables/many"
 
 module Refinements
   # Provides additional enhancements to the Hash primitive.
-  module Hashes
-    refine Hash.singleton_class do
+  module Hash
+    refine ::Hash.singleton_class do
       def infinite
         new { |new_hash, missing_key| new_hash[missing_key] = new(&new_hash.default_proc) }
       end
@@ -13,7 +13,7 @@ module Refinements
       def with_default(value) = new { |new_hash, missing_key| new_hash[missing_key] = value }
     end
 
-    refine Hash do
+    refine ::Hash do
       import_methods Shared::Enumerables::Many
 
       def compress = compact.delete_if { |_key, value| value.respond_to?(:empty?) && value.empty? }
@@ -57,7 +57,7 @@ module Refinements
         reduce({}) do |accumulator, (key, value)|
           flat_key = prefix ? :"#{prefix}#{delimiter}#{key}" : key
 
-          next accumulator.merge flat_key => value unless value in Hash
+          next accumulator.merge flat_key => value unless value.is_a? ::Hash
 
           accumulator.merge(recurse { value.flatten_keys prefix: flat_key, delimiter: })
         end
@@ -69,7 +69,7 @@ module Refinements
         return self unless block
 
         transform = yield self
-        transform.each { |key, value| transform[key] = value.recurse(&block) if value in Hash }
+        transform.each { |key, value| transform[key] = value.recurse(&block) if value.is_a? ::Hash }
       end
 
       def stringify_keys = transform_keys(&:to_s)

data/lib/refinements/{ios.rb → io.rb}

@@ -4,8 +4,8 @@ require "refinements/shared/ios/reread"
 
 module Refinements
   # Provides additional enhancements to the IO primitive.
-  module IOs
-    refine IO.singleton_class do
+  module IO
+    refine ::IO.singleton_class do
       def void
         new(sysopen("/dev/null", "w+")).then do |io|
           return io unless block_given?
@@ -16,7 +16,7 @@ module Refinements
       end
     end
 
-    refine IO do
+    refine ::IO do
       import_methods Shared::IOs::Reread
 
       def redirect other

data/lib/refinements/{log_devices.rb → log_device.rb}

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

data/lib/refinements/{loggers.rb → logger.rb}

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "refinements/log_devices"
+require "refinements/log_device"
 
 module Refinements
   # Provides additional enhancements to a logger.
-  module Loggers
-    using LogDevices
+  module Logger
+    using LogDevice
 
-    refine Logger do
+    refine ::Logger do
       def reread = @logdev.reread
 
       alias_method :any, :unknown

data/lib/refinements/{pathnames.rb → pathname.rb}

@@ -4,7 +4,7 @@ require "pathname"
 
 module Refinements
   # Provides additional enhancements to the Pathname primitive.
-  module Pathnames
+  module Pathname
     refine Kernel do
       def Pathname object
         return super(String(object)) unless object
@@ -13,7 +13,7 @@ module Refinements
       end
     end
 
-    refine Pathname.singleton_class do
+    refine ::Pathname.singleton_class do
       def home = new ENV.fetch("HOME", "")
 
       def make_temp_dir prefix: "temp-", suffix: nil, root: nil
@@ -29,7 +29,7 @@ module Refinements
       def root = new(File::SEPARATOR)
     end
 
-    refine Pathname do
+    refine ::Pathname do
       def change_dir
         if block_given?
           Dir.chdir(self) { |path| yield Pathname(path) }

data/lib/refinements/{strings.rb → string.rb}

@@ -2,10 +2,10 @@
 
 module Refinements
   # Provides additional enhancements to the String primitive.
-  module Strings
+  module String
     DELIMITERS = %r([a-z][A-Z]|\s*-\s*|\s*/\s*|\s*:+\s*|\s*_\s*|\s+)
 
-    refine String do
+    refine ::String do
       def blank? = empty? || match?(/\A[[:space:]]*\z/)
 
       def camelcase
@@ -38,9 +38,9 @@ module Refinements
         self[(minimum + 1)..]
       end
 
-      def pluralize(suffix, replace: /$/, count: 0) = count.abs == 1 ? self : sub(replace, suffix)
+      def pluralize(suffix, count = 0, replace: /$/) = count.abs == 1 ? self : sub(replace, suffix)
 
-      def singularize(suffix, replace: "", count: 1) = count.abs == 1 ? sub(suffix, replace) : self
+      def singularize(suffix, count = 1, replace: "") = count.abs == 1 ? sub(suffix, replace) : self
 
       def snakecase
         return downcase unless match? DELIMITERS
@@ -60,7 +60,15 @@ module Refinements
                                               .then { |parts| combine parts, :up, "/" }
       end
 
-      def to_bool = %w[true yes on t y 1].include?(downcase.strip)
+      def truncate to, delimiter = nil, trailer: "..."
+        return dup if length <= to
+
+        offset = to - trailer.length
+        maximum = delimiter ? rindex(delimiter, offset) || offset : offset
+        "#{self[...maximum]}#{trailer}"
+      end
+
+      def to_bool = %w[true yes on t y 1].include? downcase.strip
 
       def up = empty? ? self : first.upcase + self[1, size]
 

data/lib/refinements/{string_ios.rb → string_io.rb}

@@ -5,8 +5,8 @@ require "stringio"
 
 module Refinements
   # Provides additional enhancements to the StringIO primitive.
-  module StringIOs
-    refine StringIO do
+  module StringIO
+    refine ::StringIO do
       import_methods Shared::IOs::Reread
     end
   end

data/lib/refinements/{structs.rb → struct.rb}

@@ -4,12 +4,12 @@ require "refinements/shared/values/diff"
 
 module Refinements
   # Provides additional enhancements to the Struct primitive.
-  module Structs
-    refine Struct.singleton_class do
+  module Struct
+    refine ::Struct.singleton_class do
       def with_positions(*values) = keyword_init? ? new(**members.zip(values).to_h) : new(*values)
     end
 
-    refine Struct do
+    refine ::Struct do
       import_methods Shared::Values::Diff
 
       def merge(...) = dup.merge!(...)

data/lib/refinements/{symbols.rb → symbol.rb}

@@ -2,8 +2,8 @@
 
 module Refinements
   # Provides additional enhancements to the Symbol primitive.
-  module Symbols
-    refine Symbol do
+  module Symbol
+    refine ::Symbol do
       # rubocop:todo Naming/BlockForwarding
       def call(*arguments, &block)
         proc { |receiver| receiver.public_send self, *arguments, &block }

data/lib/refinements.rb

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
 
-require "refinements/arrays"
-require "refinements/big_decimals"
+require "refinements/array"
 require "refinements/data"
-require "refinements/date_times"
-require "refinements/hashes"
-require "refinements/ios"
-require "refinements/log_devices"
-require "refinements/loggers"
-require "refinements/pathnames"
-require "refinements/string_ios"
-require "refinements/strings"
-require "refinements/structs"
-require "refinements/symbols"
+require "refinements/date_time"
+require "refinements/hash"
+require "refinements/io"
+require "refinements/log_device"
+require "refinements/logger"
+require "refinements/pathname"
+require "refinements/string"
+require "refinements/string_io"
+require "refinements/struct"
+require "refinements/symbol"

data/refinements.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "refinements"
-  spec.version = "11.1.3"
+  spec.version = "12.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://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.2", "<= 3.3"]
+  spec.required_ruby_version = "~> 3.3"
 
   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: 11.1.3
+  version: 12.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-12-25 00:00:00.000000000 Z
+date: 2024-01-01 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -49,22 +49,21 @@ files:
 - LICENSE.adoc
 - README.adoc
 - lib/refinements.rb
-- lib/refinements/arrays.rb
-- lib/refinements/big_decimals.rb
+- lib/refinements/array.rb
 - lib/refinements/data.rb
-- 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/date_time.rb
+- lib/refinements/hash.rb
+- lib/refinements/io.rb
+- lib/refinements/log_device.rb
+- lib/refinements/logger.rb
+- lib/refinements/pathname.rb
 - lib/refinements/shared/enumerables/many.rb
 - lib/refinements/shared/ios/reread.rb
 - lib/refinements/shared/values/diff.rb
-- lib/refinements/string_ios.rb
-- lib/refinements/strings.rb
-- lib/refinements/structs.rb
-- lib/refinements/symbols.rb
+- lib/refinements/string.rb
+- lib/refinements/string_io.rb
+- lib/refinements/struct.rb
+- lib/refinements/symbol.rb
 - refinements.gemspec
 homepage: https://alchemists.io/projects/refinements
 licenses:
@@ -83,10 +82,7 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '3.2'
-  - - "<="
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement

data/lib/refinements/big_decimals.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "bigdecimal"
-
-module Refinements
-  # Provides additional enhancements to the BigDecimal primitive.
-  module BigDecimals
-    refine BigDecimal do
-      def inspect = format("#<BigDecimal:%<id>s %<string>s>", id: object_id, string: to_s("F"))
-    end
-  end
-end