rubyzip 1.3.0 → 3.0.0.alpha

data/samples/write_simple.rb

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

@@ -1,37 +1,39 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 $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 +43,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,104 +1,152 @@
 --- !ruby/object:Gem::Specification
 name: rubyzip
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 3.0.0.alpha
 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: 2023-04-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.3'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 6.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 6.4.0
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: 1.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: 1.12.0
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 1.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 0.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
-description: 
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description:
 email:
+- hainesr@gmail.com
+- jdleesmiller@gmail.com
 - alex@simonov.me
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Changelog.md
 - README.md
 - Rakefile
-- TODO
 - lib/zip.rb
 - 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
 - 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
@@ -109,10 +157,16 @@ files:
 - 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
@@ -127,6 +181,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
@@ -134,90 +189,16 @@ 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
+- 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/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
   wiki_uri: https://github.com/rubyzip/rubyzip/wiki
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -225,89 +206,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.23
+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/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

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

data/test/case_sensitivity_test.rb

@@ -1,69 +0,0 @@
-require 'test_helper'
-
-class ZipCaseSensitivityTest < MiniTest::Test
-  include CommonZipFileFixture
-
-  SRC_FILES = [['test/data/file1.txt', 'testfile.rb'],
-               ['test/data/file2.txt', 'testFILE.rb']]
-
-  def teardown
-    ::Zip.case_insensitive_match = false
-  end
-
-  # Ensure that everything functions normally when +case_insensitive_match = false+
-  def test_add_case_sensitive
-    ::Zip.case_insensitive_match = false
-
-    SRC_FILES.each { |fn, _en| assert(::File.exist?(fn)) }
-    zf = ::Zip::File.new(EMPTY_FILENAME, ::Zip::File::CREATE)
-
-    SRC_FILES.each { |fn, en| zf.add(en, fn) }
-    zf.close
-
-    zfRead = ::Zip::File.new(EMPTY_FILENAME)
-    assert_equal(SRC_FILES.size, zfRead.entries.length)
-    SRC_FILES.each_with_index { |a, i|
-      assert_equal(a.last, zfRead.entries[i].name)
-      AssertEntry.assert_contents(a.first,
-                                  zfRead.get_input_stream(a.last) { |zis| zis.read })
-    }
-  end
-
-  # Ensure that names are treated case insensitively when adding files and +case_insensitive_match = false+
-  def test_add_case_insensitive
-    ::Zip.case_insensitive_match = true
-
-    SRC_FILES.each { |fn, _en| assert(::File.exist?(fn)) }
-    zf = ::Zip::File.new(EMPTY_FILENAME, ::Zip::File::CREATE)
-
-    assert_raises Zip::EntryExistsError do
-      SRC_FILES.each { |fn, en| zf.add(en, fn) }
-    end
-  end
-
-  # Ensure that names are treated case insensitively when reading files and +case_insensitive_match = true+
-  def test_add_case_sensitive_read_case_insensitive
-    ::Zip.case_insensitive_match = false
-
-    SRC_FILES.each { |fn, _en| assert(::File.exist?(fn)) }
-    zf = ::Zip::File.new(EMPTY_FILENAME, ::Zip::File::CREATE)
-
-    SRC_FILES.each { |fn, en| zf.add(en, fn) }
-    zf.close
-
-    ::Zip.case_insensitive_match = true
-
-    zfRead = ::Zip::File.new(EMPTY_FILENAME)
-    assert_equal(SRC_FILES.collect { |_fn, en| en.downcase }.uniq.size, zfRead.entries.length)
-    assert_equal(SRC_FILES.last.last.downcase, zfRead.entries.first.name.downcase)
-    AssertEntry.assert_contents(SRC_FILES.last.first,
-                                zfRead.get_input_stream(SRC_FILES.last.last) { |zis| zis.read })
-  end
-
-  private
-
-  def assert_contains(zf, entryName, filename = entryName)
-    assert(zf.entries.detect { |e| e.name == entryName } != nil, "entry #{entryName} not in #{zf.entries.join(', ')} in zip file #{zf}")
-    assert_entry_contents(zf, entryName, filename) if File.exist?(filename)
-  end
-end