zip_tricks 4.2.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a529e0fc4dae54675a7ba880475ec6860ae6c4e
-  data.tar.gz: e5ef83a503a377bfa504a9daeeb415367c9c680e
+  metadata.gz: 99c656baa62bbe09d48e090b2971d63ab3bb875a
+  data.tar.gz: d6b84eb8c621b7039ae205f9e3d9ff5d29887032
 SHA512:
-  metadata.gz: 46d2a64d61873cf3b32889ef99408fab97aeb25eecc7cd76690f40c328c7bdcec9aa6f9d981726a775b79d1746709a35817156221aaf339dc7cda885e58796bc
-  data.tar.gz: 458b3a982c1e533d321b2fffebd086125aeb29e0b5e687cfc187e340847200e946ce7944ee237298dae1c1702ef8e3a971ceb53b439e7156f12ae9c7ff995842
+  metadata.gz: fa0dfe2f578443c695be43c3e170b81bc24fdc836401e3b8e50f41379a7583bd425fffbb1ed1d618624988c63e45fd0732f234d57abb249ccea3ef4d20c863d9
+  data.tar.gz: 30a98f251dd26cde99a62f1cf93ff889aceb30f3ae3eebbba3516b01da3fd56d920e8816d5f742b4c0b17d731b6d8be1f235b4d5bc595b0dc3ecd3960e6b1618

data/.travis.yml

@@ -1,6 +1,7 @@
 rvm:
 - 2.1
 - 2.2
+- 2.3.0
 - jruby-9.0
 sudo: false
 cache: bundler

data/Gemfile

@@ -1,7 +1,7 @@
 source "http://rubygems.org"
 
 group :development do
-  gem 'rubyzip', '~> 1.1', '>= 1.1.7'
+  gem 'rubyzip', '~> 1.1'
   gem 'terminal-table'
   gem 'range_utils'
   gem 'rack', '~> 1.6' # For Jeweler

data/Rakefile

@@ -12,6 +12,9 @@ end
 require 'rake'
 require_relative 'lib/zip_tricks'
 require 'jeweler'
+
+
+
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
   gem.name = "zip_tricks"

data/lib/zip_tricks.rb

@@ -1,5 +1,5 @@
 module ZipTricks
-  VERSION = '4.2.0'
+  VERSION = '4.2.1'
   
   # Require all the sub-components except myself
   Dir.glob(__dir__ + '/**/*.rb').sort.each {|p| require p unless p == __FILE__ }

data/lib/zip_tricks/streamer.rb

@@ -37,15 +37,21 @@
 #
 #     ZipTricks::Streamer.open(socket) do | zip |
 #       zip.add_stored_entry(filename: "myfile1.bin", size: 9090821, crc32: 12485)
-#       zip.simulate_write(tempfile1.size)
 #       socket.sendfile(tempfile1)
+#       zip.simulate_write(tempfile1.size)
+#
 #       zip.add_stored_entry(filename: "myfile2.bin", size: 458678, crc32: 89568)
-#       zip.simulate_write(tempfile2.size)
 #       socket.sendfile(tempfile2)
+#       zip.simulate_write(tempfile2.size)
 #     end
 #
-# Note that you need to use `simulate_write` to let the 
-# The central directory will be written automatically at the end of the block.
+# Note that you need to use `simulate_write` in this case. This needs to happen since Streamer
+# writes absolute offsets into the ZIP (local file header offsets and the like),
+# and it relies on the output object to tell it how many bytes have been written
+# so far. When using `sendfile` the Ruby write methods get bypassed entirely, and the
+# offsets in the IO will not be updated - which will result in an invalid ZIP.
+#
+# The central directory will be written automatically at the end of the `open` block.
 class ZipTricks::Streamer
   require_relative 'streamer/deflated_writer'
   require_relative 'streamer/writable'
@@ -58,8 +64,6 @@ class ZipTricks::Streamer
   EntryBodySizeMismatch = Class.new(StandardError)
   InvalidOutput = Class.new(ArgumentError)
   Overflow = Class.new(StandardError)
-  PathError = Class.new(StandardError)
-  DuplicateFilenames = Class.new(StandardError)
   UnknownMode = Class.new(StandardError)
 
   private_constant :DeflatedWriter, :StoredWriter, :STORED, :DEFLATED
@@ -86,7 +90,7 @@ class ZipTricks::Streamer
     unless stream.respond_to?(:tell) && stream.respond_to?(:advance_position_by)
       stream = ZipTricks::WriteAndTell.new(stream) 
     end
-    
+
     @out = stream
     @files = []
     @local_header_offsets = []
@@ -208,7 +212,7 @@ class ZipTricks::Streamer
   def close
     # Record the central directory offset, so that it can be written into the EOCD record
     cdir_starts_at = @out.tell
-    
+
     # Write out the central directory entries, one for each file
     @files.each_with_index do |entry, i|
       header_loc = @local_header_offsets.fetch(i)
@@ -217,7 +221,7 @@ class ZipTricks::Streamer
         compressed_size: entry.compressed_size, uncompressed_size: entry.uncompressed_size,
         mtime: entry.mtime, crc32: entry.crc32, filename: entry.filename) #, external_attrs: DEFAULT_EXTERNAL_ATTRS)
     end
-    
+
     # Record the central directory size, for the EOCDR
     cdir_size = @out.tell - cdir_starts_at
 
@@ -226,7 +230,7 @@ class ZipTricks::Streamer
        central_directory_size: cdir_size, num_files_in_archive: @files.length)
     @out.tell
   end
-  
+
   # Sets up the ZipWriter with wrappers if necessary. The method is called once, when the Streamer
   # gets instantiated - the Writer then gets reused. This method is primarily there so that you
   # can override it.
@@ -235,22 +239,18 @@ class ZipTricks::Streamer
   def create_writer
     ZipTricks::ZipWriter.new
   end
-  
+
   private
-  
+
   def add_file_and_write_local_header(filename:, crc32:, storage_mode:, compressed_size:,
       uncompressed_size:, use_data_descriptor: false)
-    if @files.any?{|e| e.filename == filename }
-      raise DuplicateFilenames, "Filename #{filename.inspect} already used in the archive"
-    end
-    
+
+    # Clean backslashes and uniqify filenames if there are duplicates
+    filename = remove_backslash(filename)
+    filename = uniquify_name(filename) if @files.any? { |e| e.filename == filename }
+
     raise UnknownMode, "Unknown compression mode #{storage_mode}" unless [STORED, DEFLATED].include?(storage_mode)
     raise Overflow, "Filename is too long" if filename.bytesize > 0xFFFF
-    raise PathError, "Paths in ZIP may only contain forward slashes (UNIX separators)" if filename.include?('\\')
-
-    @check_compressed_size_after_leaving_body = !use_data_descriptor
-    @bytes_written_for_entry = 0
-    @expected_bytes_for_entry = compressed_size
 
     e = Entry.new(filename, crc32, compressed_size, uncompressed_size, storage_mode, mtime=Time.now.utc, use_data_descriptor)
     @files << e
@@ -258,9 +258,37 @@ class ZipTricks::Streamer
     @writer.write_local_file_header(io: @out, gp_flags: e.gp_flags, crc32: e.crc32, compressed_size: e.compressed_size,
       uncompressed_size: e.uncompressed_size, mtime: e.mtime, filename: e.filename, storage_mode: e.storage_mode)
   end
-  
+
   def write_data_descriptor_for_last_entry
     e = @files.fetch(-1)
     @writer.write_data_descriptor(io: @out, crc32: 0, compressed_size: e.compressed_size, uncompressed_size: e.uncompressed_size)
   end
+
+  def remove_backslash(filename)
+    filename.tr('\\', '_')
+  end
+
+  def uniquify_name(filename)
+    files = Set.new(@files.map(&:filename))
+    copy_pattern = /\((\d+)\)$/ # we add (1), (2), (n) at the end of a filename if there is a duplicate
+    parts = filename.split(".")
+    ext = if parts.last =~ /gz|zip/ && parts.size > 2
+            parts.pop(2)
+          elsif parts.size > 1
+            parts.pop
+          end
+    fn_last_part = parts.pop
+
+    duplicate_counter = 1
+    loop do
+      if fn_last_part =~ copy_pattern
+        fn_last_part.sub!(copy_pattern, "(#{duplicate_counter})")
+      else
+        fn_last_part = "#{fn_last_part} (#{duplicate_counter})"
+      end
+      new_filename = (parts + [fn_last_part, ext]).compact.join(".")
+      return new_filename unless files.include?(new_filename)
+      duplicate_counter += 1
+    end
+  end
 end

data/spec/zip_tricks/streamer_spec.rb

@@ -24,21 +24,21 @@ describe ZipTricks::Streamer do
       described_class.new(nil)
     }.to raise_error(ZipTricks::Streamer::InvalidOutput)
   end
-  
+
   it 'allows the writer to be injectable' do
     fake_writer = double('ZipWriter')
     expect(fake_writer).to receive(:write_local_file_header)
     expect(fake_writer).to receive(:write_data_descriptor)
     expect(fake_writer).to receive(:write_central_directory_file_header)
     expect(fake_writer).to receive(:write_end_of_central_directory)
-    
+
     described_class.open('', writer: fake_writer) do |zip|
       zip.write_deflated_file('stored.txt') do |sink|
         sink << File.read(__dir__ + '/war-and-peace.txt')
       end
     end
   end
-  
+
   it 'returns the position in the IO at every call' do
     io = StringIO.new
     zip = described_class.new(io)
@@ -135,7 +135,7 @@ describe ZipTricks::Streamer do
       outbuf.flush
       File.unlink('test.zip') rescue nil
       File.rename(outbuf.path, 'osx-archive-test.zip')
-      
+
       # Mark this test as skipped if the system does not have the binary
       open_zip_with_archive_utility('osx-archive-test.zip', skip_if_missing: true)
     end
@@ -226,7 +226,7 @@ describe ZipTricks::Streamer do
       expect(second_entry.name).to eq("второй-файл.bin".force_encoding(Encoding::BINARY))
     end
   end
-  
+
   it 'creates an archive with data descriptors that can be opened by Rubyzip, with a small number of very tiny text files' do
     tf = ManagedTempfile.new('zip')
     z = described_class.open(tf) do |zip|
@@ -238,14 +238,14 @@ describe ZipTricks::Streamer do
       end
     end
     tf.flush
-    
+
     pending 'https://github.com/rubyzip/rubyzip/issues/295'
-    
+
     Zip::File.foreach(tf.path) do |entry|
       # Make sure it is tagged as UNIX
       expect(entry.fstype).to eq(3)
 
-       # The CRC
+      # The CRC
       expect(entry.crc).to eq(Zlib.crc32(File.read(__dir__ + '/war-and-peace.txt')))
 
       # Check the name
@@ -253,7 +253,7 @@ describe ZipTricks::Streamer do
 
       # Check the right external attributes (non-executable on UNIX)
       expect(entry.external_file_attributes).to eq(2175008768)
-      
+
       # Check the file contents
       readback = entry.get_input_stream.read
       readback.force_encoding(Encoding::BINARY)
@@ -265,7 +265,7 @@ describe ZipTricks::Streamer do
 
   it 'can create a valid ZIP archive without any files' do
     tf = ManagedTempfile.new('zip')
-    
+
     described_class.open(tf) do |zip|
     end
 
@@ -276,4 +276,21 @@ describe ZipTricks::Streamer do
       Zip::File.foreach(tf.path, &b)
     }.not_to yield_control
   end
+
+  it 'prevents duplicates in the stored files' do
+    files = ["README", "README", "file.one\\two.jpg", "file_one.jpg", "file_one (1).jpg",
+             "file\\one.jpg", "My.Super.file.txt.zip", "My.Super.file.txt.zip"]
+    fake_writer = double('Writer').as_null_object
+    seen_filenames = []
+    allow(fake_writer).to receive(:write_local_file_header) {|filename:, **others|
+      seen_filenames << filename
+    }
+    zip_streamer = described_class.new(StringIO.new, writer: fake_writer)
+    files.each do |fn|
+      zip_streamer.add_stored_entry(filename: fn, size: 1024, crc32: 0xCC)
+    end
+    expect(seen_filenames).to eq(["README", "README (1)", "file.one_two.jpg", "file_one.jpg",
+                                  "file_one (1).jpg", "file_one (2).jpg", "My.Super.file.txt.zip",
+                                  "My.Super.file (1).txt.zip"])
+  end
 end

data/zip_tricks.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: zip_tricks 4.2.0 ruby lib
+# stub: zip_tricks 4.2.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "zip_tricks"
-  s.version = "4.2.0"
+  s.version = "4.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Julik Tarkhanov"]
-  s.date = "2016-09-17"
+  s.date = "2016-10-10"
   s.description = "Stream out ZIP files from Ruby"
   s.email = "me@julik.nl"
   s.extra_rdoc_files = [
@@ -70,14 +70,14 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/wetransfer/zip_tricks"
   s.licenses = ["MIT"]
-  s.rubygems_version = "2.5.1"
+  s.rubygems_version = "2.4.5.1"
   s.summary = "Stream out ZIP files from Ruby"
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rubyzip>, [">= 1.1.7", "~> 1.1"])
+      s.add_development_dependency(%q<rubyzip>, ["~> 1.1"])
       s.add_development_dependency(%q<terminal-table>, [">= 0"])
       s.add_development_dependency(%q<range_utils>, [">= 0"])
       s.add_development_dependency(%q<rack>, ["~> 1.6"])
@@ -88,7 +88,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, ["~> 1.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
     else
-      s.add_dependency(%q<rubyzip>, [">= 1.1.7", "~> 1.1"])
+      s.add_dependency(%q<rubyzip>, ["~> 1.1"])
       s.add_dependency(%q<terminal-table>, [">= 0"])
       s.add_dependency(%q<range_utils>, [">= 0"])
       s.add_dependency(%q<rack>, ["~> 1.6"])
@@ -100,7 +100,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
     end
   else
-    s.add_dependency(%q<rubyzip>, [">= 1.1.7", "~> 1.1"])
+    s.add_dependency(%q<rubyzip>, ["~> 1.1"])
     s.add_dependency(%q<terminal-table>, [">= 0"])
     s.add_dependency(%q<range_utils>, [">= 0"])
     s.add_dependency(%q<rack>, ["~> 1.6"])

metadata

@@ -1,22 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: zip_tricks
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.2.1
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-17 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.7
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
@@ -24,9 +21,6 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.7
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
@@ -238,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Stream out ZIP files from Ruby