rubyzip 0.9.9 → 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43c105816327e51ada812102f96fb5ee767f4111
+  data.tar.gz: 9885633481d4b7f0887a5d7861e99fb8a632e913
+SHA512:
+  metadata.gz: 5d5b39710bf4d51ffeff8d4de6a9b1583f5fc844c1a128014a591288d3e770d20fb89a600884cfac0795dedbea0caea37a3af1b407f477a504923f719a4be158
+  data.tar.gz: 6549a23e186d61d456c3214e627dd084b80a569142bc0994c8dc9e2e87dcdfe7059f027d7ff045287c6daa73e95391c7247bc36fb0da4562e95a3f0fcd615b8c

data/NEWS

@@ -8,6 +8,10 @@ even though there is actually a comment.
 
 Fixed: "Unitialized constant NullInputStream" error
 
+= Version 0.9.5
+
+Removed support for loading ruby in zip files (ziprequire.rb).
+
 = Version 0.9.4
 
 Changed ZipOutputStream.put_next_entry signature (API CHANGE!). Now
@@ -103,11 +107,11 @@ Fixed ZipFile.get_output_stream bug.
 
 List of changes:
 * Ruby 1.8.0 and ruby-zlib 0.6.0 compatibility
-* Changed method names from camelCase to rubys underscore style. 
+* 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. 
+zip file.
 * Added sample application zipfind which works like Find.find, only
 Zip::ZipFind.find traverses into zip archives too.
 
@@ -122,11 +126,11 @@ 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: 
+Bug fixes:
 
-* Read and write date and time information correctly for zip entries. 
+* 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. 
+cause problems.
 
 = Version 0.4.2
 

data/README.md

@@ -1,7 +1,12 @@
-# rubyzip [![Build Status](https://secure.travis-ci.org/aussiegeek/rubyzip.png)](http://travis-ci.org/aussiegeek/rubyzip)
+# rubyzip [![Build Status](https://secure.travis-ci.org/rubyzip/rubyzip.png)](http://travis-ci.org/aussiegeek/rubyzip)[![Code Climate](https://codeclimate.com/github/aussiegeek/rubyzip.png)](https://codeclimate.com/github/aussiegeek/rubyzip)
 
 rubyzip is a ruby library for reading and writing zip files.
 
+## Important note
+
+This branch for next version of rubyzip. Do not use it on production.
+Rubyzip interface will be changed!!!
+
 ## Installation
 rubyzip is available on RubyGems, so:
 
@@ -21,14 +26,14 @@ gem 'rubyzip'
 
 ```ruby
 require 'rubygems'
-require 'zip/zip'
- 
+require 'zip'
+
 folder = "Users/me/Desktop/stuff_to_zip"
 input_filenames = ['image.jpg', 'description.txt', 'stats.csv']
- 
+
 zipfile_name = "/Users/me/Desktop/archive.zip"
- 
-Zip::ZipFile.open(zipfile_name, Zip::ZipFile::CREATE) do |zipfile|
+
+Zip::File.open(zipfile_name, Zip::File::CREATE) do |zipfile|
   input_filenames.each do |filename|
     # Two arguments:
     # - The name of the file as it will appear in the archive
@@ -38,31 +43,68 @@ Zip::ZipFile.open(zipfile_name, Zip::ZipFile::CREATE) do |zipfile|
 end
 ```
 
+### Zipping a directory recursively
+
+```ruby
+require 'rubygems'
+require 'zip'
+
+directory = '/Users/me/Desktop/directory_to_zip/'
+zipfile_name = '/Users/me/Desktop/recursive_directory.zip'
+
+Zip::File.open(zipfile_name, Zip::File::CREATE) do |zipfile|
+	Dir[File.join(directory, '**', '**')].each do |file|
+	  zipfile.add(file.sub(directory, ''), file)
+	end
+end
+```
+
+## Known issues
+
+### Modify docx file with rubyzip
+
+Use `write_buffer` instead `open`. Thanks to @jondruse
+
+```ruby
+buffer = Zip::OutputStream.write_buffer do |out|
+  @zip_file.entries.each do |e|
+    unless [DOCUMENT_FILE_PATH, RELS_FILE_PATH].include?(e.name)
+      out.put_next_entry(e.name)
+      out.write e.get_input_stream.read
+     end
+  end
+
+  out.put_next_entry(DOCUMENT_FILE_PATH)
+  out.write xml_doc.to_xml(:indent => 0).gsub("\n","")
+
+  out.put_next_entry(RELS_FILE_PATH)
+  out.write rels.to_xml(:indent => 0).gsub("\n","")
+end
+
+File.open(new_path, "w") {|f| f.write(buffer.string) }
+```
+
 ## Further 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
+as Zip::InputStream, Zip::OutputStream and
+Zip::File. Zip::InputStream 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
+object. OutputStream is the corresponding basic output
+facility. Zip::File 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
+java.util.zip.ZipFile rubyzip's Zip::File 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
+Zip::FileSystem 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.
@@ -72,16 +114,32 @@ visit http://rubyzip.sourceforge.net.
 
 By default, rubyzip will not overwrite files if they already exist inside of the extracted path.  To change this behavior, you may specify a configuration option like so:
 
-```
-Zip.options[:on_exists_proc] = true
+```ruby
+Zip.on_exists_proc = true
 ```
 
 If you're using rubyzip with rails, consider placing this snippet of code in an initializer file such as `config/initializers/rubyzip.rb`
 
 Additionally, if you want to configure rubyzip to overwrite existing files while creating a .zip file, you can do so with the following:
 
+```ruby
+Zip.continue_on_exists_proc = true
+```
+
+If you want to store non english names and want to open properly file on Windows(pre 7) you need to set next option:
+
+```ruby
+Zip.unicode_names = true
 ```
-Zip.options[:continue_on_exists_proc] = true
+
+All settings in same time
+
+```ruby
+  Zip.setup do |c|
+    c.on_exists_proc = true
+    c.continue_on_exists_proc = true
+    c.unicode_names = true
+  end
 ```
 
 ## Developing
@@ -95,9 +153,9 @@ rake
 
 ## Website and Project Home
 
-http://github.com/aussiegeek/rubyzip
+http://github.com/rubyzip/rubyzip
 
-http://rdoc.info/github/aussiegeek/rubyzip/master/frames
+http://rdoc.info/github/rubyzip/rubyzip/master/frames
 
 ## Authors
 

data/Rakefile

@@ -1,4 +1,4 @@
-require 'rubygems'
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 task :default => [:test]

data/lib/zip.rb

@@ -0,0 +1,52 @@
+require 'delegate'
+require 'singleton'
+require 'tempfile'
+require 'fileutils'
+require 'stringio'
+require 'zlib'
+require 'zip/dos_time'
+require 'zip/ioextras'
+require 'rbconfig'
+require 'zip/entry'
+require 'zip/extra_field'
+require 'zip/entry_set'
+require 'zip/central_directory'
+require 'zip/file'
+require 'zip/input_stream'
+require 'zip/output_stream'
+require 'zip/decompressor'
+require 'zip/compressor'
+require 'zip/null_decompressor'
+require 'zip/null_compressor'
+require 'zip/null_input_stream'
+require 'zip/pass_thru_compressor'
+require 'zip/pass_thru_decompressor'
+require 'zip/inflater'
+require 'zip/deflater'
+require 'zip/streamable_stream'
+require 'zip/streamable_directory'
+require 'zip/constants'
+require 'zip/errors'
+
+module Zip
+  extend self
+  attr_accessor :unicode_names, :on_exists_proc, :continue_on_exists_proc
+
+  def reset!
+    @_ran_once = false
+    @unicode_names = false
+    @on_exists_proc = false
+    @continue_on_exists_proc = false
+  end
+
+  def setup
+    yield self unless @_ran_once
+    @_ran_once = true
+  end
+
+  reset!
+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/central_directory.rb

@@ -0,0 +1,135 @@
+module Zip
+  class CentralDirectory
+    include Enumerable
+
+    END_OF_CENTRAL_DIRECTORY_SIGNATURE          = 0x06054b50
+    MAX_END_OF_CENTRAL_DIRECTORY_STRUCTURE_SIZE = 65536 + 18
+    STATIC_EOCD_SIZE                            = 22
+
+    attr_reader :comment
+
+    # Returns an Enumerable containing the entries.
+    def entries
+      @entry_set.entries
+    end
+
+    def initialize(entries = EntrySet.new, comment = "") #:nodoc:
+      super()
+      @entry_set = entries.kind_of?(EntrySet) ? entries : EntrySet.new(entries)
+      @comment  = comment
+    end
+
+    def write_to_stream(io) #:nodoc:
+      offset = io.tell
+      @entry_set.each { |entry| entry.write_c_dir_entry(io) }
+      write_e_o_c_d(io, offset)
+    end
+
+    def write_e_o_c_d(io, offset) #:nodoc:
+      tmp = [
+        END_OF_CENTRAL_DIRECTORY_SIGNATURE,
+        0, # @numberOfThisDisk
+        0, # @numberOfDiskWithStartOfCDir
+        @entry_set ? @entry_set.size : 0,
+        @entry_set ? @entry_set.size : 0,
+        cdir_size,
+        offset,
+        @comment ? @comment.length : 0
+      ]
+      io << tmp.pack('VvvvvVVv')
+      io << @comment
+    end
+
+    private :write_e_o_c_d
+
+    def cdir_size #:nodoc:
+                  # does not include eocd
+      @entry_set.inject(0) do |value, entry|
+        entry.cdir_header_size + value
+      end
+    end
+
+    private :cdir_size
+
+    def read_e_o_c_d(io) #:nodoc:
+      buf                                   = get_e_o_c_d(io)
+      @numberOfThisDisk                     = Entry.read_zip_short(buf)
+      @numberOfDiskWithStartOfCDir          = Entry.read_zip_short(buf)
+      @totalNumberOfEntriesInCDirOnThisDisk = Entry.read_zip_short(buf)
+      @size                                 = Entry.read_zip_short(buf)
+      @sizeInBytes                          = Entry.read_zip_long(buf)
+      @cdirOffset                           = Entry.read_zip_long(buf)
+      commentLength                         = Entry.read_zip_short(buf)
+      if commentLength <= 0
+        @comment = buf.slice!(0, buf.size)
+      else
+        @comment = buf.read(commentLength)
+      end
+      raise ZipError, "Zip consistency problem while reading eocd structure" unless buf.size == 0
+    end
+
+    def read_central_directory_entries(io) #:nodoc:
+      begin
+        io.seek(@cdirOffset, IO::SEEK_SET)
+      rescue Errno::EINVAL
+        raise ZipError, "Zip consistency problem while reading central directory entry"
+      end
+      @entry_set = EntrySet.new
+      @size.times do
+        tmp = Entry.read_c_dir_entry(io)
+        @entry_set << tmp
+      end
+    end
+
+    def read_from_stream(io) #:nodoc:
+      read_e_o_c_d(io)
+      read_central_directory_entries(io)
+    end
+
+    def get_e_o_c_d(io) #:nodoc:
+      begin
+        io.seek(-MAX_END_OF_CENTRAL_DIRECTORY_STRUCTURE_SIZE, IO::SEEK_END)
+      rescue Errno::EINVAL
+        io.seek(0, IO::SEEK_SET)
+      end
+      buf      = io.read
+      sigIndex = buf.rindex([END_OF_CENTRAL_DIRECTORY_SIGNATURE].pack('V'))
+      raise ZipError, "Zip end of central directory signature not found" unless sigIndex
+      buf = buf.slice!((sigIndex + 4)..(buf.bytesize))
+
+      def buf.read(count)
+        slice!(0, count)
+      end
+
+      buf
+    end
+
+    # For iterating over the entries.
+    def each(&proc)
+      @entry_set.each(&proc)
+    end
+
+    # Returns the number of entries in the central directory (and 
+    # consequently in the zip archive).
+    def size
+      @entry_set.size
+    end
+
+    def CentralDirectory.read_from_stream(io) #:nodoc:
+      cdir = new
+      cdir.read_from_stream(io)
+      return cdir
+    rescue ZipError
+      return nil
+    end
+
+    def ==(other) #:nodoc:
+      return false unless other.kind_of?(CentralDirectory)
+      @entry_set.entries.sort == other.entries.sort && comment == other.comment
+    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/constants.rb

@@ -1,11 +1,61 @@
 module Zip
-  VERSION = '0.9.7'
-  RUBY_MINOR_VERSION = RUBY_VERSION.split(".")[1].to_i
   RUNNING_ON_WINDOWS = RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/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
+  CENTRAL_DIRECTORY_ENTRY_SIGNATURE = 0x02014b50
+  CDIR_ENTRY_STATIC_HEADER_LENGTH   = 46
+
+  LOCAL_ENTRY_SIGNATURE                  = 0x04034b50
+  LOCAL_ENTRY_STATIC_HEADER_LENGTH       = 30
+  LOCAL_ENTRY_TRAILING_DESCRIPTOR_LENGTH = 4+4+4
+  VERSION_NEEDED_TO_EXTRACT              = 20
+
+  FILE_TYPE_FILE    = 010
+  FILE_TYPE_DIR     = 004
+  FILE_TYPE_SYMLINK = 012
+
+  FSTYPE_FAT      = 0
+  FSTYPE_AMIGA    = 1
+  FSTYPE_VMS      = 2
+  FSTYPE_UNIX     = 3
+  FSTYPE_VM_CMS   = 4
+  FSTYPE_ATARI    = 5
+  FSTYPE_HPFS     = 6
+  FSTYPE_MAC      = 7
+  FSTYPE_Z_SYSTEM = 8
+  FSTYPE_CPM      = 9
+  FSTYPE_TOPS20   = 10
+  FSTYPE_NTFS     = 11
+  FSTYPE_QDOS     = 12
+  FSTYPE_ACORN    = 13
+  FSTYPE_VFAT     = 14
+  FSTYPE_MVS      = 15
+  FSTYPE_BEOS     = 16
+  FSTYPE_TANDEM   = 17
+  FSTYPE_THEOS    = 18
+  FSTYPE_MAC_OSX  = 19
+  FSTYPE_ATHEOS   = 30
+
+  FSTYPES = {
+    FSTYPE_FAT      => 'FAT'.freeze,
+    FSTYPE_AMIGA    => 'Amiga'.freeze,
+    FSTYPE_VMS      => 'VMS (Vax or Alpha AXP)'.freeze,
+    FSTYPE_UNIX     => 'Unix'.freeze,
+    FSTYPE_VM_CMS   => 'VM/CMS'.freeze,
+    FSTYPE_ATARI    => 'Atari ST'.freeze,
+    FSTYPE_HPFS     => 'OS/2 or NT HPFS'.freeze,
+    FSTYPE_MAC      => 'Macintosh'.freeze,
+    FSTYPE_Z_SYSTEM => 'Z-System'.freeze,
+    FSTYPE_CPM      => 'CP/M'.freeze,
+    FSTYPE_TOPS20   => 'TOPS-20'.freeze,
+    FSTYPE_NTFS     => 'NTFS'.freeze,
+    FSTYPE_QDOS     => 'SMS/QDOS'.freeze,
+    FSTYPE_ACORN    => 'Acorn RISC OS'.freeze,
+    FSTYPE_VFAT     => 'Win32 VFAT'.freeze,
+    FSTYPE_MVS      => 'MVS'.freeze,
+    FSTYPE_BEOS     => 'BeOS'.freeze,
+    FSTYPE_TANDEM   => 'Tandem NSK'.freeze,
+    FSTYPE_THEOS    => 'Theos'.freeze,
+    FSTYPE_MAC_OSX  => 'Mac OS/X (Darwin)'.freeze,
+    FSTYPE_ATHEOS   => 'AtheOS'.freeze,
+  }.freeze
 end