iostreams 1.9.0 → 1.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 410a7bdcec2ee16f130bbb7010bfd2258975253c1bd380c1832f034ae18b2979
-  data.tar.gz: 6f8e7bd896166b10a77477a95a0eae88b742a117525d48c10fd23952fa37faa7
+  metadata.gz: 30ace4685022c88754654b2b48d1c86185e47841f1d3c6a3916bc348098b178d
+  data.tar.gz: 040c669d7ad4521941a3752dc405390c4f7dda98a583cc0f5d923091e12bd452
 SHA512:
-  metadata.gz: 85a53eae7c90affdfcd577836d83533d75eff5eb8e880352c6890d4805c219b91e99fc1d936cc72829dbe93d6b8ea55585cc0a2b3a1c8886ab2b261e7c078cb7
-  data.tar.gz: 5bd17a2bae394ca10a84f659fe1e0aac8315ab393cfe11e4606b3b0e4ca901d121c2b0aeae91cf6dac0f1939fec039fac21036a5c8382abe382f5d705bf519ad
+  metadata.gz: 90f2635d2e443fe4c4f3992d8f92a725118b2f52c0d4861ee1d778be8f145d93c2f0663904f8cf699b33106a154d13980634881a0039c7e0ad6389d137d69760
+  data.tar.gz: 970da1fd8e3b6ea7e1b36dad476c7f842413c2b8b50dc2939802b1962c00347bcdfa6a135245550c9cb639b694e9ca2c16439bde1afe7677701f3867cdc277e4

data/lib/io_streams/gzip/reader.rb

@@ -2,9 +2,9 @@ module IOStreams
   module Gzip
     class Reader < IOStreams::Reader
       # Read from a gzip stream, decompressing the contents as it is read
-      def self.stream(input_stream, original_file_name: nil, &block)
+      def self.stream(input_stream, original_file_name: nil)
         io = ::Zlib::GzipReader.new(input_stream)
-        block.call(io)
+        yield io
       ensure
         io&.close
       end

data/lib/io_streams/line/reader.rb

@@ -146,8 +146,8 @@ module IOStreams
         data
       end
 
-      # Returns [Integer] the number of characters read into the internal buffer
-      # Returns 0 on EOF
+      # Returns whether more data is available to read
+      # Returns false on EOF
       def read_block
         return false if @eof
 
@@ -157,7 +157,8 @@ module IOStreams
               @input_stream.read(@buffer_size, @read_cache_buffer)
             rescue ArgumentError
               # Handle arity of -1 when just 0..1
-              @read_cache_buffer = nil
+              @read_cache_buffer     = nil
+              @use_read_cache_buffer = false
               @input_stream.read(@buffer_size)
             end
           else

data/lib/io_streams/paths/file.rb

@@ -89,6 +89,11 @@ module IOStreams
       # "**.rb"     "lib/song.rb"    true
       # "*"         "dave/.profile"  true
       def each_child(pattern = "*", case_sensitive: false, directories: false, hidden: false)
+        unless block_given?
+          return to_enum(__method__, pattern,
+                         case_sensitive: case_sensitive, directories: directories, hidden: hidden)
+        end
+
         flags = 0
         flags |= ::File::FNM_CASEFOLD unless case_sensitive
         flags |= ::File::FNM_DOTMATCH if hidden

data/lib/io_streams/paths/s3.rb

@@ -284,6 +284,11 @@ module IOStreams
       # Notes:
       # - Currently all S3 lookups are recursive as of the pattern regardless of whether the pattern includes `**`.
       def each_child(pattern = "*", case_sensitive: false, directories: false, hidden: false)
+        unless block_given?
+          return to_enum(__method__, pattern,
+                         case_sensitive: case_sensitive, directories: directories, hidden: hidden)
+        end
+
         matcher = Matcher.new(self, pattern, case_sensitive: case_sensitive, hidden: hidden)
 
         # When the pattern includes an exact file name without any pattern characters

data/lib/io_streams/paths/sftp.rb

@@ -142,6 +142,11 @@ module IOStreams
       # sftp://sftp.example.org/a/b/c/test.txt {:type=>1, :size=>37, :owner=>"test_owner", :group=>"test_group",
       #   :permissions=>420, :atime=>1572378136, :mtime=>1572378136, :link_count=>1, :extended=>{}}
       def each_child(pattern = "*", case_sensitive: true, directories: false, hidden: false)
+        unless block_given?
+          return to_enum(__method__, pattern,
+                         case_sensitive: case_sensitive, directories: directories, hidden: hidden)
+        end
+
         Utils.load_soft_dependency("net-sftp", "SFTP glob capability", "net/sftp") unless defined?(Net::SFTP)
 
         flags = ::File::FNM_EXTGLOB

data/lib/io_streams/pgp/writer.rb

@@ -89,10 +89,11 @@ module IOStreams
 
         IOStreams::Pgp.logger&.debug { "IOStreams::Pgp::Writer.open: #{command}" }
 
+        result = nil
         Open3.popen2e(command) do |stdin, out, waith_thr|
           begin
             stdin.binmode
-            yield(stdin)
+            result = yield(stdin)
             stdin.close
           rescue Errno::EPIPE
             # Ignore broken pipe because gpg terminates early due to an error
@@ -104,6 +105,7 @@ module IOStreams
             raise(Pgp::Failure, "GPG Failed to create encrypted file: #{file_name}: #{out.read.chomp}")
           end
         end
+        result
       end
     end
   end

data/lib/io_streams/tabular/parser/fixed.rb

@@ -148,14 +148,14 @@ module IOStreams
 
           def initialize(size:, key: nil, type: :string, decimals: 2)
             @key      = key
-            @size     = size == :remainder ? -1 : size.to_i
+            @size     = (size == :remainder || size == "remainder") ? -1 : size.to_i
             @type     = type.to_sym
             @decimals = decimals
 
             unless @size.positive? || (@size == -1)
               raise(Errors::InvalidLayout, "Size #{size.inspect} must be positive or :remainder")
             end
-            raise(Errors::InvalidLayout, "Unknown type: #{type.inspect}") unless TYPES.include?(type)
+            raise(Errors::InvalidLayout, "Unknown type: #{type.inspect}") unless TYPES.include?(@type)
           end
 
           def parse(value)

data/lib/io_streams/version.rb

@@ -1,3 +1,3 @@
 module IOStreams
-  VERSION = "1.9.0".freeze
+  VERSION = "1.10.3".freeze
 end

data/lib/io_streams/writer.rb

@@ -4,8 +4,9 @@ module IOStreams
     # and then pass that filename in for this reader.
     def self.stream(output_stream, original_file_name: nil, **args, &block)
       Utils.temp_file_name("iostreams_writer") do |file_name|
-        file(file_name, original_file_name: original_file_name, **args, &block)
+        count = file(file_name, original_file_name: original_file_name, **args, &block)
         ::File.open(file_name, "rb") { |source| ::IO.copy_stream(source, output_stream) }
+        count
       end
     end
 

data/lib/io_streams/zip/writer.rb

@@ -14,7 +14,7 @@ module IOStreams
       #     Name of the file entry within the Zip file.
       #
       # The stream supplied to the block only responds to #write
-      def self.stream(output_stream, original_file_name: nil, zip_file_name: nil, entry_file_name: zip_file_name, &block)
+      def self.stream(output_stream, original_file_name: nil, zip_file_name: nil, entry_file_name: zip_file_name)
         # Default the name of the file within the zip to the supplied file_name without the zip extension
         if entry_file_name.nil? && original_file_name && (original_file_name =~ /\.(zip)\z/i)
           entry_file_name = original_file_name.to_s[0..-5]
@@ -23,7 +23,11 @@ module IOStreams
 
         Utils.load_soft_dependency("zip_tricks", "Zip") unless defined?(ZipTricks::Streamer)
 
-        ZipTricks::Streamer.open(output_stream) { |zip| zip.write_deflated_file(entry_file_name, &block) }
+        result = nil
+        ZipTricks::Streamer.open(output_stream) do |zip|
+          zip.write_deflated_file(entry_file_name) { |io| result = yield(io) }
+        end
+        result
       end
     end
   end

data/test/bzip2_writer_test.rb

@@ -20,10 +20,13 @@ class Bzip2WriterTest < Minitest::Test
 
     describe ".file" do
       it "file" do
-        IOStreams::Bzip2::Writer.file(file_name) do |io|
-          io.write(decompressed)
-          io.write(decompressed)
-        end
+        result =
+          IOStreams::Bzip2::Writer.file(file_name) do |io|
+            io.write(decompressed)
+            io.write(decompressed)
+            53534
+          end
+        assert_equal 53534, result
 
         File.open(file_name, "rb") do |file|
           io     = ::Bzip2::FFI::Reader.new(file)
@@ -35,10 +38,13 @@ class Bzip2WriterTest < Minitest::Test
 
       it "stream" do
         io_string = StringIO.new("".b)
-        IOStreams::Bzip2::Writer.stream(io_string) do |io|
-          io.write(decompressed)
-          io.write(decompressed)
-        end
+        result    =
+          IOStreams::Bzip2::Writer.stream(io_string) do |io|
+            io.write(decompressed)
+            io.write(decompressed)
+            53534
+          end
+        assert_equal 53534, result
 
         io     = StringIO.new(io_string.string)
         rbzip2 = ::Bzip2::FFI::Reader.new(io)

data/test/encode_writer_test.rb

@@ -22,18 +22,24 @@ class EncodeWriterTest < Minitest::Test
       it "file" do
         temp_file = Tempfile.new("rocket_job")
         file_name = temp_file.to_path
-        IOStreams::Encode::Writer.file(file_name, encoding: "ASCII-8BIT") do |io|
-          io << bad_data
-        end
+        result    =
+          IOStreams::Encode::Writer.file(file_name, encoding: "ASCII-8BIT") do |io|
+            io << bad_data
+            53534
+          end
+        assert_equal 53534, result
         result = File.read(file_name, mode: "rb")
         assert_equal bad_data, result
       end
 
       it "stream" do
-        io = StringIO.new("".b)
-        IOStreams::Encode::Writer.stream(io, encoding: "ASCII-8BIT") do |encoded|
-          encoded << bad_data
-        end
+        io     = StringIO.new("".b)
+        result =
+          IOStreams::Encode::Writer.stream(io, encoding: "ASCII-8BIT") do |encoded|
+            encoded << bad_data
+            53534
+          end
+        assert_equal 53534, result
         assert_equal "ASCII-8BIT", io.string.encoding.to_s
         assert_equal bad_data, io.string
       end
@@ -70,9 +76,12 @@ class EncodeWriterTest < Minitest::Test
       it "returns byte count" do
         io_string = StringIO.new("".b)
         count     = 0
-        IOStreams::Encode::Writer.stream(io_string, encoding: "ASCII-8BIT") do |io|
-          count += io.write(bad_data)
-        end
+        result    =
+          IOStreams::Encode::Writer.stream(io_string, encoding: "ASCII-8BIT") do |io|
+            count += io.write(bad_data)
+            53534
+          end
+        assert_equal 53534, result
         assert_equal bad_data, io_string.string
         assert_equal bad_data.size, count
       end

data/test/gzip_writer_test.rb

@@ -20,9 +20,13 @@ class GzipWriterTest < Minitest::Test
 
     describe ".file" do
       it "file" do
-        IOStreams::Gzip::Writer.file(file_name) do |io|
-          io.write(decompressed)
-        end
+        result =
+          IOStreams::Gzip::Writer.file(file_name) do |io|
+            io.write(decompressed)
+            53534
+          end
+        assert_equal 53534, result
+
         result = Zlib::GzipReader.open(file_name, &:read)
         temp_file.delete
         assert_equal decompressed, result
@@ -30,11 +34,15 @@ class GzipWriterTest < Minitest::Test
 
       it "stream" do
         io_string = StringIO.new("".b)
-        IOStreams::Gzip::Writer.stream(io_string) do |io|
-          io.write(decompressed)
-        end
-        io = StringIO.new(io_string.string)
-        gz = Zlib::GzipReader.new(io)
+        result    =
+          IOStreams::Gzip::Writer.stream(io_string) do |io|
+            io.write(decompressed)
+            53534
+          end
+        assert_equal 53534, result
+
+        io   = StringIO.new(io_string.string)
+        gz   = Zlib::GzipReader.new(io)
         data = gz.read
         gz.close
         assert_equal decompressed, data

data/test/line_writer_test.rb

@@ -18,18 +18,25 @@ class DelimitedWriterTest < Minitest::Test
       it "file" do
         temp_file = Tempfile.new("rocket_job")
         file_name = temp_file.to_path
-        IOStreams::Line::Writer.file(file_name) do |io|
-          lines.each { |line| io << line }
-        end
+        result    =
+          IOStreams::Line::Writer.file(file_name) do |io|
+            lines.each { |line| io << line }
+            53534
+          end
+        assert_equal 53534, result
+
         result = File.read(file_name)
         assert_equal raw, result
       end
 
       it "stream" do
         io_string = StringIO.new
-        IOStreams::Line::Writer.stream(io_string) do |io|
-          lines.each { |line| io << line }
-        end
+        result    =
+          IOStreams::Line::Writer.stream(io_string) do |io|
+            lines.each { |line| io << line }
+            53534
+          end
+        assert_equal 53534, result
         assert_equal raw, io_string.string
       end
     end
@@ -38,9 +45,12 @@ class DelimitedWriterTest < Minitest::Test
       it "returns byte count" do
         io_string = StringIO.new
         count     = 0
-        IOStreams::Line::Writer.stream(io_string) do |io|
-          lines.each { |line| count += io.write(line) }
-        end
+        result    =
+          IOStreams::Line::Writer.stream(io_string) do |io|
+            lines.each { |line| count += io.write(line) }
+            53534
+          end
+        assert_equal 53534, result
         assert_equal raw, io_string.string
         assert_equal raw.size, count
       end

data/test/paths/file_test.rb

@@ -5,7 +5,7 @@ module Paths
     describe IOStreams::Paths::File do
       let(:root) { IOStreams::Paths::File.new("/tmp/iostreams").delete_all }
       let(:directory) { root.join("/some_test_dir") }
-      let(:data) { "Hello World" }
+      let(:data) { "Hello World\nHow are you doing?\nOn this fine day" }
       let(:file_path) do
         path = root.join("some_test_dir/test_file.txt")
         path.writer { |io| io << data }
@@ -17,6 +17,15 @@ module Paths
         path
       end
 
+      describe "#each" do
+        it "reads lines" do
+          records = []
+          count   = file_path.each { |line| records << line }
+          assert_equal count, data.lines.size
+          assert_equal data.lines.collect(&:strip), records
+        end
+      end
+
       describe "#each_child" do
         it "iterates an empty path" do
           none = nil
@@ -48,6 +57,12 @@ module Paths
           actual   = root.children("**/Test*.TXT", case_sensitive: true).collect(&:to_s)
           refute_equal expected, actual.sort
         end
+
+        it "with no block returns enumerator" do
+          expected = [file_path.to_s, file_path2.to_s]
+          actual   = root.each_child("**/*").first(100).collect(&:to_s)
+          assert_equal expected.sort, actual.sort
+        end
       end
 
       describe "#mkpath" do

data/test/pgp_writer_test.rb

@@ -21,9 +21,12 @@ class PgpWriterTest < Minitest::Test
 
     describe ".file" do
       it "writes encrypted text file" do
-        IOStreams::Pgp::Writer.file(file_name, recipient: "receiver@example.org") do |io|
-          io.write(decrypted)
-        end
+        result =
+          IOStreams::Pgp::Writer.file(file_name, recipient: "receiver@example.org") do |io|
+            io.write(decrypted)
+            53534
+          end
+        assert_equal 53534, result
 
         result = IOStreams::Pgp::Reader.file(file_name, passphrase: "receiver_passphrase", &:read)
         assert_equal decrypted, result
@@ -34,9 +37,12 @@ class PgpWriterTest < Minitest::Test
         binary_data      = File.open(binary_file_name, "rb", &:read)
 
         File.open(binary_file_name, "rb") do |input|
-          IOStreams::Pgp::Writer.file(file_name, recipient: "receiver@example.org") do |output|
-            IO.copy_stream(input, output)
-          end
+          result =
+            IOStreams::Pgp::Writer.file(file_name, recipient: "receiver@example.org") do |output|
+              IO.copy_stream(input, output)
+              53534
+            end
+          assert_equal 53534, result
         end
 
         result = IOStreams::Pgp::Reader.file(file_name, passphrase: "receiver_passphrase", &:read)
@@ -108,9 +114,12 @@ class PgpWriterTest < Minitest::Test
 
       it "writes to a stream" do
         io_string = StringIO.new("".b)
-        IOStreams::Pgp::Writer.stream(io_string, recipient: "receiver@example.org", signer: "sender@example.org", signer_passphrase: "sender_passphrase") do |io|
-          io.write(decrypted)
-        end
+        result    =
+          IOStreams::Pgp::Writer.stream(io_string, recipient: "receiver@example.org", signer: "sender@example.org", signer_passphrase: "sender_passphrase") do |io|
+            io.write(decrypted)
+            53534
+          end
+        assert_equal 53534, result
 
         io     = StringIO.new(io_string.string)
         result = IOStreams::Pgp::Reader.stream(io, passphrase: "receiver_passphrase", &:read)

data/test/record_writer_test.rb

@@ -43,28 +43,38 @@ class RecordWriterTest < Minitest::Test
 
     describe "#<<" do
       it "file" do
-        IOStreams::Record::Writer.file(file_name) do |io|
-          inputs.each { |hash| io << hash }
-        end
+        result =
+          IOStreams::Record::Writer.file(file_name) do |io|
+            inputs.each { |hash| io << hash }
+            53534
+          end
+        assert_equal 53534, result
         result = File.read(file_name)
         assert_equal raw_csv_data, result
       end
 
       it "json file" do
-        IOStreams::Record::Writer.file(file_name, file_name: "abc.json") do |io|
-          inputs.each { |hash| io << hash }
-        end
+        result =
+          IOStreams::Record::Writer.file(file_name, file_name: "abc.json") do |io|
+            inputs.each { |hash| io << hash }
+            53534
+          end
+        assert_equal 53534, result
+
         result = File.read(file_name)
         assert_equal raw_json_data, result
       end
 
       it "stream" do
         io_string = StringIO.new
-        IOStreams::Line::Writer.stream(io_string) do |io|
-          IOStreams::Record::Writer.stream(io) do |stream|
-            inputs.each { |row| stream << row }
+        result    =
+          IOStreams::Line::Writer.stream(io_string) do |io|
+            IOStreams::Record::Writer.stream(io) do |stream|
+              inputs.each { |row| stream << row }
+              53534
+            end
           end
-        end
+        assert_equal 53534, result
         assert_equal raw_csv_data, io_string.string
       end
     end

data/test/row_reader_test.rb

@@ -10,7 +10,7 @@ class RowReaderTest < Minitest::Test
       CSV.read(file_name)
     end
 
-    describe ".open" do
+    describe "#each" do
       it "file" do
         rows  = []
         count = IOStreams::Row::Reader.file(file_name) do |io|

data/test/row_writer_test.rb

@@ -29,20 +29,26 @@ class RowWriterTest < Minitest::Test
 
     describe ".stream" do
       it "file" do
-        IOStreams::Row::Writer.file(file_name) do |io|
-          csv_rows.each { |array| io << array }
-        end
+        result =
+          IOStreams::Row::Writer.file(file_name) do |io|
+            csv_rows.each { |array| io << array }
+            53534
+          end
+        assert_equal 53534, result
         result = ::File.read(file_name)
         assert_equal raw_csv_data, result
       end
 
       it "streams" do
         io_string = StringIO.new
-        IOStreams::Line::Writer.stream(io_string) do |io|
-          IOStreams::Row::Writer.stream(io) do |stream|
-            csv_rows.each { |array| stream << array }
+        result    =
+          IOStreams::Line::Writer.stream(io_string) do |io|
+            IOStreams::Row::Writer.stream(io) do |stream|
+              csv_rows.each { |array| stream << array }
+              53534
+            end
           end
-        end
+        assert_equal 53534, result
         assert_equal raw_csv_data, io_string.string
       end
     end

data/test/tabular_test.rb

@@ -40,6 +40,19 @@ class TabularTest < Minitest::Test
       IOStreams::Tabular.new(format: :fixed, format_options: {layout: layout})
     end
 
+    let :fixed_with_strings do
+      layout = [
+        {size: "23", key: "name"},
+        {size: 40, key: "address"},
+        {size: 2},
+        {size: 5.0, key: "zip", type: "integer"},
+        {size: "8", key: "age", type: "integer"},
+        {size: 10, key: "weight", type: "float", decimals: 2},
+        {size: "remainder", key: "remainder"}
+      ]
+      IOStreams::Tabular.new(format: :fixed, format_options: {layout: layout})
+    end
+
     describe "#parse_header" do
       it "parses and sets the csv header" do
         tabular = IOStreams::Tabular.new(format: :csv)
@@ -269,6 +282,11 @@ class TabularTest < Minitest::Test
           assert_equal "Jack                   over there                                34618000000210123456.79", string
         end
 
+        it "renders fixed data with string keys" do
+          assert string = fixed_with_strings.render("name" => "Jack", "address" => "over there", "zip" => 34_618, "weight" => 123_456.789123, "age" => 21)
+          assert_equal "Jack                   over there                                34618000000210123456.79", string
+        end
+
         it "truncates long strings" do
           assert string = fixed.render(name: "Jack ran up the beanstalk and when jack reached the top it was truncated", address: "over there", zip: 34_618)
           assert_equal "Jack ran up the beanstaover there                                34618000000000000000.00", string

data/test/zip_writer_test.rb

@@ -21,19 +21,25 @@ class ZipWriterTest < Minitest::Test
 
     describe ".file" do
       it "file" do
-        IOStreams::Zip::Writer.file(file_name, entry_file_name: "text.txt") do |io|
-          io.write(decompressed)
-        end
+        result =
+          IOStreams::Zip::Writer.file(file_name, entry_file_name: "text.txt") do |io|
+            io.write(decompressed)
+            53534
+          end
+        assert_equal 53534, result
         result = IOStreams::Zip::Reader.file(file_name, &:read)
         assert_equal decompressed, result
       end
 
       it "stream" do
         io_string = StringIO.new("".b)
-        IOStreams::Zip::Writer.stream(io_string) do |io|
-          io.write(decompressed)
-        end
-        io = StringIO.new(io_string.string)
+        result    =
+          IOStreams::Zip::Writer.stream(io_string) do |io|
+            io.write(decompressed)
+            53534
+          end
+        assert_equal 53534, result
+        io     = StringIO.new(io_string.string)
         result = IOStreams::Zip::Reader.stream(io, &:read)
         assert_equal decompressed, result
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iostreams
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.3
 platform: ruby
 authors:
 - Reid Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-17 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -87,6 +87,7 @@ files:
 - test/files/unclosed_quote_large_test.csv
 - test/files/unclosed_quote_test.csv
 - test/files/unclosed_quote_test2.csv
+- test/files/utf16_test.csv
 - test/gzip_reader_test.rb
 - test/gzip_writer_test.rb
 - test/io_streams_test.rb
@@ -159,6 +160,7 @@ test_files:
 - test/files/unclosed_quote_large_test.csv
 - test/files/unclosed_quote_test.csv
 - test/files/unclosed_quote_test2.csv
+- test/files/utf16_test.csv
 - test/gzip_reader_test.rb
 - test/gzip_writer_test.rb
 - test/io_streams_test.rb