archive-zip 0.12.0 → 0.13.0.pre1

data/lib/archive/zip/codec/null_encryption.rb

@@ -1,193 +1,11 @@
 # encoding: UTF-8
 
-require 'archive/support/io-like'
 require 'archive/zip/codec'
 
 module Archive; class Zip; module Codec
   # Archive::Zip::Codec::NullEncryption is a handle for an encryption codec
   # which passes data through itself unchanged.
   class NullEncryption
-    # Archive::Zip::Codec::NullEncryption::Encrypt is a writable, IO-like object
-    # which writes all data written to it directly to a delegate IO object.  A
-    # _close_ method is also provided which can optionally closed the delegate
-    # object.
-    class Encrypt
-      include IO::Like
-
-      # Creates a new instance of this class with the given argument using #new
-      # and then passes the instance to the given block.  The #close method is
-      # guaranteed to be called after the block completes.
-      #
-      # Equivalent to #new if no block is given.
-      def self.open(io)
-        encrypt_io = new(io)
-        return encrypt_io unless block_given?
-
-        begin
-          yield(encrypt_io)
-        ensure
-          encrypt_io.close unless encrypt_io.closed?
-        end
-      end
-
-      # Creates a new instance of this class using _io_ as a data sink.  _io_
-      # must be writable and must provide a write method as IO does or errors
-      # will be raised when performing write operations.
-      #
-      # The _flush_size_ attribute is set to <tt>0</tt> by default under the
-      # assumption that _io_ is already buffered.
-      def initialize(io)
-        @io = io
-
-        # Keep track of the total number of bytes written.
-        @total_bytes_in = 0
-
-        # Assume that the delegate IO object is already buffered.
-        self.flush_size = 0
-      end
-
-      # Closes this object so that further write operations will fail.  If
-      # _close_delegate_ is +true+, the delegate object used as a data sink will
-      # also be closed using its close method.
-      def close(close_delegate = true)
-        super()
-        @io.close if close_delegate
-      end
-
-      private
-
-      # Allows resetting this object and the delegate object back to the
-      # beginning of the stream or reporting the current position in the stream.
-      #
-      # Raises Errno::EINVAL unless _offset_ is <tt>0</tt> and _whence_ is
-      # either IO::SEEK_SET or IO::SEEK_CUR.  Raises Errno::EINVAL if _whence_
-      # is IO::SEEK_SEK and the delegate object does not respond to the _rewind_
-      # method.
-      def unbuffered_seek(offset, whence = IO::SEEK_SET)
-        unless offset == 0 &&
-               ((whence == IO::SEEK_SET && @io.respond_to?(:rewind)) ||
-                whence == IO::SEEK_CUR) then
-          raise Errno::EINVAL
-        end
-
-        case whence
-        when IO::SEEK_SET
-          @io.rewind
-          @total_bytes_in = 0
-        when IO::SEEK_CUR
-          @total_bytes_in
-        end
-      end
-
-      # Writes _string_ to the delegate IO object and returns the result.
-      def unbuffered_write(string)
-        bytes_written = @io.write(string)
-        @total_bytes_in += bytes_written
-        bytes_written
-      end
-    end
-
-    # Archive::Zip::Codec::NullEncryption::Decrypt is a readable, IO-like object
-    # which reads data directly from a delegate IO object, making no changes.  A
-    # _close_ method is also provided which can optionally closed the delegate
-    # object.
-    class Decrypt
-      include IO::Like
-
-      # Creates a new instance of this class with the given argument using #new
-      # and then passes the instance to the given block.  The #close method is
-      # guaranteed to be called after the block completes.
-      #
-      # Equivalent to #new if no block is given.
-      def self.open(io)
-        decrypt_io = new(io)
-        return decrypt_io unless block_given?
-
-        begin
-          yield(decrypt_io)
-        ensure
-          decrypt_io.close unless decrypt_io.closed?
-        end
-      end
-
-      # Creates a new instance of this class using _io_ as a data source.  _io_
-      # must be readable and provide a _read_ method as an IO instance would or
-      # errors will be raised when performing read operations.
-      #
-      # This class has extremely limited seek capabilities.  It is possible to
-      # seek with an offset of <tt>0</tt> and a whence of <tt>IO::SEEK_CUR</tt>.
-      # As a result, the _pos_ and _tell_ methods also work as expected.
-      #
-      # Due to certain optimizations within IO::Like#seek and if there is data
-      # in the read buffer, the _seek_ method can be used to seek forward from
-      # the current stream position up to the end of the buffer.  Unless it is
-      # known definitively how much data is in the buffer, it is best to avoid
-      # relying on this behavior.
-      #
-      # If _io_ also responds to _rewind_, then the _rewind_ method of this
-      # class can be used to reset the whole stream back to the beginning. Using
-      # _seek_ of this class to seek directly to offset <tt>0</tt> using
-      # <tt>IO::SEEK_SET</tt> for whence will also work in this case.
-      #
-      # Any other seeking attempts, will raise Errno::EINVAL exceptions.
-      #
-      # The _fill_size_ attribute is set to <tt>0</tt> by default under the
-      # assumption that _io_ is already buffered.
-      def initialize(io)
-        @io = io
-
-        # Keep track of the total number of bytes read.
-        @total_bytes_out = 0
-
-        # Assume that the delegate IO object is already buffered.
-        self.fill_size = 0
-      end
-
-      # Closes this object so that further write operations will fail.  If
-      # _close_delegate_ is +true+, the delegate object used as a data source
-      # will also be closed using its close method.
-      def close(close_delegate = true)
-        super()
-        @io.close if close_delegate
-      end
-
-      private
-
-      # Reads and returns at most _length_ bytes from the delegate IO object.
-      #
-      # Raises EOFError if there is no data to read.
-      def unbuffered_read(length)
-        buffer = @io.read(length)
-        raise EOFError, 'end of file reached' if buffer.nil?
-        @total_bytes_out += buffer.length
-
-        buffer
-      end
-
-      # Allows resetting this object and the delegate object back to the
-      # beginning of the stream or reporting the current position in the stream.
-      #
-      # Raises Errno::EINVAL unless _offset_ is <tt>0</tt> and _whence_ is
-      # either IO::SEEK_SET or IO::SEEK_CUR.  Raises Errno::EINVAL if _whence_
-      # is IO::SEEK_SEK and the delegate object does not respond to the _rewind_
-      # method.
-      def unbuffered_seek(offset, whence = IO::SEEK_SET)
-        unless offset == 0 &&
-               ((whence == IO::SEEK_SET && @io.respond_to?(:rewind)) ||
-                whence == IO::SEEK_CUR) then
-          raise Errno::EINVAL
-        end
-
-        case whence
-        when IO::SEEK_SET
-          @io.rewind
-          @total_bytes_out = 0
-        when IO::SEEK_CUR
-          @total_bytes_out
-        end
-      end
-    end
-
     # This method signature is part of the interface contract expected by
     # Archive::Zip::Entry for encryption codec objects.
     #
@@ -195,7 +13,8 @@ module Archive; class Zip; module Codec
     # Archive::Zip::Codec::NullEncryption::Encrypt object using that class' open
     # method.
     def encryptor(io, password, &b)
-      Encrypt.open(io, &b)
+      return io unless block_given?
+      b[io]
     end
 
     # This method signature is part of the interface contract expected by
@@ -205,7 +24,8 @@ module Archive; class Zip; module Codec
     # Archive::Zip::Codec::NullEncryption::Decrypt object using that class' open
     # method.
     def decryptor(io, password, &b)
-      Decrypt.open(io, &b)
+      return io unless block_given?
+      b[io]
     end
 
     # This method signature is part of the interface contract expected by

data/lib/archive/zip/codec/store/reader.rb

@@ -0,0 +1,97 @@
+# encoding: UTF-8
+
+require 'io/like_helpers/delegated_io'
+
+require 'archive/support/zlib'
+require 'archive/zip/data_descriptor'
+
+module Archive; class Zip; module Codec; class Store
+# Archive::Zip::Codec::Store::Reader is a readable, IO-like wrapper
+# around a readable, IO-like object which provides a CRC32 checksum of the
+# data read through it as well as the count of the total amount of data.  A
+# _close_ method is also provided which can optionally close the delegate
+# object.  In addition a convenience method is provided for generating
+# DataDescriptor objects based on the data which is passed through this
+# object.
+#
+# Instances of this class should only be accessed via the
+# Archive::Zip::Codec::Store#decompressor method.
+class Reader < IO::LikeHelpers::DelegatedIO
+  # Creates a new instance of this class using _io_ as a data source.  _io_
+  # must be readable and provide a _read_ method as an IO instance would or
+  # errors will be raised when performing read operations.
+  #
+  # This class has extremely limited seek capabilities.  It is possible to
+  # seek with an offset of <tt>0</tt> and a whence of <tt>IO::SEEK_CUR</tt>.
+  # As a result, the _pos_ and _tell_ methods also work as expected.
+  #
+  # Due to certain optimizations within IO::Like#seek and if there is data
+  # in the read buffer, the _seek_ method can be used to seek forward from
+  # the current stream position up to the end of the buffer.  Unless it is
+  # known definitively how much data is in the buffer, it is best to avoid
+  # relying on this behavior.
+  #
+  # If _io_ also responds to _rewind_, then the _rewind_ method of this
+  # class can be used to reset the whole stream back to the beginning. Using
+  # _seek_ of this class to seek directly to offset <tt>0</tt> using
+  # <tt>IO::SEEK_SET</tt> for whence will also work in this case.
+  #
+  # Any other seeking attempts, will raise Errno::EINVAL exceptions.
+  def initialize(delegate, autoclose: true)
+    super
+    @crc32 = 0
+    @uncompressed_size = 0
+  end
+
+  # Returns an instance of Archive::Zip::DataDescriptor with information
+  # regarding the data which has passed through this object from the
+  # delegate object.  It is recommended to call the close method before
+  # calling this in order to ensure that no further read operations change
+  # the state of this object.
+  def data_descriptor
+    DataDescriptor.new(
+      @crc32,
+      @uncompressed_size,
+      @uncompressed_size
+    )
+  end
+
+  # Returns at most _length_ bytes from the delegate object.  Updates the
+  # uncompressed_size and crc32 attributes as a side effect.
+  def read(length, buffer: nil, buffer_offset: 0)
+    result = super
+    return result if Symbol === result
+
+    buffer = result if buffer.nil?
+    @uncompressed_size += buffer.bytesize
+    @crc32 = Zlib.crc32(buffer, @crc32)
+
+    result
+  end
+
+  # Allows resetting this object and the delegate object back to the
+  # beginning of the stream or reporting the current position in the stream.
+  #
+  # Raises Errno::EINVAL unless _offset_ is <tt>0</tt> and _whence_ is
+  # either IO::SEEK_SET or IO::SEEK_CUR.  Raises Errno::EINVAL if _whence_
+  # is IO::SEEK_SEK and the delegate object does not respond to the _rewind_
+  # method.
+  def seek(amount, whence = IO::SEEK_SET)
+    assert_open
+    raise Errno::ESPIPE if amount != 0 || whence == IO::SEEK_END
+
+    case whence
+    when IO::SEEK_SET
+      result = super
+      return result if Symbol === result
+      @crc32 = 0
+      @uncompressed_size = 0
+      result
+    when IO::SEEK_CUR
+      @uncompressed_size
+    else
+      raise Errno::EINVAL
+    end
+  end
+end
+end; end; end; end

data/lib/archive/zip/codec/store/writer.rb

@@ -0,0 +1,78 @@
+# encoding: UTF-8
+
+require 'io/like_helpers/delegated_io'
+
+require 'archive/support/zlib'
+require 'archive/zip/data_descriptor'
+
+module Archive; class Zip; module Codec; class Store
+# Archive::Zip::Codec::Store::Writer is simply a writable, IO-like wrapper
+# around a writable, IO-like object which provides a CRC32 checksum of the
+# data written through it as well as the count of the total amount of data.
+# A _close_ method is also provided which can optionally close the delegate
+# object.  In addition a convenience method is provided for generating
+# DataDescriptor objects based on the data which is passed through this
+# object.
+#
+# Instances of this class should only be accessed via the
+# Archive::Zip::Codec::Store#compressor method.
+class Writer < IO::LikeHelpers::DelegatedIO
+  # Creates a new instance of this class using _io_ as a data sink.  _io_
+  # must be writable and must provide a write method as IO does or errors
+  # will be raised when performing write operations.
+  def initialize(delegate, autoclose: true)
+    super
+    @crc32 = 0
+    @uncompressed_size = 0
+  end
+
+  # Returns an instance of Archive::Zip::DataDescriptor with information
+  # regarding the data which has passed through this object to the delegate
+  # object.  The close or flush methods should be called before using this
+  # method in order to ensure that any possibly buffered data is flushed to
+  # the delegate object; otherwise, the contents of the data descriptor may
+  # be inaccurate.
+  def data_descriptor
+    DataDescriptor.new(@crc32, @uncompressed_size, @uncompressed_size)
+  end
+
+  # Allows resetting this object and the delegate object back to the
+  # beginning of the stream or reporting the current position in the stream.
+  #
+  # Raises Errno::EINVAL unless _offset_ is <tt>0</tt> and _whence_ is
+  # either IO::SEEK_SET or IO::SEEK_CUR.  Raises Errno::EINVAL if _whence_
+  # is IO::SEEK_SEK and the delegate object does not respond to the _rewind_
+  # method.
+  def seek(amount, whence = IO::SEEK_SET)
+    assert_open
+    raise Errno::ESPIPE if amount != 0 || whence == IO::SEEK_END
+
+    case whence
+    when IO::SEEK_SET
+      result = super
+      return result if Symbol === result
+      @crc32 = 0
+      @uncompressed_size = 0
+      result
+    when IO::SEEK_CUR
+      @uncompressed_size
+    else
+      raise Errno::EINVAL
+    end
+  end
+
+  # Writes _string_ to the delegate object and returns the number of bytes
+  # actually written.  Updates the uncompressed_size and crc32 attributes as
+  # a side effect.
+  def write(buffer, length: buffer.bytesize)
+    result = super
+    return result if Symbol === result
+
+    @uncompressed_size += result
+    buffer = buffer[0, result] if result < buffer.bytesize
+    @crc32 = Zlib.crc32(buffer, @crc32)
+
+    result
+  end
+end
+end; end; end; end

data/lib/archive/zip/codec/store.rb

@@ -1,237 +1,12 @@
 # encoding: UTF-8
 
-require 'archive/support/io-like'
-require 'archive/support/zlib'
-require 'archive/zip/codec'
-require 'archive/zip/data_descriptor'
+require 'archive/zip/codec/store/reader'
+require 'archive/zip/codec/store/writer'
 
 module Archive; class Zip; module Codec
   # Archive::Zip::Codec::Store is a handle for the store-unstore (no
   # compression) codec.
   class Store
-    # Archive::Zip::Codec::Store::Compress is simply a writable, IO-like wrapper
-    # around a writable, IO-like object which provides a CRC32 checksum of the
-    # data written through it as well as the count of the total amount of data.
-    # A _close_ method is also provided which can optionally close the delegate
-    # object.  In addition a convenience method is provided for generating
-    # DataDescriptor objects based on the data which is passed through this
-    # object.
-    #
-    # Instances of this class should only be accessed via the
-    # Archive::Zip::Codec::Store#compressor method.
-    class Compress
-      include IO::Like
-
-      # Creates a new instance of this class with the given argument using #new
-      # and then passes the instance to the given block.  The #close method is
-      # guaranteed to be called after the block completes.
-      #
-      # Equivalent to #new if no block is given.
-      def self.open(io)
-        store_io = new(io)
-        return store_io unless block_given?
-
-        begin
-          yield(store_io)
-        ensure
-          store_io.close unless store_io.closed?
-        end
-      end
-
-      # Creates a new instance of this class using _io_ as a data sink.  _io_
-      # must be writable and must provide a write method as IO does or errors
-      # will be raised when performing write operations.
-      #
-      # The _flush_size_ attribute is set to <tt>0</tt> by default under the
-      # assumption that _io_ is already buffered.
-      def initialize(io)
-        @io = io
-        @crc32 = 0
-        @uncompressed_size = 0
-        # Assume that the delegate IO object is already buffered.
-        self.flush_size = 0
-      end
-
-      # Closes this object so that further write operations will fail.  If
-      # _close_delegate_ is +true+, the delegate object used as a data sink will
-      # also be closed using its close method.
-      def close(close_delegate = true)
-        super()
-        @io.close if close_delegate
-        nil
-      end
-
-      # Returns an instance of Archive::Zip::DataDescriptor with information
-      # regarding the data which has passed through this object to the delegate
-      # object.  The close or flush methods should be called before using this
-      # method in order to ensure that any possibly buffered data is flushed to
-      # the delegate object; otherwise, the contents of the data descriptor may
-      # be inaccurate.
-      def data_descriptor
-        DataDescriptor.new(
-          @crc32,
-          @uncompressed_size,
-          @uncompressed_size
-        )
-      end
-
-      private
-
-      # Allows resetting this object and the delegate object back to the
-      # beginning of the stream or reporting the current position in the stream.
-      #
-      # Raises Errno::EINVAL unless _offset_ is <tt>0</tt> and _whence_ is
-      # either IO::SEEK_SET or IO::SEEK_CUR.  Raises Errno::EINVAL if _whence_
-      # is IO::SEEK_SEK and the delegate object does not respond to the _rewind_
-      # method.
-      def unbuffered_seek(offset, whence = IO::SEEK_SET)
-        unless offset == 0 &&
-               ((whence == IO::SEEK_SET && @io.respond_to?(:rewind)) ||
-                whence == IO::SEEK_CUR) then
-          raise Errno::EINVAL
-        end
-
-        case whence
-        when IO::SEEK_SET
-          @io.rewind
-          @crc32 = 0
-          @uncompressed_size = 0
-        when IO::SEEK_CUR
-          @uncompressed_size
-        end
-      end
-
-      # Writes _string_ to the delegate object and returns the number of bytes
-      # actually written.  Updates the uncompressed_size and crc32 attributes as
-      # a side effect.
-      def unbuffered_write(string)
-        bytes_written = @io.write(string)
-        @uncompressed_size += bytes_written
-        @crc32 = Zlib.crc32(string.slice(0, bytes_written), @crc32)
-        bytes_written
-      end
-    end
-
-    # Archive::Zip::Codec::Store::Decompress is a readable, IO-like wrapper
-    # around a readable, IO-like object which provides a CRC32 checksum of the
-    # data read through it as well as the count of the total amount of data.  A
-    # _close_ method is also provided which can optionally close the delegate
-    # object.  In addition a convenience method is provided for generating
-    # DataDescriptor objects based on the data which is passed through this
-    # object.
-    #
-    # Instances of this class should only be accessed via the
-    # Archive::Zip::Codec::Store#decompressor method.
-    class Decompress
-      include IO::Like
-
-      # Creates a new instance of this class with the given arguments using #new
-      # and then passes the instance to the given block.  The #close method is
-      # guaranteed to be called after the block completes.
-      #
-      # Equivalent to #new if no block is given.
-      def self.open(io)
-        unstore_io = new(io)
-        return unstore_io unless block_given?
-
-        begin
-          yield(unstore_io)
-        ensure
-          unstore_io.close unless unstore_io.closed?
-        end
-      end
-
-      # Creates a new instance of this class using _io_ as a data source.  _io_
-      # must be readable and provide a _read_ method as an IO instance would or
-      # errors will be raised when performing read operations.
-      #
-      # This class has extremely limited seek capabilities.  It is possible to
-      # seek with an offset of <tt>0</tt> and a whence of <tt>IO::SEEK_CUR</tt>.
-      # As a result, the _pos_ and _tell_ methods also work as expected.
-      #
-      # Due to certain optimizations within IO::Like#seek and if there is data
-      # in the read buffer, the _seek_ method can be used to seek forward from
-      # the current stream position up to the end of the buffer.  Unless it is
-      # known definitively how much data is in the buffer, it is best to avoid
-      # relying on this behavior.
-      #
-      # If _io_ also responds to _rewind_, then the _rewind_ method of this
-      # class can be used to reset the whole stream back to the beginning. Using
-      # _seek_ of this class to seek directly to offset <tt>0</tt> using
-      # <tt>IO::SEEK_SET</tt> for whence will also work in this case.
-      #
-      # Any other seeking attempts, will raise Errno::EINVAL exceptions.
-      #
-      # The _fill_size_ attribute is set to <tt>0</tt> by default under the
-      # assumption that _io_ is already buffered.
-      def initialize(io)
-        @io = io
-        @crc32 = 0
-        @uncompressed_size = 0
-        # Assume that the delegate IO object is already buffered.
-        self.fill_size = 0
-      end
-
-      # Closes this object so that further read operations will fail.  If
-      # _close_delegate_ is +true+, the delegate object used as a data source
-      # will also be closed using its close method.
-      def close(close_delegate = true)
-        super()
-        @io.close if close_delegate
-        nil
-      end
-
-      # Returns an instance of Archive::Zip::DataDescriptor with information
-      # regarding the data which has passed through this object from the
-      # delegate object.  It is recommended to call the close method before
-      # calling this in order to ensure that no further read operations change
-      # the state of this object.
-      def data_descriptor
-        DataDescriptor.new(
-          @crc32,
-          @uncompressed_size,
-          @uncompressed_size
-        )
-      end
-
-      private
-
-      # Returns at most _length_ bytes from the delegate object.  Updates the
-      # uncompressed_size and crc32 attributes as a side effect.
-      def unbuffered_read(length)
-        buffer = @io.read(length)
-        raise EOFError, 'end of file reached' if buffer.nil?
-
-        @uncompressed_size += buffer.length
-        @crc32 = Zlib.crc32(buffer, @crc32)
-        buffer
-      end
-
-      # Allows resetting this object and the delegate object back to the
-      # beginning of the stream or reporting the current position in the stream.
-      #
-      # Raises Errno::EINVAL unless _offset_ is <tt>0</tt> and _whence_ is
-      # either IO::SEEK_SET or IO::SEEK_CUR.  Raises Errno::EINVAL if _whence_
-      # is IO::SEEK_SEK and the delegate object does not respond to the _rewind_
-      # method.
-      def unbuffered_seek(offset, whence = IO::SEEK_SET)
-        unless offset == 0 &&
-               ((whence == IO::SEEK_SET && @io.respond_to?(:rewind)) ||
-                whence == IO::SEEK_CUR) then
-          raise Errno::EINVAL
-        end
-
-        case whence
-        when IO::SEEK_SET
-          @io.rewind
-          @crc32 = 0
-          @uncompressed_size = 0
-        when IO::SEEK_CUR
-          @uncompressed_size
-        end
-      end
-    end
-
     # The numeric identifier assigned to this compresion codec by the ZIP
     # specification.
     ID = 0
@@ -250,20 +25,20 @@ module Archive; class Zip; module Codec
     # This method signature is part of the interface contract expected by
     # Archive::Zip::Entry for compression codec objects.
     #
-    # A convenience method for creating an Archive::Zip::Codec::Store::Compress
+    # A convenience method for creating an Archive::Zip::Codec::Store::Writer
     # object using that class' open method.
     def compressor(io, &b)
-      Compress.open(io, &b)
+      Writer.open(io, &b)
     end
 
     # This method signature is part of the interface contract expected by
     # Archive::Zip::Entry for compression codec objects.
     #
     # A convenience method for creating an
-    # Archive::Zip::Codec::Store::Decompress object using that class' open
+    # Archive::Zip::Codec::Store::Reader object using that class' open
     # method.
     def decompressor(io, &b)
-      Decompress.open(io, &b)
+      Reader.open(io, &b)
     end
 
     # This method signature is part of the interface contract expected by