tins 1.58.0 → 1.59.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 564a0581732d7b53d9882960e13662d1d279f7edf7d1bc4c6d717a5dc2f27188
-  data.tar.gz: 36ff7350160cdcc8c606ba6c91aa74d9fa7c0617caebbe7af80473f1ce499829
+  metadata.gz: 7843ec2310ee0b79ceccdfab9e4f1ad6269ffab2735ba0fbac09cad7d931df43
+  data.tar.gz: 577d7f162cf3838f33afe119d847fdfd23b748f6807bf0c54aad592e6121b3ec
 SHA512:
-  metadata.gz: 7bf1f364ec0c9a8b9e8db2fbcde42b9b93574f09fc2ebcadc089c62a4510cb766534e85ea40f2073311d36a9e64644194877e6673f3888f1a1327504004b6f6f
-  data.tar.gz: cdd850325aff0d57ccd781d8859e940161952bff48d77d72e260785ea4029fe57bfb18123471d83c1548a3e56105b2190fcb3e273aa0eb1c4e26710a0103c3df
+  metadata.gz: 44ccfe0501987243c4fb871055ef1af9083079e4d7a676e56eb389100f3b6a8fcffbd0cfa05b7be495a829d930d840c32c69faa50b3c0dc81af4ea3de9f5f418
+  data.tar.gz: 942ea6999ec5d3ed20dada3e6d5395fd68d0ab38f6c11723c05071522f92c756caeadc44b91a018a990e29184896f71b4d4dcf85795c5057c49e71d37eb0a564

data/CHANGES.md

@@ -1,5 +1,21 @@
 # Changes
 
+## 2026-09-25 v1.59.0
+
+* Add `*sels` and `&block` parameters to `squeeze` and `squeeze!`, allowing
+  squeezing to be restricted to elements matching case-equality (`===`)
+  selectors or a predicate block
+* Raise `ArgumentError` when both `*sels` and `&block` are provided
+* Change hot-loop comparison to `item != prev || !block.(item)` so non-matching
+  elements are never collapsed
+* Forward `(*sels, &block)` from `squeeze!` to `squeeze`
+* Extend YARD documentation with `@param` tags and `@example` blocks covering
+  range, type, predicate, and `String`/`Enumerable` invariance
+* Add 12 new test cases in `tests/enum_squeeze_test.rb` covering single/multi
+  value selectors, type selectors, range selectors, predicate blocks, the
+  mutual-exclusion guard, the `String#squeeze`/`Enumerable#squeeze` invariance
+  property, and `squeeze!` forwarding with selectors and blocks
+
 ## 2026-09-24 v1.58.0
 
 *   Freeze the `UNSET` sentinel constant in `Tins::Delegate` to prevent

data/lib/tins/enum_squeeze.rb

@@ -10,6 +10,19 @@ module Tins
     # Two elements are considered duplicates when
     # +item == previous+ is true.
     #
+    # Optionally restrict squeezing to elements matching one or
+    # more selectors via case-equality (+===+), mirroring how
+    # +String#squeeze+ uses character-class expressions.
+    # Elements not matching any selector are never collapsed.
+    #
+    # @param [Array] sels
+    #   Case-equality matchers (types, ranges, regexes, or any
+    #   object responding to +===+) defining which elements are
+    #   eligible for squeezing.
+    # @param [Proc, nil] block
+    #   A predicate; when it returns false for an element, that
+    #   element is never collapsed. Mutually exclusive with +sels+.
+    #
     # @return [Array] a new array with consecutive duplicates removed
     #
     # @example Basic usage:
@@ -20,12 +33,40 @@ module Tins
     #
     # @example Mirrors String#squeeze semantics:
     #   "aabbcc".squeeze            # => "abc"
-    def squeeze
+    #
+    # @example Squeeze only elements in a range:
+    #   [1, 3, 2, 2, 4, 6, 3, 3, 7].squeeze(2..3)
+    #   # => [1, 3, 2, 4, 6, 3, 7]
+    #
+    # @example Squeeze only elements of a given type:
+    #   [[1], '1', [1], [1], '1', '1', [1]].squeeze(String)
+    #   # => [[1], "1", [1], [1], "1", [1]]
+    #
+    # @example Squeeze using a predicate block:
+    #   [1, 3, 2, 2, 4, 6, 3, 3, 7].squeeze(&:even?)
+    #   # => [1, 3, 2, 4, 6, 3, 3, 7]
+    #
+    # @example Enumerable/String invariance:
+    #   str = 'fooaabaaz'
+    #   str.squeeze(?a) == str.split('').squeeze(?a).join
+    #   # => true
+    def squeeze(*sels, &block)
+      !sels.empty? && block and raise ArgumentError,
+        'you cannot pass both *sels and &block'
+
+      unless block
+        if sels.empty?
+          block = -> x { true }
+        else
+          block = -> x { sels.any? { _1 === x } }
+        end
+      end
+
       result = []
       prev   = A_THING_THAT_IS_NOT_A_THING
 
       each do |item|
-        unless item == prev
+        if item != prev || !block.(item)
           result << item
           prev = item
         end
@@ -39,6 +80,11 @@ module Tins
     # Destructive counterpart to +squeeze+: the receiver is modified
     # via +replace+; no new object is allocated.
     #
+    # @param [Array] sels
+    #   Case-equality matchers (see +squeeze+).
+    # @param [Proc, nil] block
+    #   A predicate (see +squeeze+).
+    #
     # @return [self] if one or more consecutive duplicates were removed
     # @return [nil]  if the receiver was already free of consecutive
     #   duplicates
@@ -55,9 +101,14 @@ module Tins
     #   b = [1, 2, 3]
     #   b.squeeze!  # => nil
     #   b           # => [1, 2, 3]
-    def squeeze!
+    #
+    # @example Squeezing with a selector:
+    #   a = [1, 3, 2, 2, 4, 6, 3, 3, 7]
+    #   a.squeeze!(2..3)
+    #   a           # => [1, 3, 2, 4, 6, 3, 7]
+    def squeeze!(*sels, &block)
       respond_to?(:replace) or raise 'cannot be squeezed in place!'
-      squeezed = squeeze
+      squeezed = squeeze(*sels, &block)
       return if squeezed.count == count
       replace squeezed
     end

data/lib/tins/version.rb

@@ -1,6 +1,6 @@
 module Tins
   # Tins version
-  VERSION         = '1.58.0'
+  VERSION         = '1.59.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/tests/enum_squeeze_test.rb

@@ -50,6 +50,71 @@ module Tins
       assert_equal [1, 2, 3], result
     end
 
+    # --- squeeze with selectors ---
+
+    def test_squeeze_single_value_selector
+      assert_equal(
+        [1, 3, 2, 2, 4, 6, 3, 7],
+        [1, 3, 2, 2, 4, 6, 3, 3, 7].squeeze(3)
+      )
+    end
+
+    def test_squeeze_multiple_value_selectors
+      assert_equal(
+        [1, 3, 2, 4, 6, 3, 7],
+        [1, 3, 2, 2, 4, 6, 3, 3, 7].squeeze(3, 2)
+      )
+    end
+
+    def test_squeeze_type_selector
+      assert_equal(
+        [[1], "1", [1], [1], "1", [1]],
+        [[1], '1', [1], [1], '1', '1', [1]].squeeze(String)
+      )
+    end
+
+    def test_squeeze_multiple_type_selectors
+      assert_equal(
+        [[1], "1", [1], "1", [1]],
+        [[1], '1', [1], [1], '1', '1', [1]].squeeze(String, Array)
+      )
+    end
+
+    def test_squeeze_range_selector
+      # Only 2 and 3 are in range; 5,5 survives (out of scope)
+      assert_equal(
+        [1, 3, 2, 4, 6, 3, 7, 5, 5, 7],
+        [1, 3, 2, 2, 4, 6, 3, 3, 7, 5, 5, 7].squeeze(2..3)
+      )
+    end
+
+    def test_squeeze_even_block
+      assert_equal(
+        [1, 3, 2, 4, 6, 3, 3, 7],
+        [1, 3, 2, 2, 4, 6, 3, 3, 7].squeeze(&:even?)
+      )
+    end
+
+    def test_squeeze_odd_block
+      assert_equal(
+        [1, 3, 2, 2, 4, 6, 3, 7],
+        [1, 3, 2, 2, 4, 6, 3, 3, 7].squeeze(&:odd?)
+      )
+    end
+
+    def test_squeeze_raises_when_both_sels_and_block
+      assert_raise(ArgumentError) do
+        [1, 1, 2].squeeze(Integer) { |x| true }
+      end
+    end
+
+    def test_string_array_invariance
+      str  = 'fooaabaaz'
+      sels = [?a]
+      assert_equal str.squeeze(*sels),
+                   str.split('').squeeze(*sels).join
+    end
+
     # --- squeeze! (bang) ---
 
     def test_squeeze_bang_modifies_in_place
@@ -80,5 +145,27 @@ module Tins
       enum = [1, 1, 2].each # Enumerator has no #replace
       assert_raise(RuntimeError) { enum.squeeze! }
     end
+
+    # --- squeeze! with selectors ---
+
+    def test_squeeze_bang_with_selector
+      a = [1, 3, 2, 2, 4, 6, 3, 3, 7]
+      result = a.squeeze!(3)
+      assert_equal [1, 3, 2, 2, 4, 6, 3, 7], a
+      assert_same a, result
+    end
+
+    def test_squeeze_bang_with_selector_no_change
+      a = [1, 2, 4, 6, 7]
+      assert_nil a.squeeze!(3)
+      assert_equal [1, 2, 4, 6, 7], a
+    end
+
+    def test_squeeze_bang_with_block
+      a = [1, 3, 2, 2, 4, 6, 3, 3, 7]
+      result = a.squeeze!(&:even?)
+      assert_equal [1, 3, 2, 4, 6, 3, 3, 7], a
+      assert_same a, result
+    end
   end
 end

data/tins.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: tins 1.58.0 ruby lib
+# stub: tins 1.59.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "tins".freeze
-  s.version = "1.58.0".freeze
+  s.version = "1.59.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tins
 version: !ruby/object:Gem::Version
-  version: 1.58.0
+  version: 1.59.0
 platform: ruby
 authors:
 - Florian Frank