zip_kit 6.3.3 → 6.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e037e0584d0dbee2e4ab4d934567d04564a26e4f30348f538bda6f7697f8d700
-  data.tar.gz: e069300aae55e54c3d88ed1a6c1e23803bdffbc92a7764de3f58a38a892f2b82
+  metadata.gz: f513e5300c8daa205994e7aa5a957c2270ea7378fab0dd13f57effd8f431d1ea
+  data.tar.gz: 9873a993a94a45339e9a1f383862ed1cc942db2fd23f4d09f6da70705afcf123
 SHA512:
-  metadata.gz: d35e87fc08da2212b9238e4f39df44091454ff77ef41e9810785aaa6855b46c017b285672b1fd0c0bb36df3255a24219331185ce1fc5f7dcf49584c46cce92f0
-  data.tar.gz: b50c429db7b8bbfe7b62d6b14be6cd0827cf1937f6065078b28a6d19b5e016e90e3ac2af0a3567b645ce14f44e4767ac42a5f5c20bb0e0d65ba207b310c02fc0
+  metadata.gz: 4e3ace1ea348f7232d04932981bb5a3d4fb2f1f5e32f01523d5420bff97cc119b7a54bc9bd0f2269f92785167fa2acfdf1e013551def137d69f02e559deae244
+  data.tar.gz: 41c9791db83d11845dfff560526bf4d32cfaf7a0be99933a20ef2677d2027064bd7dd8f1071ac6a7b1864362c6cefa439728b422dcdb9c7529394233ad1dd85b

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 6.3.4
+
+* Fix a bug whereby `rollback!` would cause an exception without any entries having been written yet (rollback on first entry).
+
 ## 6.3.3
 
 * Make sure `Writable#<<` converts the strings it is given into binary if they are not already in binary. This fixes an issue where `Heuristic` would suddenly start forwarding strings as-is to downstream callees. There is a lot of spots where the string-to-write gets forwarded and converting in every single one will be quite wasteful, but it can be handy to do in a few key places.

data/lib/zip_kit/streamer/heuristic.rb

@@ -23,7 +23,7 @@ class ZipKit::Streamer::Heuristic < ZipKit::Streamer::Writable
     @filename = filename
     @write_file_options = write_file_options
 
-    @buf = StringIO.new.binmode
+    @buf = +"".b # Just use a mutable String
     @deflater = ::Zlib::Deflate.new(Zlib::DEFAULT_COMPRESSION, -::Zlib::MAX_WBITS)
     @bytes_deflated = 0
 
@@ -37,7 +37,7 @@ class ZipKit::Streamer::Heuristic < ZipKit::Streamer::Writable
     else
       @buf << bytes
       @deflater.deflate(bytes) { |chunk| @bytes_deflated += chunk.bytesize }
-      decide if @buf.size > BYTES_WRITTEN_THRESHOLD
+      decide if @buf.bytesize > BYTES_WRITTEN_THRESHOLD
     end
     self
   end
@@ -61,7 +61,7 @@ class ZipKit::Streamer::Heuristic < ZipKit::Streamer::Writable
 
     # If the deflated version is smaller than the stored one
     # - use deflate, otherwise stored
-    ratio = @bytes_deflated / @buf.size.to_f
+    ratio = @bytes_deflated / @buf.bytesize.to_f
     @winner = if ratio <= MINIMUM_VIABLE_COMPRESSION
       @streamer.write_deflated_file(@filename, **@write_file_options)
     else
@@ -69,9 +69,8 @@ class ZipKit::Streamer::Heuristic < ZipKit::Streamer::Writable
     end
 
     # Copy the buffered uncompressed data into the newly initialized writable
-    @buf.rewind
-    IO.copy_stream(@buf, @winner)
-    @buf.truncate(0)
+    @winner << @buf
+    @buf.clear
   ensure
     @deflater.close
   end

data/lib/zip_kit/streamer.rb

@@ -273,6 +273,11 @@ class ZipKit::Streamer
   #    output (using `IO.copy_stream` is a good approach).
   # @return [ZipKit::Streamer::Writable] without a block - the Writable sink which has to be closed manually
   def write_file(filename, modification_time: Time.now.utc, unix_permissions: nil, &blk)
+    # Reset rollback state when starting a new entry attempt, so that if this entry
+    # fails before writing a header, rollback! won't use stale values from a previous entry
+    @offset_before_last_local_file_header = nil
+    @remove_last_file_at_rollback = false
+
     writable = ZipKit::Streamer::Heuristic.new(self, filename, modification_time: modification_time, unix_permissions: unix_permissions)
     yield_or_return_writable(writable, &blk)
   end
@@ -510,8 +515,13 @@ class ZipKit::Streamer
     end
 
     # Create filler for the truncated or unusable local file entry that did get written into the output
-    filler_size_bytes = @out.tell - @offset_before_last_local_file_header
-    @files << Filler.new(filler_size_bytes)
+    # Only create a filler if a local file header was actually written (indicated by
+    # @offset_before_last_local_file_header being set). If it's nil, no header was written,
+    # so there's nothing to create a filler for.
+    if @offset_before_last_local_file_header
+      filler_size_bytes = @out.tell - @offset_before_last_local_file_header
+      @files << Filler.new(filler_size_bytes)
+    end
 
     @out.tell
   end

data/lib/zip_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZipKit
-  VERSION = "6.3.3"
+  VERSION = "6.3.4"
 end

data/rbi/zip_kit.rbi

@@ -1,6 +1,6 @@
 # typed: strong
 module ZipKit
-  VERSION = T.let("6.3.3", T.untyped)
+  VERSION = T.let("6.3.4", T.untyped)
 
   class Railtie < Rails::Railtie
   end

data/zip_kit.gemspec

@@ -39,18 +39,22 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3"
   spec.add_development_dependency "rspec-mocks", "~> 3.10", ">= 3.10.2" # ruby 3 compatibility
   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 "standard"
   spec.add_development_dependency "magic_frozen_string_literal"
   spec.add_development_dependency "puma"
-  spec.add_development_dependency "mutex_m" # Some deps use it but it is no longer in stdlib since 3.4
-  spec.add_development_dependency "bigdecimal" # Some deps use it but it is no longer in stdlib since 3.4
   spec.add_development_dependency "rails", "~> 5" # For testing RailsStreaming against an actual Rails controller
   spec.add_development_dependency "actionpack", "~> 5" # For testing RailsStreaming against an actual Rails controller
+  spec.add_development_dependency "sinatra" # We test streaming a ZIP out of an actual Sinatra app too
   spec.add_development_dependency "nokogiri", "~> 1", ">= 1.13" # Rails 5 does by mistake use an older Nokogiri otherwise
-  spec.add_development_dependency "sinatra"
   spec.add_development_dependency "sord"
+
+  # Some deps use stdlib gems which are no longer available in stdlib
+  spec.add_development_dependency "mutex_m"
+  spec.add_development_dependency "abbrev"
+  spec.add_development_dependency "ostruct"
+  spec.add_development_dependency "bigdecimal"
+  spec.add_development_dependency "benchmark"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zip_kit
 version: !ruby/object:Gem::Version
-  version: 6.3.3
+  version: 6.3.4
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -11,7 +11,7 @@ authors:
 - Felix Bünemann
 bindir: exe
 cert_chain: []
-date: 2025-04-18 00:00:00.000000000 Z
+date: 2025-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -117,20 +117,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: coderay
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -216,21 +202,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mutex_m
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: bigdecimal
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -244,55 +244,83 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: sord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: mutex_m
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: abbrev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -306,7 +334,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sord
+  name: benchmark
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="