rubyzip 3.0.0.alpha → 3.0.0.rc1

data/lib/zip/file.rb

@@ -52,8 +52,9 @@ module Zip
     extend Forwardable
     extend FileSplit
 
-    IO_METHODS = [:tell, :seek, :read, :eof, :close].freeze
+    IO_METHODS = [:tell, :seek, :read, :eof, :close].freeze # :nodoc:
 
+    # The name of this zip archive.
     attr_reader :name
 
     # default -> false.
@@ -69,28 +70,40 @@ module Zip
 
     # Opens a zip archive. Pass create: true to create
     # a new archive if it doesn't exist already.
-    def initialize(path_or_io, create: false, buffer: false, **options)
+    def initialize(path_or_io, create: false, buffer: false,
+                   restore_ownership: DEFAULT_RESTORE_OPTIONS[:restore_ownership],
+                   restore_permissions: DEFAULT_RESTORE_OPTIONS[:restore_permissions],
+                   restore_times: DEFAULT_RESTORE_OPTIONS[:restore_times],
+                   compression_level: ::Zip.default_compression)
       super()
-      options  = DEFAULT_RESTORE_OPTIONS
-                 .merge(compression_level: ::Zip.default_compression)
-                 .merge(options)
+
       @name    = path_or_io.respond_to?(:path) ? path_or_io.path : path_or_io
       @create  = create ? true : false # allow any truthy value to mean true
 
       initialize_cdir(path_or_io, buffer: buffer)
 
-      @restore_ownership   = options[:restore_ownership]
-      @restore_permissions = options[:restore_permissions]
-      @restore_times       = options[:restore_times]
-      @compression_level   = options[:compression_level]
+      @restore_ownership   = restore_ownership
+      @restore_permissions = restore_permissions
+      @restore_times       = restore_times
+      @compression_level   = compression_level
     end
 
     class << self
       # Similar to ::new. If a block is passed the Zip::File object is passed
       # to the block and is automatically closed afterwards, just as with
       # ruby's builtin File::open method.
-      def open(file_name, create: false, **options)
-        zf = ::Zip::File.new(file_name, create: create, **options)
+      def open(file_name, create: false,
+               restore_ownership: DEFAULT_RESTORE_OPTIONS[:restore_ownership],
+               restore_permissions: DEFAULT_RESTORE_OPTIONS[:restore_permissions],
+               restore_times: DEFAULT_RESTORE_OPTIONS[:restore_times],
+               compression_level: ::Zip.default_compression)
+
+        zf = ::Zip::File.new(file_name, create:              create,
+                                        restore_ownership:   restore_ownership,
+                                        restore_permissions: restore_permissions,
+                                        restore_times:       restore_times,
+                                        compression_level:   compression_level)
+
         return zf unless block_given?
 
         begin
@@ -104,7 +117,12 @@ module Zip
       # stream, and outputs data to a buffer.
       # (This can be used to extract data from a
       # downloaded zip archive without first saving it to disk.)
-      def open_buffer(io = ::StringIO.new, create: false, **options)
+      def open_buffer(io = ::StringIO.new, create: false,
+                      restore_ownership: DEFAULT_RESTORE_OPTIONS[:restore_ownership],
+                      restore_permissions: DEFAULT_RESTORE_OPTIONS[:restore_permissions],
+                      restore_times: DEFAULT_RESTORE_OPTIONS[:restore_times],
+                      compression_level: ::Zip.default_compression)
+
         unless IO_METHODS.map { |method| io.respond_to?(method) }.all? || io.kind_of?(String)
           raise 'Zip::File.open_buffer expects a String or IO-like argument' \
                 "(responds to #{IO_METHODS.join(', ')}). Found: #{io.class}"
@@ -112,7 +130,12 @@ module Zip
 
         io = ::StringIO.new(io) if io.kind_of?(::String)
 
-        zf = ::Zip::File.new(io, create: create, buffer: true, **options)
+        zf = ::Zip::File.new(io, create: create, buffer: true,
+                                 restore_ownership:   restore_ownership,
+                                 restore_permissions: restore_permissions,
+                                 restore_times:       restore_times,
+                                 compression_level:   compression_level)
+
         return zf unless block_given?
 
         yield zf
@@ -278,7 +301,7 @@ module Zip
 
     # Write buffer write changes to buffer and return
     def write_buffer(io = ::StringIO.new)
-      return unless commit_required?
+      return io unless commit_required?
 
       ::Zip::OutputStream.write_buffer(io) do |zos|
         @cdir.each { |e| e.write_to_zip_output_stream(zos) }
@@ -356,7 +379,7 @@ module Zip
         # This zip is probably a non-empty StringIO.
         @create = false
         @cdir.read_from_stream(path_or_io)
-      elsif !@create && ::File.zero?(@name)
+      elsif !@create && ::File.empty?(@name)
         # A file exists, but it is empty, and we've said we're
         # NOT creating a new zip.
         raise Error, "File #{@name} has zero size. Did you mean to pass the create flag?"

data/lib/zip/file_split.rb

@@ -7,13 +7,7 @@ module Zip
     DATA_BUFFER_SIZE = 8192
 
     def get_segment_size_for_split(segment_size)
-      if MIN_SEGMENT_SIZE > segment_size
-        MIN_SEGMENT_SIZE
-      elsif MAX_SEGMENT_SIZE < segment_size
-        MAX_SEGMENT_SIZE
-      else
-        segment_size
-      end
+      segment_size.clamp(MIN_SEGMENT_SIZE, MAX_SEGMENT_SIZE)
     end
 
     def get_partial_zip_file_name(zip_file_name, partial_zip_file_name)

data/lib/zip/filesystem/dir.rb

@@ -45,8 +45,8 @@ module Zip
         entries
       end
 
-      def glob(*args, &block)
-        @mapped_zip.glob(*args, &block)
+      def glob(...)
+        @mapped_zip.glob(...)
       end
 
       def foreach(directory_name)

data/lib/zip/filesystem/zip_file_name_mapper.rb

@@ -74,7 +74,7 @@ module Zip
       private
 
       def expand_to_entry(path)
-        expand_path(path)[1..-1]
+        expand_path(path)[1..]
       end
     end
   end

data/lib/zip/filesystem.rb

@@ -64,7 +64,7 @@ module Zip
     end
   end
 
-  class File
+  class File # :nodoc:
     include FileSystem
   end
 end

data/lib/zip/input_stream.rb

@@ -1,5 +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,
@@ -39,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
 
@@ -60,6 +60,7 @@ module Zip
       @complete_entry = nil
     end
 
+    # Close this InputStream. All further IO will raise an IOError.
     def close
       @archive_io.close
     end
@@ -78,7 +79,7 @@ module Zip
       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?
 
@@ -114,16 +115,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: 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)
@@ -135,7 +131,7 @@ module Zip
       end
     end
 
-    def open_entry
+    def open_entry # :nodoc:
       @current_entry = ::Zip::Entry.read_local_entry(@archive_io)
       return if @current_entry.nil?
 
@@ -144,8 +140,7 @@ module Zip
               'A password is required to decode this zip file'
       end
 
-      if @current_entry.incomplete? && @current_entry.compressed_size == 0 \
-        && !@complete_entry
+      if @current_entry.incomplete? && @current_entry.compressed_size == 0 && !@complete_entry
         raise StreamingError, @current_entry
       end
 
@@ -155,19 +150,19 @@ module Zip
       @current_entry
     end
 
-    def get_decrypted_io
+    def get_decrypted_io # :nodoc:
       header = @archive_io.read(@decrypter.header_bytesize)
       @decrypter.reset!(header)
 
       ::Zip::DecryptedIo.new(@archive_io, @decrypter)
     end
 
-    def get_decompressor
+    def get_decompressor # :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
@@ -183,11 +178,11 @@ module Zip
       decompressor_class.new(@decrypted_io, decompressed_size)
     end
 
-    def produce_input
+    def produce_input # :nodoc:
       @decompressor.read(CHUNK_SIZE)
     end
 
-    def input_finished?
+    def input_finished? # :nodoc:
       @decompressor.eof
     end
   end

data/lib/zip/ioextras/abstract_input_stream.rb

@@ -76,13 +76,13 @@ module Zip
         a_sep_string = "#{$INPUT_RECORD_SEPARATOR}#{$INPUT_RECORD_SEPARATOR}" if a_sep_string.empty?
 
         buffer_index = 0
-        over_limit   = (number_of_bytes && @output_buffer.bytesize >= number_of_bytes)
+        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?
 
           @output_buffer << produce_input
-          over_limit = (number_of_bytes && @output_buffer.bytesize >= number_of_bytes)
+          over_limit = number_of_bytes && @output_buffer.bytesize >= number_of_bytes
         end
         sep_index = [
           match_index + a_sep_string.bytesize,

data/lib/zip/ioextras.rb

@@ -12,7 +12,7 @@ module Zip
       def copy_stream_n(ostream, istream, nbytes)
         toread = nbytes
         while toread > 0 && !istream.eof?
-          tr = toread > CHUNK_SIZE ? CHUNK_SIZE : toread
+          tr = [toread, CHUNK_SIZE].min
           ostream.write(istream.read(tr, +''))
           toread -= tr
         end

data/lib/zip/output_stream.rb

@@ -2,6 +2,7 @@
 
 require 'forwardable'
 
+##
 module Zip
   # ZipOutputStream is the basic class for writing zip files. It is
   # possible to create a ZipOutputStream object directly, passing
@@ -20,7 +21,6 @@ module Zip
   #
   # java.util.zip.ZipOutputStream is the original inspiration for this
   # class.
-
   class OutputStream
     extend Forwardable
     include ::Zip::IOExtras::AbstractOutputStream
@@ -47,10 +47,10 @@ module Zip
       @current_entry = 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
+      # 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(file_name, encrypter: nil)
         return new(file_name) unless block_given?
 
@@ -114,7 +114,7 @@ module Zip
       @current_entry = new_entry
     end
 
-    def copy_raw_entry(entry)
+    def copy_raw_entry(entry) # :nodoc:
       entry = entry.dup
       raise Error, 'zip stream is closed' if @closed
       raise Error, 'entry is not a ZipEntry' unless entry.kind_of?(Entry)
@@ -139,8 +139,8 @@ module Zip
       return unless @current_entry
 
       finish
-      @current_entry.compressed_size = @output_stream.tell - \
-                                       @current_entry.local_header_offset - \
+      @current_entry.compressed_size = @output_stream.tell -
+                                       @current_entry.local_header_offset -
                                        @current_entry.calculate_local_header_size
       @current_entry.size = @compressor.size
       @current_entry.crc = @compressor.crc
@@ -185,7 +185,7 @@ module Zip
 
     protected
 
-    def finish
+    def finish # :nodoc:
       @compressor.finish
     end
 

data/lib/zip/version.rb

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

data/lib/zip.rb

@@ -57,15 +57,15 @@ module Zip
     restore_ownership:   false,
     restore_permissions: true,
     restore_times:       true
-  }.freeze
+  }.freeze # :nodoc:
 
-  def reset!
+  def reset! # :nodoc:
     @_ran_once = false
     @unicode_names = false
     @on_exists_proc = false
     @continue_on_exists_proc = false
     @sort_entries = false
-    @default_compression = ::Zlib::DEFAULT_COMPRESSION
+    @default_compression = Zlib::DEFAULT_COMPRESSION
     @write_zip64_support = true
     @warn_invalid_date = true
     @case_insensitive_match = false
@@ -73,6 +73,7 @@ module Zip
     @validate_entry_sizes = true
   end
 
+  # Set options for RubyZip in one block.
   def setup
     yield self unless @_ran_once
     @_ran_once = true

data/rubyzip.gemspec

@@ -4,7 +4,7 @@ require_relative 'lib/zip/version'
 
 Gem::Specification.new do |s|
   s.name          = 'rubyzip'
-  s.version       = ::Zip::VERSION
+  s.version       = Zip::VERSION
   s.authors       = ['Robert Haines', 'John Lees-Miller', 'Alexander Simonov']
   s.email         = [
     'hainesr@gmail.com', 'jdleesmiller@gmail.com', 'alex@simonov.me'
@@ -13,26 +13,27 @@ Gem::Specification.new do |s|
   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]
+                    %w[LICENSE.md 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'
+    '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',
+    'rubygems_mfa_required' => 'true'
   }
 
-  s.required_ruby_version = '>= 2.5'
+  s.required_ruby_version = '>= 3.0'
 
-  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 'minitest', '~> 5.25'
+  s.add_development_dependency 'rake', '~> 13.2'
+  s.add_development_dependency 'rdoc', '~> 6.11'
+  s.add_development_dependency 'rubocop', '~> 1.61.0'
+  s.add_development_dependency 'rubocop-performance', '~> 1.20.0'
+  s.add_development_dependency 'rubocop-rake', '~> 0.6.0'
+  s.add_development_dependency 'simplecov', '~> 0.22.0'
   s.add_development_dependency 'simplecov-lcov', '~> 0.8'
 end

data/samples/example_filesystem.rb

@@ -7,7 +7,7 @@ require 'zip/filesystem'
 
 EXAMPLE_ZIP = 'filesystem.zip'
 
-File.delete(EXAMPLE_ZIP) if File.exist?(EXAMPLE_ZIP)
+FileUtils.rm_f(EXAMPLE_ZIP)
 
 Zip::File.open(EXAMPLE_ZIP, create: true) do |zf|
   zf.file.open('file1.txt', 'w') { |os| os.write 'first file1.txt' }

data/samples/write_simple.rb

@@ -5,7 +5,7 @@ $LOAD_PATH << '../lib'
 
 require 'zip'
 
-::Zip::OutputStream.open('simple.zip') do |zos|
+Zip::OutputStream.open('simple.zip') do |zos|
   zos.put_next_entry 'entry.txt'
   zos.puts 'Hello world'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyzip
 version: !ruby/object:Gem::Version
-  version: 3.0.0.alpha
+  version: 3.0.0.rc1
 platform: ruby
 authors:
 - Robert Haines
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-16 00:00:00.000000000 Z
+date: 2025-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -18,98 +18,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.25'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.25'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.4.0
+        version: '6.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.4.0
+        version: '6.11'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.61.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.12.0
+        version: 1.61.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.22.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
@@ -134,6 +134,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Changelog.md
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/zip.rb
@@ -194,10 +195,11 @@ licenses:
 - BSD-2-Clause
 metadata:
   bug_tracker_uri: https://github.com/rubyzip/rubyzip/issues
-  changelog_uri: https://github.com/rubyzip/rubyzip/blob/v3.0.0.alpha/Changelog.md
-  documentation_uri: https://www.rubydoc.info/gems/rubyzip/3.0.0.alpha
-  source_code_uri: https://github.com/rubyzip/rubyzip/tree/v3.0.0.alpha
+  changelog_uri: https://github.com/rubyzip/rubyzip/blob/v3.0.0.rc1/Changelog.md
+  documentation_uri: https://www.rubydoc.info/gems/rubyzip/3.0.0.rc1
+  source_code_uri: https://github.com/rubyzip/rubyzip/tree/v3.0.0.rc1
   wiki_uri: https://github.com/rubyzip/rubyzip/wiki
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -206,14 +208,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.3.23
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: rubyzip is a ruby module for reading and writing zip files