rubyzip 1.3.0 → 2.4.1

data/lib/zip.rb

@@ -1,10 +1,11 @@
+require 'English'
 require 'delegate'
 require 'singleton'
 require 'tempfile'
-require 'tmpdir'
 require 'fileutils'
 require 'stringio'
 require 'zlib'
+require 'zip/constants'
 require 'zip/dos_time'
 require 'zip/ioextras'
 require 'rbconfig'
@@ -22,6 +23,7 @@ require 'zip/null_compressor'
 require 'zip/null_input_stream'
 require 'zip/pass_thru_compressor'
 require 'zip/pass_thru_decompressor'
+require 'zip/crypto/decrypted_io'
 require 'zip/crypto/encryption'
 require 'zip/crypto/null_encryption'
 require 'zip/crypto/traditional_encryption'
@@ -29,10 +31,28 @@ require 'zip/inflater'
 require 'zip/deflater'
 require 'zip/streamable_stream'
 require 'zip/streamable_directory'
-require 'zip/constants'
 require 'zip/errors'
 
 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,
@@ -55,7 +75,7 @@ module Zip
     @write_zip64_support = false
     @warn_invalid_date = true
     @case_insensitive_match = false
-    @validate_entry_sizes = false
+    @validate_entry_sizes = true
   end
 
   def setup

data/samples/example.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$: << '../lib'
+$LOAD_PATH << '../lib'
 system('zip example.zip example.rb gtk_ruby_zip.rb')
 
 require 'zip'
@@ -71,7 +71,7 @@ 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.to_f * 100).to_i}%"
+  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,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$: << '../lib'
+$LOAD_PATH << '../lib'
 
 require 'zip/filesystem'
 

data/samples/gtk_ruby_zip.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-$: << '../lib'
+$LOAD_PATH << '../lib'
 
 $VERBOSE = true
 
@@ -18,14 +18,14 @@ class MainApp < Gtk::Window
     add(box)
 
     @zipfile = nil
-    @buttonPanel = ButtonPanel.new
-    @buttonPanel.openButton.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+    @button_panel = ButtonPanel.new
+    @button_panel.open_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
       show_file_selector
     end
-    @buttonPanel.extractButton.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+    @button_panel.extract_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
       puts 'Not implemented!'
     end
-    box.pack_start(@buttonPanel, false, false, 0)
+    box.pack_start(@button_panel, false, false, 0)
 
     sw = Gtk::ScrolledWindow.new
     sw.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC)
@@ -42,27 +42,27 @@ class MainApp < Gtk::Window
   end
 
   class ButtonPanel < Gtk::HButtonBox
-    attr_reader :openButton, :extractButton
+    attr_reader :open_button, :extract_button
     def initialize
       super
       set_layout(Gtk::BUTTONBOX_START)
       set_spacing(0)
-      @openButton = Gtk::Button.new('Open archive')
-      @extractButton = Gtk::Button.new('Extract entry')
-      pack_start(@openButton)
-      pack_start(@extractButton)
+      @open_button = Gtk::Button.new('Open archive')
+      @extract_button = Gtk::Button.new('Extract entry')
+      pack_start(@open_button)
+      pack_start(@extract_button)
     end
   end
 
   def show_file_selector
-    @fileSelector = Gtk::FileSelection.new('Open zip file')
-    @fileSelector.show
-    @fileSelector.ok_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
-      open_zip(@fileSelector.filename)
-      @fileSelector.destroy
+    @file_selector = Gtk::FileSelection.new('Open zip file')
+    @file_selector.show
+    @file_selector.ok_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+      open_zip(@file_selector.filename)
+      @file_selector.destroy
     end
-    @fileSelector.cancel_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
-      @fileSelector.destroy
+    @file_selector.cancel_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+      @file_selector.destroy
     end
   end
 
@@ -77,8 +77,8 @@ class MainApp < Gtk::Window
   end
 end
 
-mainApp = MainApp.new
+main_app = MainApp.new
 
-mainApp.show_all
+main_app.show_all
 
 Gtk.main

data/samples/qtzip.rb

@@ -2,7 +2,7 @@
 
 $VERBOSE = true
 
-$: << '../lib'
+$LOAD_PATH << '../lib'
 
 require 'Qt'
 system('rbuic -o zipdialogui.rb zipdialogui.ui')
@@ -20,12 +20,12 @@ class ZipDialog < ZipDialogUI
             self, SLOT('extract_files()'))
   end
 
-  def zipfile(&proc)
-    Zip::File.open(@zip_filename, &proc)
+  def zipfile(&a_proc)
+    Zip::File.open(@zip_filename, &a_proc)
   end
 
-  def each(&proc)
-    Zip::File.foreach(@zip_filename, &proc)
+  def each(&a_proc)
+    Zip::File.foreach(@zip_filename, &a_proc)
   end
 
   def refresh
@@ -80,7 +80,7 @@ class ZipDialog < ZipDialogUI
 end
 
 unless ARGV[0]
-  puts "usage: #{$0} zipname"
+  puts "usage: #{$PROGRAM_NAME} zipname"
   exit
 end
 

data/samples/write_simple.rb

@@ -1,12 +1,10 @@
 #!/usr/bin/env ruby
 
-$: << '../lib'
+$LOAD_PATH << '../lib'
 
 require 'zip'
 
-include 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

@@ -2,36 +2,37 @@
 
 $VERBOSE = true
 
-$: << '../lib'
+$LOAD_PATH << '../lib'
 
 require 'zip'
 require 'find'
 
 module Zip
   module ZipFind
-    def self.find(path, zipFilePattern = /\.zip$/i)
-      Find.find(path) do |fileName|
-        yield(fileName)
-        next unless zipFilePattern.match(fileName) && File.file?(fileName)
+    def self.find(path, zip_file_pattern = /\.zip$/i)
+      Find.find(path) do |filename|
+        yield(filename)
+        next unless zip_file_pattern.match(filename) && File.file?(filename)
+
         begin
-          Zip::File.foreach(fileName) do |zipEntry|
-            yield(fileName + File::SEPARATOR + zipEntry.to_s)
+          Zip::File.foreach(filename) do |entry|
+            yield(filename + File::SEPARATOR + entry.to_s)
           end
-        rescue Errno::EACCES => ex
-          puts ex
+        rescue Errno::EACCES => e
+          puts e
         end
       end
     end
 
-    def self.find_file(path, fileNamePattern, zipFilePattern = /\.zip$/i)
-      find(path, zipFilePattern) do |fileName|
-        yield(fileName) if fileNamePattern.match(fileName)
+    def self.find_file(path, filename_pattern, zip_file_pattern = /\.zip$/i)
+      find(path, zip_file_pattern) do |filename|
+        yield(filename) if filename_pattern.match(filename)
       end
     end
   end
 end
 
-if $0 == __FILE__
+if $PROGRAM_NAME == __FILE__
   module ZipFindConsoleRunner
     PATH_ARG_INDEX = 0
     FILENAME_PATTERN_ARG_INDEX = 1
@@ -41,24 +42,24 @@ if $0 == __FILE__
       check_args(args)
       Zip::ZipFind.find_file(args[PATH_ARG_INDEX],
                              args[FILENAME_PATTERN_ARG_INDEX],
-                             args[ZIPFILE_PATTERN_ARG_INDEX]) do |fileName|
-        report_entry_found fileName
+                             args[ZIPFILE_PATTERN_ARG_INDEX]) do |filename|
+        report_entry_found filename
       end
     end
 
     def self.check_args(args)
-      if args.size != 3
-        usage
-        exit
-      end
+      return if args.size == 3
+
+      usage
+      exit
     end
 
     def self.usage
-      puts "Usage: #{$0} PATH ZIPFILENAME_PATTERN FILNAME_PATTERN"
+      puts "Usage: #{$PROGRAM_NAME} PATH ZIPFILENAME_PATTERN FILNAME_PATTERN"
     end
 
-    def self.report_entry_found(fileName)
-      puts fileName
+    def self.report_entry_found(filename)
+      puts filename
     end
   end
 

metadata

@@ -1,29 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: rubyzip
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.4.1
 platform: ruby
 authors:
+- Robert Haines
+- John Lees-Miller
 - Alexander Simonov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2025-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: '5.4'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -39,49 +41,43 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '12.3'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.4'
-- !ruby/object:Gem::Dependency
-  name: coveralls
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: '0.79'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
-description: 
+        version: '0.79'
+description:
 email:
+- hainesr@gmail.com
+- jdleesmiller@gmail.com
 - alex@simonov.me
 executables: []
 extensions: []
@@ -94,6 +90,7 @@ files:
 - lib/zip/central_directory.rb
 - lib/zip/compressor.rb
 - lib/zip/constants.rb
+- lib/zip/crypto/decrypted_io.rb
 - lib/zip/crypto/encryption.rb
 - lib/zip/crypto/null_encryption.rb
 - lib/zip/crypto/traditional_encryption.rb
@@ -134,90 +131,40 @@ files:
 - samples/qtzip.rb
 - samples/write_simple.rb
 - samples/zipfind.rb
-- test/basic_zip_file_test.rb
-- test/case_sensitivity_test.rb
-- test/central_directory_entry_test.rb
-- test/central_directory_test.rb
-- test/crypto/null_encryption_test.rb
-- test/crypto/traditional_encryption_test.rb
-- test/data/WarnInvalidDate.zip
-- test/data/file1.txt
-- test/data/file1.txt.deflatedData
-- test/data/file2.txt
-- test/data/globTest.zip
-- test/data/globTest/foo.txt
-- test/data/globTest/foo/bar/baz/foo.txt
-- test/data/globTest/food.txt
-- test/data/gpbit3stored.zip
-- test/data/mimetype
-- test/data/notzippedruby.rb
-- test/data/ntfs.zip
-- test/data/oddExtraField.zip
-- test/data/path_traversal/Makefile
-- test/data/path_traversal/jwilk/README.md
-- test/data/path_traversal/jwilk/absolute1.zip
-- test/data/path_traversal/jwilk/absolute2.zip
-- test/data/path_traversal/jwilk/dirsymlink.zip
-- test/data/path_traversal/jwilk/dirsymlink2a.zip
-- test/data/path_traversal/jwilk/dirsymlink2b.zip
-- test/data/path_traversal/jwilk/relative0.zip
-- test/data/path_traversal/jwilk/relative2.zip
-- test/data/path_traversal/jwilk/symlink.zip
-- test/data/path_traversal/relative1.zip
-- test/data/path_traversal/tilde.zip
-- test/data/path_traversal/tuzovakaoff/README.md
-- test/data/path_traversal/tuzovakaoff/absolutepath.zip
-- test/data/path_traversal/tuzovakaoff/symlink.zip
-- test/data/rubycode.zip
-- test/data/rubycode2.zip
-- test/data/test.xls
-- test/data/testDirectory.bin
-- test/data/zip64-sample.zip
-- test/data/zipWithDirs.zip
-- test/data/zipWithEncryption.zip
-- test/deflater_test.rb
-- test/encryption_test.rb
-- test/entry_set_test.rb
-- test/entry_test.rb
-- test/errors_test.rb
-- test/extra_field_test.rb
-- test/file_extract_directory_test.rb
-- test/file_extract_test.rb
-- test/file_permissions_test.rb
-- test/file_split_test.rb
-- test/file_test.rb
-- test/filesystem/dir_iterator_test.rb
-- test/filesystem/directory_test.rb
-- test/filesystem/file_mutating_test.rb
-- test/filesystem/file_nonmutating_test.rb
-- test/filesystem/file_stat_test.rb
-- test/gentestfiles.rb
-- test/inflater_test.rb
-- test/input_stream_test.rb
-- test/ioextras/abstract_input_stream_test.rb
-- test/ioextras/abstract_output_stream_test.rb
-- test/ioextras/fake_io_test.rb
-- test/local_entry_test.rb
-- test/output_stream_test.rb
-- test/pass_thru_compressor_test.rb
-- test/pass_thru_decompressor_test.rb
-- test/path_traversal_test.rb
-- test/samples/example_recursive_test.rb
-- test/settings_test.rb
-- test/test_helper.rb
-- test/unicode_file_names_and_comments_test.rb
-- test/zip64_full_test.rb
-- test/zip64_support_test.rb
 homepage: http://github.com/rubyzip/rubyzip
 licenses:
 - BSD 2-Clause
 metadata:
   bug_tracker_uri: https://github.com/rubyzip/rubyzip/issues
-  changelog_uri: https://github.com/rubyzip/rubyzip/blob/v1.3.0/Changelog.md
-  documentation_uri: https://www.rubydoc.info/gems/rubyzip/1.3.0
-  source_code_uri: https://github.com/rubyzip/rubyzip/tree/v1.3.0
+  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
   wiki_uri: https://github.com/rubyzip/rubyzip/wiki
-post_install_message: 
+  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.
 rdoc_options: []
 require_paths:
 - lib
@@ -225,89 +172,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: rubyzip is a ruby module for reading and writing zip files
-test_files:
-- test/file_permissions_test.rb
-- test/path_traversal_test.rb
-- test/ioextras/abstract_input_stream_test.rb
-- test/ioextras/fake_io_test.rb
-- test/ioextras/abstract_output_stream_test.rb
-- test/central_directory_test.rb
-- test/central_directory_entry_test.rb
-- test/crypto/traditional_encryption_test.rb
-- test/crypto/null_encryption_test.rb
-- test/input_stream_test.rb
-- test/file_extract_directory_test.rb
-- test/basic_zip_file_test.rb
-- test/inflater_test.rb
-- test/file_extract_test.rb
-- test/pass_thru_compressor_test.rb
-- test/filesystem/file_nonmutating_test.rb
-- test/filesystem/file_stat_test.rb
-- test/filesystem/file_mutating_test.rb
-- test/filesystem/dir_iterator_test.rb
-- test/filesystem/directory_test.rb
-- test/extra_field_test.rb
-- test/zip64_support_test.rb
-- test/local_entry_test.rb
-- test/samples/example_recursive_test.rb
-- test/entry_test.rb
-- test/case_sensitivity_test.rb
-- test/zip64_full_test.rb
-- test/pass_thru_decompressor_test.rb
-- test/settings_test.rb
-- test/gentestfiles.rb
-- test/encryption_test.rb
-- test/file_test.rb
-- test/deflater_test.rb
-- test/test_helper.rb
-- test/errors_test.rb
-- test/file_split_test.rb
-- test/data/file2.txt
-- test/data/testDirectory.bin
-- test/data/globTest/foo.txt
-- test/data/globTest/foo/bar/baz/foo.txt
-- test/data/globTest/food.txt
-- test/data/file1.txt
-- test/data/rubycode.zip
-- test/data/WarnInvalidDate.zip
-- test/data/zipWithDirs.zip
-- test/data/rubycode2.zip
-- test/data/mimetype
-- test/data/zipWithEncryption.zip
-- test/data/path_traversal/tilde.zip
-- test/data/path_traversal/Makefile
-- test/data/path_traversal/relative1.zip
-- test/data/path_traversal/jwilk/dirsymlink.zip
-- test/data/path_traversal/jwilk/symlink.zip
-- test/data/path_traversal/jwilk/README.md
-- test/data/path_traversal/jwilk/relative2.zip
-- test/data/path_traversal/jwilk/relative0.zip
-- test/data/path_traversal/jwilk/absolute2.zip
-- test/data/path_traversal/jwilk/dirsymlink2b.zip
-- test/data/path_traversal/jwilk/absolute1.zip
-- test/data/path_traversal/jwilk/dirsymlink2a.zip
-- test/data/path_traversal/tuzovakaoff/symlink.zip
-- test/data/path_traversal/tuzovakaoff/README.md
-- test/data/path_traversal/tuzovakaoff/absolutepath.zip
-- test/data/oddExtraField.zip
-- test/data/gpbit3stored.zip
-- test/data/ntfs.zip
-- test/data/notzippedruby.rb
-- test/data/globTest.zip
-- test/data/file1.txt.deflatedData
-- test/data/test.xls
-- test/data/zip64-sample.zip
-- test/unicode_file_names_and_comments_test.rb
-- test/entry_set_test.rb
-- test/output_stream_test.rb
+test_files: []

data/test/basic_zip_file_test.rb

@@ -1,60 +0,0 @@
-require 'test_helper'
-
-class BasicZipFileTest < MiniTest::Test
-  include AssertEntry
-
-  def setup
-    @zip_file = ::Zip::File.new(TestZipFile::TEST_ZIP2.zip_name)
-    @testEntryNameIndex = 0
-  end
-
-  def test_entries
-    assert_equal(TestZipFile::TEST_ZIP2.entry_names.sort,
-                 @zip_file.entries.entries.sort.map { |e| e.name })
-  end
-
-  def test_each
-    count = 0
-    visited = {}
-    @zip_file.each do |entry|
-      assert(TestZipFile::TEST_ZIP2.entry_names.include?(entry.name))
-      assert(!visited.include?(entry.name))
-      visited[entry.name] = nil
-      count = count.succ
-    end
-    assert_equal(TestZipFile::TEST_ZIP2.entry_names.length, count)
-  end
-
-  def test_foreach
-    count = 0
-    visited = {}
-    ::Zip::File.foreach(TestZipFile::TEST_ZIP2.zip_name) do |entry|
-      assert(TestZipFile::TEST_ZIP2.entry_names.include?(entry.name))
-      assert(!visited.include?(entry.name))
-      visited[entry.name] = nil
-      count = count.succ
-    end
-    assert_equal(TestZipFile::TEST_ZIP2.entry_names.length, count)
-  end
-
-  def test_get_input_stream
-    count = 0
-    visited = {}
-    @zip_file.each do |entry|
-      assert_entry(entry.name, @zip_file.get_input_stream(entry), entry.name)
-      assert(!visited.include?(entry.name))
-      visited[entry.name] = nil
-      count = count.succ
-    end
-    assert_equal(TestZipFile::TEST_ZIP2.entry_names.length, count)
-  end
-
-  def test_get_input_stream_block
-    fileAndEntryName = @zip_file.entries.first.name
-    @zip_file.get_input_stream(fileAndEntryName) do |zis|
-      assert_entry_contents_for_stream(fileAndEntryName,
-                                       zis,
-                                       fileAndEntryName)
-    end
-  end
-end