rubyzip 1.2.0 → 1.3.0

data/test/file_test.rb

@@ -2,6 +2,7 @@ require 'test_helper'
 
 class ZipFileTest < MiniTest::Test
   include CommonZipFileFixture
+  include ZipEntryData
 
   OK_DELETE_FILE = 'test/data/generated/okToDelete.txt'
   OK_DELETE_MOVED_FILE = 'test/data/generated/okToDeleteMoved.txt'
@@ -40,6 +41,26 @@ class ZipFileTest < MiniTest::Test
     assert_equal(2, zfRead.entries.length)
   end
 
+  def test_create_from_scratch_with_old_create_parameter
+    comment = 'a short comment'
+
+    zf = ::Zip::File.new(EMPTY_FILENAME, 1)
+    zf.get_output_stream('myFile') { |os| os.write 'myFile contains just this' }
+    zf.mkdir('dir1')
+    zf.comment = comment
+    zf.close
+
+    zfRead = ::Zip::File.new(EMPTY_FILENAME)
+    assert_equal(comment, zfRead.comment)
+    assert_equal(2, zfRead.entries.length)
+  end
+
+  def test_get_input_stream_stored_with_gpflag_bit3
+    ::Zip::File.open('test/data/gpbit3stored.zip') do |zf|
+      assert_equal("foo\n", zf.read("foo.txt"))
+    end
+  end
+
   def test_get_output_stream
     entryCount = nil
     ::Zip::File.open(TEST_ZIP.zip_name) do |zf|
@@ -56,7 +77,7 @@ class ZipFileTest < MiniTest::Test
       assert_equal(entryCount + 1, zf.size)
       assert_equal('Putting stuff in data/generated/empty.txt', zf.read('test/data/generated/empty.txt'))
 
-      custom_entry_args = [ZipEntryTest::TEST_COMMENT, ZipEntryTest::TEST_EXTRA, ZipEntryTest::TEST_COMPRESSED_SIZE, ZipEntryTest::TEST_CRC, ::Zip::Entry::STORED, ZipEntryTest::TEST_SIZE, ZipEntryTest::TEST_TIME]
+      custom_entry_args = [TEST_COMMENT, TEST_EXTRA, TEST_COMPRESSED_SIZE, TEST_CRC, ::Zip::Entry::STORED, TEST_SIZE, TEST_TIME]
       zf.get_output_stream('entry_with_custom_args.txt', nil, *custom_entry_args) do |os|
         os.write 'Some data'
       end
@@ -82,6 +103,13 @@ class ZipFileTest < MiniTest::Test
     end
   end
 
+  def test_open_buffer_with_string
+    string = File.read('test/data/rubycode.zip')
+    ::Zip::File.open_buffer string do |zf|
+      assert zf.entries.map { |e| e.name }.include?('zippedruby1.rb')
+    end
+  end
+
   def test_open_buffer_with_stringio
     string_io = StringIO.new File.read('test/data/rubycode.zip')
     ::Zip::File.open_buffer string_io do |zf|
@@ -89,6 +117,63 @@ class ZipFileTest < MiniTest::Test
     end
   end
 
+  def test_close_buffer_with_stringio
+    string_io = StringIO.new File.read('test/data/rubycode.zip')
+    zf = ::Zip::File.open_buffer string_io
+    assert_nil zf.close
+  end
+
+  def test_open_buffer_no_op_does_not_change_file
+    Dir.mktmpdir do |tmp|
+      test_zip = File.join(tmp, 'test.zip')
+      FileUtils.cp 'test/data/rubycode.zip', test_zip
+
+      # Note: this may change the file if it is opened with r+b instead of rb.
+      # The 'extra fields' in this particular zip file get reordered.
+      File.open(test_zip, 'rb') do |file|
+        Zip::File.open_buffer(file) do |zf|
+          nil # do nothing
+        end
+      end
+
+      assert_equal \
+        File.binread('test/data/rubycode.zip'),
+        File.binread(test_zip)
+    end
+  end
+
+  def test_open_buffer_close_does_not_change_file
+    Dir.mktmpdir do |tmp|
+      test_zip = File.join(tmp, 'test.zip')
+      FileUtils.cp 'test/data/rubycode.zip', test_zip
+
+      File.open(test_zip, 'rb') do |file|
+        zf = Zip::File.open_buffer(file)
+        refute zf.commit_required?
+        assert_nil zf.close
+      end
+
+      assert_equal \
+        File.binread('test/data/rubycode.zip'),
+        File.binread(test_zip)
+    end
+  end
+
+  def test_open_buffer_with_io_and_block
+    File.open('test/data/rubycode.zip') do |io|
+      io.set_encoding(Encoding::BINARY) # not strictly required but can be set
+      Zip::File.open_buffer(io) do |zip_io|
+        # left empty on purpose
+      end
+    end
+  end
+
+  def test_open_buffer_without_block
+    string_io = StringIO.new File.read('test/data/rubycode.zip')
+    zf = ::Zip::File.open_buffer string_io
+    assert zf.entries.map { |e| e.name }.include?('zippedruby1.rb')
+  end
+
   def test_cleans_up_tempfiles_after_close
     zf = ::Zip::File.new(EMPTY_FILENAME, ::Zip::File::CREATE)
     zf.get_output_stream('myFile') do |os|
@@ -119,17 +204,37 @@ class ZipFileTest < MiniTest::Test
                                 zfRead.get_input_stream(entryName) { |zis| zis.read })
   end
 
+  def test_add_stored
+    srcFile = 'test/data/file2.txt'
+    entryName = 'newEntryName.rb'
+    assert(::File.exist?(srcFile))
+    zf = ::Zip::File.new(EMPTY_FILENAME, ::Zip::File::CREATE)
+    zf.add_stored(entryName, srcFile)
+    zf.close
+
+    zfRead = ::Zip::File.new(EMPTY_FILENAME)
+    entry = zfRead.entries.first
+    assert_equal('', zfRead.comment)
+    assert_equal(1, zfRead.entries.length)
+    assert_equal(entryName, entry.name)
+    assert_equal(File.size(srcFile), entry.size)
+    assert_equal(entry.size, entry.compressed_size)
+    assert_equal(::Zip::Entry::STORED, entry.compression_method)
+    AssertEntry.assert_contents(srcFile,
+                                zfRead.get_input_stream(entryName) { |zis| zis.read })
+  end
+
   def test_recover_permissions_after_add_files_to_archive
     srcZip = TEST_ZIP.zip_name
-    ::File.chmod(0664, srcZip)
+    ::File.chmod(0o664, srcZip)
     srcFile = 'test/data/file2.txt'
     entryName = 'newEntryName.rb'
-    assert_equal(::File.stat(srcZip).mode, 0100664)
+    assert_equal(::File.stat(srcZip).mode, 0o100664)
     assert(::File.exist?(srcZip))
     zf = ::Zip::File.new(srcZip, ::Zip::File::CREATE)
     zf.add(entryName, srcFile)
     zf.close
-    assert_equal(::File.stat(srcZip).mode, 0100664)
+    assert_equal(::File.stat(srcZip).mode, 0o100664)
   end
 
   def test_add_existing_entry_name
@@ -213,7 +318,7 @@ class ZipFileTest < MiniTest::Test
       zf.mkdir('test')
       arr << 'test/'
       arr_renamed << 'Ztest/'
-      %w(a b c d).each do |f|
+      %w[a b c d].each do |f|
         zf.get_output_stream("test/#{f}") { |file| file.puts 'aaaa' }
         arr << "test/#{f}"
         arr_renamed << "Ztest/#{f}"
@@ -308,7 +413,7 @@ class ZipFileTest < MiniTest::Test
 
   def test_replace_non_entry
     entryToReplace = 'nonExistingEntryname'
-    ::Zip::File.open(TEST_ZIP.zip_name) do  |zf|
+    ::Zip::File.open(TEST_ZIP.zip_name) do |zf|
       assert_raises(Errno::ENOENT) { zf.replace(entryToReplace, 'test/data/file2.txt') }
     end
   end
@@ -326,7 +431,7 @@ class ZipFileTest < MiniTest::Test
     zfRead.close
 
     zf.close
-    res = system("unzip -t #{TEST_ZIP.zip_name}")
+    res = system("unzip -tqq #{TEST_ZIP.zip_name}")
     assert_equal(res, true)
   end
 
@@ -342,7 +447,7 @@ class ZipFileTest < MiniTest::Test
     zf2 = ::Zip::File.open(filename)
     assert(zf2.entries.detect { |e| e.name == 'test1.txt' } != nil)
     assert(zf2.entries.detect { |e| e.name == 'test2.txt' } != nil)
-    res = system("unzip -t #{filename}")
+    res = system("unzip -tqq #{filename}")
     assert_equal(res, true)
   end
 
@@ -413,7 +518,6 @@ class ZipFileTest < MiniTest::Test
       filename_to_remove = originalEntries.map(&:to_s).find { |name| name.match('longBinary') }
       zf.remove(filename_to_remove)
       assert_not_contains(zf, filename_to_remove)
-
     ensure
       zf.close
     end
@@ -528,9 +632,8 @@ class ZipFileTest < MiniTest::Test
   end
 
   def test_empty_zip
-    puts `touch empty.zip`
     assert_raises(::Zip::Error) do
-      ::Zip::File.open('empty.zip')
+      ::Zip::File.open(TestFiles::NULL_FILE)
     end
   end
 
@@ -538,7 +641,7 @@ class ZipFileTest < MiniTest::Test
     entry_count = 0
     File.open 'test/data/oddExtraField.zip', 'rb' do |zip_io|
       Zip::File.open_buffer zip_io.read do |zip|
-        zip.each do |zip_entry|
+        zip.each do |_zip_entry|
           entry_count += 1
         end
       end

data/test/filesystem/dir_iterator_test.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 require 'zip/filesystem'
 
 class ZipFsDirIteratorTest < MiniTest::Test
-  FILENAME_ARRAY = %w(f1 f2 f3 f4 f5 f6)
+  FILENAME_ARRAY = %w[f1 f2 f3 f4 f5 f6]
 
   def setup
     @dirIt = ::Zip::FileSystem::ZipFsDirIterator.new(FILENAME_ARRAY)

data/test/filesystem/directory_test.rb

@@ -3,6 +3,7 @@ require 'zip/filesystem'
 
 class ZipFsDirectoryTest < MiniTest::Test
   TEST_ZIP = 'test/data/generated/zipWithDirs_copy.zip'
+  GLOB_TEST_ZIP = 'test/data/globTest.zip'
 
   def setup
     FileUtils.cp('test/data/zipWithDirs.zip', TEST_ZIP)
@@ -51,10 +52,10 @@ class ZipFsDirectoryTest < MiniTest::Test
         zf.dir.chdir 'file1'
       end
 
-      assert_equal(%w(dir1 dir2 file1).sort, zf.dir.entries('.').sort)
+      assert_equal(%w[dir1 dir2 file1].sort, zf.dir.entries('.').sort)
       zf.dir.chdir 'dir1'
       assert_equal('/dir1', zf.dir.pwd)
-      assert_equal(%w(dir11 file11 file12), zf.dir.entries('.').sort)
+      assert_equal(%w[dir11 file11 file12], zf.dir.entries('.').sort)
 
       zf.dir.chdir '../dir2/dir21'
       assert_equal('/dir2/dir21', zf.dir.pwd)
@@ -77,11 +78,11 @@ class ZipFsDirectoryTest < MiniTest::Test
 
       entries = []
       zf.dir.foreach('.') { |e| entries << e }
-      assert_equal(%w(dir1 dir2 file1).sort, entries.sort)
+      assert_equal(%w[dir1 dir2 file1].sort, entries.sort)
 
       entries = []
       zf.dir.foreach('dir1') { |e| entries << e }
-      assert_equal(%w(dir11 file11 file12), entries.sort)
+      assert_equal(%w[dir11 file11 file12], entries.sort)
     end
   end
 
@@ -93,11 +94,28 @@ class ZipFsDirectoryTest < MiniTest::Test
     end
   end
 
-  # Globbing not supported yet
-  # def test_glob
-  #  # test alias []-operator too
-  #  fail "implement test"
-  # end
+  def test_glob
+    globbed_files = [
+      'globTest/foo/bar/baz/foo.txt',
+      'globTest/foo.txt',
+      'globTest/food.txt'
+    ]
+
+    ::Zip::File.open(GLOB_TEST_ZIP) do |zf|
+      zf.dir.glob('**/*.txt') do |f|
+        assert globbed_files.include?(f.name)
+      end
+
+      zf.dir.glob('globTest/foo/**/*.txt') do |f|
+        assert_equal globbed_files[0], f.name
+      end
+
+      zf.dir.chdir('globTest/foo')
+      zf.dir.glob('**/*.txt') do |f|
+        assert_equal globbed_files[0], f.name
+      end
+    end
+  end
 
   def test_open_new
     ::Zip::File.open(TEST_ZIP) do |zf|
@@ -110,11 +128,11 @@ class ZipFsDirectoryTest < MiniTest::Test
       end
 
       d = zf.dir.new('.')
-      assert_equal(%w(file1 dir1 dir2).sort, d.entries.sort)
+      assert_equal(%w[file1 dir1 dir2].sort, d.entries.sort)
       d.close
 
       zf.dir.open('dir1') do |dir|
-        assert_equal(%w(dir11 file11 file12).sort, dir.entries.sort)
+        assert_equal(%w[dir11 file11 file12].sort, dir.entries.sort)
       end
     end
   end

data/test/filesystem/file_mutating_test.rb

@@ -7,8 +7,7 @@ class ZipFsFileMutatingTest < MiniTest::Test
     FileUtils.cp('test/data/zipWithDirs.zip', TEST_ZIP)
   end
 
-  def teardown
-  end
+  def teardown; end
 
   def test_delete
     do_test_delete_or_unlink(:delete)
@@ -51,11 +50,11 @@ class ZipFsFileMutatingTest < MiniTest::Test
 
   def test_chmod
     ::Zip::File.open(TEST_ZIP) do |zf|
-      zf.file.chmod(0765, 'file1')
+      zf.file.chmod(0o765, 'file1')
     end
 
     ::Zip::File.open(TEST_ZIP) do |zf|
-      assert_equal(0100765,  zf.file.stat('file1').mode)
+      assert_equal(0o100765, zf.file.stat('file1').mode)
     end
   end
 

data/test/filesystem/file_nonmutating_test.rb

@@ -14,11 +14,11 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
 
   def test_umask
     assert_equal(::File.umask, @zip_file.file.umask)
-    @zip_file.file.umask(0006)
+    @zip_file.file.umask(0o006)
   end
 
   def test_exists?
-    assert(! @zip_file.file.exists?('notAFile'))
+    assert(!@zip_file.file.exists?('notAFile'))
     assert(@zip_file.file.exists?('file1'))
     assert(@zip_file.file.exists?('dir1'))
     assert(@zip_file.file.exists?('dir1/'))
@@ -103,24 +103,24 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
   end
 
   def test_size?
-    assert_equal(nil, @zip_file.file.size?('notAFile'))
+    assert_nil(@zip_file.file.size?('notAFile'))
     assert_equal(72, @zip_file.file.size?('file1'))
-    assert_equal(nil, @zip_file.file.size?('dir2/dir21'))
+    assert_nil(@zip_file.file.size?('dir2/dir21'))
 
     assert_equal(72, @zip_file.file.stat('file1').size?)
-    assert_equal(nil, @zip_file.file.stat('dir2/dir21').size?)
+    assert_nil(@zip_file.file.stat('dir2/dir21').size?)
   end
 
   def test_file?
     assert(@zip_file.file.file?('file1'))
     assert(@zip_file.file.file?('dir2/file21'))
-    assert(! @zip_file.file.file?('dir1'))
-    assert(! @zip_file.file.file?('dir1/dir11'))
+    assert(!@zip_file.file.file?('dir1'))
+    assert(!@zip_file.file.file?('dir1/dir11'))
 
     assert(@zip_file.file.stat('file1').file?)
     assert(@zip_file.file.stat('dir2/file21').file?)
-    assert(! @zip_file.file.stat('dir1').file?)
-    assert(! @zip_file.file.stat('dir1/dir11').file?)
+    assert(!@zip_file.file.stat('dir1').file?)
+    assert(!@zip_file.file.stat('dir1/dir11').file?)
   end
 
   include ExtraAssertions
@@ -160,15 +160,15 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
   end
 
   def assert_always_false(operation)
-    assert(! @zip_file.file.send(operation, 'noSuchFile'))
-    assert(! @zip_file.file.send(operation, 'file1'))
-    assert(! @zip_file.file.send(operation, 'dir1'))
-    assert(! @zip_file.file.stat('file1').send(operation))
-    assert(! @zip_file.file.stat('dir1').send(operation))
+    assert(!@zip_file.file.send(operation, 'noSuchFile'))
+    assert(!@zip_file.file.send(operation, 'file1'))
+    assert(!@zip_file.file.send(operation, 'dir1'))
+    assert(!@zip_file.file.stat('file1').send(operation))
+    assert(!@zip_file.file.stat('dir1').send(operation))
   end
 
   def assert_true_if_entry_exists(operation)
-    assert(! @zip_file.file.send(operation, 'noSuchFile'))
+    assert(!@zip_file.file.send(operation, 'noSuchFile'))
     assert(@zip_file.file.send(operation, 'file1'))
     assert(@zip_file.file.send(operation, 'dir1'))
     assert(@zip_file.file.stat('file1').send(operation))
@@ -221,15 +221,15 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
   end
 
   def test_directory?
-    assert(! @zip_file.file.directory?('notAFile'))
-    assert(! @zip_file.file.directory?('file1'))
-    assert(! @zip_file.file.directory?('dir1/file11'))
+    assert(!@zip_file.file.directory?('notAFile'))
+    assert(!@zip_file.file.directory?('file1'))
+    assert(!@zip_file.file.directory?('dir1/file11'))
     assert(@zip_file.file.directory?('dir1'))
     assert(@zip_file.file.directory?('dir1/'))
     assert(@zip_file.file.directory?('dir2/dir21'))
 
-    assert(! @zip_file.file.stat('file1').directory?)
-    assert(! @zip_file.file.stat('dir1/file11').directory?)
+    assert(!@zip_file.file.stat('file1').directory?)
+    assert(!@zip_file.file.stat('dir1/file11').directory?)
     assert(@zip_file.file.stat('dir1').directory?)
     assert(@zip_file.file.stat('dir1/').directory?)
     assert(@zip_file.file.stat('dir2/dir21').directory?)
@@ -243,8 +243,8 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
   end
 
   def test_zero?
-    assert(! @zip_file.file.zero?('notAFile'))
-    assert(! @zip_file.file.zero?('file1'))
+    assert(!@zip_file.file.zero?('notAFile'))
+    assert(!@zip_file.file.zero?('file1'))
     assert(@zip_file.file.zero?('dir1'))
     blockCalled = false
     ::Zip::File.open('test/data/generated/5entry.zip') do |zf|
@@ -253,7 +253,7 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
     end
     assert(blockCalled)
 
-    assert(! @zip_file.file.stat('file1').zero?)
+    assert(!@zip_file.file.stat('file1').zero?)
     assert(@zip_file.file.stat('dir1').zero?)
     blockCalled = false
     ::Zip::File.open('test/data/generated/5entry.zip') do |zf|
@@ -309,7 +309,7 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
   end
 
   def test_readable?
-    assert(! @zip_file.file.readable?('noSuchFile'))
+    assert(!@zip_file.file.readable?('noSuchFile'))
     assert(@zip_file.file.readable?('file1'))
     assert(@zip_file.file.readable?('dir1'))
     assert(@zip_file.file.stat('file1').readable?)
@@ -317,7 +317,7 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
   end
 
   def test_readable_real?
-    assert(! @zip_file.file.readable_real?('noSuchFile'))
+    assert(!@zip_file.file.readable_real?('noSuchFile'))
     assert(@zip_file.file.readable_real?('file1'))
     assert(@zip_file.file.readable_real?('dir1'))
     assert(@zip_file.file.stat('file1').readable_real?)
@@ -325,7 +325,7 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
   end
 
   def test_writable?
-    assert(! @zip_file.file.writable?('noSuchFile'))
+    assert(!@zip_file.file.writable?('noSuchFile'))
     assert(@zip_file.file.writable?('file1'))
     assert(@zip_file.file.writable?('dir1'))
     assert(@zip_file.file.stat('file1').writable?)
@@ -333,7 +333,7 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
   end
 
   def test_writable_real?
-    assert(! @zip_file.file.writable_real?('noSuchFile'))
+    assert(!@zip_file.file.writable_real?('noSuchFile'))
     assert(@zip_file.file.writable_real?('file1'))
     assert(@zip_file.file.writable_real?('dir1'))
     assert(@zip_file.file.stat('file1').writable_real?)
@@ -341,18 +341,18 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
   end
 
   def test_executable?
-    assert(! @zip_file.file.executable?('noSuchFile'))
-    assert(! @zip_file.file.executable?('file1'))
+    assert(!@zip_file.file.executable?('noSuchFile'))
+    assert(!@zip_file.file.executable?('file1'))
     assert(@zip_file.file.executable?('dir1'))
-    assert(! @zip_file.file.stat('file1').executable?)
+    assert(!@zip_file.file.stat('file1').executable?)
     assert(@zip_file.file.stat('dir1').executable?)
   end
 
   def test_executable_real?
-    assert(! @zip_file.file.executable_real?('noSuchFile'))
-    assert(! @zip_file.file.executable_real?('file1'))
+    assert(!@zip_file.file.executable_real?('noSuchFile'))
+    assert(!@zip_file.file.executable_real?('file1'))
     assert(@zip_file.file.executable_real?('dir1'))
-    assert(! @zip_file.file.stat('file1').executable_real?)
+    assert(!@zip_file.file.stat('file1').executable_real?)
     assert(@zip_file.file.stat('dir1').executable_real?)
   end
 
@@ -455,7 +455,7 @@ class ZipFsFileNonmutatingTest < MiniTest::Test
       zf.glob('**/foo.txt') do |match|
         results << "<#{match.class.name}: #{match}>"
       end
-      assert((!results.empty?), 'block not run, or run out of context')
+      assert(!results.empty?, 'block not run, or run out of context')
       assert_equal 2, results.size
       assert_operator results, :include?, '<Zip::Entry: globTest/foo.txt>'
       assert_operator results, :include?, '<Zip::Entry: globTest/foo/bar/baz/foo.txt>'