rubyzip 0.9.9 → 1.3.0

data/samples/{gtkRubyzip.rb → gtk_ruby_zip.rb}

@@ -1,17 +1,17 @@
 #!/usr/bin/env ruby
 
-$: << "../lib"
+$: << '../lib'
 
 $VERBOSE = true
 
 require 'gtk'
-require 'zip/zip'
+require 'zip'
 
 class MainApp < Gtk::Window
   def initialize
     super()
     set_usize(400, 256)
-    set_title("rubyzip")
+    set_title('rubyzip')
     signal_connect(Gtk::Window::SIGNAL_DESTROY) { Gtk.main_quit }
 
     box = Gtk::VBox.new(false, 0)
@@ -19,26 +19,25 @@ class MainApp < Gtk::Window
 
     @zipfile = nil
     @buttonPanel = ButtonPanel.new
-    @buttonPanel.openButton.signal_connect(Gtk::Button::SIGNAL_CLICKED) {
+    @buttonPanel.openButton.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
       show_file_selector
-    }
-    @buttonPanel.extractButton.signal_connect(Gtk::Button::SIGNAL_CLICKED) {
-      puts "Not implemented!"
-    }
+    end
+    @buttonPanel.extractButton.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
+      puts 'Not implemented!'
+    end
     box.pack_start(@buttonPanel, false, false, 0)
-    
+
     sw = Gtk::ScrolledWindow.new
     sw.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC)
     box.pack_start(sw, true, true, 0)
 
-    @clist = Gtk::CList.new(["Name", "Size", "Compression"])
+    @clist = Gtk::CList.new(%w[Name Size Compression])
     @clist.set_selection_mode(Gtk::SELECTION_BROWSE)
     @clist.set_column_width(0, 120)
     @clist.set_column_width(1, 120)
-    @clist.signal_connect(Gtk::CList::SIGNAL_SELECT_ROW) {
-      |w, row, column, event|
+    @clist.signal_connect(Gtk::CList::SIGNAL_SELECT_ROW) do |_w, row, _column, _event|
       @selected_row = row
-    }
+    end
     sw.add(@clist)
   end
 
@@ -48,38 +47,37 @@ class MainApp < Gtk::Window
       super
       set_layout(Gtk::BUTTONBOX_START)
       set_spacing(0)
-      @openButton = Gtk::Button.new("Open archive")
-      @extractButton = Gtk::Button.new("Extract entry")
+      @openButton = Gtk::Button.new('Open archive')
+      @extractButton = Gtk::Button.new('Extract entry')
       pack_start(@openButton)
       pack_start(@extractButton)
     end
   end
 
   def show_file_selector
-    @fileSelector = Gtk::FileSelection.new("Open zip file")
+    @fileSelector = Gtk::FileSelection.new('Open zip file')
     @fileSelector.show
-    @fileSelector.ok_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) {
+    @fileSelector.ok_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
       open_zip(@fileSelector.filename)
       @fileSelector.destroy
-    }
-    @fileSelector.cancel_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) {
+    end
+    @fileSelector.cancel_button.signal_connect(Gtk::Button::SIGNAL_CLICKED) do
       @fileSelector.destroy
-    }
+    end
   end
 
   def open_zip(filename)
-    @zipfile = Zip::ZipFile.open(filename)
+    @zipfile = Zip::File.open(filename)
     @clist.clear
-    @zipfile.each { 
-      |entry|
-      @clist.append([ entry.name, 
-		      entry.size.to_s, 
-		      (100.0*entry.compressedSize/entry.size).to_s+"%" ])
-    }
+    @zipfile.each do |entry|
+      @clist.append([entry.name,
+                     entry.size.to_s,
+                     (100.0 * entry.compressedSize / entry.size).to_s + '%'])
+    end
   end
 end
 
-mainApp = MainApp.new()
+mainApp = MainApp.new
 
 mainApp.show_all
 

data/samples/qtzip.rb

@@ -1,22 +1,18 @@
 #!/usr/bin/env ruby
 
-$VERBOSE=true
+$VERBOSE = true
 
-$: << "../lib"
+$: << '../lib'
 
 require 'Qt'
 system('rbuic -o zipdialogui.rb zipdialogui.ui')
 require 'zipdialogui.rb'
-require 'zip/zip'
-
-
+require 'zip'
 
 a = Qt::Application.new(ARGV)
 
 class ZipDialog < ZipDialogUI
-
-
-  def initialize()
+  def initialize
     super()
     connect(child('add_button'), SIGNAL('clicked()'),
             self, SLOT('add_files()'))
@@ -25,23 +21,21 @@ class ZipDialog < ZipDialogUI
   end
 
   def zipfile(&proc)
-    Zip::ZipFile.open(@zip_filename, &proc)
+    Zip::File.open(@zip_filename, &proc)
   end
 
   def each(&proc)
-    Zip::ZipFile.foreach(@zip_filename, &proc)
+    Zip::File.foreach(@zip_filename, &proc)
   end
-  
-  def refresh()
-    lv = child("entry_list_view")
+
+  def refresh
+    lv = child('entry_list_view')
     lv.clear
-    each { 
-      |e|
+    each do |e|
       lv.insert_item(Qt::ListViewItem.new(lv, e.name, e.size.to_s))
-    }
+    end
   end
 
-    
   def load(zipfile)
     @zip_filename = zipfile
     refresh
@@ -49,13 +43,11 @@ class ZipDialog < ZipDialogUI
 
   def add_files
     l = Qt::FileDialog.getOpenFileNames(nil, nil, self)
-    zipfile { 
-      |zf| 
-      l.each { 
-        |path|
+    zipfile do |zf|
+      l.each do |path|
         zf.add(File.basename(path), path)
-      }
-    }
+      end
+    end
     refresh
   end
 
@@ -63,7 +55,7 @@ class ZipDialog < ZipDialogUI
     selected_items = []
     unselected_items = []
     lv_item = entry_list_view.first_child
-    while (lv_item)
+    while lv_item
       if entry_list_view.is_selected(lv_item)
         selected_items << lv_item.text(0)
       else
@@ -73,22 +65,21 @@ class ZipDialog < ZipDialogUI
     end
     puts "selected_items.size = #{selected_items.size}"
     puts "unselected_items.size = #{unselected_items.size}"
-    items = selected_items.size > 0 ? selected_items : unselected_items
+    items = !selected_items.empty? ? selected_items : unselected_items
     puts "items.size = #{items.size}"
 
     d = Qt::FileDialog.get_existing_directory(nil, self)
-    if (!d)
-      puts "No directory chosen"
+    if !d
+      puts 'No directory chosen'
     else
       zipfile { |zf| items.each { |e| zf.extract(e, File.join(d, e)) } }
     end
-    
   end
 
   slots 'add_files()', 'extract_files()'
 end
 
-if !ARGV[0]
+unless ARGV[0]
   puts "usage: #{$0} zipname"
   exit
 end
@@ -97,5 +88,5 @@ zd = ZipDialog.new
 zd.load(ARGV[0])
 
 a.mainWidget = zd
-zd.show()
-a.exec()
+zd.show
+a.exec

data/samples/write_simple.rb

@@ -1,13 +1,12 @@
-#!/usr/bin/env ruby
-
-$: << "../lib"
-
-require 'zip/zip'
-
-include Zip
-
-ZipOutputStream.open('simple.zip') {
-  |zos|
-  ze = zos.put_next_entry 'entry.txt'
-  zos.puts "Hello world"
-}
+#!/usr/bin/env ruby
+
+$: << '../lib'
+
+require 'zip'
+
+include Zip
+
+OutputStream.open('simple.zip') do |zos|
+  zos.put_next_entry 'entry.txt'
+  zos.puts 'Hello world'
+end

data/samples/zipfind.rb

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

data/test/basic_zip_file_test.rb

@@ -0,0 +1,60 @@
+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

@@ -0,0 +1,69 @@
+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

data/test/central_directory_entry_test.rb

@@ -0,0 +1,69 @@
+require 'test_helper'
+
+class ZipCentralDirectoryEntryTest < MiniTest::Test
+  def test_read_from_stream
+    File.open('test/data/testDirectory.bin', 'rb') do |file|
+      entry = ::Zip::Entry.read_c_dir_entry(file)
+
+      assert_equal('longAscii.txt', entry.name)
+      assert_equal(::Zip::Entry::DEFLATED, entry.compression_method)
+      assert_equal(106_490, entry.size)
+      assert_equal(3784, entry.compressed_size)
+      assert_equal(0xfcd1799c, entry.crc)
+      assert_equal('', entry.comment)
+
+      entry = ::Zip::Entry.read_c_dir_entry(file)
+      assert_equal('empty.txt', entry.name)
+      assert_equal(::Zip::Entry::STORED, entry.compression_method)
+      assert_equal(0, entry.size)
+      assert_equal(0, entry.compressed_size)
+      assert_equal(0x0, entry.crc)
+      assert_equal('', entry.comment)
+
+      entry = ::Zip::Entry.read_c_dir_entry(file)
+      assert_equal('short.txt', entry.name)
+      assert_equal(::Zip::Entry::STORED, entry.compression_method)
+      assert_equal(6, entry.size)
+      assert_equal(6, entry.compressed_size)
+      assert_equal(0xbb76fe69, entry.crc)
+      assert_equal('', entry.comment)
+
+      entry = ::Zip::Entry.read_c_dir_entry(file)
+      assert_equal('longBinary.bin', entry.name)
+      assert_equal(::Zip::Entry::DEFLATED, entry.compression_method)
+      assert_equal(1_000_024, entry.size)
+      assert_equal(70_847, entry.compressed_size)
+      assert_equal(0x10da7d59, entry.crc)
+      assert_equal('', entry.comment)
+
+      entry = ::Zip::Entry.read_c_dir_entry(file)
+      assert_nil(entry)
+      # Fields that are not check by this test:
+      #          version made by                 2 bytes
+      #          version needed to extract       2 bytes
+      #          general purpose bit flag        2 bytes
+      #          last mod file time              2 bytes
+      #          last mod file date              2 bytes
+      #          compressed size                 4 bytes
+      #          uncompressed size               4 bytes
+      #          disk number start               2 bytes
+      #          internal file attributes        2 bytes
+      #          external file attributes        4 bytes
+      #          relative offset of local header 4 bytes
+
+      #          file name (variable size)
+      #          extra field (variable size)
+      #          file comment (variable size)
+    end
+  end
+
+  def test_read_entry_from_truncated_zip_file
+    fragment = ''
+    File.open('test/data/testDirectory.bin') { |f| fragment = f.read(12) } # cdir entry header is at least 46 bytes
+    fragment.extend(IOizeString)
+    entry = ::Zip::Entry.new
+    entry.read_c_dir_entry(fragment)
+    fail 'ZipError expected'
+  rescue ::Zip::Error
+  end
+end

data/test/central_directory_test.rb

@@ -0,0 +1,100 @@
+require 'test_helper'
+
+class ZipCentralDirectoryTest < MiniTest::Test
+  def teardown
+    ::Zip.reset!
+  end
+
+  def test_read_from_stream
+    ::File.open(TestZipFile::TEST_ZIP2.zip_name, 'rb') do |zipFile|
+      cdir = ::Zip::CentralDirectory.read_from_stream(zipFile)
+
+      assert_equal(TestZipFile::TEST_ZIP2.entry_names.size, cdir.size)
+      assert(cdir.entries.sort.compare_enumerables(TestZipFile::TEST_ZIP2.entry_names.sort) do |cdirEntry, testEntryName|
+        cdirEntry.name == testEntryName
+      end)
+      assert_equal(TestZipFile::TEST_ZIP2.comment, cdir.comment)
+    end
+  end
+
+  def test_read_from_invalid_stream
+    File.open('test/data/file2.txt', 'rb') do |zipFile|
+      cdir = ::Zip::CentralDirectory.new
+      cdir.read_from_stream(zipFile)
+    end
+    fail 'ZipError expected!'
+  rescue ::Zip::Error
+  end
+
+  def test_read_from_truncated_zip_file
+    fragment = ''
+    File.open('test/data/testDirectory.bin', 'rb') { |f| fragment = f.read }
+    fragment.slice!(12) # removed part of first cdir entry. eocd structure still complete
+    fragment.extend(IOizeString)
+    entry = ::Zip::CentralDirectory.new
+    entry.read_from_stream(fragment)
+    fail 'ZipError expected'
+  rescue ::Zip::Error
+  end
+
+  def test_write_to_stream
+    entries = [::Zip::Entry.new('file.zip', 'flimse', 'myComment', 'somethingExtra'),
+               ::Zip::Entry.new('file.zip', 'secondEntryName'),
+               ::Zip::Entry.new('file.zip', 'lastEntry.txt', 'Has a comment too')]
+    cdir = ::Zip::CentralDirectory.new(entries, 'my zip comment')
+    File.open('test/data/generated/cdirtest.bin', 'wb') { |f| cdir.write_to_stream(f) }
+    cdirReadback = ::Zip::CentralDirectory.new
+    File.open('test/data/generated/cdirtest.bin', 'rb') { |f| cdirReadback.read_from_stream(f) }
+
+    assert_equal(cdir.entries.sort, cdirReadback.entries.sort)
+  end
+
+  def test_write64_to_stream
+    ::Zip.write_zip64_support = true
+    entries = [::Zip::Entry.new('file.zip', 'file1-little', 'comment1', '', 200, 101, ::Zip::Entry::STORED, 200),
+               ::Zip::Entry.new('file.zip', 'file2-big', 'comment2', '', 18_000_000_000, 102, ::Zip::Entry::DEFLATED, 20_000_000_000),
+               ::Zip::Entry.new('file.zip', 'file3-alsobig', 'comment3', '', 15_000_000_000, 103, ::Zip::Entry::DEFLATED, 21_000_000_000),
+               ::Zip::Entry.new('file.zip', 'file4-little', 'comment4', '', 100, 104, ::Zip::Entry::DEFLATED, 121)]
+    [0, 250, 18_000_000_300, 33_000_000_350].each_with_index do |offset, index|
+      entries[index].local_header_offset = offset
+    end
+    cdir = ::Zip::CentralDirectory.new(entries, 'zip comment')
+    File.open('test/data/generated/cdir64test.bin', 'wb') { |f| cdir.write_to_stream(f) }
+    cdirReadback = ::Zip::CentralDirectory.new
+    File.open('test/data/generated/cdir64test.bin', 'rb') { |f| cdirReadback.read_from_stream(f) }
+
+    assert_equal(cdir.entries.sort, cdirReadback.entries.sort)
+    assert_equal(::Zip::VERSION_NEEDED_TO_EXTRACT_ZIP64, cdirReadback.instance_variable_get(:@version_needed_for_extract))
+  end
+
+  def test_equality
+    cdir1 = ::Zip::CentralDirectory.new([::Zip::Entry.new('file.zip', 'flimse', nil,
+                                                          'somethingExtra'),
+                                         ::Zip::Entry.new('file.zip', 'secondEntryName'),
+                                         ::Zip::Entry.new('file.zip', 'lastEntry.txt')],
+                                        'my zip comment')
+    cdir2 = ::Zip::CentralDirectory.new([::Zip::Entry.new('file.zip', 'flimse', nil,
+                                                          'somethingExtra'),
+                                         ::Zip::Entry.new('file.zip', 'secondEntryName'),
+                                         ::Zip::Entry.new('file.zip', 'lastEntry.txt')],
+                                        'my zip comment')
+    cdir3 = ::Zip::CentralDirectory.new([::Zip::Entry.new('file.zip', 'flimse', nil,
+                                                          'somethingExtra'),
+                                         ::Zip::Entry.new('file.zip', 'secondEntryName'),
+                                         ::Zip::Entry.new('file.zip', 'lastEntry.txt')],
+                                        'comment?')
+    cdir4 = ::Zip::CentralDirectory.new([::Zip::Entry.new('file.zip', 'flimse', nil,
+                                                          'somethingExtra'),
+                                         ::Zip::Entry.new('file.zip', 'lastEntry.txt')],
+                                        'comment?')
+    assert_equal(cdir1, cdir1)
+    assert_equal(cdir1, cdir2)
+
+    assert(cdir1 != cdir3)
+    assert(cdir2 != cdir3)
+    assert(cdir2 != cdir3)
+    assert(cdir3 != cdir4)
+
+    assert(cdir3 != 'hello')
+  end
+end