rubyzip 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f572a7ce284e7e1dcdd10b0ba8e278c862957e9ac47d1b00dad5ea26db6fcba
-  data.tar.gz: 8afd167d9dcd0b902d79d1dc4111964c3edb75739419cd30cff9ebc36c38bdc7
+  metadata.gz: 869a32fef1374d44c2d01fcf90d92d10760ceb619cbc2ccb545f7753503efee4
+  data.tar.gz: 9eb0b0601572717187029c44fbcfdd7fa3a47005d869d8aea2b36ab465b18de5
 SHA512:
-  metadata.gz: e09c8b007382e0243cdb57d63560d5b6c8ef9a153c8dafc35a1c284ad41dc49c5afc284cf6175ffc311691e98dcdd81221cee8f2d1b060a665ade5de11d00c58
-  data.tar.gz: 306dfe485b10b421d4232c44314bd609c14004b3f0b1b8d76d7ef78234f6a34dc76eae38126a53ac34553f7538a87a807991be1d5b06b8788a81bd8eba723fdc
+  metadata.gz: 8cc3d0b1cb58eabdafb91db1cc8e7a2ef3932bcaf993df9a8c21ae261d480ffa43d431111faa11f5e19e52aa59a70e14a4724bbd174a8628a7ffacb48119ccdb
+  data.tar.gz: 1171566d3c91b07b01e3f5fe77e9d098f6c5fa6f94891cf289c1edbaa35bbe2a3a96165bebfcb7b35f2d41eedb268b13e90aab27683cd05175ea0ffbc9a485c6

data/Changelog.md

@@ -1,3 +1,16 @@
+# 3.1.1 (2025-09-26)
+
+- Improve the IO pipeline when decompressing. [#649](https://github.com/rubyzip/rubyzip/pull/649) (which also fixes [#647](https://github.com/rubyzip/rubyzip/issues/647))
+
+Tooling/internal:
+
+- Improve the `DecryptedIo` class with various updates and optimizations.
+- Remove the `NullDecrypter` class.
+- Properly convert the test suite to use minitest.
+- Move all test helper code into separate files.
+- Updates to the Actions CI, including new OS versions.
+- Update rubocop versions and fix resultant cop failures. [#646](https://github.com/rubyzip/rubyzip/pull/646)
+
 # 3.1.0 (2025-09-06)
 
 - Support AES decryption. [#579](https://github.com/rubyzip/rubyzip/pull/579) and [#645](https://github.com/rubyzip/rubyzip/pull/645)

data/README.md

@@ -3,7 +3,8 @@
 [![Gem Version](https://badge.fury.io/rb/rubyzip.svg)](http://badge.fury.io/rb/rubyzip)
 [![Tests](https://github.com/rubyzip/rubyzip/actions/workflows/tests.yml/badge.svg)](https://github.com/rubyzip/rubyzip/actions/workflows/tests.yml)
 [![Linter](https://github.com/rubyzip/rubyzip/actions/workflows/lint.yml/badge.svg)](https://github.com/rubyzip/rubyzip/actions/workflows/lint.yml)
-[![Code Climate](https://codeclimate.com/github/rubyzip/rubyzip.svg)](https://codeclimate.com/github/rubyzip/rubyzip)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+[![Maintainability](https://qlty.sh/gh/rubyzip/projects/rubyzip/maintainability.svg)](https://qlty.sh/gh/rubyzip/projects/rubyzip)
 [![Coverage Status](https://img.shields.io/coveralls/rubyzip/rubyzip.svg)](https://coveralls.io/r/rubyzip/rubyzip?branch=master)
 
 Rubyzip is a ruby library for reading and writing zip files.

data/Rakefile

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-require 'rake/testtask'
+require 'minitest/test_task'
 require 'rdoc/task'
 require 'rubocop/rake_task'
 
 task default: :test
 
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib'
-  test.libs << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
+Minitest::TestTask.create do |test|
+  test.framework = 'require "simplecov"'
+  test.test_globs = 'test/**/*_test.rb'
 end
 
 RDoc::Task.new do |rdoc|

data/lib/zip/crypto/aes_encryption.rb

@@ -112,7 +112,8 @@ module Zip
       @hmac = OpenSSL::HMAC.new(enc_hmac_key, OpenSSL::Digest.new('SHA1'))
     end
 
-    def check_integrity(auth_code)
+    def check_integrity!(io)
+      auth_code = io.read(AUTHENTICATION_CODE_LENGTH)
       raise Error, 'Integrity fault' if @hmac.digest[0...AUTHENTICATION_CODE_LENGTH] != auth_code
     end
   end

data/lib/zip/crypto/decrypted_io.rb

@@ -7,48 +7,39 @@ module Zip
     def initialize(io, decrypter, compressed_size)
       @io = io
       @decrypter = decrypter
-      @offset = io.tell
-      @compressed_size = compressed_size
+      @bytes_remaining = compressed_size
+      @buffer = +''
     end
 
     def read(length = nil, outbuf = +'')
-      return (length.nil? || length.zero? ? '' : nil) if eof
+      return (length.nil? || length.zero? ? '' : nil) if eof?
 
-      while length.nil? || (buffer.bytesize < length)
+      while length.nil? || (@buffer.bytesize < length)
         break if input_finished?
 
-        buffer << produce_input
+        @buffer << produce_input
       end
 
-      if @decrypter.kind_of?(::Zip::AESDecrypter) && input_finished?
-        @decrypter.check_integrity(@io.read(::Zip::AESEncryption::AUTHENTICATION_CODE_LENGTH))
-      end
+      @decrypter.check_integrity!(@io) if input_finished?
 
-      outbuf.replace(buffer.slice!(0...(length || buffer.bytesize)))
+      outbuf.replace(@buffer.slice!(0...(length || @buffer.bytesize)))
     end
 
     private
 
-    def eof
-      buffer.empty? && input_finished?
-    end
-
-    def buffer
-      @buffer ||= +''
-    end
-
-    def pos
-      @io.tell - @offset
+    def eof?
+      @buffer.empty? && input_finished?
     end
 
     def input_finished?
-      @io.eof || pos >= @compressed_size
+      !@bytes_remaining.positive?
     end
 
     def produce_input
-      chunk_size = [CHUNK_SIZE, @compressed_size - pos].min
+      chunk_size = [@bytes_remaining, CHUNK_SIZE].min
       return '' unless chunk_size.positive?
 
+      @bytes_remaining -= chunk_size
       @decrypter.decrypt(@io.read(chunk_size))
     end
   end

data/lib/zip/crypto/null_encryption.rb

@@ -28,16 +28,6 @@ module Zip
 
     def reset!; end
   end
-
-  class NullDecrypter < Decrypter # :nodoc:
-    include NullEncryption
-
-    def decrypt(data)
-      data
-    end
-
-    def reset!(_header); end
-  end
 end
 
 # Copyright (C) 2002, 2003 Thomas Sondergaard

data/lib/zip/crypto/traditional_encryption.rb

@@ -86,6 +86,8 @@ module Zip
       end
     end
 
+    def check_integrity!(_io); end
+
     private
 
     def decode(num)

data/lib/zip/dos_time.rb

@@ -21,7 +21,7 @@ module Zip
     def absolute_time?
       # If absolute time is not set, we can assume it is an absolute time
       # because times do have timezone information by default.
-      @absolute_time.nil? ? true : @absolute_time
+      @absolute_time.nil? || @absolute_time
     end
 
     def to_binary_dos_time
@@ -36,7 +36,8 @@ module Zip
         ((year - 1980) << 9)
     end
 
-    def dos_equals(other)
+    # Deprecated. Remove for version 4.
+    def dos_equals(other) # rubocop:disable Naming/PredicateMethod
       warn 'Zip::DOSTime#dos_equals is deprecated. Use `==` instead.'
       self == other
     end

data/lib/zip/file.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'fileutils'
 require 'forwardable'
 
 require_relative 'file_split'
@@ -98,7 +99,6 @@ module Zip
                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,
@@ -123,7 +123,6 @@ module Zip
                       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}"
@@ -191,7 +190,6 @@ module Zip
                           extra: nil, compressed_size: nil, crc: nil,
                           compression_method: nil, compression_level: nil,
                           size: nil, time: nil, &a_proc)
-
       new_entry =
         if entry.kind_of?(Entry)
           entry
@@ -412,7 +410,7 @@ module Zip
           ::File.chmod(@file_permissions, name) unless @create
         end
       ensure
-        ::File.unlink(tmp_filename) if ::File.exist?(tmp_filename)
+        FileUtils.rm_f(tmp_filename)
       end
     end
   end

data/lib/zip/filesystem/file.rb

@@ -27,7 +27,7 @@ module Zip
 
       def unix_mode_cmp(filename, mode)
         e = find_entry(filename)
-        e.fstype == FSTYPE_UNIX && ((e.external_file_attributes >> 16) & mode) != 0
+        e.fstype == FSTYPE_UNIX && (e.external_file_attributes >> 16).anybits?(mode)
       rescue Errno::ENOENT
         false
       end
@@ -102,10 +102,11 @@ module Zip
         @mapped_zip.get_entry(filename).size
       end
 
-      # Returns nil for not found and nil for directories
+      # Returns nil for not found and nil for directories.
+      # We disable the cop here for compatibility with `::File.size?`.
       def size?(filename)
         entry = @mapped_zip.find_entry(filename)
-        entry.nil? || entry.directory? ? nil : entry.size
+        entry.nil? || entry.directory? ? nil : entry.size # rubocop:disable Style/ReturnNilInPredicateMethodDefinition
       end
 
       def chown(owner, group, *filenames)

data/lib/zip/inflater.rb

@@ -10,7 +10,7 @@ module Zip
     end
 
     def read(length = nil, outbuf = +'')
-      return (length.nil? || length.zero? ? '' : nil) if eof
+      return (length.nil? || length.zero? ? '' : nil) if eof?
 
       while length.nil? || (@buffer.bytesize < length)
         break if input_finished?
@@ -21,11 +21,12 @@ module Zip
       outbuf.replace(@buffer.slice!(0...(length || @buffer.bytesize)))
     end
 
-    def eof
+    def eof?
       @buffer.empty? && input_finished?
     end
 
-    alias eof? eof
+    # Alias for compatibility. Remove for version 4.
+    alias eof eof?
 
     private
 

data/lib/zip/input_stream.rb

@@ -55,7 +55,7 @@ module Zip
       super()
       @archive_io = get_io(context, offset)
       @decompressor = ::Zip::NullDecompressor
-      @decrypter = decrypter || ::Zip::NullDecrypter.new
+      @decrypter = decrypter
       @current_entry = nil
       @complete_entry = nil
     end
@@ -135,21 +135,27 @@ module Zip
       @current_entry = ::Zip::Entry.read_local_entry(@archive_io)
       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.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 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)
@@ -170,7 +176,7 @@ module Zip
       ::Zip::DecryptedIo.new(@archive_io, @decrypter, compressed_size)
     end
 
-    def get_decompressor # :nodoc:
+    def get_decompressor(io) # :nodoc:
       return ::Zip::NullDecompressor if @current_entry.nil?
 
       decompressed_size =
@@ -188,7 +194,7 @@ module Zip
         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 # :nodoc:
@@ -196,7 +202,7 @@ module Zip
     end
 
     def input_finished? # :nodoc:
-      @decompressor.eof
+      @decompressor.eof?
     end
   end
 end

data/lib/zip/ioextras/abstract_input_stream.rb

@@ -117,11 +117,12 @@ module Zip
 
       alias each each_line
 
-      def eof
+      def eof?
         @output_buffer.empty? && input_finished?
       end
 
-      alias eof? eof
+      # Alias for compatibility. Remove for version 4.
+      alias eof eof?
     end
   end
 end

data/lib/zip/null_decompressor.rb

@@ -8,11 +8,12 @@ module Zip
       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/pass_thru_decompressor.rb

@@ -8,7 +8,7 @@ module Zip
     end
 
     def read(length = nil, outbuf = +'')
-      return (length.nil? || length.zero? ? '' : nil) if eof
+      return (length.nil? || length.zero? ? '' : nil) if eof?
 
       if length.nil? || (@read_so_far + length) > decompressed_size
         length = decompressed_size - @read_so_far
@@ -18,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_stream.rb

@@ -3,7 +3,7 @@
 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

data/lib/zip/version.rb

@@ -2,5 +2,5 @@
 
 module Zip
   # The version of the Rubyzip library.
-  VERSION = '3.1.0'
+  VERSION = '3.1.1'
 end

data/lib/zip.rb

@@ -44,6 +44,7 @@ require 'zip/errors'
 # ::Dir APIs then `require 'zip/filesystem'` and see FileSystem.
 module Zip
   extend self
+
   attr_accessor :unicode_names,
                 :on_exists_proc,
                 :continue_on_exists_proc,

data/rubyzip.gemspec

@@ -31,9 +31,9 @@ Gem::Specification.new do |s|
   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 '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/gtk_ruby_zip.rb

@@ -10,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 }

data/samples/qtzip.rb

@@ -14,7 +14,7 @@ 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()'),

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyzip
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Robert Haines
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-06 00:00:00.000000000 Z
+date: 2025-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -60,42 +60,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.61.0
+        version: 1.80.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.61.0
+        version: 1.80.2
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.0
+        version: 1.26.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.20.0
+        version: 1.26.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -197,9 +197,9 @@ licenses:
 - BSD-2-Clause
 metadata:
   bug_tracker_uri: https://github.com/rubyzip/rubyzip/issues
-  changelog_uri: https://github.com/rubyzip/rubyzip/blob/v3.1.0/Changelog.md
-  documentation_uri: https://www.rubydoc.info/gems/rubyzip/3.1.0
-  source_code_uri: https://github.com/rubyzip/rubyzip/tree/v3.1.0
+  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: