rubyzip 1.1.7 → 1.2.1

data/lib/zip/errors.rb

@@ -5,6 +5,7 @@ module Zip
   class CompressionMethodError < Error; end
   class EntryNameError < Error; end
   class InternalError < Error; end
+  class GPFBit3Error < Error; end
 
   # Backwards compatibility with v1 (delete in v2)
   ZipError = Error

data/lib/zip/extra_field.rb

@@ -3,7 +3,7 @@ module Zip
     ID_MAP = {}
 
     def initialize(binstr = nil)
-      binstr and merge(binstr)
+      merge(binstr) if binstr
     end
 
     def extra_field_type_exist(binstr, id, len, i)
@@ -51,7 +51,7 @@ module Zip
     end
 
     def create(name)
-      unless field_class = ID_MAP.values.find { |k| k.name == name }
+      unless (field_class = ID_MAP.values.find { |k| k.name == name })
         raise Error, "Unknown extra field '#{name}'"
       end
       self[name] = field_class.new
@@ -61,7 +61,7 @@ module Zip
     # does not prevent known fields from being read back in
     def ordered_values
       result = []
-      self.each { |k,v| k == 'Unknown' ? result.push(v) : result.unshift(v) }
+      each { |k, v| k == 'Unknown' ? result.push(v) : result.unshift(v) }
       result
     end
 
@@ -69,7 +69,7 @@ module Zip
       ordered_values.map! { |v| v.to_local_bin.force_encoding('BINARY') }.join
     end
 
-    alias :to_s :to_local_bin
+    alias to_s to_local_bin
 
     def to_c_dir_bin
       ordered_values.map! { |v| v.to_c_dir_bin.force_encoding('BINARY') }.join
@@ -83,8 +83,8 @@ module Zip
       to_local_bin.bytesize
     end
 
-    alias :length :local_size
-    alias :size :local_size
+    alias length local_size
+    alias size local_size
   end
 end
 

data/lib/zip/extra_field/generic.rb

@@ -2,12 +2,12 @@ module Zip
   class ExtraField::Generic
     def self.register_map
       if self.const_defined?(:HEADER_ID)
-        ::Zip::ExtraField::ID_MAP[self.const_get(:HEADER_ID)] = self
+        ::Zip::ExtraField::ID_MAP[const_get(:HEADER_ID)] = self
       end
     end
 
     def self.name
-      @name ||= self.to_s.split("::")[-1]
+      @name ||= to_s.split('::')[-1]
     end
 
     # return field [size, content] or false
@@ -16,28 +16,28 @@ module Zip
         # If nil, start with empty.
         return false
       elsif binstr[0, 2] != self.class.const_get(:HEADER_ID)
-        $stderr.puts "Warning: weired extra feild header ID. skip parsing"
+        $stderr.puts 'Warning: weired extra feild header ID. skip parsing'
         return false
       end
-      [binstr[2, 2].unpack("v")[0], binstr[4..-1]]
+      [binstr[2, 2].unpack('v')[0], binstr[4..-1]]
     end
 
     def ==(other)
       return false if self.class != other.class
       each do |k, v|
-        v != other[k] and return false
+        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
+      self.class.const_get(:HEADER_ID) + [s.bytesize].pack('v') << s
     end
 
     def to_c_dir_bin
       s = pack_for_c_dir
-      self.class.const_get(:HEADER_ID) + [s.bytesize].pack("v") << s
+      self.class.const_get(:HEADER_ID) + [s.bytesize].pack('v') << s
     end
   end
 end

data/lib/zip/extra_field/ntfs.rb

@@ -5,14 +5,14 @@ module Zip
     HEADER_ID = [0x000A].pack('v')
     register_map
 
-    WINDOWS_TICK = 10000000.0
-    SEC_TO_UNIX_EPOCH = 11644473600
+    WINDOWS_TICK = 10_000_000.0
+    SEC_TO_UNIX_EPOCH = 11_644_473_600
 
     def initialize(binstr = nil)
       @ctime = nil
       @mtime = nil
       @atime = nil
-      binstr and merge(binstr)
+      binstr && merge(binstr)
     end
 
     attr_accessor :atime, :ctime, :mtime
@@ -20,18 +20,17 @@ module Zip
     def merge(binstr)
       return if binstr.empty?
       size, content = initial_parse(binstr)
-      (size && content) or return
+      (size && content) || return
 
       content = content[4..-1]
       tags = parse_tags(content)
 
       tag1 = tags[1]
-      if tag1
-        ntfs_mtime, ntfs_atime, ntfs_ctime = tag1.unpack("Q<Q<Q<")
-        ntfs_mtime and @mtime ||= from_ntfs_time(ntfs_mtime)
-        ntfs_atime and @atime ||= from_ntfs_time(ntfs_atime)
-        ntfs_ctime and @ctime ||= from_ntfs_time(ntfs_ctime)
-      end
+      return unless tag1
+      ntfs_mtime, ntfs_atime, ntfs_ctime = tag1.unpack('Q<Q<Q<')
+      ntfs_mtime && @mtime ||= from_ntfs_time(ntfs_mtime)
+      ntfs_atime && @atime ||= from_ntfs_time(ntfs_atime)
+      ntfs_ctime && @ctime ||= from_ntfs_time(ntfs_ctime)
     end
 
     def ==(other)
@@ -48,16 +47,14 @@ module Zip
     # But 7-zip for Windows only stores at central dir
     def pack_for_c_dir
       # reserved 0 and tag 1
-      s = [0, 1].pack("Vv")
+      s = [0, 1].pack('Vv')
 
       tag1 = ''.force_encoding(Encoding::BINARY)
       if @mtime
         tag1 << [to_ntfs_time(@mtime)].pack('Q<')
         if @atime
           tag1 << [to_ntfs_time(@atime)].pack('Q<')
-          if @ctime
-            tag1 << [to_ntfs_time(@ctime)].pack('Q<')
-          end
+          tag1 << [to_ntfs_time(@ctime)].pack('Q<') if @ctime
         end
       end
       s << [tag1.bytesize].pack('v') << tag1
@@ -65,11 +62,12 @@ module Zip
     end
 
     private
+
     def parse_tags(content)
       return {} if content.nil?
       tags = {}
       i = 0
-      while i < content.bytesize do
+      while i < content.bytesize
         tag, size = content[i, 4].unpack('vv')
         i += 4
         break unless tag && size
@@ -89,4 +87,4 @@ module Zip
       ((time.to_f + SEC_TO_UNIX_EPOCH) * WINDOWS_TICK).to_i
     end
   end
-end
+end

data/lib/zip/extra_field/old_unix.rb

@@ -1,7 +1,7 @@
 module Zip
   # Olf Info-ZIP Extra for UNIX uid/gid and file timestampes
   class ExtraField::OldUnix < ExtraField::Generic
-    HEADER_ID = "UX"
+    HEADER_ID = 'UX'
     register_map
 
     def initialize(binstr = nil)
@@ -9,7 +9,7 @@ module Zip
       @gid = 0
       @atime = nil
       @mtime = nil
-      binstr and merge(binstr)
+      binstr && merge(binstr)
     end
 
     attr_accessor :uid, :gid, :atime, :mtime
@@ -18,8 +18,8 @@ module Zip
       return if binstr.empty?
       size, content = initial_parse(binstr)
       # size: 0 for central directory. 4 for local header
-      return if (!size || size == 0)
-      atime, mtime, uid, gid = content.unpack("VVvv")
+      return if !size || size == 0
+      atime, mtime, uid, gid = content.unpack('VVvv')
       @uid ||= uid
       @gid ||= gid
       @atime ||= atime
@@ -29,17 +29,16 @@ module Zip
     def ==(other)
       @uid == other.uid &&
         @gid == other.gid &&
-          @atime == other.atime &&
-            @mtime == other.mtime
+        @atime == other.atime &&
+        @mtime == other.mtime
     end
 
     def pack_for_local
-      [@atime, @mtime, @uid, @gid].pack("VVvv")
+      [@atime, @mtime, @uid, @gid].pack('VVvv')
     end
 
     def pack_for_c_dir
-      [@atime, @mtime].pack("VV")
+      [@atime, @mtime].pack('VV')
     end
   end
-
-end
+end

data/lib/zip/extra_field/universal_time.rb

@@ -1,7 +1,7 @@
 module Zip
   # Info-ZIP Additional timestamp field
   class ExtraField::UniversalTime < ExtraField::Generic
-    HEADER_ID = "UT"
+    HEADER_ID = 'UT'
     register_map
 
     def initialize(binstr = nil)
@@ -9,7 +9,7 @@ module Zip
       @mtime = nil
       @atime = nil
       @flag  = nil
-      binstr and merge(binstr)
+      binstr && merge(binstr)
     end
 
     attr_accessor :atime, :ctime, :mtime, :flag
@@ -17,11 +17,11 @@ module Zip
     def merge(binstr)
       return if binstr.empty?
       size, content = initial_parse(binstr)
-      size or return
-      @flag, mtime, atime, ctime = content.unpack("CVVV")
-      mtime and @mtime ||= ::Zip::DOSTime.at(mtime)
-      atime and @atime ||= ::Zip::DOSTime.at(atime)
-      ctime and @ctime ||= ::Zip::DOSTime.at(ctime)
+      size || return
+      @flag, mtime, atime, ctime = content.unpack('CVVV')
+      mtime && @mtime ||= ::Zip::DOSTime.at(mtime)
+      atime && @atime ||= ::Zip::DOSTime.at(atime)
+      ctime && @ctime ||= ::Zip::DOSTime.at(ctime)
     end
 
     def ==(other)
@@ -31,17 +31,17 @@ module Zip
     end
 
     def pack_for_local
-      s = [@flag].pack("C")
-      @flag & 1 != 0 and s << [@mtime.to_i].pack("V")
-      @flag & 2 != 0 and s << [@atime.to_i].pack("V")
-      @flag & 4 != 0 and s << [@ctime.to_i].pack("V")
+      s = [@flag].pack('C')
+      @flag & 1 != 0 && s << [@mtime.to_i].pack('V')
+      @flag & 2 != 0 && s << [@atime.to_i].pack('V')
+      @flag & 4 != 0 && s << [@ctime.to_i].pack('V')
       s
     end
 
     def pack_for_c_dir
-      s = [@flag].pack("C")
-      @flag & 1 == 1 and s << [@mtime.to_i].pack("V")
+      s = [@flag].pack('C')
+      @flag & 1 == 1 && s << [@mtime.to_i].pack('V')
       s
     end
   end
-end
+end

data/lib/zip/extra_field/unix.rb

@@ -1,13 +1,13 @@
 module Zip
   # Info-ZIP Extra for UNIX uid/gid
   class ExtraField::IUnix < ExtraField::Generic
-    HEADER_ID = "Ux"
+    HEADER_ID = 'Ux'
     register_map
 
     def initialize(binstr = nil)
       @uid = 0
       @gid = 0
-      binstr and merge(binstr)
+      binstr && merge(binstr)
     end
 
     attr_accessor :uid, :gid
@@ -16,10 +16,10 @@ module Zip
       return if binstr.empty?
       size, content = initial_parse(binstr)
       # size: 0 for central directory. 4 for local header
-      return if (!size || size == 0)
-      uid, gid = content.unpack("vv")
-      @uid     ||= uid
-      @gid     ||= gid
+      return if !size || size == 0
+      uid, gid = content.unpack('vv')
+      @uid ||= uid
+      @gid ||= gid
     end
 
     def ==(other)
@@ -27,12 +27,11 @@ module Zip
     end
 
     def pack_for_local
-      [@uid, @gid].pack("vv")
+      [@uid, @gid].pack('vv')
     end
 
     def pack_for_c_dir
       ''
     end
   end
-
-end
+end

data/lib/zip/extra_field/zip64.rb

@@ -6,21 +6,22 @@ module Zip
     register_map
 
     def initialize(binstr = nil)
-      @content = nil # unparsed binary; we don't actually know what this contains
-                     # without looking for FFs in the associated file header
-                     # call parse after initializing with a binary string
+      # unparsed binary; we don't actually know what this contains
+      # without looking for FFs in the associated file header
+      # call parse after initializing with a binary string
+      @content = nil
       @original_size          = nil
       @compressed_size        = nil
       @relative_header_offset = nil
       @disk_start_number      = nil
-      binstr and merge(binstr)
+      binstr && merge(binstr)
     end
 
     def ==(other)
       other.original_size == @original_size &&
         other.compressed_size == @compressed_size &&
-          other.relative_header_offset == @relative_header_offset &&
-            other.disk_start_number == @disk_start_number
+        other.relative_header_offset == @relative_header_offset &&
+        other.disk_start_number == @disk_start_number
     end
 
     def merge(binstr)
@@ -51,16 +52,16 @@ module Zip
     def pack_for_local
       # 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<")
+      [@original_size, @compressed_size].pack('Q<Q<')
     end
 
     def pack_for_c_dir
       # central directory entries contain only fields that didn't fit in the main entry part
       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
-      packed << [@disk_start_number].pack("V") if @disk_start_number
+      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
+      packed << [@disk_start_number].pack('V') if @disk_start_number
       packed
     end
   end

data/lib/zip/extra_field/zip64_placeholder.rb

@@ -6,7 +6,7 @@ module Zip
     HEADER_ID = ['9999'].pack('H*') # this ID is used by other libraries such as .NET's Ionic.zip
     register_map
 
-    def initialize(binstr = nil)
+    def initialize(_binstr = nil)
     end
 
     def pack_for_local

data/lib/zip/file.rb

@@ -43,13 +43,13 @@ module Zip
   # interface for accessing the filesystem, ie. the File and Dir classes.
 
   class File < CentralDirectory
-
-    CREATE               = 1
+    CREATE               = true
     SPLIT_SIGNATURE      = 0x08074b50
     ZIP64_EOCD_SIGNATURE = 0x06064b50
-    MAX_SEGMENT_SIZE     = 3221225472
-    MIN_SEGMENT_SIZE     = 65536
+    MAX_SEGMENT_SIZE     = 3_221_225_472
+    MIN_SEGMENT_SIZE     = 65_536
     DATA_BUFFER_SIZE     = 8192
+    IO_METHODS           = [:tell, :seek, :read, :close]
 
     attr_reader :name
 
@@ -64,20 +64,22 @@ module Zip
 
     # Opens a zip archive. Pass true as the second parameter to create
     # a new archive if it doesn't exist already.
-    def initialize(file_name, create = nil, buffer = false, options = {})
+    def initialize(file_name, create = false, buffer = false, options = {})
       super()
       @name    = file_name
       @comment = ''
-      @create  = create
+      @create  = create ? true : false # allow any truthy value to mean true
       case
       when !buffer && ::File.size?(file_name)
-        @create = nil
-        @exist_file_perms = ::File.stat(file_name).mode
+        @create = false
+        @file_permissions = ::File.stat(file_name).mode
         ::File.open(name, 'rb') do |f|
           read_from_stream(f)
         end
-      when create
+      when @create
         @entry_set = EntrySet.new
+      when ::File.zero?(file_name)
+        raise Error, "File #{file_name} has zero size. Did you mean to pass the create flag?"
       else
         raise Error, "File #{file_name} not found"
       end
@@ -92,7 +94,7 @@ module Zip
       # Same as #new. If a block is passed the ZipFile object is passed
       # to the block and is automatically closed afterwards just as with
       # ruby's builtin File.open method.
-      def open(file_name, create = nil)
+      def open(file_name, create = false)
         zf = ::Zip::File.new(file_name, create)
         return zf unless block_given?
         begin
@@ -115,23 +117,24 @@ module Zip
       # (This can be used to extract data from a
       # downloaded zip archive without first saving it to disk.)
       def open_buffer(io, options = {})
-        unless io.is_a?(IO) || io.is_a?(String) || io.is_a?(Tempfile)
-          raise "Zip::File.open_buffer expects an argument of class String, IO, or Tempfile. Found: #{io.class}"
+        unless IO_METHODS.map { |method| io.respond_to?(method) }.all? || io.is_a?(String)
+          raise "Zip::File.open_buffer expects a String or IO-like argument (responds to #{IO_METHODS.join(', ')}). Found: #{io.class}"
         end
         if io.is_a?(::String)
           require 'stringio'
           io = ::StringIO.new(io)
-        elsif io.is_a?(IO)
+        elsif io.respond_to?(:binmode)
           # https://github.com/rubyzip/rubyzip/issues/119
           io.binmode
         end
         zf = ::Zip::File.new(io, true, true, options)
         zf.read_from_stream(io)
+        return zf unless block_given?
         yield zf
         begin
           zf.write_buffer(io)
         rescue IOError => e
-          raise unless e.message == "not opened for writing"
+          raise unless e.message == 'not opened for writing'
         end
       end
 
@@ -181,7 +184,7 @@ module Zip
       def save_splited_part(zip_file, partial_zip_file_name, zip_file_size, szip_file_index, segment_size, segment_count)
         ssegment_size  = zip_file_size - zip_file.pos
         ssegment_size  = segment_size if ssegment_size > segment_size
-        szip_file_name = "#{partial_zip_file_name}.#{'%03d'%(szip_file_index)}"
+        szip_file_name = "#{partial_zip_file_name}.#{format('%03d', szip_file_index)}"
         ::File.open(szip_file_name, 'wb') do |szip_file|
           if szip_file_index == 1
             ssegment_size = put_split_signature(szip_file, segment_size)
@@ -191,7 +194,7 @@ module Zip
             segment_bytes_left = ssegment_size - chunk_bytes
             buffer_size        = segment_bytes_left < DATA_BUFFER_SIZE ? segment_bytes_left : DATA_BUFFER_SIZE
             chunk              = zip_file.read(buffer_size)
-            chunk_bytes        += buffer_size
+            chunk_bytes += buffer_size
             szip_file << chunk
             # Info for track splitting
             yield segment_count, szip_file_index, chunk_bytes, ssegment_size if block_given?
@@ -208,7 +211,7 @@ module Zip
         return if zip_file_size <= segment_size
         segment_count = get_segment_count_for_split(zip_file_size, segment_size)
         # Checking for correct zip structure
-        self.open(zip_file_name) {}
+        open(zip_file_name) {}
         partial_zip_file_name = get_partial_zip_file_name(zip_file_name, partial_zip_file_name)
         szip_file_index       = 0
         ::File.open(zip_file_name, 'rb') do |zip_file|
@@ -222,7 +225,6 @@ module Zip
       end
     end
 
-
     # Returns an input stream to the specified entry. If a block is passed
     # the stream object is passed to the block and the stream is automatically
     # closed afterwards just as with ruby's builtin File.open method.
@@ -265,7 +267,7 @@ module Zip
     # Convenience method for adding the contents of a file to the archive
     def add(entry, src_path, &continue_on_exists_proc)
       continue_on_exists_proc ||= proc { ::Zip.continue_on_exists_proc }
-      check_entry_exists(entry, continue_on_exists_proc, "add")
+      check_entry_exists(entry, continue_on_exists_proc, 'add')
       new_entry = entry.kind_of?(::Zip::Entry) ? entry : ::Zip::Entry.new(@name, entry.to_s)
       new_entry.gather_fileinfo_from_srcpath(src_path)
       new_entry.dirty = true
@@ -338,7 +340,7 @@ module Zip
       @entry_set.each do |e|
         return true if e.dirty
       end
-      @comment != @stored_comment || @entry_set != @stored_entries || @create == ::Zip::File::CREATE
+      @comment != @stored_comment || @entry_set != @stored_entries || @create
     end
 
     # Searches for entry with the specified name. Returns nil if
@@ -356,9 +358,7 @@ module Zip
     # if no entry is found.
     def get_entry(entry)
       selected_entry = find_entry(entry)
-      unless selected_entry
-        raise Errno::ENOENT, entry
-      end
+      raise Errno::ENOENT, entry unless selected_entry
       selected_entry.restore_ownership   = @restore_ownership
       selected_entry.restore_permissions = @restore_permissions
       selected_entry.restore_times       = @restore_times
@@ -367,9 +367,7 @@ module Zip
 
     # Creates a directory
     def mkdir(entryName, permissionInt = 0755)
-      if find_entry(entryName)
-        raise Errno::EEXIST, "File exists - #{entryName}"
-      end
+      raise Errno::EEXIST, "File exists - #{entryName}" if find_entry(entryName)
       entryName = entryName.dup.to_s
       entryName << '/' unless entryName.end_with?('/')
       @entry_set << ::Zip::StreamableDirectory.new(@name, entryName, nil, permissionInt)
@@ -377,57 +375,46 @@ module Zip
 
     private
 
-    def is_directory(newEntry, srcPath)
+    def directory?(newEntry, srcPath)
       srcPathIsDirectory = ::File.directory?(srcPath)
-      if newEntry.is_directory && !srcPathIsDirectory
+      if newEntry.directory? && !srcPathIsDirectory
         raise ArgumentError,
-              "entry name '#{newEntry}' indicates directory entry, but "+
-                "'#{srcPath}' is not a directory"
-      elsif !newEntry.is_directory && srcPathIsDirectory
-        newEntry.name += "/"
+              "entry name '#{newEntry}' indicates directory entry, but " \
+                  "'#{srcPath}' is not a directory"
+      elsif !newEntry.directory? && srcPathIsDirectory
+        newEntry.name += '/'
       end
-      newEntry.is_directory && srcPathIsDirectory
+      newEntry.directory? && srcPathIsDirectory
     end
 
     def check_entry_exists(entryName, continue_on_exists_proc, procedureName)
       continue_on_exists_proc ||= proc { Zip.continue_on_exists_proc }
-      if @entry_set.include?(entryName)
-        if continue_on_exists_proc.call
-          remove get_entry(entryName)
-        else
-          raise ::Zip::EntryExistsError,
-                procedureName + " failed. Entry #{entryName} already exists"
-        end
+      return unless @entry_set.include?(entryName)
+      if continue_on_exists_proc.call
+        remove get_entry(entryName)
+      else
+        raise ::Zip::EntryExistsError,
+              procedureName + " failed. Entry #{entryName} already exists"
       end
     end
 
     def check_file(path)
-      unless ::File.readable?(path)
-        raise Errno::ENOENT, path
-      end
+      raise Errno::ENOENT, path unless ::File.readable?(path)
     end
 
     def on_success_replace
-      tmpfile      = get_tempfile
-      tmp_filename = tmpfile.path
-      ObjectSpace.undefine_finalizer(tmpfile)
-      tmpfile.close
-      if yield tmp_filename
-        ::File.rename(tmp_filename, self.name)
-        if defined?(@exist_file_perms)
-          ::File.chmod(@exist_file_perms, self.name)
+      dirname, basename = ::File.split(name)
+      ::Dir::Tmpname.create(basename, dirname) do |tmp_filename|
+        begin
+          if yield tmp_filename
+            ::File.rename(tmp_filename, name)
+            ::File.chmod(@file_permissions, name) unless @create
+          end
+        ensure
+          ::File.unlink(tmp_filename) if ::File.exist?(tmp_filename)
         end
       end
-    ensure
-      tmpfile.unlink if tmpfile
     end
-
-    def get_tempfile
-      temp_file = Tempfile.new(::File.basename(name), ::File.dirname(name))
-      temp_file.binmode
-      temp_file
-    end
-
   end
 end