rubyzip 2.3.1 → 3.0.0.alpha

data/lib/zip/input_stream.rb

@@ -1,3 +1,5 @@
+# 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,
@@ -49,24 +51,30 @@ 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 || ::Zip::NullDecrypter.new
       @current_entry = nil
+      @complete_entry = nil
     end
 
     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
 
@@ -85,12 +93,19 @@ module Zip
       @decompressor.read(length, outbuf)
     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
@@ -100,9 +115,9 @@ module Zip
         end
       end
 
-      def open_buffer(filename_or_io, offset = 0)
+      def open_buffer(filename_or_io, offset: 0)
         warn 'open_buffer is deprecated!!! Use open instead!'
-        ::Zip::InputStream.open(filename_or_io, offset)
+        ::Zip::InputStream.open(filename_or_io, offset: offset)
       end
     end
 
@@ -122,17 +137,18 @@ module Zip
 
     def open_entry
       @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'
+      return if @current_entry.nil?
+
+      if @current_entry.encrypted? && @decrypter.kind_of?(NullDecrypter)
+        raise Error,
+              'A password is required to decode this zip file'
       end
 
-      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
       flush
@@ -150,16 +166,18 @@ module Zip
       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)

data/lib/zip/ioextras/abstract_input_stream.rb

@@ -1,9 +1,11 @@
+# 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
     # depends on: input_finished?, produce_input and read
-    module AbstractInputStream
+    module AbstractInputStream # :nodoc:
       include Enumerable
       include FakeIO
 
@@ -11,15 +13,15 @@ module Zip
         super
         @lineno        = 0
         @pos           = 0
-        @output_buffer = ''
+        @output_buffer = +''
       end
 
       attr_accessor :lineno
       attr_reader :pos
 
-      def read(number_of_bytes = nil, buf = '')
+      def read(number_of_bytes = nil, buf = +'')
         tbuf = if @output_buffer.bytesize > 0
-                 if number_of_bytes <= @output_buffer.bytesize
+                 if number_of_bytes && number_of_bytes <= @output_buffer.bytesize
                    @output_buffer.slice!(0, number_of_bytes)
                  else
                    number_of_bytes -= @output_buffer.bytesize if number_of_bytes
@@ -34,7 +36,7 @@ module Zip
                end
 
         if tbuf.nil? || tbuf.empty?
-          return nil if number_of_bytes
+          return nil if number_of_bytes&.positive?
 
           return ''
         end
@@ -82,7 +84,10 @@ module Zip
           @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
+        sep_index = [
+          match_index + a_sep_string.bytesize,
+          number_of_bytes || @output_buffer.bytesize
+        ].min
         @pos += sep_index
         @output_buffer.slice!(0...sep_index)
       end
@@ -93,7 +98,7 @@ module Zip
 
       def flush
         ret_val        = @output_buffer
-        @output_buffer = ''
+        @output_buffer = +''
         ret_val
       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,7 +13,7 @@ module Zip
       end
 
       def print(*params)
-        self << params.join($OUTPUT_FIELD_SEPARATOR) << $OUTPUT_RECORD_SEPARATOR.to_s
+        self << params.join << $OUTPUT_RECORD_SEPARATOR.to_s
       end
 
       def printf(a_format_string, *params)

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, ''))
+          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,5 +1,7 @@
+# frozen_string_literal: true
+
 module Zip
-  module NullDecompressor #:nodoc:all
+  module NullDecompressor # :nodoc:all
     module_function
 
     def read(_length = nil, _outbuf = nil)

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

data/lib/zip/output_stream.rb

@@ -1,3 +1,7 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
 module Zip
   # ZipOutputStream is the basic class for writing zip files. It is
   # possible to create a ZipOutputStream object directly, passing
@@ -18,48 +22,48 @@ module Zip
   # class.
 
   class OutputStream
+    extend Forwardable
     include ::Zip::IOExtras::AbstractOutputStream
 
-    attr_accessor :comment
+    def_delegators :@cdir, :comment, :comment=
 
     # Opens the indicated zip file. If a file with that name already
     # exists it will be overwritten.
-    def initialize(file_name, stream = false, encrypter = nil)
+    def initialize(file_name, stream: false, encrypter: nil)
       super()
       @file_name = file_name
       @output_stream = if stream
-                         iostream = @file_name.dup
+                         iostream = Zip::RUNNING_ON_WINDOWS ? @file_name : @file_name.dup
                          iostream.reopen(@file_name)
                          iostream.rewind
                          iostream
                        else
                          ::File.new(@file_name, 'wb')
                        end
-      @entry_set = ::Zip::EntrySet.new
+      @cdir = ::Zip::CentralDirectory.new
       @compressor = ::Zip::NullCompressor.instance
       @encrypter = encrypter || ::Zip::NullEncrypter.new
       @closed = false
       @current_entry = nil
-      @comment = nil
     end
 
     # Same as #initialize but if a block is passed the opened
     # stream is passed to the block and closed when the block
     # returns.
     class << self
-      def open(file_name, encrypter = nil)
+      def open(file_name, encrypter: nil)
         return new(file_name) unless block_given?
 
-        zos = new(file_name, false, encrypter)
+        zos = new(file_name, stream: false, encrypter: encrypter)
         yield zos
       ensure
         zos.close if zos
       end
 
       # Same as #open but writes to a filestream instead
-      def write_buffer(io = ::StringIO.new(''), encrypter = nil)
+      def write_buffer(io = ::StringIO.new, encrypter: nil)
         io.binmode if io.respond_to?(:binmode)
-        zos = new(io, true, encrypter)
+        zos = new(io, stream: true, encrypter: encrypter)
         yield zos
         zos.close_buffer
       end
@@ -71,7 +75,7 @@ module Zip
 
       finalize_current_entry
       update_local_headers
-      write_central_directory
+      @cdir.write_to_stream(@output_stream)
       @output_stream.close
       @closed = true
     end
@@ -82,27 +86,31 @@ module Zip
 
       finalize_current_entry
       update_local_headers
-      write_central_directory
+      @cdir.write_to_stream(@output_stream)
       @closed = true
+      @output_stream.flush
       @output_stream
     end
 
     # Closes the current entry and opens a new for writing.
     # +entry+ can be a ZipEntry object or a string.
-    def put_next_entry(entry_name, comment = nil, extra = nil, compression_method = Entry::DEFLATED, level = Zip.default_compression)
+    def put_next_entry(
+      entry_name, comment = '', extra = ExtraField.new,
+      compression_method = Entry::DEFLATED, level = Zip.default_compression
+    )
       raise Error, 'zip stream is closed' if @closed
 
-      new_entry = if entry_name.kind_of?(Entry)
-                    entry_name
-                  else
-                    Entry.new(@file_name, entry_name.to_s)
-                  end
-      new_entry.comment = comment unless comment.nil?
-      unless extra.nil?
-        new_entry.extra = extra.kind_of?(ExtraField) ? extra : ExtraField.new(extra.to_s)
-      end
-      new_entry.compression_method = compression_method unless compression_method.nil?
-      init_next_entry(new_entry, level)
+      new_entry =
+        if entry_name.kind_of?(Entry) || entry_name.kind_of?(StreamableStream)
+          entry_name
+        else
+          Entry.new(
+            @file_name, entry_name.to_s, comment: comment, extra: extra,
+            compression_method: compression_method, compression_level: level
+          )
+        end
+
+      init_next_entry(new_entry)
       @current_entry = new_entry
     end
 
@@ -112,7 +120,7 @@ module Zip
       raise Error, 'entry is not a ZipEntry' unless entry.kind_of?(Entry)
 
       finalize_current_entry
-      @entry_set << entry
+      @cdir << entry
       src_pos = entry.local_header_offset
       entry.write_local_entry(@output_stream)
       @compressor = NullCompressor.instance
@@ -136,47 +144,45 @@ module Zip
                                        @current_entry.calculate_local_header_size
       @current_entry.size = @compressor.size
       @current_entry.crc = @compressor.crc
-      @output_stream << @encrypter.data_descriptor(@current_entry.crc, @current_entry.compressed_size, @current_entry.size)
+      @output_stream << @encrypter.data_descriptor(
+        @current_entry.crc,
+        @current_entry.compressed_size,
+        @current_entry.size
+      )
       @current_entry.gp_flags |= @encrypter.gp_flags
       @current_entry = nil
       @compressor = ::Zip::NullCompressor.instance
     end
 
-    def init_next_entry(entry, level = Zip.default_compression)
+    def init_next_entry(entry)
       finalize_current_entry
-      @entry_set << entry
+      @cdir << entry
       entry.write_local_entry(@output_stream)
       @encrypter.reset!
       @output_stream << @encrypter.header(entry.mtime)
-      @compressor = get_compressor(entry, level)
+      @compressor = get_compressor(entry)
     end
 
-    def get_compressor(entry, level)
+    def get_compressor(entry)
       case entry.compression_method
       when Entry::DEFLATED
-        ::Zip::Deflater.new(@output_stream, level, @encrypter)
+        ::Zip::Deflater.new(@output_stream, entry.compression_level, @encrypter)
       when Entry::STORED
         ::Zip::PassThruCompressor.new(@output_stream)
       else
-        raise ::Zip::CompressionMethodError,
-              "Invalid compression method: '#{entry.compression_method}'"
+        raise ::Zip::CompressionMethodError, entry.compression_method
       end
     end
 
     def update_local_headers
       pos = @output_stream.pos
-      @entry_set.each do |entry|
+      @cdir.each do |entry|
         @output_stream.pos = entry.local_header_offset
-        entry.write_local_entry(@output_stream, true)
+        entry.write_local_entry(@output_stream, rewrite: true)
       end
       @output_stream.pos = pos
     end
 
-    def write_central_directory
-      cdir = CentralDirectory.new(@entry_set, @comment)
-      cdir.write_to_stream(@output_stream)
-    end
-
     protected
 
     def finish

data/lib/zip/pass_thru_compressor.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Zip
-  class PassThruCompressor < Compressor #:nodoc:all
+  class PassThruCompressor < Compressor # :nodoc:all
     def initialize(output_stream)
       super()
       @output_stream = output_stream

data/lib/zip/pass_thru_decompressor.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Zip
-  class PassThruDecompressor < Decompressor #:nodoc:all
+  class PassThruDecompressor < Decompressor # :nodoc:all
     def initialize(*args)
       super
       @read_so_far = 0
     end
 
-    def read(length = nil, outbuf = '')
+    def read(length = nil, outbuf = +'')
       return (length.nil? || length.zero? ? '' : nil) if eof
 
       if length.nil? || (@read_so_far + length) > decompressed_size

data/lib/zip/streamable_directory.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Zip
-  class StreamableDirectory < Entry
+  class StreamableDirectory < Entry # :nodoc:
     def initialize(zipfile, entry, src_path = nil, permission = nil)
       super(zipfile, entry)
 

data/lib/zip/streamable_stream.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zip
   class StreamableStream < DelegateClass(Entry) # :nodoc:all
     def initialize(entry)
@@ -42,6 +44,7 @@ module Zip
     end
 
     def clean_up
+      super
       @temp_file.unlink
     end
   end

data/lib/zip/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Zip
-  VERSION = '2.3.1'
+  VERSION = '3.0.0.alpha'
 end

data/lib/zip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'English'
 require 'delegate'
 require 'singleton'
@@ -33,26 +35,12 @@ require 'zip/streamable_stream'
 require 'zip/streamable_directory'
 require 'zip/errors'
 
+# Rubyzip is a ruby module for reading and writing zip files.
+#
+# The main entry points are File, InputStream and OutputStream. For a
+# file/directory interface in the style of the standard ruby ::File and
+# ::Dir APIs then `require 'zip/filesystem'` and see FileSystem.
 module Zip
-  BANNER = [
-    'RubyZip 3.0 is coming!',
-    '**********************',
-    '',
-    'The public API of some Rubyzip classes has been modernized to use named',
-    'parameters for optional arguments. Please check your usage of the',
-    'following classes:',
-    ' * `Zip::File`',
-    ' * `Zip::Entry`',
-    ' * `Zip::InputStream`',
-    ' * `Zip::OutputStream`',
-    '',
-    'Please ensure that your Gemfiles and .gemspecs are suitably restrictive',
-    'to avoid an unexpected breakage when 3.0 is released (e.g. ~> 2.3.0).',
-    'See https://github.com/rubyzip/rubyzip for details. The Changelog also',
-    'lists other enhancements and bugfixes that have been implemented since',
-    'version 2.3.0.'
-  ].freeze
-
   extend self
   attr_accessor :unicode_names,
                 :on_exists_proc,
@@ -65,18 +53,23 @@ module Zip
                 :force_entry_names_encoding,
                 :validate_entry_sizes
 
-  def reset!
-    warn BANNER.join("\n") unless BANNER.empty?
+  DEFAULT_RESTORE_OPTIONS = {
+    restore_ownership:   false,
+    restore_permissions: true,
+    restore_times:       true
+  }.freeze
 
+  def reset!
     @_ran_once = false
     @unicode_names = false
     @on_exists_proc = false
     @continue_on_exists_proc = false
     @sort_entries = false
     @default_compression = ::Zlib::DEFAULT_COMPRESSION
-    @write_zip64_support = false
+    @write_zip64_support = true
     @warn_invalid_date = true
     @case_insensitive_match = false
+    @force_entry_names_encoding = nil
     @validate_entry_sizes = true
   end
 

data/rubyzip.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative 'lib/zip/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'rubyzip'
+  s.version       = ::Zip::VERSION
+  s.authors       = ['Robert Haines', 'John Lees-Miller', 'Alexander Simonov']
+  s.email         = [
+    'hainesr@gmail.com', 'jdleesmiller@gmail.com', 'alex@simonov.me'
+  ]
+  s.homepage      = 'http://github.com/rubyzip/rubyzip'
+  s.platform      = Gem::Platform::RUBY
+  s.summary       = 'rubyzip is a ruby module for reading and writing zip files'
+  s.files         = Dir.glob('{samples,lib}/**/*.rb') +
+                    %w[README.md Changelog.md Rakefile rubyzip.gemspec]
+  s.require_paths = ['lib']
+  s.license       = 'BSD-2-Clause'
+
+  s.metadata      = {
+    'bug_tracker_uri'   => 'https://github.com/rubyzip/rubyzip/issues',
+    'changelog_uri'     => "https://github.com/rubyzip/rubyzip/blob/v#{s.version}/Changelog.md",
+    'documentation_uri' => "https://www.rubydoc.info/gems/rubyzip/#{s.version}",
+    'source_code_uri'   => "https://github.com/rubyzip/rubyzip/tree/v#{s.version}",
+    'wiki_uri'          => 'https://github.com/rubyzip/rubyzip/wiki'
+  }
+
+  s.required_ruby_version = '>= 2.5'
+
+  s.add_development_dependency 'minitest', '~> 5.4'
+  s.add_development_dependency 'rake', '~> 12.3.3'
+  s.add_development_dependency 'rdoc', '~> 6.4.0'
+  s.add_development_dependency 'rubocop', '~> 1.12.0'
+  s.add_development_dependency 'rubocop-performance', '~> 1.10.0'
+  s.add_development_dependency 'rubocop-rake', '~> 0.5.0'
+  s.add_development_dependency 'simplecov', '~> 0.18.0'
+  s.add_development_dependency 'simplecov-lcov', '~> 0.8'
+end

data/samples/example.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 $LOAD_PATH << '../lib'
 system('zip example.zip example.rb gtk_ruby_zip.rb')
@@ -20,7 +21,8 @@ end
 
 zf = Zip::File.new('example.zip')
 zf.each_with_index do |entry, index|
-  puts "entry #{index} is #{entry.name}, size = #{entry.size}, compressed size = #{entry.compressed_size}"
+  puts "entry #{index} is #{entry.name}, size = #{entry.size}, " \
+       "compressed size = #{entry.compressed_size}"
   # use zf.get_input_stream(entry) to get a ZipInputStream for the entry
   # entry can be the ZipEntry object or any object which has a to_s method that
   # returns the name of the entry.
@@ -70,8 +72,11 @@ part_zips_count = Zip::File.split('large_zip_file.zip', 2_097_152, false)
 puts "Zip file splitted in #{part_zips_count} parts"
 
 # Track splitting an archive
-Zip::File.split('large_zip_file.zip', 1_048_576, true, 'part_zip_file') do |part_count, part_index, chunk_bytes, segment_bytes|
-  puts "#{part_index} of #{part_count} part splitting: #{(chunk_bytes.to_f / segment_bytes * 100).to_i}%"
+Zip::File.split(
+  'large_zip_file.zip', 1_048_576, true, 'part_zip_file'
+) do |part_count, part_index, chunk_bytes, segment_bytes|
+  puts "#{part_index} of #{part_count} part splitting: " \
+       "#{(chunk_bytes.to_f / segment_bytes * 100).to_i}%"
 end
 
 # For other examples, look at zip.rb and ziptest.rb

data/samples/example_filesystem.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 $LOAD_PATH << '../lib'
 
@@ -8,7 +9,7 @@ EXAMPLE_ZIP = 'filesystem.zip'
 
 File.delete(EXAMPLE_ZIP) if File.exist?(EXAMPLE_ZIP)
 
-Zip::File.open(EXAMPLE_ZIP, Zip::File::CREATE) do |zf|
+Zip::File.open(EXAMPLE_ZIP, create: true) do |zf|
   zf.file.open('file1.txt', 'w') { |os| os.write 'first file1.txt' }
   zf.dir.mkdir('dir1')
   zf.dir.chdir('dir1')