iostreams 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 410a7bdcec2ee16f130bbb7010bfd2258975253c1bd380c1832f034ae18b2979
-  data.tar.gz: 6f8e7bd896166b10a77477a95a0eae88b742a117525d48c10fd23952fa37faa7
+  metadata.gz: 06e71b70e09ed1f57a4d776795d48fc973d32888a078c9e42319fc3eaee56db0
+  data.tar.gz: 7d956af5453840aee0a8c8cca5e7e4e44c465e1dcb13030daa37f2abc8f5cc78
 SHA512:
-  metadata.gz: 85a53eae7c90affdfcd577836d83533d75eff5eb8e880352c6890d4805c219b91e99fc1d936cc72829dbe93d6b8ea55585cc0a2b3a1c8886ab2b261e7c078cb7
-  data.tar.gz: 5bd17a2bae394ca10a84f659fe1e0aac8315ab393cfe11e4606b3b0e4ca901d121c2b0aeae91cf6dac0f1939fec039fac21036a5c8382abe382f5d705bf519ad
+  metadata.gz: 9ed848fcc886ed53d36504097036605d13735887a880ed65620460f55d78fc26771a18b1ab32e1685f765cf25097fa42f7e59ba233099aeb15a93b0005936bb5
+  data.tar.gz: 6301601fa85f7f9198e0c61fabdd0a9206c4dfb2b239c0e8155a01a47973f6cb545272a870a593d67437ef25476901aed9c1101c24cacef5ab22e4f794936398

data/lib/io_streams/line/reader.rb

@@ -75,6 +75,8 @@ module IOStreams
       # Note:
       # * The line delimiter is _not_ returned.
       def each
+        return to_enum(__method__) unless block_given?
+
         line_count = 0
         until eof?
           line = readline
@@ -146,8 +148,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 +159,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
@@ -170,6 +173,9 @@ module IOStreams
           return false
         end
 
+        # When less data is returned than was requested, it means the end of the file with partial data.
+        @eof = true if block.size < @buffer_size
+
         if @buffer
           @buffer << block
         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/record/reader.rb

@@ -68,6 +68,8 @@ module IOStreams
       end
 
       def each
+        return to_enum(__method__) unless block_given?
+
         @line_reader.each do |line|
           if @tabular.header?
             @tabular.parse_header(line)

data/lib/io_streams/row/reader.rb

@@ -40,6 +40,8 @@ module IOStreams
       end
 
       def each
+        return to_enum(__method__) unless block_given?
+
         @line_reader.each do |line|
           if @tabular.header?
             columns = @tabular.parse_header(line)

data/lib/io_streams/version.rb

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

data/test/line_reader_test.rb

@@ -98,6 +98,13 @@ class LineReaderTest < Minitest::Test
         assert_equal data.size, count
       end
 
+      it "with no block returns enumerator" do
+        lines = IOStreams::Line::Reader.file(file_name) do |io|
+          io.each.first(100)
+        end
+        assert_equal data, lines
+      end
+
       it "each_line stream" do
         lines = []
         count = File.open(file_name) do |file|

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,20 @@ 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
+
+        it "reads lines without block" do
+          records = file_path.each.first(100)
+          assert_equal data.lines.collect(&:strip), records
+        end
+      end
+
       describe "#each_child" do
         it "iterates an empty path" do
           none = nil
@@ -48,6 +62,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/record_reader_test.rb

@@ -46,6 +46,13 @@ class RecordReaderTest < Minitest::Test
         end
         assert_equal expected, rows
       end
+
+      it "with no block returns enumerator" do
+        records = IOStreams::Record::Reader.file(file_name, cleanse_header: false) do |io|
+          io.each.first(100)
+        end
+        assert_equal expected, records
+      end
     end
 
     describe "#collect" 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|
@@ -20,6 +20,13 @@ class RowReaderTest < Minitest::Test
         assert_equal expected.size, count
       end
 
+      it "with no block returns enumerator" do
+        rows = IOStreams::Row::Reader.file(file_name) do |io|
+          io.each.first(100)
+        end
+        assert_equal expected, rows
+      end
+
       it "stream" do
         rows  = []
         count = IOStreams::Line::Reader.file(file_name) do |file|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iostreams
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Reid Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-17 00:00:00.000000000 Z
+date: 2021-08-23 00:00:00.000000000 Z
 dependencies: []
 description:
 email: