zip_kit 6.3.1 → 6.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 442833a965d373fd56e8d085164f536e17560ed4a74e11aab5befc61946de1bc
-  data.tar.gz: 6c470314702d643b8f5b55fb3a328ab62cecfe1982587df9b8179fd84bf9013e
+  metadata.gz: 2ff5f4284066004d435d36f28020e6ef2279fe0abe36c520436db3bd39d7608a
+  data.tar.gz: ac9f9c4312c632410cee6ffb98c2ec471f9de16e5260793a30df8ac28639218d
 SHA512:
-  metadata.gz: 8532b5faf979cc98ba0f1e05dff6adf3e6748466553446397c3f7f706fe663182f8fab47a973e3e911b2457eb0622579a62d7b35c1fe18644b7ea05541d7e316
-  data.tar.gz: 377ef88938f5ec86ea6cd2e15c6857eac9ff2ffc25bb629cf2a0d0ba774a823013e4b4061d1a5392dc4b88e8cbd3d022a1f90e41d1cb68ad72c5e9d42f3c51cd
+  metadata.gz: 34389f0a2d38a532af341c7694fcd10c2bbfb2f819ce9d1168afd51fbfc815b8c4ef0b36929f286f3ad31ead98479b07b871ec35d1d8f5adefbf2bb2717f3f58
+  data.tar.gz: 821151643cc5adafd9fe3446412e9d9de60ff049f6bab3ca1e9a7c0dc24dbcef0688b8bc0ab1fa51d88feb85892b3707ccbf8483e41c532680c2e9ddb073e823

data/.github/workflows/ci.yml

@@ -7,23 +7,46 @@ env:
   BUNDLE_PATH: vendor/bundle
 
 jobs:
-  test:
-    name: Tests and Lint
+  test_baseline_ruby:
+    name: "Tests (Ruby 2.6 baseline)"
     runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        ruby:
-          - '2.6'
-          - '3.3'
     steps:
       - name: Checkout
         uses: actions/checkout@v4
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: ${{ matrix.ruby }}
+          ruby-version: '2.6'
           bundler-cache: true
       - name: "Tests"
         run: bundle exec rspec --backtrace --fail-fast
+
+  test_newest_ruby:
+    name: "Tests (Ruby 3.4 with frozen string literals)"
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4.1'
+          bundler-cache: true
+      - name: "Tests" # Make the test suite hard-crash on frozen string literal violations
+        env:
+          RUBYOPT: "--enable=frozen-string-literal --debug=frozen-string-literal"
+        run: "bundle exec rspec --backtrace --fail-fast"
+
+  lint_baseline_ruby: # We need to use syntax appropriate for the minimum supported Ruby version
+    name: Lint (Ruby 2.6 syntax)
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.6'
+          bundler-cache: true
       - name: "Lint"
         run: bundle exec rake standard

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 6.3.2
+
+* Make sure `rollback!` correctly works with `write_file` and the original exception gets re-raised from `write_file` if
+  closing the current entry happens in `Writable#close`
+
 ## 6.3.1
 
 * Include `RailsStreaming` in a Rails loader callback, so that ActionController does not need to be in the namespace.

data/README.md

@@ -21,6 +21,11 @@ the library can be used to generate JAR files, EPUBs, OpenOffice/Office document
 
 ## How does it work? How is it different from Rubyzip?
 
+zip_kit outputs the metadata of the ZIP file as it becomes available. Same for the content of the ZIP
+entries. This allows nearly-unbuffered, streaming output. When reading ZIP files, zip_kit only reads
+the metadata and does so in an accelerated, efficient way - permitting ZIP unarchiving directly from
+a resource on HTTP (provided that the server supports HTTP ranges).
+
 Check out [the implementation details](IMPLEMENTATION_DETAILS.md) on the design of the library, and
 we have a separate [reference](RUBYZIP_DIFFERENCES.md) on why you might want to use ZipKit over
 Rubyzip and vice versa.

data/lib/zip_kit/output_enumerator.rb

@@ -112,6 +112,17 @@ class ZipKit::OutputEnumerator
   # but are of a file format built "on top" of ZIPs - such as ODTs, [pkpass files](https://developer.apple.com/documentation/walletpasses/building_a_pass)
   # and ePubs.
   #
+  # More value, however, is in the "technical" headers this method will provide. It will take the following steps to make sure streaming works correctly.
+  #
+  # * `Last-Modified` will be set to "now" so that the response is considered "fresh" by `Rack::ETag`. This is done so that `Rack::ETag` won't try to
+  #      calculate a lax ETag value and thus won't start buffering your response out of nowhere
+  # * `Content-Encoding` will be set to `identity`. This is so that proxies or the Rack middleware that applies compression to the response (like gzip)
+  #      is not going to try to compress your response. It also tells the receiving browsers (or downstream proxies) that they should not attempt to
+  #      open or uncompress the response before saving it or passing it onwards.
+  # * `X-Accel-Buffering` will be set to 'no` - this tells both nginx and the Google Cloud load balancer that the response should not be buffered
+  #
+  # These header values are known to get as close as possible to guaranteeing streaming on most environments where Ruby web applications may be hosted.
+  #
   # @return [Hash]
   def self.streaming_http_headers
     _headers = {

data/lib/zip_kit/remote_io.rb

@@ -74,7 +74,7 @@ class ZipKit::RemoteIO
   # @param range[Range] the HTTP range of data to fetch from remote
   # @return [String] the response body of the ranged request
   def request_range(range)
-    http = Net::HTTP.start(@uri.hostname, @uri.port)
+    http = Net::HTTP.start(@uri.hostname, @uri.port, use_ssl: @uri.scheme == "https")
     request = Net::HTTP::Get.new(@uri)
     request.range = range
     response = http.request(request)
@@ -91,7 +91,7 @@ class ZipKit::RemoteIO
   #
   # @return [Integer] the size of the remote resource, parsed either from Content-Length or Content-Range header
   def request_object_size
-    http = Net::HTTP.start(@uri.hostname, @uri.port)
+    http = Net::HTTP.start(@uri.hostname, @uri.port, use_ssl: @uri.scheme == "https")
     request = Net::HTTP::Get.new(@uri)
     request.range = 0..0
     response = http.request(request)

data/lib/zip_kit/size_estimator.rb

@@ -36,8 +36,11 @@ class ZipKit::SizeEstimator
   #
   # @param filename [String] the name of the file (filenames are variable-width in the ZIP)
   # @param size [Integer] size of the uncompressed entry
-  # @param use_data_descriptor[Boolean] whether the entry uses a postfix
-  # data descriptor to specify size
+  # @param use_data_descriptor[Boolean] whether there is going to be a data descriptor written
+  #                                     after the entry body, to specify size.
+  #                                     You must enable this if you are going to be
+  #                                     using {Streamer#write_stored_file} as otherwise your
+  #                                     estimated size is not going to be accurate
   # @return self
   def add_stored_entry(filename:, size:, use_data_descriptor: false)
     @streamer.add_stored_entry(filename: filename,
@@ -56,8 +59,11 @@ class ZipKit::SizeEstimator
   # @param filename [String] the name of the file (filenames are variable-width in the ZIP)
   # @param uncompressed_size [Integer] size of the uncompressed entry
   # @param compressed_size [Integer] size of the compressed entry
-  # @param use_data_descriptor[Boolean] whether the entry uses a postfix data
-  #                                     descriptor to specify size
+  # @param use_data_descriptor[Boolean] whether there is going to be a data descriptor written
+  #                                     after the entry body, to specify size.
+  #                                     You must enable this if you are going to be
+  #                                     using {Streamer#write_deflated_file} as otherwise your
+  #                                     estimated size is not going to be accurate
   # @return self
   def add_deflated_entry(filename:, uncompressed_size:, compressed_size:, use_data_descriptor: false)
     @streamer.add_deflated_entry(filename: filename,

data/lib/zip_kit/streamer/heuristic.rb

@@ -26,6 +26,7 @@ class ZipKit::Streamer::Heuristic < ZipKit::Streamer::Writable
     @bytes_deflated = 0
 
     @winner = nil
+    @started_closing = false
   end
 
   def <<(bytes)
@@ -40,6 +41,9 @@ class ZipKit::Streamer::Heuristic < ZipKit::Streamer::Writable
   end
 
   def close
+    return if @started_closing
+    @started_closing = true # started_closing because an exception may get raised inside close(), as we add an entry there
+
     decide unless @winner
     @winner.close
   end
@@ -47,6 +51,7 @@ class ZipKit::Streamer::Heuristic < ZipKit::Streamer::Writable
   private def decide
     # Finish and then close the deflater - it has likely buffered some data
     @bytes_deflated += @deflater.finish.bytesize until @deflater.finished?
+
     # If the deflated version is smaller than the stored one
     # - use deflate, otherwise stored
     ratio = @bytes_deflated / @buf.size.to_f
@@ -55,9 +60,12 @@ class ZipKit::Streamer::Heuristic < ZipKit::Streamer::Writable
     else
       @streamer.write_stored_file(@filename, **@write_file_options)
     end
+
     # Copy the buffered uncompressed data into the newly initialized writable
     @buf.rewind
     IO.copy_stream(@buf, @winner)
     @buf.truncate(0)
+  ensure
+    @deflater.close
   end
 end

data/lib/zip_kit/streamer.rb

@@ -5,8 +5,12 @@ require "set"
 # Is used to write ZIP archives without having to read them back or to overwrite
 # data. It outputs into any object that supports `<<` or `write`, namely:
 #
-# An `Array`, `File`, `IO`, `Socket` and even `String` all can be output destinations
-# for the `Streamer`.
+# * `Array` - will contain binary strings
+# * `File` - data will be written to it as it gets generated
+# * `IO` (`Socket`, `StringIO`) - data gets written into it
+# * `String` - in binary encoding and unfrozen - also makes a decent output target
+#
+# or anything else that responds to `#<<` or `#write`.
 #
 # You can also combine output through the `Streamer` with direct output to the destination,
 # all while preserving the correct offsets in the ZIP file structures. This allows usage
@@ -482,6 +486,10 @@ class ZipKit::Streamer
   # is likely already on the wire. However, excluding the entry from the central directory of the ZIP
   # file will allow better-behaved ZIP unarchivers to extract the entries which did store correctly,
   # provided they read the ZIP from the central directory and not straight-ahead.
+  # Rolling back does not perform any writes.
+  #
+  # `rollback!` gets called for you if an exception is raised inside the block of `write_file`,
+  # `write_deflated_file` and `write_stored_file`.
   #
   # @example
   #     zip.add_stored_entry(filename: "data.bin", size: 4.megabytes, crc32: the_crc)
@@ -493,14 +501,17 @@ class ZipKit::Streamer
   #     end
   # @return [Integer] position in the output stream / ZIP archive
   def rollback!
-    removed_entry = @files.pop
-    return @out.tell unless removed_entry
+    @files.pop if @remove_last_file_at_rollback
 
+    # Recreate the path set from remaining entries (PathSet does not support cheap deletes yet)
     @path_set.clear
     @files.each do |e|
       @path_set.add_directory_or_file_path(e.filename) unless e.filler?
     end
-    @files << Filler.new(@out.tell - removed_entry.local_header_offset)
+
+    # 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)
 
     @out.tell
   end
@@ -554,6 +565,11 @@ class ZipKit::Streamer
     use_data_descriptor:,
     unix_permissions:
   )
+    # Set state needed for proper rollback later. If write_local_file_header
+    # does manage to write _some_ bytes, but fails later (we write in tiny bits sometimes)
+    # we should be able to create a filler from this offset on when we
+    @offset_before_last_local_file_header = @out.tell
+    @remove_last_file_at_rollback = false
 
     # Clean backslashes
     filename = remove_backslash(filename)
@@ -600,9 +616,11 @@ class ZipKit::Streamer
       mtime: e.mtime,
       filename: e.filename,
       storage_mode: e.storage_mode)
+
     e.bytes_used_for_local_header = @out.tell - e.local_header_offset
 
     @files << e
+    @remove_last_file_at_rollback = true
   end
 
   def remove_backslash(filename)

data/lib/zip_kit/version.rb

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

data/rbi/zip_kit.rbi

@@ -1897,13 +1897,11 @@ end, T.untyped)
 
     # Add a fake entry to the archive, to see how big it is going to be in the end.
     # 
-    # data descriptor to specify size
-    # 
     # _@param_ `filename` — the name of the file (filenames are variable-width in the ZIP)
     # 
     # _@param_ `size` — size of the uncompressed entry
     # 
-    # _@param_ `use_data_descriptor` — whether the entry uses a postfix
+    # _@param_ `use_data_descriptor` — whether there is going to be a data descriptor written after the entry body, to specify size. You must enable this if you are going to be using {Streamer#write_stored_file} as otherwise your estimated size is not going to be accurate
     # 
     # _@return_ — self
     sig { params(filename: String, size: Integer, use_data_descriptor: T::Boolean).returns(T.untyped) }
@@ -1917,7 +1915,7 @@ end, T.untyped)
     # 
     # _@param_ `compressed_size` — size of the compressed entry
     # 
-    # _@param_ `use_data_descriptor` — whether the entry uses a postfix data descriptor to specify size
+    # _@param_ `use_data_descriptor` — whether there is going to be a data descriptor written after the entry body, to specify size. You must enable this if you are going to be using {Streamer#write_deflated_file} as otherwise your estimated size is not going to be accurate
     # 
     # _@return_ — self
     sig do
@@ -2102,6 +2100,17 @@ end, T.untyped)
     # ones - for example, specific content types are needed for files which are, technically, ZIP files
     # but are of a file format built "on top" of ZIPs - such as ODTs, [pkpass files](https://developer.apple.com/documentation/walletpasses/building_a_pass)
     # and ePubs.
+    # 
+    # More value, however, is in the "technical" headers this method will provide. It will take the following steps to make sure streaming works correctly.
+    # 
+    # * `Last-Modified` will be set to "now" so that the response is considered "fresh" by `Rack::ETag`. This is done so that `Rack::ETag` won't try to
+    #      calculate a lax ETag value and thus won't start buffering your response out of nowhere
+    # * `Content-Encoding` will be set to `identity`. This is so that proxies or the Rack middleware that applies compression to the response (like gzip)
+    #      is not going to try to compress your response. It also tells the receiving browsers (or downstream proxies) that they should not attempt to
+    #      open or uncompress the response before saving it or passing it onwards.
+    # * `X-Accel-Buffering` will be set to 'no` - this tells both nginx and the Google Cloud load balancer that the response should not be buffered
+    # 
+    # These header values are known to get as close as possible to guaranteeing streaming on most environments where Ruby web applications may be hosted.
     sig { returns(T::Hash[T.untyped, T.untyped]) }
     def self.streaming_http_headers; end
 

data/zip_kit.gemspec

@@ -40,6 +40,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "standard", "1.28.5" # Very specific version of standard for 2.6 with _known_ settings
   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 "nokogiri", "~> 1", ">= 1.13" # Rails 5 does by mistake use an older Nokogiri otherwise

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zip_kit
 version: !ruby/object:Gem::Version
-  version: 6.3.1
+  version: 6.3.2
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -9,10 +9,9 @@ authors:
 - Dmitry Tymchuk
 - David Bosveld
 - Felix Bünemann
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-11 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -216,6 +215,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  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: bigdecimal
+  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: rails
   requirement: !ruby/object:Gem::Requirement
@@ -356,7 +383,6 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -371,8 +397,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Stream out ZIP files from Ruby. Successor to zip_tricks.
 test_files: []