rubyzip 2.3.2 → 3.3.0

data/lib/zip/input_stream.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+##
 module Zip
   # InputStream is the basic class for reading zip entries in a
   # zip file. It is possible to create a InputStream object directly,
@@ -37,9 +40,8 @@ module Zip
   #
   # java.util.zip.ZipInputStream is the original inspiration for this
   # class.
-
   class InputStream
-    CHUNK_SIZE = 32_768
+    CHUNK_SIZE = 32_768 # :nodoc:
 
     include ::Zip::IOExtras::AbstractInputStream
 
@@ -49,28 +51,35 @@ module Zip
     #
     # @param context [String||IO||StringIO] file path or IO/StringIO object
     # @param offset [Integer] offset in the IO/StringIO
-    def initialize(context, offset = 0, decrypter = nil)
+    def initialize(context, offset: 0, decrypter: nil)
       super()
-      @archive_io    = get_io(context, offset)
-      @decompressor  = ::Zip::NullDecompressor
-      @decrypter     = decrypter || ::Zip::NullDecrypter.new
+      @archive_io = get_io(context, offset)
+      @decompressor = ::Zip::NullDecompressor
+      @decrypter = decrypter
       @current_entry = nil
+      @complete_entry = nil
     end
 
+    # Close this InputStream. All further IO will raise an IOError.
     def close
       @archive_io.close
     end
 
-    # Returns a Entry object. It is necessary to call this
-    # method on a newly created InputStream before reading from
-    # the first entry in the archive. Returns nil when there are
-    # no more entries.
+    # Returns an Entry object and positions the stream at the beginning of
+    # the entry data. It is necessary to call this method on a newly created
+    # InputStream before reading from the first entry in the archive.
+    # Returns nil when there are no more entries.
     def get_next_entry
-      @archive_io.seek(@current_entry.next_header_offset, IO::SEEK_SET) if @current_entry
+      unless @current_entry.nil?
+        raise StreamingError, @current_entry if @current_entry.incomplete?
+
+        @archive_io.seek(@current_entry.next_header_offset, IO::SEEK_SET)
+      end
+
       open_entry
     end
 
-    # Rewinds the stream to the beginning of the current entry
+    # Rewinds the stream to the beginning of the current entry.
     def rewind
       return if @current_entry.nil?
 
@@ -80,17 +89,43 @@ module Zip
       open_entry
     end
 
-    # Modeled after IO.sysread
-    def sysread(length = nil, outbuf = '')
-      @decompressor.read(length, outbuf)
+    # Modelled after IO#sysread.
+    #
+    # Reads up to maxlen bytes from the stream; returns a string
+    # (either a new string or the given out_string).
+    # Its encoding is the unchanged encoding of out_string, if out_string is
+    # given; ASCII-8BIT, otherwise. Output contains maxlen bytes from the
+    # stream, if available; otherwise contains all available bytes, if any
+    # available; otherwise is an empty string.
+    #
+    # This method should not be used with buffered input stream-reader methods,
+    # such as #read, #readline, #gets.
+    def sysread(maxlen, out_string = nil)
+      return (maxlen.nil? || maxlen.zero? ? '' : nil) if eof?
+
+      output = produce_input(maxlen)
+
+      if out_string.nil?
+        output.force_encoding(Encoding::ASCII_8BIT)
+      else
+        encoding = out_string.encoding
+        out_string.replace(output).force_encoding(encoding)
+      end
+    end
+
+    # Returns the size of the current entry, or `nil` if there isn't one.
+    def size
+      return if @current_entry.nil?
+
+      @current_entry.size
     end
 
     class << self
       # Same as #initialize but if a block is passed the opened
       # stream is passed to the block and closed when the block
       # returns.
-      def open(filename_or_io, offset = 0, decrypter = nil)
-        zio = new(filename_or_io, offset, decrypter)
+      def open(filename_or_io, offset: 0, decrypter: nil)
+        zio = new(filename_or_io, offset: offset, decrypter: decrypter)
         return zio unless block_given?
 
         begin
@@ -99,16 +134,11 @@ module Zip
           zio.close if zio
         end
       end
-
-      def open_buffer(filename_or_io, offset = 0)
-        warn 'open_buffer is deprecated!!! Use open instead!'
-        ::Zip::InputStream.open(filename_or_io, offset)
-      end
     end
 
     protected
 
-    def get_io(io_or_file, offset = 0)
+    def get_io(io_or_file, offset = 0) # :nodoc:
       if io_or_file.respond_to?(:seek)
         io = io_or_file.dup
         io.seek(offset, ::IO::SEEK_SET)
@@ -120,57 +150,78 @@ module Zip
       end
     end
 
-    def open_entry
+    def open_entry # :nodoc:
       @current_entry = ::Zip::Entry.read_local_entry(@archive_io)
-      if @current_entry && @current_entry.encrypted? && @decrypter.kind_of?(NullEncrypter)
-        raise Error, 'password required to decode zip file'
-      end
+      return if @current_entry.nil?
 
-      if @current_entry && @current_entry.incomplete? && @current_entry.crc == 0 \
-        && @current_entry.compressed_size == 0 \
-        && @current_entry.size == 0 && !@complete_entry
-        raise GPFBit3Error,
-              'General purpose flag Bit 3 is set so not possible to get proper info from local header.' \
-              'Please use ::Zip::File instead of ::Zip::InputStream'
+      if @current_entry.incomplete? && @current_entry.compressed_size == 0 && !@complete_entry
+        raise StreamingError, @current_entry
       end
-      @decrypted_io = get_decrypted_io
-      @decompressor = get_decompressor
+
+      @decompressor = assemble_io
       flush
       @current_entry
     end
 
-    def get_decrypted_io
+    def assemble_io # :nodoc:
+      io = if @current_entry.encrypted?
+             raise Error, 'A password is required to decode this zip file.' if @decrypter.nil?
+
+             get_decrypted_io
+           else
+             @archive_io
+           end
+
+      get_decompressor(io)
+    end
+
+    def get_decrypted_io # :nodoc:
       header = @archive_io.read(@decrypter.header_bytesize)
       @decrypter.reset!(header)
 
-      ::Zip::DecryptedIo.new(@archive_io, @decrypter)
+      compressed_size =
+        if @current_entry.incomplete? && @current_entry.crc == 0 &&
+           @current_entry.compressed_size == 0 && @complete_entry
+          @complete_entry.compressed_size
+        else
+          @current_entry.compressed_size
+        end
+
+      if @decrypter.kind_of?(::Zip::AESDecrypter)
+        compressed_size -= @decrypter.header_bytesize
+        compressed_size -= ::Zip::AESEncryption::AUTHENTICATION_CODE_LENGTH
+      end
+
+      ::Zip::DecryptedIo.new(@archive_io, @decrypter, compressed_size)
     end
 
-    def get_decompressor
+    def get_decompressor(io) # :nodoc:
       return ::Zip::NullDecompressor if @current_entry.nil?
 
       decompressed_size =
-        if @current_entry.incomplete? && @current_entry.crc == 0 && @current_entry.size == 0 && @complete_entry
+        if @current_entry.incomplete? && @current_entry.crc == 0 &&
+           @current_entry.size == 0 && @complete_entry
           @complete_entry.size
         else
           @current_entry.size
         end
 
-      decompressor_class = ::Zip::Decompressor.find_by_compression_method(@current_entry.compression_method)
+      decompressor_class = ::Zip::Decompressor.find_by_compression_method(
+        @current_entry.compression_method
+      )
       if decompressor_class.nil?
-        raise ::Zip::CompressionMethodError,
-              "Unsupported compression method #{@current_entry.compression_method}"
+        raise ::Zip::CompressionMethodError, @current_entry.compression_method
       end
 
-      decompressor_class.new(@decrypted_io, decompressed_size)
+      decompressor_class.new(io, decompressed_size)
     end
 
-    def produce_input
-      @decompressor.read(CHUNK_SIZE)
+    def produce_input(maxlen = CHUNK_SIZE) # :nodoc:
+      @decompressor.read(maxlen)
     end
 
-    def input_finished?
-      @decompressor.eof
+    def input_finished? # :nodoc:
+      @decompressor.eof?
     end
   end
 end

data/lib/zip/ioextras/abstract_input_stream.rb

@@ -1,122 +1,210 @@
+# frozen_string_literal: true
+
 module Zip
-  module IOExtras
+  module IOExtras # :nodoc:
     # Implements many of the convenience methods of IO
-    # such as gets, getc, readline and readlines
+    # such as gets, getc, read, readline and readlines
     # depends on: input_finished?, produce_input and read
     module AbstractInputStream
       include Enumerable
       include FakeIO
 
-      def initialize
+      def initialize # :nodoc:
         super
         @lineno        = 0
         @pos           = 0
-        @output_buffer = ''
+        @output_buffer = +''.b
       end
 
+      # Returns (or sets) the current line number in the decompressed
+      # (possibly decrypted) data stream. See the Line Number documentation
+      # for the IO class for more information.
       attr_accessor :lineno
+
+      # Returns the current position (in bytes) in the decompressed (possibly
+      # decrypted) data stream.
       attr_reader :pos
 
-      def read(number_of_bytes = nil, buf = '')
+      # Reads bytes from the stream decompressed (possibly decrypted) data
+      # stream. If `maxlen` is `nil`, reads all bytes; otherwise, reads up to
+      # `maxlen` bytes. If `maxlen` is zero, returns an empty string.
+      #
+      # Returns a string (either a new string or the given `out_string`)
+      # containing the bytes read. The string's encoding is the unchanged
+      # encoding of `out_string`, if `out_string` is given; `ASCII-8BIT`,
+      # otherwise.
+      def read(maxlen = nil, out_string = nil) # rubocop:disable Metrics/PerceivedComplexity
+        return (maxlen.nil? || maxlen.zero? ? '' : nil) if eof?
+
         tbuf = if @output_buffer.bytesize > 0
-                 if number_of_bytes <= @output_buffer.bytesize
-                   @output_buffer.slice!(0, number_of_bytes)
+                 if maxlen && maxlen <= @output_buffer.bytesize
+                   @output_buffer.slice!(0, maxlen)
                  else
-                   number_of_bytes -= @output_buffer.bytesize if number_of_bytes
-                   rbuf = sysread(number_of_bytes, buf)
+                   maxlen -= @output_buffer.bytesize if maxlen
+                   rbuf = produce_input(maxlen)
                    out  = @output_buffer
                    out << rbuf if rbuf
-                   @output_buffer = ''
+                   @output_buffer = +''.b
                    out
                  end
                else
-                 sysread(number_of_bytes, buf)
+                 produce_input(maxlen)
                end
 
         if tbuf.nil? || tbuf.empty?
-          return nil if number_of_bytes
+          return nil if maxlen&.positive?
 
           return ''
         end
 
         @pos += tbuf.length
 
-        if buf
-          buf.replace(tbuf)
+        if out_string.nil?
+          tbuf.force_encoding(Encoding::ASCII_8BIT)
         else
-          buf = tbuf
+          encoding = out_string.encoding
+          out_string.replace(tbuf).force_encoding(encoding)
         end
-        buf
       end
 
-      def readlines(a_sep_string = $INPUT_RECORD_SEPARATOR)
-        ret_val = []
-        each_line(a_sep_string) { |line| ret_val << line }
-        ret_val
+      # Reads and returns all remaining lines from the stream. See the Line IO
+      # documentation in the IO class for more information.
+      #
+      # With no arguments given, returns lines as determined by line
+      # separator `$/`, or `nil` if none.
+      #
+      # With only string argument `sep` given, returns lines as
+      # determined by line separator `sep`, or `nil` if none. See the
+      # Line Separator documentation in the IO class for more information.
+      # The two special values for `sep` (`nil` and `""`) are honoured.
+      #
+      # With only integer argument `limit` given, limits the number of bytes
+      # in each line; see the Line Limit documentation in the IO class for more
+      # information.
+      #
+      # With arguments `sep` and `limit` given, combines the two behaviors.
+      #
+      # Optional keyword argument `chomp` specifies whether line separators
+      # are to be omitted.
+      def readlines(sep = $INPUT_RECORD_SEPARATOR, limit = nil, chomp: false)
+        each(sep, limit, chomp: chomp).to_a
       end
 
-      def gets(a_sep_string = $INPUT_RECORD_SEPARATOR, number_of_bytes = nil)
-        @lineno = @lineno.next
+      # Reads and returns a line from the stream. See the Line IO
+      # documentation in the IO class for more information.
+      #
+      # With no arguments given, returns the next line as determined by line
+      # separator `$/`, or `nil` if none.
+      #
+      # With only string argument `sep` given, returns the next line as
+      # determined by line separator `sep`, or `nil` if none. See the
+      # Line Separator documentation in the IO class for more information.
+      # The two special values for `sep` (`nil` and `""`) are honoured.
+      #
+      # With only integer argument `limit` given, limits the number of bytes
+      # in the line; see the Line Limit documentation in the IO class for more
+      # information.
+      #
+      # With arguments `sep` and `limit` given, combines the two behaviors.
+      #
+      # Optional keyword argument `chomp` specifies whether line separators
+      # are to be omitted.
+      def gets(sep = $INPUT_RECORD_SEPARATOR, limit = nil, chomp: false)
+        if sep.nil?
+          return nil if eof?
+
+          @lineno = @lineno.next
+          return read(limit)
+        end
 
-        if number_of_bytes.respond_to?(:to_int)
-          number_of_bytes = number_of_bytes.to_int
-          a_sep_string = a_sep_string.to_str if a_sep_string
-        elsif a_sep_string.respond_to?(:to_int)
-          number_of_bytes = a_sep_string.to_int
-          a_sep_string    = $INPUT_RECORD_SEPARATOR
-        else
-          number_of_bytes = nil
-          a_sep_string = a_sep_string.to_str if a_sep_string
+        if sep.respond_to?(:to_int)
+          limit = sep.to_int
+          sep   = $INPUT_RECORD_SEPARATOR
+        elsif sep&.empty?
+          sep = "#{$INPUT_RECORD_SEPARATOR}#{$INPUT_RECORD_SEPARATOR}"
         end
 
-        return read(number_of_bytes) if a_sep_string.nil?
+        buffer_index = 0
+        while (sep_index = @output_buffer.index(sep, buffer_index)).nil?
+          break if limit && @output_buffer.bytesize >= limit
 
-        a_sep_string = "#{$INPUT_RECORD_SEPARATOR}#{$INPUT_RECORD_SEPARATOR}" if a_sep_string.empty?
+          if input_finished?
+            return nil if @output_buffer.empty?
 
-        buffer_index = 0
-        over_limit   = (number_of_bytes && @output_buffer.bytesize >= number_of_bytes)
-        while (match_index = @output_buffer.index(a_sep_string, buffer_index)).nil? && !over_limit
-          buffer_index = [buffer_index, @output_buffer.bytesize - a_sep_string.bytesize].max
-          return @output_buffer.empty? ? nil : flush if input_finished?
+            @lineno = @lineno.next
+            @pos += @output_buffer.bytesize
+            return @output_buffer.slice!(0..)
+          end
 
+          buffer_index = [buffer_index, @output_buffer.bytesize - sep.bytesize].max
           @output_buffer << produce_input
-          over_limit = (number_of_bytes && @output_buffer.bytesize >= number_of_bytes)
         end
-        sep_index = [match_index + a_sep_string.bytesize, number_of_bytes || @output_buffer.bytesize].min
-        @pos += sep_index
-        @output_buffer.slice!(0...sep_index)
+
+        limit ||= @output_buffer.bytesize
+        cut_index = sep_index ? [sep_index + sep.bytesize, limit].min : limit
+        @lineno = @lineno.next
+        @pos += cut_index
+        chomp ? @output_buffer.slice!(0, cut_index).chomp(sep) : @output_buffer.slice!(0, cut_index)
       end
 
-      def ungetc(byte)
+      def ungetc(byte) # :nodoc:
         @output_buffer = byte.chr + @output_buffer
       end
 
-      def flush
-        ret_val        = @output_buffer
-        @output_buffer = ''
-        ret_val
+      def flush # :nodoc:
+        @output_buffer.slice!(0..)
       end
 
-      def readline(a_sep_string = $INPUT_RECORD_SEPARATOR)
-        ret_val = gets(a_sep_string)
-        raise EOFError unless ret_val
+      # Reads a line as with #gets, but raises `EOFError` if already at
+      # end-of-stream.
+      #
+      # Optional keyword argument `chomp` specifies whether line separators
+      # are to be omitted.
+      def readline(sep = $INPUT_RECORD_SEPARATOR, limit = nil, chomp: false)
+        raise EOFError if eof?
 
-        ret_val
+        gets(sep, limit, chomp: chomp)
       end
 
-      def each_line(a_sep_string = $INPUT_RECORD_SEPARATOR)
-        loop { yield readline(a_sep_string) }
-      rescue EOFError
-        # We just need to catch this; we don't need to handle it.
+      # Calls the block with each remaining line read from the stream.
+      # Does nothing if already at end-of-stream. See the Line IO
+      # documentation in the IO class for more information.
+      #
+      # With no arguments given, reads lines as determined by line separator
+      # `$/`. With only string argument `sep` given, reads lines as determined
+      # by line separator `sep`. See the Line Separator documentation in the
+      # IO class for more information. The two special values for `sep`
+      # (`nil` and `""`) are honoured.
+      #
+      # With only integer argument `limit` given, limits the number of bytes
+      # in each line; see the Line Limit documentation in the IO class for
+      # more information.
+      #
+      # With arguments `sep` and `limit` given, combines the two behaviors.
+      #
+      # Optional keyword argument `chomp` specifies whether line separators
+      # are to be omitted.
+      #
+      # Returns an `Enumerator` if no block is given.
+      def each(sep = $INPUT_RECORD_SEPARATOR, limit = nil, chomp: false)
+        return to_enum(:each, sep, limit, chomp: chomp) unless block_given?
+
+        while (line = gets(sep, limit, chomp: chomp))
+          yield line
+        end
       end
 
-      alias each each_line
+      alias each_line each
 
-      def eof
+      # Returns `true` if the stream is positioned at its end, `false`
+      # otherwise. See Position documentation in the IO class for more
+      # information.
+      def eof?
         @output_buffer.empty? && input_finished?
       end
 
-      alias eof? eof
+      # Alias for compatibility. Remove for version 4.
+      alias eof eof? # :nodoc:
     end
   end
 end

data/lib/zip/ioextras/abstract_output_stream.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Zip
-  module IOExtras
+  module IOExtras # :nodoc:
     # Implements many of the output convenience methods of IO.
     # relies on <<
-    module AbstractOutputStream
+    module AbstractOutputStream # :nodoc:
       include FakeIO
 
       def write(data)
@@ -11,11 +13,19 @@ module Zip
       end
 
       def print(*params)
-        self << params.join($OUTPUT_FIELD_SEPARATOR) << $OUTPUT_RECORD_SEPARATOR.to_s
+        self << params.join
+
+        # Deflate doesn't like `nil`s or empty strings!
+        unless $OUTPUT_RECORD_SEPARATOR.nil? || $OUTPUT_RECORD_SEPARATOR.empty?
+          self << $OUTPUT_RECORD_SEPARATOR
+        end
+
+        nil
       end
 
       def printf(a_format_string, *params)
         self << format(a_format_string, *params)
+        nil
       end
 
       def putc(an_object)

data/lib/zip/ioextras.rb

@@ -1,26 +1,26 @@
+# frozen_string_literal: true
+
 module Zip
-  module IOExtras #:nodoc:
+  module IOExtras # :nodoc:
     CHUNK_SIZE = 131_072
 
-    RANGE_ALL = 0..-1
-
     class << self
       def copy_stream(ostream, istream)
-        ostream.write(istream.read(CHUNK_SIZE, '')) until istream.eof?
+        ostream.write(istream.read(CHUNK_SIZE, +'')) until istream.eof?
       end
 
       def copy_stream_n(ostream, istream, nbytes)
         toread = nbytes
         while toread > 0 && !istream.eof?
-          tr = toread > CHUNK_SIZE ? CHUNK_SIZE : toread
-          ostream.write(istream.read(tr, ''))
+          tr = [toread, CHUNK_SIZE].min
+          ostream.write(istream.read(tr, +''))
           toread -= tr
         end
       end
     end
 
     # Implements kind_of? in order to pretend to be an IO object
-    module FakeIO
+    module FakeIO # :nodoc:
       def kind_of?(object)
         object == IO || super
       end

data/lib/zip/null_compressor.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Zip
-  class NullCompressor < Compressor #:nodoc:all
+  class NullCompressor < Compressor # :nodoc:all
     include Singleton
 
     def <<(_data)

data/lib/zip/null_decompressor.rb

@@ -1,16 +1,19 @@
+# frozen_string_literal: true
+
 module Zip
-  module NullDecompressor #:nodoc:all
+  module NullDecompressor # :nodoc:all
     module_function
 
     def read(_length = nil, _outbuf = nil)
       nil
     end
 
-    def eof
+    def eof?
       true
     end
 
-    alias eof? eof
+    # Alias for compatibility. Remove for version 4.
+    alias eof eof?
   end
 end
 

data/lib/zip/null_input_stream.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Zip
-  module NullInputStream #:nodoc:all
+  module NullInputStream # :nodoc:all
     include ::Zip::NullDecompressor
     include ::Zip::IOExtras::AbstractInputStream
   end