mezza-rubyzip 0.9.4.1

data/NEWS

@@ -0,0 +1,162 @@
+= 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
+memory usage during decompression.
+
+New methods ZipFile::[follow_symlinks, restore_times, restore_permissions, restore_ownership].
+New methods ZipEntry::unix_perms, ZipInputStream::eof?.
+Added documentation and test for new ZipFile::extract.
+Added some of the API suggestions from sf.net #1281314.
+Applied patch for sf.net bug #1446926.
+Applied patch for sf.net bug #1459902.
+Rework ZipEntry and delegate classes.
+
+= Version 0.5.12
+
+Fixed problem with writing binary content to a ZipFile in MS Windows.
+
+= Version 0.5.11
+
+Fixed name clash file method copy_stream from fileutils.rb. Fixed
+problem with references to constant CHUNK_SIZE.
+ZipInputStream/AbstractInputStream read is now buffered like ruby IO's
+read method, which means that read and gets etc can be mixed. The
+unbuffered read method has been renamed to sysread.
+
+= Version 0.5.10
+
+Fixed method name resolution problem with FileUtils::copy_stream and
+IOExtras::copy_stream.
+
+= Version 0.5.9
+
+Fixed serious memory consumption issue
+
+= Version 0.5.8
+
+Fixed install script.
+
+= Version 0.5.7
+
+install.rb no longer assumes it is being run from the toplevel source
+dir. Directory structure changed to reflect common ruby library
+project structure. Migrated from RubyUnit to Test::Unit format.  Now
+uses Rake to build source packages and gems and run unit tests.
+
+= Version 0.5.6
+
+Fix for FreeBSD 4.9 which returns Errno::EFBIG instead of
+Errno::EINVAL for some invalid seeks. Fixed 'version needed to
+extract'-field incorrect in local headers.
+
+= Version 0.5.5
+
+Fix for a problem with writing zip files that concerns only ruby 1.8.1.
+
+= Version 0.5.4
+
+Significantly reduced memory footprint when modifying zip files.
+
+= Version 0.5.3
+
+Added optimization to avoid decompressing and recompressing individual
+entries when modifying a zip archive.
+
+= Version 0.5.2
+
+Fixed ZipFile corruption bug in ZipFile class. Added basic unix
+extra-field support.
+
+= Version 0.5.1
+
+Fixed ZipFile.get_output_stream bug.
+
+= Version 0.5.0
+
+List of changes:
+* Ruby 1.8.0 and ruby-zlib 0.6.0 compatibility
+* Changed method names from camelCase to rubys underscore style. 
+* Installs to zip/ subdir instead of directly to site_ruby
+* Added ZipFile.directory and ZipFile.file - each method return an
+object that can be used like Dir and File only for the contents of the
+zip file. 
+* Added sample application zipfind which works like Find.find, only
+Zip::ZipFind.find traverses into zip archives too.
+
+Bug fixes:
+* AbstractInputStream.each_line with non-default separator
+
+
+= Version 0.5.0a
+
+Source reorganized. Added ziprequire, which can be used to load ruby
+modules from a zip file, in a fashion similar to jar files in
+Java. Added gtkRubyzip, another sample application. Implemented
+ZipInputStream.lineno and ZipInputStream.rewind
+
+Bug fixes: 
+
+* Read and write date and time information correctly for zip entries. 
+* Fixed read() using separate buffer, causing mix of gets/readline/read to
+cause problems. 
+
+= Version 0.4.2
+
+Performance optimizations. Test suite runs in half the time.
+
+= Version 0.4.1
+
+Windows compatibility fixes.
+
+= Version 0.4.0
+
+Zip::ZipFile is now mutable and provides a more convenient way of
+modifying zip archives than Zip::ZipOutputStream. Operations for
+adding, extracting, renaming, replacing and removing entries to zip
+archives are now available.
+
+Runs without warnings with -w switch.
+
+Install script install.rb added.
+
+
+= Version 0.3.1
+
+Rudimentary support for writing zip archives.
+
+
+= Version 0.2.2
+
+Fixed and extended unit test suite. Updated to work with ruby/zlib
+0.5. It doesn't work with earlier versions of ruby/zlib.
+
+
+= Version 0.2.0
+
+Class ZipFile added. Where ZipInputStream is used to read the
+individual entries in a zip file, ZipFile reads the central directory
+in the zip archive, so you can get to any entry in the zip archive
+without having to skipping through all the preceeding entries.
+
+
+= Version 0.1.0
+
+First working version of ZipInputStream.

data/README

@@ -0,0 +1,68 @@
+= rubyzip
+
+rubyzip is a ruby library for reading and writing zip files.
+
+= Install
+
+  gem install rubyzip
+
+
+To run the unit tests you need to have test::unit installed
+
+  rake test
+
+
+= Documentation
+
+There is more than one way to access or create a zip archive with
+rubyzip. The basic API is modeled after the classes in
+java.util.zip from the Java SDK. This means there are classes such
+as Zip::ZipInputStream, Zip::ZipOutputStream and
+Zip::ZipFile. Zip::ZipInputStream provides a basic interface for
+iterating through the entries in a zip archive and reading from the
+entries in the same way as from a regular File or IO
+object. ZipOutputStream is the corresponding basic output
+facility. Zip::ZipFile provides a mean for accessing the archives
+central directory and provides means for accessing any entry without
+having to iterate through the archive. Unlike Java's
+java.util.zip.ZipFile rubyzip's Zip::ZipFile is mutable, which means
+it can be used to change zip files as well.
+
+Another way to access a zip archive with rubyzip is to use rubyzip's
+Zip::ZipFileSystem API. Using this API files can be read from and
+written to the archive in much the same manner as ruby's builtin
+classes allows files to be read from and written to the file system.
+
+rubyzip also features the
+zip/ziprequire.rb[link:files/lib/zip/ziprequire_rb.html] module which
+allows ruby to load ruby modules from zip archives.
+
+For details about the specific behaviour of classes and methods refer
+to the test suite. Finally you can generate the rdoc documentation or
+visit http://rubyzip.sourceforge.net.
+
+= License
+
+rubyzip is distributed under the same license as ruby. See
+http://www.ruby-lang.org/en/LICENSE.txt
+
+
+= Website and Project Home
+
+http://github.com/aussiegeek/dotfiles
+
+http://rdoc.info/github/aussiegeek/rubyzip/master/frames
+
+== Download (tarballs and gems)
+
+
+
+= Authors
+
+Alan Harper ( alan at aussiegeek.net)
+
+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)

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << File.join(File.dirname(__FILE__), 'lib')
+  test.libs << File.join(File.dirname(__FILE__), 'test')
+  test.pattern = File.join(File.dirname(__FILE__), 'test/**/*.rb')
+  test.verbose = true
+  Dir.chdir File.join(File.dirname(__FILE__), 'test')
+end
+

data/TODO

@@ -0,0 +1,16 @@
+
+* 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
+* SUggestion: ZipInputStream/ZipOutputStream should accept an IO object in addition to a filename.
+* (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/compressor.rb

@@ -0,0 +1,23 @@
+module Zip
+
+  VERSION = '0.9.4'
+
+  RUBY_MINOR_VERSION = RUBY_VERSION.split(".")[1].to_i
+
+  RUNNING_ON_WINDOWS = Config::CONFIG['host_os'] =~ /^win|mswin/i 
+
+  # Ruby 1.7.x compatibility
+  # In ruby 1.6.x and 1.8.0 reading from an empty stream returns 
+  # an empty string the first time and then nil.
+  #  not so in 1.7.x
+  EMPTY_FILE_RETURNS_EMPTY_STRING_FIRST = RUBY_MINOR_VERSION != 7
+
+  class Compressor #:nodoc:all
+    def finish
+    end
+  end
+end
+
+# Copyright (C) 2002, 2003 Thomas Sondergaard
+# rubyzip is free software; you can redistribute it and/or
+# modify it under the terms of the ruby license.

data/lib/zip/decompressor.rb

@@ -0,0 +1,13 @@
+module Zip
+  class Decompressor  #:nodoc:all
+    CHUNK_SIZE=32768
+    def initialize(inputStream)
+      super()
+      @inputStream=inputStream
+    end
+  end
+end
+
+# Copyright (C) 2002, 2003 Thomas Sondergaard
+# rubyzip is free software; you can redistribute it and/or
+# modify it under the terms of the ruby license.

data/lib/zip/deflater.rb

@@ -0,0 +1,30 @@
+module Zip
+  class Deflater < Compressor #:nodoc:all
+    def initialize(outputStream, level = Zlib::DEFAULT_COMPRESSION)
+      super()
+      @outputStream = outputStream
+      @zlibDeflater = Zlib::Deflate.new(level, -Zlib::MAX_WBITS)
+      @size = 0
+      @crc = Zlib::crc32
+    end
+    
+    def << (data)
+      val = data.to_s
+      @crc = Zlib::crc32(val, @crc)
+      @size += val.size
+      @outputStream << @zlibDeflater.deflate(data)
+    end
+
+    def finish
+      until @zlibDeflater.finished?
+	@outputStream << @zlibDeflater.finish
+      end
+    end
+
+    attr_reader :size, :crc
+  end
+end
+
+# Copyright (C) 2002, 2003 Thomas Sondergaard
+# rubyzip is free software; you can redistribute it and/or
+# modify it under the terms of the ruby license.

data/lib/zip/inflater.rb

@@ -0,0 +1,65 @@
+module Zip
+  class Inflater < Decompressor  #:nodoc:all
+    def initialize(inputStream)
+      super
+      @zlibInflater = Zlib::Inflate.new(-Zlib::MAX_WBITS)
+      @outputBuffer=""
+      @hasReturnedEmptyString = ! EMPTY_FILE_RETURNS_EMPTY_STRING_FIRST
+    end
+    
+    def sysread(numberOfBytes = nil, buf = nil)
+      readEverything = (numberOfBytes == nil)
+      while (readEverything || @outputBuffer.length < numberOfBytes)
+	break if internal_input_finished?
+	@outputBuffer << internal_produce_input(buf)
+      end
+      return value_when_finished if @outputBuffer.length==0 && input_finished?
+      endIndex= numberOfBytes==nil ? @outputBuffer.length : numberOfBytes
+      return @outputBuffer.slice!(0...endIndex)
+    end
+    
+    def produce_input
+      if (@outputBuffer.empty?)
+	return internal_produce_input
+      else
+	return @outputBuffer.slice!(0...(@outputBuffer.length))
+      end
+    end
+
+    # to be used with produce_input, not read (as read may still have more data cached)
+    # is data cached anywhere other than @outputBuffer?  the comment above may be wrong
+    def input_finished?
+      @outputBuffer.empty? && internal_input_finished?
+    end
+    alias :eof :input_finished?
+    alias :eof? :input_finished?
+
+    private
+
+    def internal_produce_input(buf = nil)
+      retried = 0
+      begin
+        @zlibInflater.inflate(@inputStream.read(Decompressor::CHUNK_SIZE, buf))
+      rescue Zlib::BufError
+        raise if (retried >= 5) # how many times should we retry?
+        retried += 1
+        retry
+      end
+    end
+
+    def internal_input_finished?
+      @zlibInflater.finished?
+    end
+
+    # TODO: Specialize to handle different behaviour in ruby > 1.7.0 ?
+    def value_when_finished   # mimic behaviour of ruby File object.
+      return nil if @hasReturnedEmptyString
+      @hasReturnedEmptyString=true
+      return ""
+    end
+  end
+end
+
+# Copyright (C) 2002, 2003 Thomas Sondergaard
+# rubyzip is free software; you can redistribute it and/or
+# modify it under the terms of the ruby license.

data/lib/zip/ioextras.rb

@@ -0,0 +1,165 @@
+module IOExtras  #:nodoc:
+
+  CHUNK_SIZE = 131072
+
+  RANGE_ALL = 0..-1
+
+  def self.copy_stream(ostream, istream)
+    s = ''
+    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
+    def kind_of?(object)
+      object == IO || super
+    end
+  end
+
+  # Implements many of the convenience methods of IO
+  # such as gets, getc, readline and readlines 
+  # depends on: input_finished?, produce_input and read
+  module AbstractInputStream  
+    include Enumerable
+    include FakeIO
+
+    def initialize
+      super
+      @lineno = 0
+      @outputBuffer = ""
+    end
+
+    attr_accessor :lineno
+
+    def read(numberOfBytes = nil, buf = nil)
+      tbuf = nil
+
+      if @outputBuffer.length > 0
+        if numberOfBytes <= @outputBuffer.length
+          tbuf = @outputBuffer.slice!(0, numberOfBytes)
+        else
+          numberOfBytes -= @outputBuffer.length if (numberOfBytes)
+          rbuf = sysread(numberOfBytes, buf)
+          tbuf = @outputBuffer
+          tbuf << rbuf if (rbuf)
+          @outputBuffer = ""
+        end
+      else
+        tbuf = sysread(numberOfBytes, buf)
+      end
+
+      return nil unless (tbuf)
+
+      if buf
+        buf.replace(tbuf)
+      else
+        buf = tbuf
+      end
+
+      buf
+    end
+
+    def readlines(aSepString = $/)
+      retVal = []
+      each_line(aSepString) { |line| retVal << line }
+      return retVal
+    end
+    
+    def gets(aSepString=$/)
+      @lineno = @lineno.next
+      return read if aSepString == nil
+      aSepString="#{$/}#{$/}" if aSepString == ""
+      
+      bufferIndex=0
+      while ((matchIndex = @outputBuffer.index(aSepString, bufferIndex)) == nil)
+	bufferIndex=@outputBuffer.length
+	if input_finished?
+	  return @outputBuffer.empty? ? nil : flush 
+	end
+	@outputBuffer << produce_input
+      end
+      sepIndex=matchIndex + aSepString.length
+      return @outputBuffer.slice!(0...sepIndex)
+    end
+    
+    def flush
+      retVal=@outputBuffer
+      @outputBuffer=""
+      return retVal
+    end
+    
+    def readline(aSepString = $/)
+      retVal = gets(aSepString)
+      raise EOFError if retVal == nil
+      return retVal
+    end
+    
+    def each_line(aSepString = $/)
+      while true
+	yield readline(aSepString)
+      end
+    rescue EOFError
+    end
+    
+    alias_method :each, :each_line
+  end
+
+
+  # Implements many of the output convenience methods of IO.
+  # relies on <<
+  module AbstractOutputStream 
+    include FakeIO
+
+    def write(data)
+      self << data
+      data.to_s.length
+    end
+
+
+    def print(*params)
+      self << params.join($,) << $\.to_s
+    end
+
+    def printf(aFormatString, *params)
+      self << sprintf(aFormatString, *params)
+    end
+
+    def putc(anObject)
+      self << case anObject
+	      when Fixnum then anObject.chr
+	      when String then anObject
+	      else raise TypeError, "putc: Only Fixnum and String supported"
+	      end
+      anObject
+    end
+    
+    def puts(*params)
+      params << "\n" if params.empty?
+      params.flatten.each {
+	|element|
+	val = element.to_s
+	self << val
+	self << "\n" unless val[-1,1] == "\n"
+      }
+    end
+
+  end
+
+end # IOExtras namespace module
+
+
+
+# Copyright (C) 2002-2004 Thomas Sondergaard
+# rubyzip is free software; you can redistribute it and/or
+# modify it under the terms of the ruby license.