iostreams 0.20.1 → 0.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2c3b941a898cf14f2e8d5ac430f55efc602126f0d2e339014cb3de97d7c9233
-  data.tar.gz: e5745a12f24746ecf624627ac45e900251b0c3b83b109d7f18c04ffaf4efeba5
+  metadata.gz: f09dde2bcb517dd7c24e6bdf7bdfcfe313b2c5a17f3c8b1ac6caf850d1057364
+  data.tar.gz: 8886732d0a04007205ac6b0f76aede0efc4617dc5fae51f06d9d9a4f5420fdb9
 SHA512:
-  metadata.gz: ae879c20c587da2b9a2c5ae36a0488346b49f11470bd812640d6ccda161434221b98cdb65c5d7cc2988492621822a4e301665033e94207f90b323299b2e0fc24
-  data.tar.gz: a325782b46feeaf314a94f758be89d02b006fabfe824c91b2ac17309841980cab4cb9129318040426d9d6582bff6dd7345bc40f9234b0cd2e89c0d5555948335
+  metadata.gz: 894766215e6e1e6d942e3afbc5a1c797dbf5abf7a885a0a63e9fb29985e77f9ff84449d53f147484b0edb041e6bd89094b2824e3144ba0020cbadb8dc9fb9943
+  data.tar.gz: 69806e7e4ff2cd9184c63a906ca25d44a69003c52e477fe96fa563bc99590f117b0701e0231cf8543e617cb31f63c0ed615a2d54ff8d757e00eb1e420d637d1d

data/lib/io_streams/version.rb

@@ -1,3 +1,3 @@
 module IOStreams
-  VERSION = '0.20.1'
+  VERSION = '0.20.2'
 end

data/lib/io_streams/zip/reader.rb

@@ -3,7 +3,12 @@ module IOStreams
     class Reader
       # Read from a zip file or stream, decompressing the contents as it is read
       # The input stream from the first file found in the zip file is passed
-      # to the supplied block
+      # to the supplied block.
+      #
+      # Parameters:
+      #   entry_file_name: [String]
+      #     Name of the file within the Zip file to read.
+      #     Default: Read the first file found in the zip file.
       #
       # Example:
       #   IOStreams::Zip::Reader.open('abc.zip') do |io_stream|
@@ -12,58 +17,65 @@ module IOStreams
       #       puts data
       #     end
       #   end
-      def self.open(file_name_or_io, _ = nil, &block)
-        if !defined?(JRuby) && !defined?(::Zip)
-          # MRI needs Ruby Zip, since it only has native support for GZip
-          begin
-            require 'zip'
-          rescue LoadError => exc
-            raise(LoadError, "Install gem 'rubyzip' to read and write Zip files: #{exc.message}")
-          end
-        end
-
+      def self.open(file_name_or_io, entry_file_name: nil, &block)
         # File name supplied
-        return read_file(file_name_or_io, &block) unless IOStreams.reader_stream?(file_name_or_io)
+        return read_file(file_name_or_io, entry_file_name, &block) unless IOStreams.reader_stream?(file_name_or_io)
 
-        # ZIP can only work against a file, not a stream, so create temp file.
+        # Ruby ZIP gem uses `#seek` so can only work against a file, not a stream, so create temp file.
+        # JRuby ZIP requires an InputStream.
         IOStreams::File::Path.temp_file_name('iostreams_zip') do |temp_file_name|
           IOStreams.copy(file_name_or_io, temp_file_name, target_options: {streams: []})
-          read_file(temp_file_name, &block)
+          read_file(temp_file_name, entry_file_name, &block)
         end
       end
 
       if defined?(JRuby)
         # Java has built-in support for Zip files
-        def self.read_file(file_name, &block)
+        def self.read_file(file_name, entry_file_name)
           fin = Java::JavaIo::FileInputStream.new(file_name)
           zin = Java::JavaUtilZip::ZipInputStream.new(fin)
-          zin.get_next_entry
-          block.call(zin.to_io)
+
+          get_entry(zin, entry_file_name) ||
+            raise(Java::JavaUtilZip::ZipException.new("File #{entry_file_name} not found within zip file."))
+
+          yield(zin.to_io)
         ensure
           zin.close if zin
           fin.close if fin
         end
 
       else
-
         # Read from a zip file or stream, decompressing the contents as it is read
         # The input stream from the first file found in the zip file is passed
         # to the supplied block
-        def self.read_file(file_name, &block)
-          begin
-            zin = ::Zip::InputStream.new(file_name)
-            zin.get_next_entry
-            block.call(zin)
-          ensure
+        def self.read_file(file_name, entry_file_name)
+          if !defined?(::Zip)
+            # MRI needs Ruby Zip, since it only has native support for GZip
             begin
-              zin.close if zin
-            rescue IOError
-              # Ignore file already closed errors since Zip::InputStream
-              # does not have a #closed? method
+              require 'zip'
+            rescue LoadError => exc
+              raise(LoadError, "Install gem 'rubyzip' to read and write Zip files: #{exc.message}")
             end
           end
+
+          ::Zip::InputStream.open(file_name) do |zin|
+            get_entry(zin, entry_file_name) ||
+              raise(::Zip::EntryNameError, "File #{entry_file_name} not found within zip file.")
+            yield(zin)
+          end
         end
+      end
 
+      def self.get_entry(zin, entry_file_name)
+        if entry_file_name.nil?
+          zin.get_next_entry
+          return true
+        end
+
+        while entry = zin.get_next_entry
+          return true if entry.name == entry_file_name
+        end
+        false
       end
     end
   end

data/test/io_streams_test.rb

@@ -30,6 +30,22 @@ class IOStreamsTest < Minitest::Test
       bad_data.gsub("\xE9".b, '').gsub("\x07", '')
     end
 
+    let :multiple_zip_file_name do
+      File.join(File.dirname(__FILE__), 'files', 'multiple_files.zip')
+    end
+
+    let :zip_gz_file_name do
+      File.join(File.dirname(__FILE__), 'files', 'text.zip.gz')
+    end
+
+    let :contents_test_txt do
+      File.read(File.join(File.dirname(__FILE__), 'files', 'text.txt'))
+    end
+
+    let :contents_test_json do
+      File.read(File.join(File.dirname(__FILE__), 'files', 'test.json'))
+    end
+
     after do
       temp_file.delete
     end
@@ -124,5 +140,20 @@ class IOStreamsTest < Minitest::Test
       end
     end
 
+    describe '.reader' do
+      it 'reads a zip file' do
+        result = IOStreams.reader(multiple_zip_file_name, streams: {zip: {entry_file_name: 'test.json'}}) do |io|
+          io.read
+        end
+        assert_equal contents_test_json, result
+      end
+
+      it 'reads a zip file from within a gz file' do
+        result = IOStreams.reader(zip_gz_file_name) do |io|
+          io.read
+        end
+        assert_equal contents_test_txt, result
+      end
+    end
   end
 end

data/test/minimal_file_reader.rb

@@ -0,0 +1,25 @@
+# The miminum methods that any IOStreams Reader must implement.
+class MinimalFileReader
+  def self.open(file_name)
+    io = new(file_name)
+    yield(io)
+  ensure
+    io.close if io
+  end
+
+  def initialize(file_name)
+    @file = File.open(file_name)
+  end
+
+  def read(size = nil, outbuf = nil)
+    @file.read(size, outbuf)
+  end
+
+  def close
+    @file.close
+  end
+
+  def closed?
+    @file.closed
+  end
+end

data/test/zip_reader_test.rb

@@ -1,4 +1,5 @@
 require_relative 'test_helper'
+require_relative 'minimal_file_reader'
 require 'zip'
 
 class ZipReaderTest < Minitest::Test
@@ -7,20 +8,46 @@ class ZipReaderTest < Minitest::Test
       File.join(File.dirname(__FILE__), 'files', 'text.zip')
     end
 
+    let :multiple_zip_file_name do
+      File.join(File.dirname(__FILE__), 'files', 'multiple_files.zip')
+    end
+
+    let :contents_test_txt do
+      File.read(File.join(File.dirname(__FILE__), 'files', 'text.txt'))
+    end
+
+    let :contents_test_json do
+      File.read(File.join(File.dirname(__FILE__), 'files', 'test.json'))
+    end
+
     let :decompressed do
       Zip::File.open(file_name) { |zip_file| zip_file.first.get_input_stream.read }
     end
 
     describe '.open' do
-      it 'file' do
+      it 'reads the first file' do
         result = IOStreams::Zip::Reader.open(file_name) do |io|
           io.read
         end
         assert_equal decompressed, result
       end
 
-      it 'stream' do
-        result = File.open(file_name) do |file|
+      it 'reads entry within zip file' do
+        result = IOStreams::Zip::Reader.open(multiple_zip_file_name, entry_file_name: 'text.txt') do |io|
+          io.read
+        end
+        assert_equal contents_test_txt, result
+      end
+
+      it 'reads another entry within zip file' do
+        result = IOStreams::Zip::Reader.open(multiple_zip_file_name, entry_file_name: 'test.json') do |io|
+          io.read
+        end
+        assert_equal contents_test_json, result
+      end
+
+      it 'reads from a stream' do
+        result = MinimalFileReader.open(file_name) do |file|
           IOStreams::Zip::Reader.open(file) do |io|
             io.read
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iostreams
 version: !ruby/object:Gem::Version
-  version: 0.20.1
+  version: 0.20.2
 platform: ruby
 authors:
 - Reid Morrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-24 00:00:00.000000000 Z
+date: 2019-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -89,6 +89,7 @@ files:
 - test/file_reader_test.rb
 - test/file_writer_test.rb
 - test/files/embedded_lines_test.csv
+- test/files/multiple_files.zip
 - test/files/spreadsheet.xlsx
 - test/files/test.csv
 - test/files/test.json
@@ -97,6 +98,7 @@ files:
 - test/files/text.txt.gz
 - test/files/text.txt.gz.zip
 - test/files/text.zip
+- test/files/text.zip.gz
 - test/files/unclosed_quote_test.csv
 - test/gzip_reader_test.rb
 - test/gzip_writer_test.rb
@@ -104,6 +106,7 @@ files:
 - test/io_streams_test.rb
 - test/line_reader_test.rb
 - test/line_writer_test.rb
+- test/minimal_file_reader.rb
 - test/path_test.rb
 - test/pgp_reader_test.rb
 - test/pgp_test.rb
@@ -147,6 +150,7 @@ test_files:
 - test/base_path_test.rb
 - test/line_reader_test.rb
 - test/xlsx_reader_test.rb
+- test/minimal_file_reader.rb
 - test/row_writer_test.rb
 - test/zip_reader_test.rb
 - test/bzip2_writer_test.rb
@@ -166,11 +170,13 @@ test_files:
 - test/files/embedded_lines_test.csv
 - test/files/test.csv
 - test/files/test.json
+- test/files/text.zip.gz
 - test/files/unclosed_quote_test.csv
 - test/files/text.txt.bz2
 - test/files/text.txt.gz.zip
 - test/files/text.txt.gz
 - test/files/text.txt
+- test/files/multiple_files.zip
 - test/gzip_reader_test.rb
 - test/encode_reader_test.rb
 - test/test_helper.rb