rubyzip 0.9.1 → 0.9.4

data/NEWS

@@ -1,3 +1,21 @@
+= Version 0.9.4
+
+Changed ZipOutputStream.put_next_entry signature (API CHANGE!). Now
+allows comment, extra field and compression method to be specified.
+
+= Version 0.9.3
+
+Fixed: Added ZipEntry::name_encoding which retrieves the character
+encoding of the name and comment of the entry. Also added convenience
+methods ZipEntry::name_in(enc) and ZipEntry::comment_in(enc) for
+getting zip entry names and comments in a specified character
+encoding.
+
+= Version 0.9.2
+
+Fixed: Renaming an entry failed if the entry's new name was a
+different length than its old name. (Diego Barros)
+
 = Version 0.9.1
 
 Added symlink support and support for unix file permissions. Reduced

data/README

@@ -69,4 +69,4 @@ Thomas Sondergaard (thomas at sondergaard.cc)
 
 Technorama Ltd. (oss-ruby-zip at technorama.net)
 
-extra-field support contributed by Tatsuki Sugiura (sugi at nemui.org)
+extra-field support contributed by Tatsuki Sugiura (sugi at nemui.org)

data/Rakefile

@@ -7,7 +7,7 @@ require 'rake/packagetask'
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
 require 'rake/contrib/sshpublisher'
-require 'net/ftp'
+require 'net/sftp'
 
 PKG_NAME = 'rubyzip'
 PKG_VERSION = File.read('lib/zip/zip.rb').match(/\s+VERSION\s*=\s*'(.*)'/)[1]
@@ -32,6 +32,10 @@ clobberFromCvsIgnore 'samples'
 clobberFromCvsIgnore 'test'
 clobberFromCvsIgnore 'test/data'
 
+def rsystem(cmd)
+  system(cmd) or raise "system command failed: '#{cmd}"
+end
+
 task :default => [:test]
 
 desc "Run unit tests"
@@ -62,29 +66,26 @@ end
 Rake::RDocTask.new do |rd|
   rd.main = "README"
   rd.rdoc_files.add %W{ lib/zip/*.rb README NEWS TODO ChangeLog }
-  rd.options << "--title 'rubyzip documentation' --webcvs http://cvs.sourceforge.net/viewcvs.py/rubyzip/rubyzip/"
+  rd.options << "-t 'rubyzip documentation' --webcvs http://cvs.sourceforge.net/viewcvs.py/rubyzip/rubyzip/"
 #  rd.options << "--all"
 end
 
 desc "Publish documentation"
 task :pdoc => [:rdoc] do
-  Rake::SshFreshDirPublisher.
-       new("thomas@rubyzip.sourceforge.net", "/home/groups/r/ru/rubyzip/htdocs", "html").upload
+  rsystem("rsync -avz --delete html/* thomas,rubyzip@frs.sourceforge.net:/home/groups/r/ru/rubyzip/htdocs")
 end
 
 desc "Publish package"
 task :ppackage => [:package] do
-  Net::FTP.open("upload.sourceforge.net", 
-                "ftp", 
-                ENV['USER']+"@"+ENV['HOSTNAME']) {
+  Net::SFTP.start("frs.sourceforge.net", "thomas,rubyzip") do
     |ftpclient|
-    ftpclient.passive = true
-    ftpclient.chdir "incoming"
-    Dir['pkg/*.{tgz,zip,gem}'].each {
+    releasedir = File.join("/home/pfs/project/r/ru/rubyzip/rubyzip", PKG_VERSION)
+    ftpclient.mkdir releasedir
+    Dir['pkg/*.{tgz,zip,gem}'].each do
       |e|
-      ftpclient.putbinaryfile(e, File.basename(e))
-    }
-  }
+      ftpclient.upload!(e, File.join(releasedir, File.basename(e)))
+    end
+  end
 end
 
 desc "Generate the ChangeLog file"

data/install.rb

@@ -4,19 +4,20 @@ $VERBOSE = true
 
 require 'rbconfig'
 require 'find'
-require 'ftools'
+require 'fileutils'
 
 include Config
 
 files = %w{ stdrubyext.rb ioextras.rb zip.rb zipfilesystem.rb ziprequire.rb tempfile_bugfixed.rb }
 
 INSTALL_DIR = File.join(CONFIG["sitelibdir"], "zip")
-File.makedirs(INSTALL_DIR)
+FileUtils.makedirs(INSTALL_DIR)
 
 SOURCE_DIR = File.join(File.dirname($0), "lib/zip")
 
 files.each { 
   |filename|
   installPath = File.join(INSTALL_DIR, filename)
-  File::install(File.join(SOURCE_DIR, filename), installPath, 0644, true)
+  FileUtils::install(File.join(SOURCE_DIR, filename), installPath, 0644,
+                     :verbose => true)
 }

data/lib/zip/ioextras.rb

@@ -1,6 +1,6 @@
 module IOExtras  #:nodoc:
 
-  CHUNK_SIZE = 32768
+  CHUNK_SIZE = 131072
 
   RANGE_ALL = 0..-1
 
@@ -9,6 +9,16 @@ module IOExtras  #:nodoc:
     ostream.write(istream.read(CHUNK_SIZE, s)) until istream.eof? 
   end
 
+  def self.copy_stream_n(ostream, istream, nbytes)
+    s = ''
+    toread = nbytes
+    while (toread > 0 && ! istream.eof?) 
+      tr = toread > CHUNK_SIZE ? CHUNK_SIZE : toread
+      ostream.write(istream.read(tr, s))
+      toread -= tr
+    end 
+  end
+
 
   # Implements kind_of? in order to pretend to be an IO object
   module FakeIO

data/lib/zip/zip.rb

@@ -1,7 +1,8 @@
 require 'delegate'
+require 'iconv'
 require 'singleton'
 require 'tempfile'
-require 'ftools'
+require 'fileutils'
 require 'stringio'
 require 'zlib'
 require 'zip/stdrubyext'
@@ -20,7 +21,7 @@ end
 
 module Zip
 
-  VERSION = '0.9.1'
+  VERSION = '0.9.4'
 
   RUBY_MINOR_VERSION = RUBY_VERSION.split(".")[1].to_i
 
@@ -349,6 +350,21 @@ module Zip
 
     attr_reader :ftype, :filepath # :nodoc:
     
+    # Returns the character encoding used for name and comment
+    def name_encoding
+      (@gp_flags & 0b100000000000) != 0 ? "utf8" : "CP437//"
+    end
+
+    # Returns the name in the encoding specified by enc
+    def name_in(enc)
+      Iconv.conv(enc, name_encoding, @name)
+    end
+
+    # Returns the name in the encoding specified by enc
+    def comment_in(enc)
+      Iconv.conv(enc, name_encoding, @name)
+    end
+
     def initialize(zipfile = "", name = "", comment = "", extra = "", 
                    compressed_size = 0, crc = 0, 
 		   compression_method = ZipEntry::DEFLATED, size = 0,
@@ -358,6 +374,7 @@ module Zip
 	raise ZipEntryNameError, "Illegal ZipEntry name '#{name}', name must not start with /" 
       end
       @localHeaderOffset = 0
+      @local_header_size = 0
       @internalFileAttributes = 1
       @externalFileAttributes = 0
       @version = 52 # this library's version
@@ -368,9 +385,14 @@ module Zip
       else
         @fstype = FSTYPE_UNIX
       end
-      @zipfile, @comment, @compressed_size, @crc, @extra, @compression_method, 
-	@name, @size = zipfile, comment, compressed_size, crc, 
-	extra, compression_method, name, size
+      @zipfile = zipfile
+      @comment = comment
+      @compressed_size = compressed_size
+      @crc = crc
+      @extra = extra
+      @compression_method = compression_method
+      @name = name
+      @size = size
       @time = time
 
       @follow_symlinks = false
@@ -432,7 +454,7 @@ module Zip
     # Returns +true+ if the entry is a symlink.
     def symlink?
       raise ZipInternalError, "current filetype is unknown: #{self.inspect}" unless @ftype
-      @ftype == :link
+      @ftype == :symlink
     end
 
     def name_is_directory?  #:nodoc:all
@@ -440,10 +462,10 @@ module Zip
     end
 
     def local_entry_offset  #:nodoc:all
-      localHeaderOffset + local_header_size
+      localHeaderOffset + @local_header_size
     end
     
-    def local_header_size  #:nodoc:all
+    def calculate_local_header_size  #:nodoc:all
       LOCAL_ENTRY_STATIC_HEADER_LENGTH + (@name ?  @name.size : 0) + (@extra ? @extra.local_size : 0)
     end
 
@@ -491,7 +513,8 @@ module Zip
     LOCAL_ENTRY_SIGNATURE = 0x04034b50
     LOCAL_ENTRY_STATIC_HEADER_LENGTH = 30
     LOCAL_ENTRY_TRAILING_DESCRIPTOR_LENGTH = 4+4+4
-    
+    VERSION_NEEDED_TO_EXTRACT = 10
+
     def read_local_entry(io)  #:nodoc:all
       @localHeaderOffset = io.tell
       staticSizedFieldsBuf = io.read(LOCAL_ENTRY_STATIC_HEADER_LENGTH)
@@ -516,6 +539,7 @@ module Zip
 	raise ZipError, "Zip local header magic not found at location '#{localHeaderOffset}'"
       end
       set_time(lastModDate, lastModTime)
+
       
       @name              = io.read(nameLength)
       extra              = io.read(extraLength)
@@ -529,6 +553,7 @@ module Zip
           @extra = ZipExtraField.new(extra)
         end
       end
+      @local_header_size = calculate_local_header_size
     end
     
     def ZipEntry.read_local_entry(io)
@@ -544,7 +569,7 @@ module Zip
       
       io << 
 	[LOCAL_ENTRY_SIGNATURE    ,
-	0                  ,
+	VERSION_NEEDED_TO_EXTRACT , # version needed to extract
 	0                         , # @gp_flags                  ,
 	@compression_method        ,
 	@time.to_binary_dos_time     , # @lastModTime              ,
@@ -615,7 +640,7 @@ module Zip
         when 010
           @ftype = :file
         when 012
-          @ftype = :link
+          @ftype = :symlink
         else
           raise ZipInternalError, "unknown file type #{'0%o' % (@externalFileAttributes >> 28)}"
         end
@@ -626,6 +651,7 @@ module Zip
           @ftype = :file
         end
       end
+      @local_header_size = calculate_local_header_size
     end
     
     def ZipEntry.read_c_dir_entry(io)  #:nodoc:all
@@ -662,8 +688,8 @@ module Zip
         # ignore setuid/setgid bits by default.  honor if @restore_ownership
         unix_perms_mask = 01777
         unix_perms_mask = 07777 if (@restore_ownership)
-      	File::chmod(@unix_perms & unix_perms_mask, destPath) if (@restore_permissions && @unix_perms)
-        File::chown(@unix_uid, @unix_gid, destPath) if (@restore_ownership && @unix_uid && @unix_gid && Process::egid == 0)
+        FileUtils::chmod(@unix_perms & unix_perms_mask, destPath) if (@restore_permissions && @unix_perms)
+        FileUtils::chown(@unix_uid, @unix_gid, destPath) if (@restore_ownership && @unix_uid && @unix_gid && Process::egid == 0)
         # File::utimes()
       end
     end
@@ -693,7 +719,7 @@ module Zip
 	[CENTRAL_DIRECTORY_ENTRY_SIGNATURE,
         @version                          , # version of encoding software
 	@fstype                           , # filesystem type
-	0                                 , # @versionNeededToExtract           ,
+	VERSION_NEEDED_TO_EXTRACT         , # @versionNeededToExtract           ,
 	0                                 , # @gp_flags                          ,
 	@compression_method                ,
         @time.to_binary_dos_time             , # @lastModTime                      ,
@@ -849,7 +875,7 @@ module Zip
 	return
       elsif File.exists? destPath
 	if block_given? && yield(self, destPath)
-	  File.rm_f destPath
+	  FileUtils::rm_f destPath
 	else
 	  raise ZipDestinationFileExistsError,
 	    "Cannot create directory '#{destPath}'. "+
@@ -951,11 +977,16 @@ module Zip
 
     # Closes the current entry and opens a new for writing.
     # +entry+ can be a ZipEntry object or a string.
-    def put_next_entry(entry, level = Zlib::DEFAULT_COMPRESSION)
+    def put_next_entry(entryname, comment = nil, extra = nil, compression_method = ZipEntry::DEFLATED,  level = Zlib::DEFAULT_COMPRESSION)
       raise ZipError, "zip stream is closed" if @closed
-      newEntry = entry.kind_of?(ZipEntry) ? entry : ZipEntry.new(@fileName, entry.to_s)
-      init_next_entry(newEntry, level)
-      @currentEntry=newEntry
+      new_entry = ZipEntry.new(@fileName, entryname.to_s)
+      new_entry.comment = comment if !comment.nil?
+      if (!extra.nil?)
+        new_entry.extra = ZipExtraField === extra ? extra : ZipExtraField.new(extra.to_s)
+      end
+      new_entry.compression_method = compression_method
+      init_next_entry(new_entry, level)
+      @currentEntry = new_entry
     end
 
     def copy_raw_entry(entry)
@@ -967,10 +998,10 @@ module Zip
       src_pos = entry.local_entry_offset
       entry.write_local_entry(@outputStream)
       @compressor = NullCompressor.instance
-      @outputStream << entry.get_raw_input_stream { 
+      entry.get_raw_input_stream { 
 	|is| 
 	is.seek(src_pos, IO::SEEK_SET)
-	is.read(entry.compressed_size)
+        IOExtras.copy_stream_n(@outputStream, is, entry.compressed_size)
       }
       @compressor = NullCompressor.instance
       @currentEntry = nil
@@ -981,7 +1012,7 @@ module Zip
       return unless @currentEntry
       finish
       @currentEntry.compressed_size = @outputStream.tell - @currentEntry.localHeaderOffset - 
-	@currentEntry.local_header_size
+	@currentEntry.calculate_local_header_size
       @currentEntry.size = @compressor.size
       @currentEntry.crc = @compressor.crc
       @currentEntry = nil
@@ -1453,7 +1484,9 @@ module Zip
     def rename(entry, newName, &continueOnExistsProc)
       foundEntry = get_entry(entry)
       check_entry_exists(newName, continueOnExistsProc, "rename")
-      foundEntry.name=newName
+      @entrySet.delete(foundEntry)
+      foundEntry.name = newName
+      @entrySet << foundEntry
     end
 
     # Replaces the specified entry with the contents of srcPath (from 
@@ -1566,7 +1599,7 @@ module Zip
       tmpFilename = tmpfile.path
       tmpfile.close
       if yield tmpFilename
-	File.move(tmpFilename, name)
+	File.rename(tmpFilename, name)
       end
     end
     

data/lib/zip/zipfilesystem.rb

@@ -225,6 +225,7 @@ module Zip
       end
       
       def open(fileName, openMode = "r", &block)
+        openMode.gsub!("b", "") # ignore b option
         case openMode
         when "r" 
           @mappedZip.get_input_stream(fileName, &block)

data/samples/example_filesystem.rb

@@ -3,7 +3,6 @@
 $: << "../lib"
 
 require 'zip/zipfilesystem'
-require 'ftools'
 
 EXAMPLE_ZIP = "filesystem.zip"
 

data/test/zipfilesystemtest.rb

@@ -6,6 +6,7 @@ $: << "../lib"
 
 require 'zip/zipfilesystem'
 require 'test/unit'
+require 'fileutils'
 
 module ExtraAssertions
 
@@ -23,7 +24,7 @@ module ExtraAssertions
     assert_equal(retVal, yield) # Invoke test
     assert_equal(expectedArgs, callArgs)
   ensure
-    anObject.instance_eval "alias #{method} #{method}_org"
+    anObject.instance_eval "undef #{method}; alias #{method} #{method}_org"
   end
 
 end
@@ -67,6 +68,15 @@ class ZipFsFileNonmutatingTest < Test::Unit::TestCase
     }
     assert(blockCalled)
 
+    blockCalled = false
+    @zipFile.file.open("file1", "rb") { # test binary flag is ignored
+      |f|
+      blockCalled = true
+      assert_equal("this is the entry 'file1' in my test archive!", 
+		    f.readline.chomp)
+    }
+    assert(blockCalled)
+
     blockCalled = false
     @zipFile.dir.chdir "dir2"
     @zipFile.file.open("file21", "r") {
@@ -552,7 +562,7 @@ end
 class ZipFsFileMutatingTest < Test::Unit::TestCase
   TEST_ZIP = "zipWithDirs_copy.zip"
   def setup
-    File.copy("data/zipWithDirs.zip", TEST_ZIP)
+    FileUtils.cp("data/zipWithDirs.zip", TEST_ZIP)
   end
 
   def teardown
@@ -579,7 +589,7 @@ class ZipFsFileMutatingTest < Test::Unit::TestCase
                     zf.file.read("test_open_write_entry"))
 
       # Test with existing entry
-      zf.file.open("file1", "w") {
+      zf.file.open("file1", "wb") { #also check that 'b' option is ignored
         |f|
         blockCalled = true
         f.write "This is what I'm writing too"
@@ -640,7 +650,7 @@ class ZipFsDirectoryTest < Test::Unit::TestCase
   TEST_ZIP = "zipWithDirs_copy.zip"
 
   def setup
-    File.copy("data/zipWithDirs.zip", TEST_ZIP)
+    FileUtils.cp("data/zipWithDirs.zip", TEST_ZIP)
   end
 
   def test_delete