iostreams 1.8.0 → 1.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b84445b48ac6697a255b5fdacd16783b8573e2cdb75ad395c3b4167ffdd6e01b
-  data.tar.gz: a37969afc9635fdac60ea45717d64b9bdd8fbb7c6d853a04c0a02cd798274606
+  metadata.gz: 26d07bc98819ce065e8c698f00b75a6c2e9fc0a9ea6bf13c1afa8bc8c1e71e66
+  data.tar.gz: 2f7898b4197d3f94cbfcc30ba6c8d23e72121877833e57ec9a989e465d019ca2
 SHA512:
-  metadata.gz: 685d6a23dfc176f3abe922fab1879c76572b73dc878864af3e38dfa5824e0eb8c115f855537dcf3c3f2d181b3381512a2c9a20c065beb62cfd91642913c84b30
-  data.tar.gz: db6e6fcb72c07fe502e64f9ab4d18c79334cde6c1622d1b2ac2a22361ed1f38967adc19bb83959e56fc2039ee595f078c1a92d6277a5b8d39d3802e020df0a1a
+  metadata.gz: 2887fb5b2935d28bcf2426fd7139a6b7a27c87c1da8d7289cc69f0a644c2d98e4667f6e6da1a57133bcf8bdd93e948d7819d24ce09cb0d65f6c35d59b0b604c7
+  data.tar.gz: 034aa07ff80107a139dd86ffd492361887de4f4e8190385b48d12b1bedeb0a3af8c1a25720d41f731330cb46d707736972c707c3ec5576551425d29d3843da68

data/lib/io_streams/builder.rb

@@ -79,15 +79,16 @@ module IOStreams
     # with their options that will be applied when the reader or writer is invoked.
     def pipeline
       return streams.dup.freeze if streams
-      return {}.freeze unless file_name
 
-      built_streams          = {}
-      # Encode stream is always first
-      built_streams[:encode] = options[:encode] if options&.key?(:encode)
+      build_pipeline.freeze
+    end
 
-      opts = options || {}
-      parse_extensions.each { |stream| built_streams[stream] = opts[stream] || {} }
-      built_streams.freeze
+    # Removes the named stream from the current pipeline.
+    # If the stream pipeline has not yet been built it will be built from the file_name if present.
+    # Note: Any options must be set _before_ calling this method.
+    def remove_from_pipeline(stream_name)
+      @streams ||= build_pipeline
+      @streams.delete(stream_name.to_sym)
     end
 
     # Returns the tabular format if set, otherwise tries to autodetect the format if the file_name has been set
@@ -106,6 +107,18 @@ module IOStreams
 
     private
 
+    def build_pipeline
+      return {} unless file_name
+
+      built_streams          = {}
+      # Encode stream is always first
+      built_streams[:encode] = options[:encode] if options&.key?(:encode)
+
+      opts = options || {}
+      parse_extensions.each { |stream| built_streams[stream] = opts[stream] || {} }
+      built_streams
+    end
+
     def class_for_stream(type, stream)
       ext = IOStreams.extensions[stream.nil? ? nil : stream.to_sym] ||
             raise(ArgumentError, "Unknown Stream type: #{stream.inspect}")

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/stream.rb

@@ -56,6 +56,14 @@ module IOStreams
       builder.pipeline
     end
 
+    # Removes the named stream from the current pipeline.
+    # If the stream pipeline has not yet been built it will be built from the file_name if present.
+    # Note: Any options must be set _before_ calling this method.
+    def remove_from_pipeline(stream_name)
+      builder.remove_from_pipeline(stream_name)
+      self
+    end
+
     # Iterate over a file / stream returning one line at a time.
     #
     # Example: Read a line at a time

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.8.0".freeze
+  VERSION = "1.10.2".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/test/builder_test.rb

@@ -237,6 +237,21 @@ class BuilderTest < Minitest::Test
       end
     end
 
+    describe "#remove_from_pipeline" do
+      let(:file_name) { "my/path/abc.bz2.pgp" }
+      it "removes a named stream from the pipeline" do
+        assert_equal({bz2: {}, pgp: {}}, streams.pipeline)
+        streams.remove_from_pipeline(:bz2)
+        assert_equal({pgp: {}}, streams.pipeline)
+      end
+      it "removes a named stream from the pipeline with options" do
+        streams.option(:pgp, passphrase: "unlock-me")
+        assert_equal({bz2: {}, pgp: {passphrase: "unlock-me"}}, streams.pipeline)
+        streams.remove_from_pipeline(:bz2)
+        assert_equal({pgp: {passphrase: "unlock-me"}}, streams.pipeline)
+      end
+    end
+
     describe "#execute" do
       it "directly calls block for an empty stream" do
         string_io = StringIO.new

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/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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iostreams
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.10.2
 platform: ruby
 authors:
 - Reid Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-22 00:00:00.000000000 Z
+date: 2021-10-25 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