filter_io 0.2.7 → 0.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 88a035f96c444d4c3c91aa87b0bb7628c8d9092b
-  data.tar.gz: 26497c89876324625e20fd824cfb83d04288b4e5
+SHA256:
+  metadata.gz: 2aa379c9231e3f092273dbc5cf5306b9dcb58b749aa4c3c4ada4081995b1dbf4
+  data.tar.gz: 370b83c3187be5d2a863e7b94e75a717da16ee6c25360edd91eae61ba0e713b8
 SHA512:
-  metadata.gz: f3f82c288657ac02c89afb0a32a3f66ea473dc83d901c6f463cd548297de2b2a7293b80575f72a1bbc05567b858411f9cec103ff0b3a838b0abb68ec0a23c98a
-  data.tar.gz: a270fe4c534c2193a35a31561157979774938036437ece8e26d5333ff658aff9085ab99b4bc803cec4ae32de228baccde59d9d7c7bdcdc8685e6afdf19c88e48
+  metadata.gz: 7805dc1d20a7325bb87161836b67e8cf949ed021411678f5280d0ebd85ef6e535c27cf4b32cc935b35690c99b529d79ad0413397ca0f50129a6f0a6a653016c3
+  data.tar.gz: e8d5aac3c61ca1b819e6b6b029af39a432735ab1734ec8d0a2ef3c0ee777812d185284a5ea40bd8275ee7ec4b34e5c11ce8857e60842a633f8aeb7c2b1f8f7db

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.5

data/README.markdown

@@ -93,7 +93,7 @@ When either `readline`, `gets` or `read(nil)` is called, `filter_io` will proces
 
 Ruby 1.9 has character encoding support can convert between UTF-8, ISO-8859-1, ASCII-8BIT, etc. This is triggered in `IO` by using `:external_encoding` and `:internal_encoding` when opening the stream.
 `filter_io` will use the underlying stream's encoding settings when reading and filtering data. The processing block will be passed data in the internal encoding.
-As per the core `IO` object, if `read` is called with a length (in bytes), the data will be returned in the external encoding.
+As per the core `IO` object, if `read` is called with a length (in bytes), the data will be returned in ASCII-8BIT.
 In summary, everything should Just Work™
 
 ### Notes on Patches/Pull Requests

data/filter_io.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'rspec', '~> 2.13'
+  spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry'
 end

data/lib/filter_io/version.rb

@@ -1,3 +1,3 @@
 class FilterIO
-  VERSION = '0.2.7'
+  VERSION = '0.2.11'
 end

data/lib/filter_io.rb

@@ -54,12 +54,11 @@ class FilterIO
   end
 
   def default_encoding
-    unless @default_encoding
+    @default_encoding ||= begin
       c = @io.getc
       @io.ungetc c
-      @default_encoding = c.encoding
+      c.encoding
     end
-    @default_encoding
   end
 
   def internal_encoding
@@ -103,6 +102,7 @@ class FilterIO
     return '' if length == 0
 
     # fill the buffer up to the fill level (or whole input if length is nil)
+    @did_first_read ||= false
     while (!source_eof? || !@did_first_read) && (length.nil? || length > @buffer.bytesize)
       @did_first_read = true
       buffer_data @options[:block_size] || length
@@ -188,12 +188,12 @@ class FilterIO
       raise ArgumentError
     end
 
+    return "" if limit == 0
     return nil if eof?
-    return read if sep_string.nil?
 
     paragraph_mode = sep_string == ''
     sep_string = "\n\n" if paragraph_mode
-    sep_string = sep_string.to_s unless sep_string.is_a? String
+    sep_string = sep_string&.to_s unless sep_string.is_a? String
 
     if paragraph_mode
       # consume any leading newlines
@@ -278,7 +278,7 @@ class FilterIO
   def with_byte_buffer
     begin
       org_encoding = @buffer.encoding
-      @buffer.force_encoding 'ASCII-8BIT'
+      @buffer.force_encoding Encoding::BINARY
       yield
     ensure
       @buffer.force_encoding org_encoding
@@ -298,7 +298,7 @@ class FilterIO
 
   def find_bytes(str)
     with_byte_buffer do
-      @buffer.index(str)
+      str && @buffer.index(str)
     end
   end
 
@@ -325,7 +325,7 @@ class FilterIO
         # and add some more data to the buffer
         raise NeedMoreData
       end
-    rescue NeedMoreData => e
+    rescue NeedMoreData
       raise EOFError, 'end of file reached' if @io.eof?
       new_data = @io.read(block_size).force_encoding(external_encoding)
       data << new_data
@@ -336,7 +336,7 @@ class FilterIO
     data = [data] unless data.is_a? Array
     raise 'Block must have 1 or 2 values' unless data.size <= 2
     if @buffer.encoding != data[0].encoding
-      if [@buffer, data[0]].any? { |x| x.encoding.to_s == 'ASCII-8BIT' }
+      if [@buffer, data[0]].any? { |x| x.encoding == Encoding::BINARY }
         data[0] = data[0].dup.force_encoding @buffer.encoding
       end
     end
@@ -367,7 +367,7 @@ class FilterIO
         rescue Errno::ESPIPE
           @source_pos
         end
-        args << BlockState.new(src_pos == data.length, source_eof?)
+        args << BlockState.new(src_pos == data.bytesize, source_eof?)
       end
       data = @block.call(*args)
       raise IOError, 'Block returned nil' if data.nil?

data/spec/filter_io_spec.rb

@@ -28,6 +28,8 @@ describe FilterIO do
           errors << [e.class, e.message]
         end
         positions << io.pos
+
+        break if results == [""] * 10 && errors == [nil] * 10 && positions == [0] * 10
         raise 'Too many iterations' if results.size > 100
       end
 
@@ -204,7 +206,7 @@ describe FilterIO do
 
   it 'converts ISO-8859-1 to UTF-8 via a block' do
     [1, 2, nil].each do |block_size|
-      expected = "über\nrésumé"
+      # expected: "über\nrésumé"
       with_iso8859_1_test_file 'UTF-8' do |io_raw|
         io = FilterIO.new(io_raw, :block_size => block_size) do |data, state|
           if state.bof?
@@ -225,7 +227,7 @@ describe FilterIO do
 
   it 'converts ISO-8859-1 to raw via a block' do
     [1, 2, nil].each do |block_size|
-      expected = "über\nrésumé".encode('ISO-8859-1')
+      # expected: "über\nrésumé".encode('ISO-8859-1')
       with_iso8859_1_test_file 'ISO-8859-1' do |io_raw|
         io = FilterIO.new(io_raw, :block_size => block_size) do |data, state|
           if state.bof?
@@ -348,6 +350,18 @@ describe FilterIO do
     expect(io.read).to eq expected
   end
 
+  it 'passes true for BOF to the block when stream starts with a UTF-8 BOM' do
+    input = "\xEF\xBB\xBFTest String"
+    expected = ">>>*\xEF\xBB\xBFT**est **Stri**ng*<<<"
+    io = FilterIO.new(StringIO.new(input), :block_size => 4) do |data, state|
+      data = "*#{data}*"
+      data = ">>>#{data}" if state.bof?
+      data = "#{data}<<<" if state.eof?
+      data
+    end
+    expect(io.read).to eq expected
+  end
+
   it 'passes false for BOF to the block if stream previously read' do
     input = StringIO.new 'Test String'
     expect(input.read(4)).to eq 'Test'
@@ -451,7 +465,7 @@ describe FilterIO do
 
   it 'can be rewound with block' do
     input = 'abcdefghij'
-    expected = input[1..-1]
+    # expected: input[1..-1]
     io = FilterIO.new(StringIO.new(input), :block_size => 4) do |data, state|
       data = data[1..-1] if state.bof?
       data
@@ -562,7 +576,7 @@ describe FilterIO do
     end
   end
 
-  it 'supports `get` with a limit' do
+  it 'supports `gets` with a limit' do
     [
       "",
       "x",
@@ -570,11 +584,24 @@ describe FilterIO do
       "abc\rdef\rghi\r",
       "über",
     ].each do |input|
-      [1, 2, 3, 4, 10].each do |limit|
+      [0, 1, 2, 3, 4, 10].each do |limit|
         matches_reference_io_behaviour(input) { |io| io.gets(limit) }
       end
     end
-    # TODO: test zero limit
+  end
+
+  it 'supports `gets` with nil separator and a limit' do
+    [
+      "",
+      "x",
+      "foo\nbar\rbaz\n",
+      "abc\rdef\rghi\r",
+      "über",
+    ].each do |input|
+      [0, 1, 2, 3, 4, 10].each do |limit|
+        matches_reference_io_behaviour(input) { |io| io.gets(nil, limit) }
+      end
+    end
   end
 
   it 'supports `gets` with a separator and a limit' do
@@ -586,15 +613,14 @@ describe FilterIO do
       "über",
     ].each do |input|
       ["\r", "x"].each do |sep_string|
-        [1, 2, 3, 4, 10].each do |limit|
+        [0, 1, 2, 3, 4, 10].each do |limit|
           matches_reference_io_behaviour(input) { |io| io.gets(sep_string, limit) }
         end
       end
     end
-    # TODO: test zero limit
   end
 
-  it 'errors when `get` is passed more than two args' do
+  it 'errors when `gets` is passed more than two args' do
     expect {
       FilterIO.new(StringIO.new).gets(1,2,3)
     }.to raise_error ArgumentError
@@ -821,11 +847,6 @@ describe FilterIO do
       expect {
         filtered_io.gets
       }.to raise_error IOError
-
-      # closing again should raise an error
-      expect {
-        filtered_io.close
-      }.to raise_error IOError
     end
   end
 
@@ -955,5 +976,4 @@ describe FilterIO do
 
     expect(dest.string).to eq 'FOO'
   end
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filter_io
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.11
 platform: ruby
 authors:
 - Jason Weathered
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-05 00:00:00.000000000 Z
+date: 2022-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - jason@jasoncodes.com
 executables: []
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".tool-versions"
 - Gemfile
 - LICENSE
 - README.markdown
@@ -101,7 +102,7 @@ homepage: http://github.com/jasoncodes/filter_io
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,9 +117,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Filter IO streams with a block. Ruby's FilterInputStream.
 test_files: