rubyzip 1.2.2 → 2.1.0

data/lib/zip/file.rb

@@ -51,50 +51,74 @@ module Zip
     DATA_BUFFER_SIZE     = 8192
     IO_METHODS           = [:tell, :seek, :read, :close]
 
+    DEFAULT_OPTIONS = {
+      restore_ownership:   false,
+      restore_permissions: false,
+      restore_times:       false
+    }.freeze
+
     attr_reader :name
 
-    # default -> false
+    # default -> false.
     attr_accessor :restore_ownership
-    # default -> false
+
+    # default -> false, but will be set to true in a future version.
     attr_accessor :restore_permissions
-    # default -> true
+
+    # default -> false, but will be set to true in a future version.
     attr_accessor :restore_times
+
     # Returns the zip files comment, if it has one
     attr_accessor :comment
 
     # Opens a zip archive. Pass true as the second parameter to create
     # a new archive if it doesn't exist already.
-    def initialize(file_name, create = false, buffer = false, options = {})
+    def initialize(path_or_io, create = false, buffer = false, options = {})
       super()
-      @name    = file_name
+      options = DEFAULT_OPTIONS.merge(options)
+      @name    = path_or_io.respond_to?(:path) ? path_or_io.path : path_or_io
       @comment = ''
       @create  = create ? true : false # allow any truthy value to mean true
-      if !buffer && ::File.size?(file_name)
+
+      if ::File.size?(@name.to_s)
+        # There is a file, which exists, that is associated with this zip.
         @create = false
-        @file_permissions = ::File.stat(file_name).mode
-        ::File.open(name, 'rb') do |f|
-          read_from_stream(f)
+        @file_permissions = ::File.stat(@name).mode
+
+        if buffer
+          read_from_stream(path_or_io)
+        else
+          ::File.open(@name, 'rb') do |f|
+            read_from_stream(f)
+          end
         end
+      elsif buffer && path_or_io.size > 0
+        # This zip is probably a non-empty StringIO.
+        read_from_stream(path_or_io)
       elsif @create
+        # This zip is completely new/empty and is to be created.
         @entry_set = EntrySet.new
-      elsif ::File.zero?(file_name)
-        raise Error, "File #{file_name} has zero size. Did you mean to pass the create flag?"
+      elsif ::File.zero?(@name)
+        # A file exists, but it is empty.
+        raise Error, "File #{@name} has zero size. Did you mean to pass the create flag?"
       else
-        raise Error, "File #{file_name} not found"
+        # Everything is wrong.
+        raise Error, "File #{@name} not found"
       end
+
       @stored_entries      = @entry_set.dup
       @stored_comment      = @comment
-      @restore_ownership   = options[:restore_ownership]    || false
-      @restore_permissions = options[:restore_permissions]  || true
-      @restore_times       = options[:restore_times]        || true
+      @restore_ownership   = options[:restore_ownership]
+      @restore_permissions = options[:restore_permissions]
+      @restore_times       = options[:restore_times]
     end
 
     class << self
-      # Same as #new. If a block is passed the ZipFile 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)
-        zf = ::Zip::File.new(file_name, create)
+      # 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, false, options)
         return zf unless block_given?
         begin
           yield zf
@@ -119,17 +143,16 @@ module Zip
         unless IO_METHODS.map { |method| io.respond_to?(method) }.all? || io.is_a?(String)
           raise "Zip::File.open_buffer expects a String or IO-like argument (responds to #{IO_METHODS.join(', ')}). Found: #{io.class}"
         end
-        if io.is_a?(::String)
-          require 'stringio'
-          io = ::StringIO.new(io)
-        elsif io.respond_to?(:binmode)
-          # https://github.com/rubyzip/rubyzip/issues/119
-          io.binmode
-        end
+
+        io = ::StringIO.new(io) if io.is_a?(::String)
+
+        # https://github.com/rubyzip/rubyzip/issues/119
+        io.binmode if io.respond_to?(:binmode)
+
         zf = ::Zip::File.new(io, true, true, options)
-        zf.read_from_stream(io)
         return zf unless block_given?
         yield zf
+
         begin
           zf.write_buffer(io)
         rescue IOError => e
@@ -274,6 +297,13 @@ module Zip
       @entry_set << new_entry
     end
 
+    # Convenience method for adding the contents of a file to the archive
+    # in Stored format (uncompressed)
+    def add_stored(entry, src_path, &continue_on_exists_proc)
+      entry = ::Zip::Entry.new(@name, entry.to_s, nil, nil, nil, nil, ::Zip::Entry::STORED)
+      add(entry, src_path, &continue_on_exists_proc)
+    end
+
     # Removes the specified entry.
     def remove(entry)
       @entry_set.delete(get_entry(entry))
@@ -346,7 +376,13 @@ module Zip
     # Searches for entry with the specified name. Returns nil if
     # no entry is found. See also get_entry
     def find_entry(entry_name)
-      @entry_set.find_entry(entry_name)
+      selected_entry = @entry_set.find_entry(entry_name)
+      return if selected_entry.nil?
+
+      selected_entry.restore_ownership   = @restore_ownership
+      selected_entry.restore_permissions = @restore_permissions
+      selected_entry.restore_times       = @restore_times
+      selected_entry
     end
 
     # Searches for entries given a glob
@@ -358,10 +394,8 @@ module Zip
     # if no entry is found.
     def get_entry(entry)
       selected_entry = find_entry(entry)
-      raise Errno::ENOENT, entry unless selected_entry
-      selected_entry.restore_ownership   = @restore_ownership
-      selected_entry.restore_permissions = @restore_permissions
-      selected_entry.restore_times       = @restore_times
+      raise Errno::ENOENT, entry if selected_entry.nil?
+
       selected_entry
     end
 

data/lib/zip/inflater.rb

@@ -3,7 +3,7 @@ module Zip
     def initialize(input_stream, decrypter = NullDecrypter.new)
       super(input_stream)
       @zlib_inflater           = ::Zlib::Inflate.new(-Zlib::MAX_WBITS)
-      @output_buffer           = ''
+      @output_buffer           = ''.dup
       @has_returned_empty_string = false
       @decrypter = decrypter
     end

data/lib/zip/input_stream.rb

@@ -103,7 +103,7 @@ module Zip
       end
 
       def open_buffer(filename_or_io, offset = 0)
-        puts 'open_buffer is deprecated!!! Use open instead!'
+        warn 'open_buffer is deprecated!!! Use open instead!'
         open(filename_or_io, offset)
       end
     end

data/lib/zip/streamable_stream.rb

@@ -2,12 +2,7 @@ module Zip
   class StreamableStream < DelegateClass(Entry) # nodoc:all
     def initialize(entry)
       super(entry)
-      dirname = if zipfile.is_a?(::String)
-                  ::File.dirname(zipfile)
-                else
-                  nil
-                end
-      @temp_file = Tempfile.new(::File.basename(name), dirname)
+      @temp_file = Tempfile.new(::File.basename(name))
       @temp_file.binmode
     end
 

data/lib/zip/version.rb

@@ -1,3 +1,3 @@
 module Zip
-  VERSION = '1.2.2'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubyzip
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Alexander Simonov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-31 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -134,83 +134,15 @@ 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/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: {}
+metadata:
+  bug_tracker_uri: https://github.com/rubyzip/rubyzip/issues
+  changelog_uri: https://github.com/rubyzip/rubyzip/blob/v2.1.0/Changelog.md
+  documentation_uri: https://www.rubydoc.info/gems/rubyzip/2.1.0
+  source_code_uri: https://github.com/rubyzip/rubyzip/tree/v2.1.0
+  wiki_uri: https://github.com/rubyzip/rubyzip/wiki
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -219,89 +151,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: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 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/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