zip_tricks 4.7.3 → 4.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 537945ff9983b6d84190281aaf71d52a265e49f5
-  data.tar.gz: 1aa8b7a739b624dd7de4ea3e960d966f6f3d9ad3
+  metadata.gz: d1119a96243d5da6b423a2a3c992efc6fbb580fa
+  data.tar.gz: 63a1d0b2c93e5b231568e83efb60220862c07b7e
 SHA512:
-  metadata.gz: 4a98133de0c4902de0babccb5ce5c59e97d9636e1191c65d61bdf538e58c3b81847871bee79584609fc1864f32a0b3dfb8068781149f5b957e43ad1ed80a8b35
-  data.tar.gz: 42e5c29411a5b1a3942bf88f359694572fe0c4a3efbd61006457e0f53c5d0b9948bf8d5f7f801a5c819d341b2e6fc52f2479030c5dd9248b53e5f031faf65423
+  metadata.gz: 89c7300a0c3af8ceb0408d2c4315fc62e4abf5fecc53ca93219bf9ce30c146d9cc8bca193d35908f1d24516bc1298c12332850ff0352dd561ed67a56a6fe7211
+  data.tar.gz: 20cdfca60a6ac3cc5beaa57bf74dba06bd09ef18931931ddead388de68e6316650e4aad14fe96b7838b415babaafe9f8aa72ca5a9ccd547eb535f3e6f27901f4

data/.rubocop.yml

@@ -7,4 +7,5 @@ Layout/FirstMethodParameterLineBreak:
 Style/GlobalVars:
   Exclude:
       - qa/*.rb
-      - spec/spec_helper.rb
+      - spec/spec_helper.rb
+      - spec/support/zip_inspection.rb

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 4.7.4
+
+* Use a single fixed capacity string in StreamCRC32.from_io to avoid unnecessary allocations
+* Fix a few tests that were calling out to external binaries
+
 ## 4.7.3
 
 * Fix RemoteUncap#request_object_size to function correctly

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 WeTransfer
+Copyright (c) 2019 WeTransfer
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -30,7 +30,7 @@ The easiest is to use the Rails' built-in streaming feature:
 class ZipsController < ActionController::Base
   include ActionController::Live # required for streaming
   include ZipTricks::RailsStreaming
-  
+
   def download
     zip_tricks_stream do |zip|
       zip.write_deflated_file('report1.csv') do |sink|
@@ -122,10 +122,10 @@ ZipTricks::Streamer.open(io) do | zip |
   # raw_file is written "as is" (STORED mode).
   # Write the local file header first..
   zip.add_stored_entry(filename: "first-file.bin", size: raw_file.size, crc32: raw_file_crc32)
-  
+
   # then send the actual file contents bypassing the Streamer interface
   io.sendfile(my_temp_file)
-  
+
   # ...and then adjust the ZIP offsets within the Streamer
   zip.simulate_write(my_temp_file.size)
 end
@@ -143,7 +143,7 @@ It is slightly more convenient for the purpose than using the raw Zlib library f
 
 ```ruby
 crc = ZipTricks::StreamCRC32.new
-crc << large_file.read(1024 * 12) until large_file.eof?
+crc << next_chunk_of_data
 ...
 
 crc.to_i # Returns the actual CRC32 value computed so far
@@ -152,6 +152,12 @@ crc.to_i # Returns the actual CRC32 value computed so far
 crc.append(precomputed_crc32, size_of_the_blob_computed_from)
 ```
 
+You can also compute the CRC32 for an entire IO object if it responds to `#eof?`:
+
+```ruby
+crc = ZipTricks::StreamCRC32.from_io(file) # Returns an Integer
+```
+
 ## Reading ZIP files
 
 The library contains a reader module, play with it to see what is possible. It is not a complete ZIP reader
@@ -160,7 +166,7 @@ as such it performs it's function quite well. Please beware of the security impl
 that have not been formally verified (ours hasn't been).
 
 ## Contributing to zip_tricks
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.
@@ -172,4 +178,4 @@ that have not been formally verified (ours hasn't been).
 
 ## Copyright
 
-Copyright (c) 2016 WeTransfer. See LICENSE.txt for further details.
+Copyright (c) 2019 WeTransfer. See LICENSE.txt for further details.

data/lib/zip_tricks/stream_crc32.rb

@@ -2,13 +2,26 @@
 
 # A simple stateful class for keeping track of a CRC32 value through multiple writes
 class ZipTricks::StreamCRC32
+  STRINGS_HAVE_CAPACITY_SUPPORT = begin
+    String.new('', capacity: 1)
+    true
+  rescue ArgumentError
+    false
+  end
+  CRC_BUF_SIZE = 1024 * 512
+  private_constant :STRINGS_HAVE_CAPACITY_SUPPORT, :CRC_BUF_SIZE
+
   # Compute a CRC32 value from an IO object. The object should respond to `read` and `eof?`
   #
   # @param io[IO] the IO to read the data from
   # @return [Fixnum] the computed CRC32 value
   def self.from_io(io)
+    # If we can specify the string capacity upfront we will not have to resize
+    # the string during operation. This saves time but is only available on
+    # recent Ruby 2.x versions.
+    blob = STRINGS_HAVE_CAPACITY_SUPPORT ? String.new('', capacity: CRC_BUF_SIZE) : String.new('')
     crc = new
-    crc << io.read(1024 * 512) until io.eof?
+    crc << io.read(CRC_BUF_SIZE, blob) until io.eof?
     crc.to_i
   end
 

data/lib/zip_tricks/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZipTricks
-  VERSION = '4.7.3'
+  VERSION = '4.7.4'
 end

data/lib/zip_tricks/write_buffer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Some operations (such as CRC32) benefit when they are performed
 # on larger chunks of data. In certain use cases, it is possible that
 # the consumer of ZipTricks is going to be writing small chunks

data/zip_tricks.gemspec

@@ -40,6 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'complexity_assert'
   spec.add_development_dependency 'coderay'
   spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'allocation_stats', '~> 0.1.5'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'wetransfer_style', '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zip_tricks
 version: !ruby/object:Gem::Version
-  version: 4.7.3
+  version: 4.7.4
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-06 00:00:00.000000000 Z
+date: 2019-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: allocation_stats
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement