archive-zip 0.3.0 → 0.4.0

data/HACKING

@@ -12,14 +12,15 @@ some cases, but such cases will be rare.
 === Runtime
 
 * Ruby 1.8.6 or greater
+* io-like 0.3.0 or greater
 
 
 === Build
 
-* rubygems 0.9.0 or greater
-* rake 0.8.1 or greater
-* allison 2.0.3 (optional - used for documentation only, if available)
-* rsync (optional - used for publishing documentation)
+* rubygems 1.8.8 or greater
+* rake 0.9.2 or greater
+* rdoc 3.9.2 or greater
+* mspec 1.5.17 or greater
 
 
 === Install
@@ -82,41 +83,23 @@ be more easily accepted if they are consistent with the rest of the code.
                            code
 
 
-== Generating Patches
-
-Patches should usually be generated against the <em>HEAD</em> revision of the
-<em>master</em> branch.  When generating patches, please try to implement only
-a single feature or bug fix per patch.  Documentation describing a patch should
-be included along with the patch so that the maintainer can more easily
-determine whether or not a patch is acceptable.  Patches lacking the necessary
-documentation will be ignored.
-
-Patches will be much more readily accepted if test cases are provided which
-verify correct operation.  Such test cases should be provided within the patch
-rather than as a separate patch.  Proper documentation, especially for
-user-visible APIs, is highly prized; providing accurate and detailed
-documentation, often in the form of rubydocs, throughout new code contributions
-will also increase the desirability of a patch.
-
-If a series of patches is generated which cannot be applied individually, make
-sure to mention the dependency relationships in whatever medium is being used
-to distribute the patches.  For instance, if a bug is discovered while
-implementing a new feature, create a patch which fixes the bug followed by a
-separate patch adding the feature.  If the feature patch requires the bug fix
-patch in order to work, note that dependency in the comments for the feature
-patch by somehow referencing the bug fix patch.
-
-The patch generation process in general:
-  $ git clone git://rubyforge.org/archive-zip.git # Clone the repo and check out
-                                                  # the master branch.
-  $ cd archive-zip                                # Enter the workspace.
-  (make and test changes)
-  $ git add file1 file2 ..                        # Add new/modified files.
-  $ git commit                                    # Commit changes.
-  $ git format-patch -C HEAD^                     # Create a patch for the last
-                                                  # commit.
-
-Repeat as necessary until all patches are generated.  Then either attach them to
-1 or more email messages addressed to the maintainer or attach them to tickets
-in the issue tracker for the project.  Remember to include a brief description
-of the patch and its dependencies, if any.
+== Contributing Code
+
+Making a contribution is pretty simple.  Fork the project on Github
+(http://github.com/javanthropus/archive-zip), make your changes, and submit a
+pull request.  Requests that meet the following criteria will be the most
+readily accepted:
+
+1. Each pull request should target an individual issue and should introduce
+   relatively few commits.
+2. Individual commits need to be small, easily digestible units.
+3. Good descriptions of the changes introduced should be included in each commit
+   message.
+4. Interdependencies on existing pull requests need to be noted in the pull
+   request.
+5. New test cases are a major plus.
+6. Documentation for new classes, methods, etc. is also a win.
+7. The coding style of the project should be respected.
+
+In other words, the less work necessary to bring your changes into the project,
+the faster you can expect them to be pulled.

data/NEWS

@@ -6,6 +6,31 @@ detailed information is available in the rest of the documentation.
 <b>NOTE:</b> Date stamps in the following entries are in YYYY/MM/DD format.
 
 
+== v0.4.0 (2011/??/??)
+
+=== Features
+
+* Added Ruby 1.9 support.
+* Simplified arguments for Archive::Zip.new.
+  * Archives cannot be directly opened for modification.
+  * Archive::Zip.archive can still emulate modifying an archive in place.
+* Added a bunch of tests (many more still needed).
+* Updated and simplified rake tasks.
+* Created a standalone gemspec file.
+
+=== Fixes
+
+* Fixed a potential data loss bug in Zlib::ZReader.
+* Archives larger than the maximum Fixnum for the platform don't falsely raise a
+  "non-integer windows position given" error.
+
+=== Notes
+
+* Broke backward compatibility for Archive::Zip.new.
+  * Wrapper class methods continue to work as before.
+* Broke backward compatibility for Archive::Zip::ExtraField.
+  * Allows separate handling of extra fields in central and local records.
+
 == v0.3.0 (2009/01/23)
 
 * Made a significant performance improvement for the extraction of compressed

data/README

@@ -12,7 +12,7 @@ supported with a moderate amount of effort.
 
 == License
 
-Copyright © 2008 Jeremy Bopp <jeremy at bopp dot net>
+Copyright © 2010 Jeremy Bopp <jeremy at bopp dot net>
 
 Licensed under the same terms as Ruby -- See the included LICENSE file for
 details
@@ -76,7 +76,7 @@ Create a few archives:
   # Create a new archive which will be written to a pipe.
   # Assume $stdout is the write end a pipe.
   # (ruby example.rb | cat >example.zip)
-  Archive::Zip.open(nil, $stdout) do |z|
+  Archive::Zip.open($stdout, :w) do |z|
     z.archive('a_directory')
   end
 

data/Rakefile

@@ -0,0 +1,202 @@
+# encoding: UTF-8
+
+require 'rubygems'
+gem 'rdoc'
+
+require 'rubygems/package_task'
+require 'rake/clean'
+require 'rdoc/task'
+
+# The path to the version.rb file and a string to eval to find the version.
+VERSION_RB = 'lib/archive/zip/version.rb'
+VERSION_REF = 'Archive::Zip::VERSION'
+
+# Load the gemspec file for this project.
+GEMSPEC = 'archive-zip.gemspec'
+SPEC = eval(File.read(GEMSPEC), nil, GEMSPEC)
+
+# Returns the value of the VERSION environment variable as a Gem::Version object
+# assuming it is set and a valid Gem version string.  Otherwise, raises an
+# exception.
+def get_version_argument
+  version = ENV['VERSION']
+  if version.nil? || version.empty?
+    raise "No version specified: Add VERSION=... to the command line"
+  end
+  begin
+    Gem::Version.create(version.dup)
+  rescue ArgumentError
+    raise "Invalid version specified in `VERSION=#{version}'"
+  end
+end
+
+# Performs an in place, per line edit of the file indicated by _path_ by calling
+# the sub method on each line and passing _pattern_, _replacement_, and _b_ as
+# arguments.
+def file_sub(path, pattern, replacement = nil, &b)
+  tmp_path = "#{path}.tmp"
+  File.open(path) do |infile|
+    File.open(tmp_path, 'w') do |outfile|
+      infile.each do |line|
+        outfile.write(line.sub(pattern, replacement, &b))
+      end
+    end
+  end
+  File.rename(tmp_path, path)
+end
+
+# Updates the version string in the gemspec file and a version.rb file it to the
+# string in _version_.
+def set_version(version)
+  file_sub(GEMSPEC, /(\.version\s*=\s*).*/, "\\1\"#{version}\"")
+  file_sub(VERSION_RB, /^(\s*VERSION\s*=\s*).*/, "\\1\"#{version}\"")
+end
+
+# A dynamically generated list of files that should match the manifest (the
+# combined contents of SPEC.files and SPEC.test_files).  The idea is for this
+# list to contain all project files except for those that have been explicitly
+# excluded.  This list will be compared with the manifest from the SPEC in order
+# to help catch the addition or removal of files to or from the project that
+# have not been accounted for either by an exclusion here or an inclusion in the
+# SPEC manifest.
+#
+# NOTE:
+# It is critical that the manifest is *not* automatically generated via globbing
+# and the like; otherwise, this will yield a simple comparison between
+# redundantly generated lists of files that probably will not protect the
+# project from the unintentional inclusion or exclusion of files in the
+# distribution.
+PKG_FILES = FileList.new('**/*', '**/.[^.][^.]*') do |files|
+  # Exclude the gemspec file.
+  files.exclude('*.gemspec')
+  # Exclude anything that doesn't exist and directories.
+  files.exclude {|file| ! File.exist?(file) || File.directory?(file)}
+  # Exclude Vim swap files.
+  files.exclude('**/.*.sw?')
+  # Exclude Git administrative files and directories.
+  files.exclude(%r{(^|[/\\])\.git(ignore|modules)?([/\\]|$)})
+
+  # Exclude the top level pkg, doc, and examples directories and their contents.
+  files.exclude(%r{^(pkg|doc|examples)([/\\]|$)})
+end
+
+# Make sure that :clean and :clobber will not whack the repository files.
+CLEAN.exclude('.git/**')
+# Vim swap files are fair game for clean up.
+CLEAN.include('**/.*.sw?')
+
+desc 'Alias for build:gem'
+task :build => 'build:gem'
+
+# Build related tasks.
+namespace :build do
+  # Create the gem and package tasks.
+  Gem::PackageTask.new(SPEC).define
+
+  # Ensure that the manifest is consulted after building the gem.  Any
+  # generated/compiled files should be available at that time.
+  task :gem => :check_manifest
+
+  desc 'Verify the manifest'
+  task :check_manifest do
+    manifest_files = (SPEC.files + SPEC.test_files).sort.uniq
+    pkg_files = PKG_FILES.sort.uniq
+    if manifest_files != pkg_files then
+      common_files = manifest_files & pkg_files
+      manifest_files -= common_files
+      pkg_files -= common_files
+      message = ["The manifest does not match the automatic file list."]
+      unless manifest_files.empty? then
+        message << "  Extraneous files:\n    " + manifest_files.join("\n    ")
+      end
+      unless pkg_files.empty?
+        message << "  Missing files:\n    " + pkg_files.join("\n    ")
+      end
+      raise message.join("\n")
+    end
+  end
+end
+
+# Ensure that the clobber task also clobbers package files.
+task :clobber => 'build:clobber_package'
+
+# Create the rdoc task.
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir   = 'doc'
+  rdoc.title      = 'Archive::Zip Documentation'
+  rdoc.rdoc_files = SPEC.files - SPEC.test_files
+  rdoc.main       = 'README'
+end
+
+# Gem related tasks.
+namespace :gem do
+  desc 'Alias for build:gem'
+  task :build => 'build:gem'
+
+  desc 'Publish the gemfile'
+  task :publish => ['version:check', :test, 'repo:tag', :build] do
+    sh "gem push pkg/#{SPEC.name}-#{SPEC.version}*.gem"
+  end
+end
+
+desc 'Run tests'
+task :test do
+  sh "mspec"
+end
+
+# Version string management tasks.
+namespace :version do
+  desc 'Set the version for the project to a specified version'
+  task :set do
+    set_version(get_version_argument)
+  end
+
+  desc 'Set the version for the project back to 0.0.0'
+  task :reset do
+    set_version('0.0.0')
+  end
+
+  desc 'Checks that all version strings are correctly set'
+  task :check do
+    version = get_version_argument
+    if version != SPEC.version
+      raise "The given version `#{version}' does not match the gemspec version `#{SPEC.version}'"
+    end
+
+    begin
+      load VERSION_RB
+      internal_version = Gem::Version.create(eval(VERSION_REF))
+      if version != internal_version
+        raise "The given version `#{version}' does not match the version.rb version `#{internal_version}'"
+      end
+    rescue ArgumentError
+      raise "Invalid version specified in `#{VERSION_RB}'"
+    end
+
+    begin
+      File.open('NEWS') do |news|
+        unless news.lines.any? {|l| l =~ /^== v#{Regexp.escape(version.to_s)} /}
+          raise "The NEWS file does not mention version `#{version}'"
+        end
+      end
+    rescue Errno::ENOENT
+      raise 'No NEWS file found'
+    end
+  end
+end
+
+# Repository and workspace management tasks.
+namespace :repo do
+  desc 'Tag the current HEAD with the version string'
+  task :tag => :check_workspace do
+    version = get_version_argument
+    sh "git tag -s -m 'Release v#{version}' v#{version}"
+  end
+
+  desc 'Ensure the workspace is fully committed and clean'
+  task :check_workspace do
+    unless `git status --untracked-files=all --porcelain`.empty?
+      raise 'Workspace has been modified.  Commit pending changes and try again.'
+    end
+  end
+end

data/TODO

@@ -0,0 +1,5 @@
+= Future work items (in no particular order):
+
+* Add test cases for all classes.
+* Add support for using non-seekable IO objects as archive sources.
+* Add support for 0x5855 and 0x7855 extra fields.

data/default.mspec

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+class MSpecScript
+  # An ordered list of the directories containing specs to run
+  set :files, ['spec']
+
+  # The default implementation to run the specs.
+  set :target, 'ruby'
+end

data/lib/archive/support/binary_stringio.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+require 'stringio'
+
+# This class is a version of StringIO that always uses the binary encoding on
+# any Ruby platform that has a notion of encodings.  On Ruby platforms without
+# encoding support, this class is equivalent to StringIO.
+class BinaryStringIO < StringIO
+  # Creates a new instance of this class.
+  #
+  # This takes all the arguments of StringIO.new.
+  def initialize(*args)
+    super
+
+    # Force a binary encoding when possible.
+    if respond_to?(:set_encoding, true)
+      set_encoding('binary')
+    end
+  end
+
+  # Hide #set_encoding so that the encoding cannot be changed later.
+  private :set_encoding if instance_methods.include?(:set_encoding)
+end

data/lib/archive/support/integer.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+
+class Integer
+  unless public_method_defined?('ord') then
+    # Returns the int itself.
+    #
+    # This method is defined here only if not already defined elsewhere, such as
+    # versions of Ruby prior to 1.8.7.
+    def ord
+      self
+    end
+  end
+end

data/lib/archive/support/io-like.rb

@@ -1,8 +1,10 @@
+# encoding: UTF-8
+
 # Try to first load io-like from rubygems and then fall back to assuming a
 # standard installation.
 begin
   require 'rubygems'
-  gem 'io-like', '>= 0.1.0'
+  gem 'io-like', '>= 0.3.0'
 rescue LoadError
   # Failed to load via rubygems.
 end

data/lib/archive/support/ioextensions.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+
+# IOExtensions provides convenience wrappers for certain IO functionality.
+module IOExtensions
+  # Reads and returns exactly _length_ bytes from _io_ using the read method on
+  # _io_.  If there is insufficient data available, an EOFError is raised.
+  def self.read_exactly(io, length, buffer = '')
+    buffer.slice!(0..-1) unless buffer.empty?
+    while buffer.size < length do
+      internal = io.read(length - buffer.size)
+      raise EOFError, 'unexpected end of file' if internal.nil?
+      buffer << internal
+    end
+    buffer
+  end
+end

data/lib/archive/support/iowindow.rb

@@ -1,7 +1,9 @@
+# encoding: UTF-8
+
 require 'archive/support/io-like'
 
-# IOWindow represents an IO object which wraps another one allowing read access
-# to a subset of the data within the stream.
+# IOWindow represents an IO object which wraps another one allowing read and/or
+# write access to a subset of the data within the stream.
 #
 # <b>NOTE:</b> This object is NOT thread safe.
 class IOWindow
@@ -15,8 +17,6 @@ class IOWindow
   # must be an integer greater than or equal to 0.  _window_size_ must be an
   # integer greater than or equal to 0.
   def initialize(io, window_position, window_size)
-    raise ArgumentError, 'non-seekable IO object given' unless io.seekable?
-
     @io = io
     @unbuffered_pos = 0
     self.window_position = window_position
@@ -29,9 +29,10 @@ class IOWindow
   # Set the file position at which this window begins.
   # _window_position_ must be an integer greater than or equal to 0.
   def window_position=(window_position)
-    unless window_position.kind_of?(Fixnum) then
-      raise ArgumentError, 'non-integer window position given'
+    unless window_position.respond_to?(:to_int) then
+      raise TypeError, "can't convert #{window_position.class} into Integer"
     end
+    window_position = window_position.to_int
     if window_position < 0 then
       raise ArgumentError, 'non-positive window position given'
     end
@@ -45,9 +46,10 @@ class IOWindow
   # Set the size of the window.
   # _window_size_ must be an integer greater than or equal to 0.
   def window_size=(window_size)
-    unless window_size.kind_of?(Fixnum) then
-      raise ArgumentError, 'non-integer window size given'
+    unless window_size.respond_to?(:to_int) then
+      raise TypeError, "can't convert #{window_size.class} into Integer"
     end
+    window_size = window_size.to_int
     raise ArgumentError, 'non-positive window size given' if window_size < 0
 
     @window_size = window_size
@@ -95,16 +97,6 @@ class IOWindow
     @unbuffered_pos = new_pos
   end
 
-  def unbuffered_write(string)
-    restore_self
-
-    # Ensure that the outputted string will not extend past the window.
-    string = string.slice(0, @window_size - @unbuffered_pos)
-    @io.write(string)
-  ensure
-    restore_delegate
-  end
-
   # Restores the state of the delegate IO object to that saved by a prior call
   # to #restore_self.
   def restore_delegate