progressive_io 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea6428465be21d680077d7ed5077c9e8e8f0f72622249e3ccb2f585f38e7d969
-  data.tar.gz: f71c4577f2642efb23c3df42697cc52ce08a7cca603af89825efaf5c760c32b0
+  metadata.gz: e46f28055cb41f75b5a00b863d1771580ec7e610dd09d5360574e123c3b99867
+  data.tar.gz: b9ff8b9bf2724da050eb49933eac10c9d35953c30abd823fcc0482823a27a3a8
 SHA512:
-  metadata.gz: ad62723654f1655d14b3a6b391581b1adcef7dbe27bf9a05901f405703118cb251b1bd4b4639ad3ce81d6099ba031596402ce16b96a54476ecdb2ddfa90cdba0
-  data.tar.gz: c1b87a837cb5f2a10defbf2dd1ec493b90b42db58f717b1aca2dfc6827af134fd223d4ca91e307ece53f0560e843fefc02b077f3cd72db47eed6e286f9a927e9
+  metadata.gz: e9c3bdfaf294545502b5dcde2381f67c4d343df02c64d9b56d290877f13619d283288a64517af7e5c5aa7f7359db6a0606684f693c0b8cdec9c32abfd2d27a43
+  data.tar.gz: 14fbce5195814ef1c583c664f8550b664e60d2d46a1465ef7ced873bd980247897fea75652f36444c4ff5511c67ba8be64dcd25644a310f907cd80d9f68ba236

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.0.2
+
+* Fix `each_line` to return an Enumerator that properly references `:each_line` method
+  when called without a block. Previously, `each_line` was an alias of `each`, causing
+  the returned Enumerator to reference `:each` instead of `:each_line`.
+* Change `each` and `each_line` to accept variadic arguments (`*args`) for proper
+  forwarding of separator and limit parameters.
+
 ## 2.0.1
 
 * Revert back to using SimpleDelegator - it's just easier.

data/lib/progressive_io.rb

@@ -28,7 +28,7 @@ require 'delegate'
 # @since 2.0.0
 class ProgressiveIO < SimpleDelegator
   # The version of the ProgressiveIO library
-  VERSION = '2.0.1'
+  VERSION = '2.0.2'
   
   # @return [Proc, nil] The progress callback block that will be called when data is read
   #   The block receives one parameter: current position
@@ -54,22 +54,51 @@ class ProgressiveIO < SimpleDelegator
   
   # Iterates over the IO stream line by line, calling the progress block for each line.
   # 
-  # @param sep_string [String] The line separator (defaults to $/)
+  # @param args [Array] Arguments to pass to the underlying IO#each method (separator and/or limit)
   # @yield [line] Each line from the IO stream
   # @yieldparam line [String] A line from the IO stream
   # @return [Enumerator] An enumerator if no block is given
   # 
   # @example
-  #   progress_io.each_line do |line|
+  #   progress_io.each do |line|
   #     puts "Processing: #{line.chomp}"
   #   end
-  def each(sep_string = $/, &blk)
+  # 
+  # @example Using as an Enumerator
+  #   progress_io.each.with_index do |line, idx|
+  #     puts "Line #{idx}: #{line.chomp}"
+  #   end
+  def each(*args, &blk)
+    return enum_for(__method__, *args) unless block_given?
+    
     # Report offset at each call of the iterator
-    super(sep_string) do |line|
+    super(*args) do |line|
       yield(line).tap { notify_read }
     end
   end
-  alias_method :each_line, :each
+  
+  # Iterates over the IO stream line by line, calling the progress block for each line.
+  # This is an alias-like method for {#each} that ensures proper Enumerator behavior.
+  # 
+  # @param args [Array] Arguments to pass to the underlying IO#each_line method (separator and/or limit)
+  # @yield [line] Each line from the IO stream
+  # @yieldparam line [String] A line from the IO stream
+  # @return [Enumerator] An enumerator if no block is given
+  # 
+  # @example
+  #   progress_io.each_line do |line|
+  #     puts "Processing: #{line.chomp}"
+  #   end
+  # 
+  # @example Using as an Enumerator
+  #   progress_io.each_line.with_index do |line, idx|
+  #     puts "Line #{idx}: #{line.chomp}"
+  #   end
+  def each_line(*args, &blk)
+    return enum_for(__method__, *args) unless block_given?
+    
+    each(*args, &blk)
+  end
   
   # Iterates over the IO stream byte by byte, calling the progress block for each byte.
   # 
@@ -81,7 +110,14 @@ class ProgressiveIO < SimpleDelegator
   #   progress_io.each_byte do |byte|
   #     puts "Byte: #{byte}"
   #   end
+  # 
+  # @example Using as an Enumerator
+  #   progress_io.each_byte.with_index do |byte, idx|
+  #     puts "Byte #{idx}: #{byte}"
+  #   end
   def each_byte(&blk)
+    return enum_for(__method__) unless block_given?
+    
     # Report offset at each call of the iterator
     super { |b| yield(b).tap { notify_read } }
   end

data/test/test_progressive_io.rb

@@ -29,6 +29,73 @@ class TestProgressiveIO < Minitest::Test
     assert_equal [[5], [9], [18], [22]], messages
   end
   
+  def test_each_returns_enumerator_without_block
+    io, messages = e("Mary\nHad\nA little\nLamb"), []
+    
+    io.progress_block = lambda do | offset |
+      messages.push([offset])
+    end
+    
+    enum = io.each
+    assert_kind_of Enumerator, enum
+    
+    # Enumerator should yield lines and still trigger progress callbacks
+    lines = enum.to_a
+    assert_equal ["Mary\n", "Had\n", "A little\n", "Lamb"], lines
+    assert_equal [[5], [9], [18], [22]], messages
+  end
+  
+  def test_each_line_returns_enumerator_without_block
+    io, messages = e("Mary\nHad\nA little\nLamb"), []
+    
+    io.progress_block = lambda do | offset |
+      messages.push([offset])
+    end
+    
+    enum = io.each_line
+    assert_kind_of Enumerator, enum
+    
+    # Enumerator should yield lines and still trigger progress callbacks
+    lines = enum.to_a
+    assert_equal ["Mary\n", "Had\n", "A little\n", "Lamb"], lines
+    assert_equal [[5], [9], [18], [22]], messages
+  end
+  
+  def test_each_enumerator_with_custom_separator
+    io, messages = e("Mary|Had|A little|Lamb"), []
+    
+    io.progress_block = lambda do | offset |
+      messages.push([offset])
+    end
+    
+    enum = io.each("|")
+    assert_kind_of Enumerator, enum
+    
+    lines = enum.to_a
+    assert_equal ["Mary|", "Had|", "A little|", "Lamb"], lines
+    assert_equal [[5], [9], [18], [22]], messages
+  end
+  
+  def test_each_enumerator_chainable
+    io = e("Mary\nHad\nA little\nLamb")
+    
+    # Should be chainable with Enumerator methods like with_index
+    result = io.each.with_index.map { |line, idx| [idx, line.chomp] }
+    assert_equal [[0, "Mary"], [1, "Had"], [2, "A little"], [3, "Lamb"]], result
+  end
+  
+  def test_each_line_enumerator_references_each_line_method
+    io = e("Mary\nHad\nLamb")
+    
+    # The enumerator returned by each_line should reference :each_line, not :each
+    # This is important for proper Enumerator behavior and introspection
+    each_enum = io.each
+    each_line_enum = io.each_line
+    
+    assert_match(/:each\b/, each_enum.inspect, "each enumerator should reference :each method")
+    assert_match(/:each_line\b/, each_line_enum.inspect, "each_line enumerator should reference :each_line method")
+  end
+  
   def test_each_byte
     io, messages = e("123"), []
     
@@ -42,6 +109,30 @@ class TestProgressiveIO < Minitest::Test
     assert_equal [[1], [2], [3]], messages
   end
   
+  def test_each_byte_returns_enumerator_without_block
+    io, messages = e("123"), []
+    
+    io.progress_block = lambda do | offset |
+      messages.push([offset])
+    end
+    
+    enum = io.each_byte
+    assert_kind_of Enumerator, enum
+    
+    # Enumerator should yield bytes and still trigger progress callbacks
+    bytes = enum.to_a
+    assert_equal [49, 50, 51], bytes
+    assert_equal [[1], [2], [3]], messages
+  end
+  
+  def test_each_byte_enumerator_chainable
+    io = e("123")
+    
+    # Should be chainable with Enumerator methods like with_index
+    result = io.each_byte.with_index.map { |byte, idx| [idx, byte] }
+    assert_equal [[0, 49], [1, 50], [2, 51]], result
+  end
+  
   def test_getc
     io = e("123")
     io.progress_block = lambda do | offset |

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: progressive_io
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Julik Tarkhanov
 bindir: bin
 cert_chain: []
-date: 2025-08-01 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake