refinements 14.1.0 → 14.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 350ced29340ad39df23a202e41b3721db7293c3993364bc8796cca57bddc764c
-  data.tar.gz: afff690e4107212f7bd72054637c9ef8da2bd1265de55899f23fe9769fd616af
+  metadata.gz: 20c9d5d74ead7b650ecdb5ff437ed6c361ca0c9ab687a594d6532319004a790c
+  data.tar.gz: 8900294ef41f48f20b806507bf767deee981d52d15564285045c8f2c09c76eae
 SHA512:
-  metadata.gz: 350c7deafda58ba8f4770ffd993ab3bdd4519fe510e18bd9f52fb383a561d5790ce00598c06aae65d20b585fc848388218118bac0430995ab19350288160cecd
-  data.tar.gz: aa43882784697baa26fdb2a522ef15ff359baa7ff91b72c6234e55b7c10d99d347bce79b33aa15051980f5ef6851eaa4536c7453f670c6bdcef51621990a5eff
+  metadata.gz: 92640b1bb83af678329d564731cd7022a1c48dc377e73a8fab982fbaab32268b8f1ca787966882e8a642c1be85f8e1507821c0324e940313c171399f91d71c48
+  data.tar.gz: 25581278e1d2ea886df83f4fc0fae01831e8fec601a55e4085bed15a1d07ba183bcb8503c678d0455e6be38c76db41a6ae21becaf71c95a59221c05a36a40fd7

data/README.adoc

@@ -25,6 +25,7 @@ Enhances the following objects:
 * StringIO
 * Struct
 * Symbol
+* Time
 
 == Requirements
 
@@ -91,6 +92,7 @@ require "refinements/string"
 require "refinements/string_io"
 require "refinements/struct"
 require "refinements/symbol"
+require "refinements/time"
 ----
 
 === Using
@@ -114,6 +116,7 @@ class Example
   using Refinements::StringIO
   using Refinements::Struct
   using Refinements::Symbol
+  using Refinements::Time
 end
 ----
 
@@ -462,6 +465,8 @@ Any object that _is not_ the same type will have a `nil` value as shown in the l
 
 Answers new DateTime object for current UTC date/time.
 
+⚠️ This method (and refinement) is deprecated and will be removed in the next major release.
+
 [source,ruby]
 ----
 DateTime.utc # "#<DateTime: 2019-12-31T18:17:00+00:00 ((2458849j,65820s,181867000n),+0s,2299161j)>"
@@ -1446,21 +1451,20 @@ Answers a title string with proper capitalization of each word.
 
 ===== #trim_end
 
-Answers the trimmed end of a string (non-mutated) for given length with optional delimiter and/or overflow.
+Answers the trimmed end of a string for maximum 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 behavior.
+The delimiter is the second positional parameter (optional) and is `nil` by default. A string or regular expression can be used to customize 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 trimmed, so keep this in mind when setting length.
+The trailer is an optional keyword parameter that is an ellipsis by default. The trailer can be a custom or empty string. The string size of the trailer is added to the size of the string being trimmed, so keep this in mind when setting the maximum length.
 
 [source,ruby]
 ----
 demo = "It was the best of times"
-length = demo.length
+size = demo.size
 
 demo.trim_end 9                          # "It was..."
 demo.trim_end 12                         # "It was th..."
-demo.trim_end length                     # "It was the best of times"
-demo.trim_end Float::INFINITY            # "It was the best of times"
+demo.trim_end size                       # "It was the best of times"
 demo.trim_end 12, " "                    # "It was..."
 demo.trim_end 12, /\s/                   # "It was..."
 demo.trim_end 6, trailer: ""             # "It was"
@@ -1468,6 +1472,22 @@ demo.trim_end 16, trailer: "... (more)"  # "It was... (more)"
 "demo".trim_end 3                        # "..."
 ----
 
+===== #trim_middle
+
+Answers the trimmed middle of a string for maximum length with optional gap (default: ellipsis). The minimum length is always the size of the gap plus one character on each side of the gap.
+
+[source,ruby]
+----
+demo = "It was the best of times"
+size = demo.size
+
+demo.trim_middle 14                         # "It w...times"
+demo.trim_middle size                       # "It was the...t of times"
+"space".trim_middle 5                       # "s...e"
+demo.trim_middle 14, gap: "+"               # "It was+ times"
+demo.trim_middle 3                          # "It was the best of times"
+----
+
 ===== #truthy?
 
 Answers if string is truthy.
@@ -1633,7 +1653,6 @@ Enhances symbol-to-proc functionality by allowing you to send positional, keywor
 
 [source,ruby]
 ----
-
 %w[clue crow cow].map(&:tr.call("c", "b"))                              # ["blue", "brow", "bow"]
 [1.3, 1.5, 1.9].map(&:round.call(half: :up))                            # [1, 2, 2]
 [%w[a b c], %w[c a b]].map(&:index.call { |element| element == "b" })   # [1, 2]
@@ -1643,6 +1662,18 @@ Enhances symbol-to-proc functionality by allowing you to send positional, keywor
 
 ⚠️ Use of `#call` without any arguments should be avoided in order to not incur extra processing costs since the original symbol-to-proc call can be used instead.
 
+==== Time
+
+===== #rfc_3339
+
+Answers time, as a string, in RFC 3339 format.
+
+[source,ruby]
+----
+Time.now.rfc_3339      # "2026-01-24T08:56:55-07:00"
+Time.now.utc.rfc_3339  # "2026-01-24T15:57:13+00:00"
+----
+
 == Development
 
 To contribute, run:

data/lib/refinements/date_time.rb

@@ -6,7 +6,10 @@ module Refinements
   # Provides additional enhancements to the DateTime primitive.
   module DateTime
     refine ::DateTime.singleton_class do
-      def utc = now.new_offset(0)
+      def utc
+        warn "`DateTime.#{__method__}` is deprecated, use `Time` instead.", category: :deprecated
+        now.new_offset 0
+      end
     end
   end
 end

data/lib/refinements/pathname.rb

@@ -71,7 +71,7 @@ module Refinements
 
       def rewrite = read.then { |content| write yield(content) if block_given? }
 
-      def touch at = Time.now
+      def touch at = ::Time.now
         exist? ? utime(at, at) : write("")
         self
       end

data/lib/refinements/string.rb

@@ -34,7 +34,7 @@ module Refinements
 
       def last minimum = 0
         return self if empty?
-        return self[size - 1] if minimum.zero?
+        return self[-1] if minimum.zero?
         return "" if minimum.negative?
 
         self[(minimum + 1)..]
@@ -52,7 +52,15 @@ module Refinements
                                            .then { |parts| combine parts, :down, "_" }
       end
 
-      def squish = gsub(/[[:space:]]+/, " ").tap(&:strip!)
+      def squish
+        duplicate = dup
+
+        # Find two or more spaces/tabs/newlines or a single space that isn't " ".
+        duplicate.gsub!(/([[:space:]]{2,}|[[[:space:]]&&[^ ]])/, " ")
+
+        duplicate.strip!
+        duplicate
+      end
 
       def titleize
         return capitalize unless match? DELIMITERS
@@ -62,12 +70,26 @@ module Refinements
                                               .then { |parts| combine parts, :up, "/" }
       end
 
-      def trim_end to, delimiter = nil, trailer: "..."
-        return dup if length <= to
+      def trim_end maximum, delimiter = nil, trailer: "..."
+        return dup if size <= maximum
+
+        offset = maximum - trailer.size
+        stop = delimiter ? rindex(delimiter, offset) || offset : offset
+        "#{self[...stop]}#{trailer}"
+      end
+
+      def trim_middle maximum, gap: "..."
+        gap_size = gap.size
+        minimum = gap_size + 2
+        limit = maximum - gap_size
+
+        return dup if maximum < minimum || maximum > size
+        return "#{first}#{gap}#{last}" if minimum == maximum
+
+        half = limit / 2
+        stop = half.odd? ? half - 1 : half
 
-        offset = to - trailer.length
-        maximum = delimiter ? rindex(delimiter, offset) || offset : offset
-        "#{self[...maximum]}#{trailer}"
+        "#{self[...stop]}#{gap}#{self[-half...]}"
       end
 
       def truthy? = %w[true yes on t y 1].include? downcase.strip

data/lib/refinements/time.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Refinements
+  # Provides additional enhancements to the Symbol primitive.
+  module Time
+    refine ::Time do
+      def rfc_3339 = strftime "%FT%T%:z"
+    end
+  end
+end

data/lib/refinements.rb

@@ -13,3 +13,4 @@ require "refinements/string"
 require "refinements/string_io"
 require "refinements/struct"
 require "refinements/symbol"
+require "refinements/time"

data/refinements.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "refinements"
-  spec.version = "14.1.0"
+  spec.version = "14.3.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/refinements"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: refinements
 version: !ruby/object:Gem::Version
-  version: 14.1.0
+  version: 14.3.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -9,9 +9,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIENjCCAp6gAwIBAgIBAjANBgkqhkiG9w0BAQsFADBBMQ8wDQYDVQQDDAZicm9v
+  MIIENjCCAp6gAwIBAgIBAzANBgkqhkiG9w0BAQsFADBBMQ8wDQYDVQQDDAZicm9v
   a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
-  aW8wHhcNMjUwMzIyMTQ1NDE3WhcNMjYwMzIyMTQ1NDE3WjBBMQ8wDQYDVQQDDAZi
+  aW8wHhcNMjYwMzI1MTI0OTEyWhcNMjcwMzI1MTI0OTEyWjBBMQ8wDQYDVQQDDAZi
   cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
   GRYCaW8wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCro8tj5/E1Hg88
   f4qfiwPVd2zJQHvdYt4GHVvuHRRgx4HGhJuNp+4BId08RBn7V6V1MW6MY3kezRBs
@@ -23,15 +23,15 @@ cert_chain:
   GUHU9MyIXbFOsnp3K3ADrAVjPWop8EZkmUR3MV/CUm00w2cZHCSGiXl1KMpiVKvk
   Ywr1gd2ZME4QLSo+EXUtLxDUa/W3xnBS8dBOuMMz02FPWYr3PN8CAwEAAaM5MDcw
   CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAFgmv0tYMZnItuPycSM
-  F5wykJEVMA0GCSqGSIb3DQEBCwUAA4IBgQBlzRfyAYx/fCFjizS0Npxw4+4T3aYL
-  hbXoDqQRWjxuhFZcXUymhz3r8/Ltyri9lSof8grzB+8/+mrMVms7Gwt5qolk6zdn
-  FkySGy/jmpN12ldOHFbBEnyVBZNBvOBVb8zkkw8PhiHdBdXOUm4Jy39yJvBLfjcC
-  iM1aeWPmgPy1GbvZU+leRGZLt6dRIR9oCDXcWLRjha8xLMoz6Yn9fJBYexBA3iEz
-  h5S7pn4AX/JhVRiSyl8pAy4jEKydpyQrliH3gHkpNmUS/XDczP+9xX1bAB4BvqL2
-  NCxMcQ+hiJNqCKpPgHxaOOHZfIxV33logIuPEQ8NryHAwZ9ZWnwtYDE8kQGGKskI
-  Kkm6QT474hZl7MpwiJjWgW313CR7jUEekQahX1QxCxHPI7LSrKpno0plH3uWIOQp
-  KUlkb9uyACBgyRO52ZHiDVI8YvtU5O/j9pSes9/3XgvBeC1onx4qWp+uRX7eVsYS
-  GiijocTc3enZVrXERetaXj8/9XWs3fB3HWY=
+  F5wykJEVMA0GCSqGSIb3DQEBCwUAA4IBgQAG+ykjp+DIXSybGEtX+/ve974mYfN6
+  8U7qcVfRM+qDSOZ+97iu30qUTbVAKIHlHCDKRn3SgOffDUB5VU2MsJBh/3TPKWBZ
+  anB/uzMcwOfru+qyA3b7ZFqZzRLWmR5FtPObFxc0gYMT3YvLNHk2Nb9Vjq/PoiGG
+  e75PXweDOokwDA5m1gMOz1rdp/dlGMXkSFQg94PPVyUKXgO4VzWTgePSDxOIL+v6
+  +OWV6AaEH9BaqxnmdA5ubi0L7bhl0gbN92FxpNO3kpTjww8kme856a+wCK3qyM5w
+  7ZLbUexynDN0Au8eSpT2Bf6ztGmB1S9ffzDJsGX1/lkpMIB51e48Xe2+gzzOgemk
+  CdZaGupj6WkarnT8kh/cPtyA5ax4rGX6GOS8meGxzkv8Uy0JSEOYAp6wLfIisYZp
+  IJBIXIOkwKKJ0eB5YHrUSJxzpP4LlcIg/eTftaXmJdYjy+2VRrCZYDjfguyLmMjR
+  KR9w4/Fjvqy87kCHmxMWa6IL2Vzt1Clm2cA=
   -----END CERTIFICATE-----
 date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
@@ -62,6 +62,7 @@ files:
 - lib/refinements/string_io.rb
 - lib/refinements/struct.rb
 - lib/refinements/symbol.rb
+- lib/refinements/time.rb
 - refinements.gemspec
 homepage: https://alchemists.io/projects/refinements
 licenses:
@@ -88,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.4
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A collection of core object refinements.
 test_files: []