zip_kit 6.3.5 → 6.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83cdf922faca6692b384bc30ba8290f0f15a4567ebce61fccb792a5b5d7993fc
-  data.tar.gz: ba3a6fee022ba663d77306850246ac8b33ba5d1e10d81f636ace18cc882dc99f
+  metadata.gz: 687884a060911fe25101e41be05bd32f4b50068c2ac592acec9937e5b0912f47
+  data.tar.gz: c209fb4839008ca84b956839db24ff65d8ec3ae390c4666aabe34743258409ec
 SHA512:
-  metadata.gz: ad24aba7c7359f01a11e94ddd1e469fdac2a77c59ece3a113cacebaf900e1cec9a9eee462b385c05d9f1789f9f5c6b48da5098b060e2c5b2c99cc5e312c4d435
-  data.tar.gz: 96eb1200ee5bdf95e2c9f6b8f91d856607f7981f0eabf7c5cee75dbb3efa200c7642f0886ffdad1965da123281c9cfe8d545614616702cadf4dc207da83a293d
+  metadata.gz: bf6bf944be2ec57fd53950c046f5ed28565c5d97f73edc91fbaf1094319d0c2ad47b0a6c6ae1194e69f7fdab3e85beb479b41755e499497fe7f4ab2423529858
+  data.tar.gz: 1d54ad55c06b14297057bc594ff45f74a551b453e9cc5d846595abf238289ed0b7b9175177d089db87bceb9601c9322773a44d4601d3a6b32fb30f331f7bbcff

data/.github/workflows/ci.yml

@@ -37,6 +37,20 @@ jobs:
           RUBYOPT: "--enable=frozen-string-literal --debug=frozen-string-literal"
         run: "bundle exec rspec --backtrace --fail-fast"
 
+  test_ractors:
+    name: "Ractor tests (Ruby 4.0)"
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '4.0'
+          bundler-cache: true
+      - name: "Tests"
+        run: "bundle exec rspec --backtrace --fail-fast spec/zip_kit/ractor_spec.rb"
+
   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

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Unreleased
 
+## 6.3.6
+
+* Fix the end of central directory record counting entries discarded by `rollback!`, which made archives with a rolled back entry unreadable for readers which check the entry count (including `ZipKit::FileReader`).
+* Make ZipKit usable from within Ractors: freeze the computed String constants in `ZipWriter`, `BlockDeflate` and `RackChunkedBody`, and stop defining the raising `BlockWrite` methods with `define_method`. Ractor tests run on Ruby 4.0 in CI.
+
 ## 6.3.5
 
 * Make `WriteBuffer#<<` much faster for lots of tiny writes, like the XML fragments written by libraries such as caxlsx. Strings are no longer copied with `String#b` before being appended: on Ruby 3.4+ `String#append_as_bytes` is used, on older Rubies the string is converted only if Ruby refuses to append it. Mixing binary strings and non-ASCII strings still works, and the writable still always receives binary strings.

data/Rakefile

@@ -16,6 +16,14 @@ RSpec::Core::RakeTask.new(:spec)
 task :generate_typedefs do
   `bundle exec sord rbi/zip_kit.rbi`
   `bundle exec sord rbi/zip_kit.rbs`
+
+  # Sord inlines the VERSION literal, which would make every version bump produce a typedef diff
+  rbi_path = "rbi/zip_kit.rbi"
+  rbi = File.read(rbi_path).sub(/^(\s*)VERSION = T\.let\(.+\)$/, '\1VERSION = T.let(T.unsafe(nil), String)')
+  File.write(rbi_path, rbi)
+  rbs_path = "rbi/zip_kit.rbs"
+  rbs = File.read(rbs_path).sub(/^(\s*)VERSION: untyped$/, '\1VERSION: String')
+  File.write(rbs_path, rbs)
 end
 
 task default: [:spec, :standard, :generate_typedefs]

data/lib/zip_kit/block_deflate.rb

@@ -47,7 +47,7 @@
 
 class ZipKit::BlockDeflate
   DEFAULT_BLOCKSIZE = 1_024 * 1024 * 5
-  END_MARKER = [3, 0].pack("C*")
+  END_MARKER = [3, 0].pack("C*").freeze
   # Zlib::NO_COMPRESSION..
   VALID_COMPRESSIONS = (Zlib::DEFAULT_COMPRESSION..Zlib::BEST_COMPRESSION).to_a.freeze
   # Write the end marker (\x3\x0) to the given IO.

data/lib/zip_kit/block_write.rb

@@ -27,11 +27,18 @@ class ZipKit::BlockWrite
     @block = block
   end
 
-  # Make sure those methods raise outright
-  %i[seek pos= to_s].each do |m|
-    define_method(m) do |*_args|
-      raise "#{m} not supported - this IO adapter is non-rewindable"
-    end
+  # Make sure those methods raise outright. These are not created with define_method,
+  # because methods defined with a block can't be called from a non-main Ractor
+  def seek(*)
+    raise "seek not supported - this IO adapter is non-rewindable"
+  end
+
+  def pos=(*)
+    raise "pos= not supported - this IO adapter is non-rewindable"
+  end
+
+  def to_s(*)
+    raise "to_s not supported - this IO adapter is non-rewindable"
   end
 
   # Sends a string through to the block stored in the BlockWrite.

data/lib/zip_kit/rack_chunked_body.rb

@@ -9,7 +9,7 @@
 # carry, so we copy it into our code.
 class ZipKit::RackChunkedBody
   TERM = "\r\n"
-  TAIL = "0#{TERM}"
+  TAIL = "0\r\n"
 
   # @param body[#each] the enumerable that yields bytes, usually a `OutputEnumerator`
   def initialize(body)

data/lib/zip_kit/streamer.rb

@@ -412,11 +412,10 @@ class ZipKit::Streamer
     # 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 do |entry|
-      # Skip fillers which are standing in for broken/incomplete files
-      next if entry.filler?
-
+    # Write out the central directory entries, one for each file.
+    # Skip fillers which are standing in for broken/incomplete files
+    entries = @files.reject(&:filler?)
+    entries.each do |entry|
       @writer.write_central_directory_file_header(io: @out,
         local_file_header_location: entry.local_header_offset,
         gp_flags: entry.gp_flags,
@@ -436,7 +435,7 @@ class ZipKit::Streamer
     @writer.write_end_of_central_directory(io: @out,
       start_of_central_directory_location: cdir_starts_at,
       central_directory_size: cdir_size,
-      num_files_in_archive: @files.length)
+      num_files_in_archive: entries.length)
 
     # Clear the files so that GC will not have to trace all the way to here to deallocate them
     @files.clear

data/lib/zip_kit/version.rb

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

data/lib/zip_kit/zip_writer.rb

@@ -29,7 +29,7 @@ require "stringio"
 class ZipKit::ZipWriter
   FOUR_BYTE_MAX_UINT = 0xFFFFFFFF
   TWO_BYTE_MAX_UINT = 0xFFFF
-  ZIP_KIT_COMMENT = "Written using ZipKit %<version>s" % {version: ZipKit::VERSION}
+  ZIP_KIT_COMMENT = ("Written using ZipKit %<version>s" % {version: ZipKit::VERSION}).freeze
   VERSION_MADE_BY = 52
   VERSION_NEEDED_TO_EXTRACT = 20
   VERSION_NEEDED_TO_EXTRACT_ZIP64 = 45
@@ -40,7 +40,7 @@ class ZipKit::ZipWriter
   MADE_BY_SIGNATURE = begin
     # A combination of the VERSION_MADE_BY low byte and the OS type high byte
     os_type = 3 # UNIX
-    [VERSION_MADE_BY, os_type].pack("CC")
+    [VERSION_MADE_BY, os_type].pack("CC").freeze
   end
 
   C_UINT4 = "V" # Encode a 4-byte unsigned little-endian uint

data/rbi/zip_kit.rbi

@@ -1,6 +1,6 @@
 # typed: strong
 module ZipKit
-  VERSION = T.let("6.3.5", T.untyped)
+  VERSION = T.let(T.unsafe(nil), String)
 
   class Railtie < Rails::Railtie
   end
@@ -942,7 +942,7 @@ module ZipKit
   class ZipWriter
     FOUR_BYTE_MAX_UINT = T.let(0xFFFFFFFF, T.untyped)
     TWO_BYTE_MAX_UINT = T.let(0xFFFF, T.untyped)
-    ZIP_KIT_COMMENT = T.let("Written using ZipKit %<version>s" % {version: ZipKit::VERSION}, T.untyped)
+    ZIP_KIT_COMMENT = T.let(("Written using ZipKit %<version>s" % {version: ZipKit::VERSION}).freeze, T.untyped)
     VERSION_MADE_BY = T.let(52, T.untyped)
     VERSION_NEEDED_TO_EXTRACT = T.let(20, T.untyped)
     VERSION_NEEDED_TO_EXTRACT_ZIP64 = T.let(45, T.untyped)
@@ -953,7 +953,7 @@ module ZipKit
     MADE_BY_SIGNATURE = T.let(begin
   # A combination of the VERSION_MADE_BY low byte and the OS type high byte
   os_type = 3 # UNIX
-  [VERSION_MADE_BY, os_type].pack("CC")
+  [VERSION_MADE_BY, os_type].pack("CC").freeze
 end, T.untyped)
     C_UINT4 = T.let("V", T.untyped)
     C_UINT2 = T.let("v", T.untyped)
@@ -1164,6 +1164,20 @@ end, T.untyped)
     sig { params(block: T.proc.params(bytes: String).void).void }
     def initialize(&block); end
 
+    # sord omit - no YARD return type given, using untyped
+    # Make sure those methods raise outright. These are not created with define_method,
+    # because methods defined with a block can't be called from a non-main Ractor
+    sig { returns(T.untyped) }
+    def seek; end
+
+    # sord omit - no YARD return type given, using untyped
+    sig { returns(T.untyped) }
+    def pos=; end
+
+    # sord omit - no YARD return type given, using untyped
+    sig { returns(T.untyped) }
+    def to_s; end
+
     # Sends a string through to the block stored in the BlockWrite.
     # 
     # _@param_ `buf` — the string to write. Note that a zero-length String will not be forwarded to the block, as it has special meaning when used with chunked encoding (it indicates the end of the stream).
@@ -1879,7 +1893,7 @@ end, T.untyped)
   #     compressed_string = ZipKit::BlockDeflate.deflate_chunk(big_string)
   class BlockDeflate
     DEFAULT_BLOCKSIZE = T.let(1_024 * 1024 * 5, T.untyped)
-    END_MARKER = T.let([3, 0].pack("C*"), T.untyped)
+    END_MARKER = T.let([3, 0].pack("C*").freeze, T.untyped)
     VALID_COMPRESSIONS = T.let((Zlib::DEFAULT_COMPRESSION..Zlib::BEST_COMPRESSION).to_a.freeze, T.untyped)
 
     # Write the end marker (\x3\x0) to the given IO.
@@ -2225,7 +2239,7 @@ end, T.untyped)
   # carry, so we copy it into our code.
   class RackChunkedBody
     TERM = T.let("\r\n", T.untyped)
-    TAIL = T.let("0#{TERM}", T.untyped)
+    TAIL = T.let("0\r\n", T.untyped)
 
     # sord duck - #each looks like a duck type, replacing with untyped
     # _@param_ `body` — the enumerable that yields bytes, usually a `OutputEnumerator`

data/rbi/zip_kit.rbs

@@ -1,5 +1,5 @@
 module ZipKit
-  VERSION: untyped
+  VERSION: String
 
   class Railtie < Rails::Railtie
   end
@@ -1038,6 +1038,17 @@ module ZipKit
     # _@param_ `block` — The block that will be called when this object receives the `<<` message
     def initialize: () ?{ (String bytes) -> void } -> void
 
+    # sord omit - no YARD return type given, using untyped
+    # Make sure those methods raise outright. These are not created with define_method,
+    # because methods defined with a block can't be called from a non-main Ractor
+    def seek: () -> untyped
+
+    # sord omit - no YARD return type given, using untyped
+    def pos=: () -> untyped
+
+    # sord omit - no YARD return type given, using untyped
+    def to_s: () -> untyped
+
     # Sends a string through to the block stored in the BlockWrite.
     # 
     # _@param_ `buf` — the string to write. Note that a zero-length String will not be forwarded to the block, as it has special meaning when used with chunked encoding (it indicates the end of the stream).

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zip_kit
 version: !ruby/object:Gem::Version
-  version: 6.3.5
+  version: 6.3.6
 platform: ruby
 authors:
 - Julik Tarkhanov
@@ -11,7 +11,7 @@ authors:
 - Felix Bünemann
 bindir: exe
 cert_chain: []
-date: 2026-09-30 00:00:00.000000000 Z
+date: 2026-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler