rubyzip 2.4.1 → 3.1.1

data/lib/zip/pass_thru_decompressor.rb

@@ -1,12 +1,14 @@
+# 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 = ''.b)
-      return (length.nil? || length.zero? ? '' : nil) if eof
+    def read(length = nil, outbuf = +'')
+      return (length.nil? || length.zero? ? '' : nil) if eof?
 
       if length.nil? || (@read_so_far + length) > decompressed_size
         length = decompressed_size - @read_so_far
@@ -16,11 +18,12 @@ module Zip
       input_stream.read(length, outbuf)
     end
 
-    def eof
+    def eof?
       @read_so_far >= decompressed_size
     end
 
-    alias eof? eof
+    # Alias for compatibility. Remove for version 4.
+    alias eof eof?
   end
 
   ::Zip::Decompressor.register(::Zip::COMPRESSION_METHOD_STORE, ::Zip::PassThruDecompressor)

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,7 +1,9 @@
+# frozen_string_literal: true
+
 module Zip
   class StreamableStream < DelegateClass(Entry) # :nodoc:all
     def initialize(entry)
-      super(entry)
+      super
       @temp_file = Tempfile.new(::File.basename(name))
       @temp_file.binmode
     end
@@ -42,6 +44,7 @@ module Zip
     end
 
     def clean_up
+      super
       @temp_file.unlink
     end
   end

data/lib/zip/version.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
 module Zip
-  VERSION = '2.4.1'
+  # The version of the Rubyzip library.
+  VERSION = '3.1.1'
 end

data/lib/zip.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'English'
 require 'delegate'
 require 'singleton'
@@ -5,6 +7,7 @@ require 'tempfile'
 require 'fileutils'
 require 'stringio'
 require 'zlib'
+require 'zip/version'
 require 'zip/constants'
 require 'zip/dos_time'
 require 'zip/ioextras'
@@ -27,33 +30,21 @@ require 'zip/crypto/decrypted_io'
 require 'zip/crypto/encryption'
 require 'zip/crypto/null_encryption'
 require 'zip/crypto/traditional_encryption'
+require 'zip/crypto/aes_encryption'
 require 'zip/inflater'
 require 'zip/deflater'
 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
-  V3_API_WARNING_MSG = <<~END_MSG
-    You have called '%s' (from %s).
-    This method is changing or deprecated in version 3.0.0. Please see
-      https://github.com/rubyzip/rubyzip/wiki/Updating-to-version-3.x
-    for more information.
-  END_MSG
-
-  def self.warn_about_v3_api(method)
-    return unless ENV['RUBYZIP_V3_API_WARN']
-
-    loc = caller_locations(2, 1)[0]
-    from = "#{loc.path.split('/').last}:#{loc.lineno}"
-    warn format(V3_API_WARNING_MSG, method, from)
-  end
-
-  if ENV['RUBYZIP_V3_API_WARN'] && RUBY_VERSION < '3.0'
-    warn 'RubyZip 3.0 will require Ruby 3.0 or later.'
-  end
-
   extend self
+
   attr_accessor :unicode_names,
                 :on_exists_proc,
                 :continue_on_exists_proc,
@@ -65,19 +56,31 @@ module Zip
                 :force_entry_names_encoding,
                 :validate_entry_sizes
 
-  def reset!
+  DEFAULT_RESTORE_OPTIONS = {
+    restore_ownership:   false,
+    restore_permissions: true,
+    restore_times:       true
+  }.freeze # :nodoc:
+
+  # :nodoc:
+  # Remove this when JRuby#3962 is fixed.
+  ZLIB_FLUSHING_STRATEGY = defined?(JRUBY_VERSION) ? Zlib::SYNC_FLUSH : Zlib::NO_FLUSH
+
+  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
-    @write_zip64_support = false
+    @default_compression = Zlib::DEFAULT_COMPRESSION
+    @write_zip64_support = true
     @warn_invalid_date = true
     @case_insensitive_match = false
+    @force_entry_names_encoding = nil
     @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

@@ -0,0 +1,39 @@
+# 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[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',
+    'rubygems_mfa_required' => 'true'
+  }
+
+  s.required_ruby_version = '>= 3.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.80.2'
+  s.add_development_dependency 'rubocop-performance', '~> 1.26.0'
+  s.add_development_dependency 'rubocop-rake', '~> 0.7.1'
+  s.add_development_dependency 'simplecov', '~> 0.22.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'
 
@@ -6,9 +7,9 @@ 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, 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')

data/samples/example_recursive.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zip'
 
 # This is a simple example which uses rubyzip to
@@ -21,7 +23,7 @@ class ZipFileGenerator
   def write
     entries = Dir.entries(@input_dir) - %w[. ..]
 
-    ::Zip::File.open(@output_file, ::Zip::File::CREATE) do |zipfile|
+    ::Zip::File.open(@output_file, create: true) do |zipfile|
       write_entries entries, '', zipfile
     end
   end

data/samples/gtk_ruby_zip.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 $LOAD_PATH << '../lib'
 
@@ -9,7 +10,7 @@ require 'zip'
 
 class MainApp < Gtk::Window
   def initialize
-    super()
+    super
     set_usize(400, 256)
     set_title('rubyzip')
     signal_connect(Gtk::Window::SIGNAL_DESTROY) { Gtk.main_quit }
@@ -42,7 +43,8 @@ class MainApp < Gtk::Window
   end
 
   class ButtonPanel < Gtk::HButtonBox
-    attr_reader :open_button, :extract_button
+    attr_reader :extract_button, :open_button
+
     def initialize
       super
       set_layout(Gtk::BUTTONBOX_START)
@@ -72,7 +74,7 @@ class MainApp < Gtk::Window
     @zipfile.each do |entry|
       @clist.append([entry.name,
                      entry.size.to_s,
-                     (100.0 * entry.compressedSize / entry.size).to_s + '%'])
+                     "#{100.0 * entry.compressedSize / entry.size}%"])
     end
   end
 end

data/samples/qtzip.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 $VERBOSE = true
 
@@ -6,14 +7,14 @@ $LOAD_PATH << '../lib'
 
 require 'Qt'
 system('rbuic -o zipdialogui.rb zipdialogui.ui')
-require 'zipdialogui.rb'
+require 'zipdialogui'
 require 'zip'
 
 a = Qt::Application.new(ARGV)
 
 class ZipDialog < ZipDialogUI
   def initialize
-    super()
+    super
     connect(child('add_button'), SIGNAL('clicked()'),
             self, SLOT('add_files()'))
     connect(child('extract_button'), SIGNAL('clicked()'),
@@ -65,14 +66,14 @@ class ZipDialog < ZipDialogUI
     end
     puts "selected_items.size = #{selected_items.size}"
     puts "unselected_items.size = #{unselected_items.size}"
-    items = !selected_items.empty? ? selected_items : unselected_items
+    items = selected_items.empty? ? unselected_items : selected_items
     puts "items.size = #{items.size}"
 
     d = Qt::FileDialog.get_existing_directory(nil, self)
-    if !d
-      puts 'No directory chosen'
-    else
+    if d
       zipfile { |zf| items.each { |e| zf.extract(e, File.join(d, e)) } }
+    else
+      puts 'No directory chosen'
     end
   end
 

data/samples/write_simple.rb

@@ -1,10 +1,11 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 $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

data/samples/zipfind.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 $VERBOSE = true
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyzip
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 3.1.1
 platform: ruby
 authors:
 - Robert Haines
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-05 00:00:00.000000000 Z
+date: 2025-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -18,62 +18,112 @@ 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: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.80.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.80.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
+        version: 1.26.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.26.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
-    - - ">="
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.79'
+        version: '0.8'
 description:
 email:
 - hainesr@gmail.com
@@ -83,33 +133,43 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Changelog.md
+- LICENSE.md
 - README.md
 - Rakefile
-- TODO
 - lib/zip.rb
 - lib/zip/central_directory.rb
 - lib/zip/compressor.rb
 - lib/zip/constants.rb
+- lib/zip/crypto/aes_encryption.rb
 - lib/zip/crypto/decrypted_io.rb
 - lib/zip/crypto/encryption.rb
 - lib/zip/crypto/null_encryption.rb
 - lib/zip/crypto/traditional_encryption.rb
 - lib/zip/decompressor.rb
 - lib/zip/deflater.rb
+- lib/zip/dirtyable.rb
 - lib/zip/dos_time.rb
 - lib/zip/entry.rb
 - lib/zip/entry_set.rb
 - lib/zip/errors.rb
 - lib/zip/extra_field.rb
+- lib/zip/extra_field/aes.rb
 - lib/zip/extra_field/generic.rb
 - lib/zip/extra_field/ntfs.rb
 - lib/zip/extra_field/old_unix.rb
 - lib/zip/extra_field/universal_time.rb
 - lib/zip/extra_field/unix.rb
+- lib/zip/extra_field/unknown.rb
 - lib/zip/extra_field/zip64.rb
-- lib/zip/extra_field/zip64_placeholder.rb
 - lib/zip/file.rb
+- lib/zip/file_split.rb
 - lib/zip/filesystem.rb
+- lib/zip/filesystem/dir.rb
+- lib/zip/filesystem/directory_iterator.rb
+- lib/zip/filesystem/file.rb
+- lib/zip/filesystem/file_stat.rb
+- lib/zip/filesystem/zip_file_name_mapper.rb
 - lib/zip/inflater.rb
 - lib/zip/input_stream.rb
 - lib/zip/ioextras.rb
@@ -124,6 +184,7 @@ files:
 - lib/zip/streamable_directory.rb
 - lib/zip/streamable_stream.rb
 - lib/zip/version.rb
+- rubyzip.gemspec
 - samples/example.rb
 - samples/example_filesystem.rb
 - samples/example_recursive.rb
@@ -133,38 +194,15 @@ files:
 - samples/zipfind.rb
 homepage: http://github.com/rubyzip/rubyzip
 licenses:
-- BSD 2-Clause
+- BSD-2-Clause
 metadata:
   bug_tracker_uri: https://github.com/rubyzip/rubyzip/issues
-  changelog_uri: https://github.com/rubyzip/rubyzip/blob/v2.4.1/Changelog.md
-  documentation_uri: https://www.rubydoc.info/gems/rubyzip/2.4.1
-  source_code_uri: https://github.com/rubyzip/rubyzip/tree/v2.4.1
+  changelog_uri: https://github.com/rubyzip/rubyzip/blob/v3.1.1/Changelog.md
+  documentation_uri: https://www.rubydoc.info/gems/rubyzip/3.1.1
+  source_code_uri: https://github.com/rubyzip/rubyzip/tree/v3.1.1
   wiki_uri: https://github.com/rubyzip/rubyzip/wiki
   rubygems_mfa_required: 'true'
-post_install_message: |
-  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`
-    * `Zip::DOSTime`
-
-  Run your test suite with the `RUBYZIP_V3_API_WARN` environment
-  variable set to see warnings about usage of the old API. This will
-  help you to identify any changes that you need to make to your code.
-  See https://github.com/rubyzip/rubyzip/wiki/Updating-to-version-3.x for
-  more information.
-
-  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.
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -172,14 +210,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: rubyzip is a ruby module for reading and writing zip files

data/TODO

@@ -1,15 +0,0 @@
-
-* ZipInputStream: Support zip-files with trailing data descriptors
-* Adjust rdoc stylesheet to advertise inherited methods if possible
-* Suggestion: Add ZipFile/ZipInputStream example that demonstrates extracting all entries.
-* Suggestion: ZipFile#extract destination should default to "."
-* Suggestion: ZipEntry should have extract(), get_input_stream() methods etc
-* (is buffering used anywhere with write?)
-* Inflater.sysread should pass the buffer to produce_input.
-* Implement ZipFsDir.glob
-* ZipFile.checkIntegrity method
-* non-MSDOS permission attributes
-** See mail from Ned Konz to ruby-talk subj. "Re: SV: [ANN] Archive 0.2"
-* Packager version, required unpacker version in zip headers
-** See mail from Ned Konz to ruby-talk subj. "Re: SV: [ANN] Archive 0.2"
-* implement storing attributes and ownership information

data/lib/zip/extra_field/zip64_placeholder.rb

@@ -1,15 +0,0 @@
-module Zip
-  # placeholder to reserve space for a Zip64 extra information record, for the
-  # local file header only, that we won't know if we'll need until after
-  # we write the file data
-  class ExtraField::Zip64Placeholder < ExtraField::Generic
-    HEADER_ID = ['9999'].pack('H*') # this ID is used by other libraries such as .NET's Ionic.zip
-    register_map
-
-    def initialize(_binstr = nil); end
-
-    def pack_for_local
-      "\x00" * 16
-    end
-  end
-end