rubyzip 2.4.1 → 3.0.0.alpha

data/lib/zip/entry_set.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module Zip
-  class EntrySet #:nodoc:all
+  class EntrySet # :nodoc:all
     include Enumerable
-    attr_accessor :entry_set, :entry_order
+
+    attr_reader :entry_set
+    protected   :entry_set
 
     def initialize(an_enumerable = [])
       super()
@@ -33,10 +37,8 @@ module Zip
       entry if @entry_set.delete(to_key(entry))
     end
 
-    def each
-      @entry_set = sorted_entries.dup.each do |_, value|
-        yield(value)
-      end
+    def each(&block)
+      entries.each(&block)
     end
 
     def entries
@@ -70,7 +72,7 @@ module Zip
     protected
 
     def sorted_entries
-      ::Zip.sort_entries ? Hash[@entry_set.sort] : @entry_set
+      ::Zip.sort_entries ? @entry_set.sort.to_h : @entry_set
     end
 
     private

data/lib/zip/errors.rb

@@ -1,19 +1,118 @@
+# frozen_string_literal: true
+
 module Zip
+  # The superclass for all rubyzip error types. Simply rescue this one if
+  # you don't need to know what sort of error has been raised.
   class Error < StandardError; end
-  class EntryExistsError < Error; end
-  class DestinationFileExistsError < Error; end
-  class CompressionMethodError < Error; end
-  class EntryNameError < Error; end
-  class EntrySizeError < Error; end
-  class InternalError < Error; end
-  class GPFBit3Error < Error; end
-  class DecompressionError < Error; end
-
-  # Backwards compatibility with v1 (delete in v2)
-  ZipError = Error
-  ZipEntryExistsError = EntryExistsError
-  ZipDestinationFileExistsError = DestinationFileExistsError
-  ZipCompressionMethodError = CompressionMethodError
-  ZipEntryNameError = EntryNameError
-  ZipInternalError = InternalError
+
+  # Error raised if an unsupported compression method is used.
+  class CompressionMethodError < Error
+    attr_reader :compression_method
+
+    def initialize(method)
+      super()
+      @compression_method = method
+    end
+
+    def message
+      "Unsupported compression method: #{COMPRESSION_METHODS[@compression_method]}."
+    end
+  end
+
+  # Error raised if there is a problem while decompressing an archive entry.
+  class DecompressionError < Error
+    attr_reader :zlib_error
+
+    def initialize(zlib_error)
+      super()
+      @zlib_error = zlib_error
+    end
+
+    def message
+      "Zlib error ('#{@zlib_error.message}') while inflating."
+    end
+  end
+
+  # Error raised when trying to extract an archive entry over an
+  # existing file.
+  class DestinationExistsError < Error
+    def initialize(destination)
+      super()
+      @destination = destination
+    end
+
+    def message
+      "Cannot create file or directory '#{@destination}'. " \
+      'A file already exists with that name.'
+    end
+  end
+
+  # Error raised when trying to add an entry to an archive where the
+  # entry name already exists.
+  class EntryExistsError < Error
+    def initialize(source, name)
+      super()
+      @source = source
+      @name = name
+    end
+
+    def message
+      "'#{@source}' failed. Entry #{@name} already exists."
+    end
+  end
+
+  # Error raised when an entry name is invalid.
+  class EntryNameError < Error
+    def initialize(name = nil)
+      super()
+      @name = name
+    end
+
+    def message
+      if @name.nil?
+        'Illegal entry name. Names must have fewer than 65,536 characters.'
+      else
+        "Illegal entry name '#{@name}'. Names must not start with '/'."
+      end
+    end
+  end
+
+  # Error raised if an entry is larger on extraction than it is advertised
+  # to be.
+  class EntrySizeError < Error
+    attr_reader :entry
+
+    def initialize(entry)
+      super()
+      @entry = entry
+    end
+
+    def message
+      "Entry '#{@entry.name}' should be #{@entry.size}B, but is larger when inflated."
+    end
+  end
+
+  # Error raised if a split archive is read. Rubyzip does not support reading
+  # split archives.
+  class SplitArchiveError < Error
+    def message
+      'Rubyzip cannot extract from split archives at this time.'
+    end
+  end
+
+  # Error raised if there is not enough metadata for the entry to be streamed.
+  class StreamingError < Error
+    attr_reader :entry
+
+    def initialize(entry)
+      super()
+      @entry = entry
+    end
+
+    def message
+      "The local header of this entry ('#{@entry.name}') does not contain " \
+      'the correct metadata for `Zip::InputStream` to be able to ' \
+      'uncompress it. Please use `Zip::File` instead of `Zip::InputStream`.'
+    end
+  end
 end

data/lib/zip/extra_field/generic.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Zip
-  class ExtraField::Generic
+  class ExtraField::Generic # :nodoc:
     def self.register_map
       return unless const_defined?(:HEADER_ID)
 
@@ -22,15 +24,6 @@ module Zip
       [binstr[2, 2].unpack1('v'), binstr[4..-1]]
     end
 
-    def ==(other)
-      return false if self.class != other.class
-
-      each do |k, v|
-        return false if v != other[k]
-      end
-      true
-    end
-
     def to_local_bin
       s = pack_for_local
       self.class.const_get(:HEADER_ID) + [s.bytesize].pack('v') << s

data/lib/zip/extra_field/ntfs.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Zip
   # PKWARE NTFS Extra Field (0x000a)
   # Only Tag 0x0001 is supported
-  class ExtraField::NTFS < ExtraField::Generic
+  class ExtraField::NTFS < ExtraField::Generic # :nodoc:
     HEADER_ID = [0x000A].pack('v')
     register_map
 
@@ -51,7 +53,7 @@ module Zip
       # reserved 0 and tag 1
       s = [0, 1].pack('Vv')
 
-      tag1 = ''.b
+      tag1 = (+'').force_encoding(Encoding::BINARY)
       if @mtime
         tag1 << [to_ntfs_time(@mtime)].pack('Q<')
         if @atime

data/lib/zip/extra_field/old_unix.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Zip
   # Olf Info-ZIP Extra for UNIX uid/gid and file timestampes
-  class ExtraField::OldUnix < ExtraField::Generic
+  class ExtraField::OldUnix < ExtraField::Generic # :nodoc:
     HEADER_ID = 'UX'
     register_map
 

data/lib/zip/extra_field/universal_time.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Zip
   # Info-ZIP Additional timestamp field
-  class ExtraField::UniversalTime < ExtraField::Generic
+  class ExtraField::UniversalTime < ExtraField::Generic # :nodoc:
     HEADER_ID = 'UT'
     register_map
 

data/lib/zip/extra_field/unix.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Zip
   # Info-ZIP Extra for UNIX uid/gid
-  class ExtraField::IUnix < ExtraField::Generic
+  class ExtraField::IUnix < ExtraField::Generic # :nodoc:
     HEADER_ID = 'Ux'
     register_map
 
@@ -20,8 +22,8 @@ module Zip
       return if !size || size == 0
 
       uid, gid = content.unpack('vv')
-      @uid ||= uid
-      @gid ||= gid # rubocop:disable Naming/MemoizedInstanceVariableName
+      @uid = uid
+      @gid = gid
     end
 
     def ==(other)

data/lib/zip/extra_field/unknown.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Zip
+  # A class to hold unknown extra fields so that they are preserved.
+  class ExtraField::Unknown # :nodoc:
+    def initialize
+      @local_bin = +''
+      @cdir_bin = +''
+    end
+
+    def merge(binstr, local: false)
+      return if binstr.empty?
+
+      if local
+        @local_bin << binstr
+      else
+        @cdir_bin << binstr
+      end
+    end
+
+    def to_local_bin
+      @local_bin
+    end
+
+    def to_c_dir_bin
+      @cdir_bin
+    end
+
+    def ==(other)
+      @local_bin == other.to_local_bin && @cdir_bin == other.to_c_dir_bin
+    end
+  end
+end

data/lib/zip/extra_field/zip64.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 module Zip
   # Info-ZIP Extra for Zip64 size
-  class ExtraField::Zip64 < ExtraField::Generic
-    attr_accessor :original_size, :compressed_size, :relative_header_offset, :disk_start_number
+  class ExtraField::Zip64 < ExtraField::Generic # :nodoc:
+    attr_accessor :compressed_size, :disk_start_number,
+                  :original_size, :relative_header_offset
+
     HEADER_ID = ['0100'].pack('H*')
     register_map
 
@@ -36,7 +40,9 @@ module Zip
     def parse(original_size, compressed_size, relative_header_offset = nil, disk_start_number = nil)
       @original_size = extract(8, 'Q<') if original_size == 0xFFFFFFFF
       @compressed_size = extract(8, 'Q<') if compressed_size == 0xFFFFFFFF
-      @relative_header_offset = extract(8, 'Q<') if relative_header_offset && relative_header_offset == 0xFFFFFFFF
+      if relative_header_offset && relative_header_offset == 0xFFFFFFFF
+        @relative_header_offset = extract(8, 'Q<')
+      end
       @disk_start_number = extract(4, 'V') if disk_start_number && disk_start_number == 0xFFFF
       @content = nil
       [@original_size || original_size,
@@ -51,7 +57,8 @@ module Zip
     private :extract
 
     def pack_for_local
-      # local header entries must contain original size and compressed size; other fields do not apply
+      # Local header entries must contain original size and compressed size;
+      # other fields do not apply.
       return '' unless @original_size && @compressed_size
 
       [@original_size, @compressed_size].pack('Q<Q<')
@@ -59,7 +66,7 @@ module Zip
 
     def pack_for_c_dir
       # central directory entries contain only fields that didn't fit in the main entry part
-      packed = ''.b
+      packed = (+'').force_encoding('BINARY')
       packed << [@original_size].pack('Q<') if @original_size
       packed << [@compressed_size].pack('Q<') if @compressed_size
       packed << [@relative_header_offset].pack('Q<') if @relative_header_offset

data/lib/zip/extra_field.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Zip
-  class ExtraField < Hash
+  class ExtraField < Hash # :nodoc:all
     ID_MAP = {}
 
-    def initialize(binstr = nil)
-      merge(binstr) if binstr
+    def initialize(binstr = nil, local: false)
+      merge(binstr, local: local) if binstr
     end
 
     def extra_field_type_exist(binstr, id, len, index)
@@ -16,25 +18,18 @@ module Zip
       end
     end
 
-    def extra_field_type_unknown(binstr, len, index)
-      create_unknown_item unless self['Unknown']
+    def extra_field_type_unknown(binstr, len, index, local)
+      self['Unknown'] ||= Unknown.new
+
       if !len || len + 4 > binstr[index..-1].bytesize
-        self['Unknown'] << binstr[index..-1]
+        self['Unknown'].merge(binstr[index..-1], local: local)
         return
       end
-      self['Unknown'] << binstr[index, len + 4]
-    end
 
-    def create_unknown_item
-      s = +''
-      class << s
-        alias_method :to_c_dir_bin, :to_s
-        alias_method :to_local_bin, :to_s
-      end
-      self['Unknown'] = s
+      self['Unknown'].merge(binstr[index, len + 4], local: local)
     end
 
-    def merge(binstr)
+    def merge(binstr, local: false)
       return if binstr.empty?
 
       i = 0
@@ -44,8 +39,7 @@ module Zip
         if id && ID_MAP.member?(id)
           extra_field_type_exist(binstr, id, len, i)
         elsif id
-          create_unknown_item unless self['Unknown']
-          break unless extra_field_type_unknown(binstr, len, i)
+          break unless extra_field_type_unknown(binstr, len, i, local)
         end
         i += len + 4
       end
@@ -59,8 +53,8 @@ module Zip
       self[name] = field_class.new
     end
 
-    # place Unknown last, so "extra" data that is missing the proper signature/size
-    # does not prevent known fields from being read back in
+    # Place Unknown last, so "extra" data that is missing the proper
+    # signature/size does not prevent known fields from being read back in.
     def ordered_values
       result = []
       each { |k, v| k == 'Unknown' ? result.push(v) : result.unshift(v) }
@@ -90,12 +84,12 @@ module Zip
   end
 end
 
+require 'zip/extra_field/unknown'
 require 'zip/extra_field/generic'
 require 'zip/extra_field/universal_time'
 require 'zip/extra_field/old_unix'
 require 'zip/extra_field/unix'
 require 'zip/extra_field/zip64'
-require 'zip/extra_field/zip64_placeholder'
 require 'zip/extra_field/ntfs'
 
 # Copyright (C) 2002, 2003 Thomas Sondergaard