rubyzip 1.1.7 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 21b11d72a619a00f577f3ac15a65d309d07ab57b
-  data.tar.gz: d2c28c4157e692118e26478c34205094eb2ca055
+SHA256:
+  metadata.gz: 971ff85e75ec367c6d983a2c5fdcb24f8c5d1a4a450068b6b925a2df735cd1aa
+  data.tar.gz: 665b1e4f89f765cd9138222b08ac7759ee8e3ad4ad6e7c68171f2afb523b2f9f
 SHA512:
-  metadata.gz: 935e9064b3fc98693e8e0eef68f147b9a62ba4dcf25c9f42cf9828a544665d749fd8ff5866b52183a569171fd3aecddb09613d526da1bc43bf34c0b556bcea02
-  data.tar.gz: b9e36842ed0830befe3ca556b954757975291f8c523be419213c5974015742e41c4bb4a4b44c88a746ad22f7656f23162cf5e5d5e7591d917927ae9830ad8dae
+  metadata.gz: 4322b88da024f5625fa1824c80a8ee8b07e9970baea5937b5a11004d21038a590aeb07c4beb2296d639fb67c1146f2ace736bef7faffb87afcc065538df37afb
+  data.tar.gz: 77ba210a9a4d66b35fa43a75ac72126c0df5fb65d04e79c50e2168698aeae66a8cf19c27fb86ccb39a6670a3e079bda953c22fd9917ed7a7b0f33c83753e3107

data/README.md

@@ -1,14 +1,15 @@
 # rubyzip
+
 [![Gem Version](https://badge.fury.io/rb/rubyzip.svg)](http://badge.fury.io/rb/rubyzip)
 [![Build Status](https://secure.travis-ci.org/rubyzip/rubyzip.svg)](http://travis-ci.org/rubyzip/rubyzip)
 [![Code Climate](https://codeclimate.com/github/rubyzip/rubyzip.svg)](https://codeclimate.com/github/rubyzip/rubyzip)
 [![Coverage Status](https://img.shields.io/coveralls/rubyzip/rubyzip.svg)](https://coveralls.io/r/rubyzip/rubyzip?branch=master)
 
-rubyzip is a ruby library for reading and writing zip files.
+Rubyzip is a ruby library for reading and writing zip files.
 
 ## Important note
 
-Rubyzip interface changed!!! No need to do `require "zip/zip"` and `Zip` prefix in class names removed.
+The Rubyzip interface has changed!!! No need to do `require "zip/zip"` and `Zip` prefix in class names removed.
 
 If you have issues with any third-party gems that require an old version of rubyzip, you can use this workaround:
 
@@ -19,10 +20,11 @@ gem 'zip-zip' # will load compatibility for old rubyzip API.
 
 ## Requirements
 
-* Ruby 1.9.2 or greater
+- Ruby 1.9.2 or greater
 
 ## Installation
-rubyzip is available on RubyGems, so:
+
+Rubyzip is available on RubyGems:
 
 ```
 gem install rubyzip
@@ -52,65 +54,76 @@ Zip::File.open(zipfile_name, Zip::File::CREATE) do |zipfile|
     # Two arguments:
     # - The name of the file as it will appear in the archive
     # - The original file, including the path to find it
-    zipfile.add(filename, folder + '/' + filename)
+    zipfile.add(filename, File.join(folder, filename))
   end
-  zipfile.get_output_stream("myFile") { |os| os.write "myFile contains just this" }
+  zipfile.get_output_stream("myFile") { |f| f.write "myFile contains just this" }
 end
 ```
 
 ### Zipping a directory recursively
-Copy from [here](https://github.com/rubyzip/rubyzip/blob/05916bf89181e1955118fd3ea059f18acac28cc8/samples/example_recursive.rb )
+
+Copy from [here](https://github.com/rubyzip/rubyzip/blob/9d891f7353e66052283562d3e252fe380bb4b199/samples/example_recursive.rb)
 
 ```ruby
-require 'rubygems'
 require 'zip'
+
 # This is a simple example which uses rubyzip to
 # recursively generate a zip file from the contents of
 # a specified directory. The directory itself is not
 # included in the archive, rather just its contents.
 #
 # Usage:
-# require /path/to/the/ZipFileGenerator/Class
-# directoryToZip = "/tmp/input"
-# outputFile = "/tmp/out.zip"
-# zf = ZipFileGenerator.new(directoryToZip, outputFile)
-# zf.write()
-
+#   directory_to_zip = "/tmp/input"
+#   output_file = "/tmp/out.zip"
+#   zf = ZipFileGenerator.new(directory_to_zip, output_file)
+#   zf.write()
 class ZipFileGenerator
   # Initialize with the directory to zip and the location of the output archive.
-  def initialize(inputDir, outputFile)
-    @inputDir = inputDir
-    @outputFile = outputFile
+  def initialize(input_dir, output_file)
+    @input_dir = input_dir
+    @output_file = output_file
   end
+
   # Zip the input directory.
-  def write()
-    entries = Dir.entries(@inputDir); entries.delete("."); entries.delete("..")
-    io = Zip::File.open(@outputFile, Zip::File::CREATE);
-    writeEntries(entries, "", io)
-    io.close();
+  def write
+    entries = Dir.entries(@input_dir) - %w[. ..]
+
+    ::Zip::File.open(@output_file, ::Zip::File::CREATE) do |zipfile|
+      write_entries entries, '', zipfile
+    end
   end
-  # A helper method to make the recursion work.
+
   private
-  def writeEntries(entries, path, io)
-    entries.each { |e|
-      zipFilePath = path == "" ? e : File.join(path, e)
-      diskFilePath = File.join(@inputDir, zipFilePath)
-      puts "Deflating " + diskFilePath
-      if File.directory?(diskFilePath)
-        io.mkdir(zipFilePath)
-        subdir =Dir.entries(diskFilePath); subdir.delete("."); subdir.delete("..")
-        writeEntries(subdir, zipFilePath, io)
+
+  # A helper method to make the recursion work.
+  def write_entries(entries, path, zipfile)
+    entries.each do |e|
+      zipfile_path = path == '' ? e : File.join(path, e)
+      disk_file_path = File.join(@input_dir, zipfile_path)
+
+      if File.directory? disk_file_path
+        recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
       else
-        io.get_output_stream(zipFilePath) { |f| f.print(File.open(diskFilePath, "rb").read())}
+        put_into_archive(disk_file_path, zipfile, zipfile_path)
       end
-    }
+    end
+  end
+
+  def recursively_deflate_directory(disk_file_path, zipfile, zipfile_path)
+    zipfile.mkdir zipfile_path
+    subdir = Dir.entries(disk_file_path) - %w[. ..]
+    write_entries subdir, zipfile_path, zipfile
+  end
+
+  def put_into_archive(disk_file_path, zipfile, zipfile_path)
+    zipfile.add(zipfile_path, disk_file_path)
   end
 end
 ```
 
 ### Save zip archive entries in sorted by name state
 
-To saving zip archives in sorted order like below you need to set `::Zip.sort_entries` to `true`
+To save zip archives in sorted order like below, you need to set `::Zip.sort_entries` to `true`
 
 ```
 Vegetable/
@@ -124,7 +137,17 @@ fruit/mango
 fruit/orange
 ```
 
-After this entries in zip archive will be saved in ordered state.
+After this, entries in the zip archive will be saved in ordered state.
+
+### Default permissions of zip archives
+
+On Posix file systems the default file permissions applied to a new archive
+are (0666 - umask), which mimics the behavior of standard tools such as `touch`.
+
+On Windows the default file permissions are set to 0644 as suggested by the
+[Ruby File documentation](http://ruby-doc.org/core-2.2.2/File.html).
+
+When modifying a zip archive the file permissions of the archive are preserved.
 
 ### Reading a Zip file
 
@@ -146,9 +169,19 @@ Zip::File.open('foo.zip') do |zip_file|
 end
 ```
 
+#### Notice about ::Zip::InputStream
+
+`::Zip::InputStream` usable for fast reading zip file content because it not read Central directory.
+
+But there is one exception when it is not working - General Purpose Flag Bit 3.
+
+> If bit 3 (0x08) of the general-purpose flags field is set, then the CRC-32 and file sizes are not known when the header is written. The fields in the local header are filled with zero, and the CRC-32 and size are appended in a 12-byte structure (optionally preceded by a 4-byte signature) immediately after the compressed data
+
+If `::Zip::InputStream` finds such entry in the zip archive it will raise an exception.
+
 ### Password Protection (Experimental)
 
-RubyZip supports reading/writing zip files with traditional zip encryption (a.k.a. "ZipCrypto"). AES encryption is not yet supported. It can be used with buffer streams, e.g.:
+Rubyzip supports reading/writing zip files with traditional zip encryption (a.k.a. "ZipCrypto"). AES encryption is not yet supported. It can be used with buffer streams, e.g.:
 
 ```ruby
 Zip::OutputStream.write_buffer(::StringIO.new(''), Zip::TraditionalEncrypter.new('password')) do |out|
@@ -181,12 +214,12 @@ buffer = Zip::OutputStream.write_buffer do |out|
   out.write rels.to_xml(:indent => 0).gsub("\n","")
 end
 
-File.open(new_path, "w") {|f| f.write(buffer.string) }
+File.open(new_path, "wb") {|f| f.write(buffer.string) }
 ```
 
 ## Configuration
 
-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:
+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:
 
 ```ruby
 Zip.on_exists_proc = true
@@ -200,13 +233,13 @@ Additionally, if you want to configure rubyzip to overwrite existing files while
 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:
+If you want to store non-english names and want to open them on Windows(pre 7) you need to set this option:
 
 ```ruby
 Zip.unicode_names = true
 ```
 
-In some zip date of files stored in incorrect format. You can hide warning about it by using:
+Some zip files might have an invalid date format, which will raise a warning. You can hide this warning with the following setting:
 
 ```ruby
 Zip.warn_invalid_date = false
@@ -217,9 +250,18 @@ You can set the default compression level like so:
 ```ruby
 Zip.default_compression = Zlib::DEFAULT_COMPRESSION
 ```
+
 It defaults to `Zlib::DEFAULT_COMPRESSION`. Possible values are `Zlib::BEST_COMPRESSION`, `Zlib::DEFAULT_COMPRESSION` and `Zlib::NO_COMPRESSION`
 
-All settings in same time
+Sometimes file names inside zip contain non-ASCII characters. If you can assume which encoding was used for such names and want to be able to find such entries using `find_entry` then you can force assumed encoding like so:
+
+```ruby
+Zip.force_entry_names_encoding = 'UTF-8'
+```
+
+Allowed encoding names are the same as accepted by `String#force_encoding`
+
+You can set multiple settings at the same time by using a block:
 
 ```ruby
   Zip.setup do |c|
@@ -230,7 +272,7 @@ All settings in same time
   end
 ```
 
-By default Zip64 support is disabled for writing. To enable it do next:
+By default, Zip64 support is disabled for writing. To enable it do this:
 
 ```ruby
 Zip.write_zip64_support = true
@@ -240,7 +282,7 @@ _NOTE_: If you will enable Zip64 writing then you will need zip extractor with Z
 
 ## Developing
 
-To run tests you need run next commands:
+To run the test you need to do this:
 
 ```
 bundle install
@@ -267,5 +309,5 @@ extra-field support contributed by Tatsuki Sugiura (sugi at nemui.org)
 
 ## License
 
-rubyzip is distributed under the same license as ruby. See
+Rubyzip is distributed under the same license as ruby. See
 http://www.ruby-lang.org/en/LICENSE.txt

data/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-task :default => :test
+task default: :test
 
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib'
@@ -10,10 +10,9 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-#Rake::TestTask.new(:zip64_full_test) do |test|
+# Rake::TestTask.new(:zip64_full_test) do |test|
 #  test.libs << File.join(File.dirname(__FILE__), 'lib')
 #  test.libs << File.join(File.dirname(__FILE__), 'test')
 #  test.pattern = File.join(File.dirname(__FILE__), 'test/zip64_full_test.rb')
 #  test.verbose = true
-#end
-
+# end

data/lib/zip.rb

@@ -1,6 +1,7 @@
 require 'delegate'
 require 'singleton'
 require 'tempfile'
+require 'tmpdir'
 require 'fileutils'
 require 'stringio'
 require 'zlib'
@@ -30,14 +31,18 @@ require 'zip/streamable_stream'
 require 'zip/streamable_directory'
 require 'zip/constants'
 require 'zip/errors'
-if defined? JRUBY_VERSION
-  require 'jruby'
-  JRuby.objectspace = true
-end
 
 module Zip
   extend self
-  attr_accessor :unicode_names, :on_exists_proc, :continue_on_exists_proc, :sort_entries, :default_compression, :write_zip64_support, :warn_invalid_date
+  attr_accessor :unicode_names,
+                :on_exists_proc,
+                :continue_on_exists_proc,
+                :sort_entries,
+                :default_compression,
+                :write_zip64_support,
+                :warn_invalid_date,
+                :case_insensitive_match,
+                :force_entry_names_encoding
 
   def reset!
     @_ran_once = false
@@ -48,6 +53,7 @@ module Zip
     @default_compression = ::Zlib::DEFAULT_COMPRESSION
     @write_zip64_support = false
     @warn_invalid_date = true
+    @case_insensitive_match = false
   end
 
   def setup

data/lib/zip/central_directory.rb

@@ -5,7 +5,7 @@ module Zip
     END_OF_CDS             = 0x06054b50
     ZIP64_END_OF_CDS       = 0x06064b50
     ZIP64_EOCD_LOCATOR     = 0x07064b50
-    MAX_END_OF_CDS_SIZE    = 65536 + 18
+    MAX_END_OF_CDS_SIZE    = 65_536 + 18
     STATIC_EOCD_SIZE       = 22
 
     attr_reader :comment
@@ -96,7 +96,7 @@ module Zip
       @size_in_bytes                                = Entry.read_zip_64_long(buf)
       @cdir_offset                                  = Entry.read_zip_64_long(buf)
       @zip_64_extensible                            = buf.slice!(0, buf.bytesize)
-      raise Error, "Zip consistency problem while reading eocd structure" unless buf.size == 0
+      raise Error, 'Zip consistency problem while reading eocd structure' unless buf.empty?
     end
 
     def read_e_o_c_d(buf) #:nodoc:
@@ -113,14 +113,14 @@ module Zip
                                                       else
                                                         buf.read(comment_length)
                                                       end
-      raise Error, "Zip consistency problem while reading eocd structure" unless buf.size == 0
+      raise Error, 'Zip consistency problem while reading eocd structure' unless buf.empty?
     end
 
     def read_central_directory_entries(io) #:nodoc:
       begin
         io.seek(@cdir_offset, IO::SEEK_SET)
       rescue Errno::EINVAL
-        raise Error, "Zip consistency problem while reading central directory entry"
+        raise Error, 'Zip consistency problem while reading central directory entry'
       end
       @entry_set = EntrySet.new
       @size.times do
@@ -130,7 +130,7 @@ module Zip
 
     def read_from_stream(io) #:nodoc:
       buf = start_buf(io)
-      if self.zip64_file?(buf)
+      if zip64_file?(buf)
         read_64_e_o_c_d(buf)
       else
         read_e_o_c_d(buf)
@@ -140,7 +140,7 @@ module Zip
 
     def get_e_o_c_d(buf) #:nodoc:
       sig_index = buf.rindex([END_OF_CDS].pack('V'))
-      raise Error, "Zip end of central directory signature not found" unless sig_index
+      raise Error, 'Zip end of central directory signature not found' unless sig_index
       buf = buf.slice!((sig_index + 4)..(buf.bytesize))
 
       def buf.read(count)
@@ -165,9 +165,9 @@ module Zip
 
     def get_64_e_o_c_d(buf) #:nodoc:
       zip_64_start = buf.rindex([ZIP64_END_OF_CDS].pack('V'))
-      raise Error, "Zip64 end of central directory signature not found" unless zip_64_start
+      raise Error, 'Zip64 end of central directory signature not found' unless zip_64_start
       zip_64_locator = buf.rindex([ZIP64_EOCD_LOCATOR].pack('V'))
-      raise Error, "Zip64 end of central directory signature locator not found" unless zip_64_locator
+      raise Error, 'Zip64 end of central directory signature locator not found' unless zip_64_locator
       buf = buf.slice!((zip_64_start + 4)..zip_64_locator)
 
       def buf.read(count)

data/lib/zip/compressor.rb

@@ -1,7 +1,6 @@
 module Zip
   class Compressor #:nodoc:all
-    def finish
-    end
+    def finish; end
   end
 end
 

data/lib/zip/constants.rb

@@ -6,14 +6,14 @@ module Zip
 
   LOCAL_ENTRY_SIGNATURE                  = 0x04034b50
   LOCAL_ENTRY_STATIC_HEADER_LENGTH       = 30
-  LOCAL_ENTRY_TRAILING_DESCRIPTOR_LENGTH = 4+4+4
+  LOCAL_ENTRY_TRAILING_DESCRIPTOR_LENGTH = 4 + 4 + 4
   VERSION_MADE_BY                        = 52 # this library's version
   VERSION_NEEDED_TO_EXTRACT              = 20
   VERSION_NEEDED_TO_EXTRACT_ZIP64        = 45
 
-  FILE_TYPE_FILE    = 010
-  FILE_TYPE_DIR     = 004
-  FILE_TYPE_SYMLINK = 012
+  FILE_TYPE_FILE    = 0o10
+  FILE_TYPE_DIR     = 0o04
+  FILE_TYPE_SYMLINK = 0o12
 
   FSTYPE_FAT      = 0
   FSTYPE_AMIGA    = 1
@@ -58,6 +58,6 @@ module Zip
     FSTYPE_TANDEM   => 'Tandem NSK'.freeze,
     FSTYPE_THEOS    => 'Theos'.freeze,
     FSTYPE_MAC_OSX  => 'Mac OS/X (Darwin)'.freeze,
-    FSTYPE_ATHEOS   => 'AtheOS'.freeze,
+    FSTYPE_ATHEOS   => 'AtheOS'.freeze
   }.freeze
 end

data/lib/zip/crypto/null_encryption.rb

@@ -12,7 +12,7 @@ module Zip
   class NullEncrypter < Encrypter
     include NullEncryption
 
-    def header(mtime)
+    def header(_mtime)
       ''
     end
 
@@ -20,12 +20,11 @@ module Zip
       data
     end
 
-    def data_descriptor(crc32, compressed_size, uncomprssed_size)
+    def data_descriptor(_crc32, _compressed_size, _uncomprssed_size)
       ''
     end
 
-    def reset!
-    end
+    def reset!; end
   end
 
   class NullDecrypter < Decrypter
@@ -35,8 +34,7 @@ module Zip
       data
     end
 
-    def reset!(header)
-    end
+    def reset!(_header); end
   end
 end