zrip 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8547d0b03673ee4f673fbacf44db390c656997518b7f96053348ac16afe7459
-  data.tar.gz: 73cbaa89c7e41c699e6d978b9429866d3a0cc62a1dad0ebec4c5c9debd9c1674
+  metadata.gz: 50caa1679bd74290e01032b2564ab2ac083633f00ad7070f2e3e597572ffe22b
+  data.tar.gz: d89a94b7221aba11a0084f8ffeab771428f682ddf19908a647c2bce862b43ffe
 SHA512:
-  metadata.gz: cc377654d9074f02ceb1479c2a7aa30af5cb2fcaea14699a50db34ac4528dba8a98e8cdf23c2e8653f58714cc9d18d9c709a8aefa95c815635df44b218a094e5
-  data.tar.gz: c0057bc6f4ccacbc843091f35893b8e44c196f4fb60915a79e94753eaf0c2c1d64165cd6556b611a9abf00c6efdccc9b611dcc6c78291b1c2b4676479c0d1bad
+  metadata.gz: 74bc8d13edae353144da41a66e80d41440157dc11c9555726c2c01659d88a02c8ffd0a7410b0157fb011a45677c54448a808ed463a1f9b1d99bd9a2769e42926
+  data.tar.gz: 91c282a2f5275e2e0cd72a9a2cf089a0582e47d256acce3c9bf67be6f494ab89a046bfece175d23f9543e7162b90b8bf66cc0dd97e5ebd5c9a695c3462e23d01

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## [Unreleased]
 
+## [0.2.0] - 2026-08-07
+
+- Release the Ruby GVL around large frame/block compression and frame
+  decompression calls.
+- Update the `zrip` crate dependency to 0.8.5.
+- Replace Magnus with direct `rb-sys` bindings, add TruffleRuby build support,
+  and lower the Ruby requirement to 3.4.
+- Apply `max_output_size:` to the total decompressed output of concatenated
+  Zstandard frames.
+- Add RubyDoc metadata and move API reference details from `README.md` into
+  YARD comments.
+
+## [0.1.2] - 2026-08-05
+
+- Update `zrip` crate dependency from 0.8.3 to 0.8.4.
+
 ## [0.1.1] - 2026-06-29
 
 - Update `zrip` crate dependency from 0.3 to 0.8.

data/Cargo.lock

@@ -4,9 +4,9 @@ version = 4
 
 [[package]]
 name = "aho-corasick"
-version = "1.1.4"
+version = "1.1.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ddd31a130427c27518df266943a5308ed92d4b226cc639f5a8f1002816174301"
+checksum = "c982642fa9e8606056828ee9a8505737230110bb1099153c79efe865c59d12ba"
 dependencies = [
  "memchr",
 ]
@@ -31,9 +31,9 @@ dependencies = [
 
 [[package]]
 name = "bitflags"
-version = "2.13.0"
+version = "2.13.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "b4388bee8683e3d04af747c73422af53102d2bd24d9eadb6cbc100baef4b43f8"
+checksum = "b588b76d00fde79687d7646a9b5bdf3cc0f655e0bbd080335a95d7e96f3587da"
 
 [[package]]
 name = "cexpr"
@@ -52,9 +52,9 @@ checksum = "9330f8b2ff13f34540b44e946ef35111825727b38d33286ef986142615121801"
 
 [[package]]
 name = "clang-sys"
-version = "1.8.1"
+version = "1.9.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0b023947811758c97c59bf9d1c188fd619ad4718dcaa767947df1cadb14f39f4"
+checksum = "157a8ba7b480713b56f4c09fd13fc3e0a22a5dfab8097ba61cbc5feef950788a"
 dependencies = [
  "glob",
  "libc",
@@ -63,21 +63,21 @@ dependencies = [
 
 [[package]]
 name = "either"
-version = "1.16.0"
+version = "1.17.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "91622ff5e7162018101f2fea40d6ebf4a78bbe5a49736a2020649edf9693679e"
+checksum = "9e5e8f6c15a24b9a3ee5efec809ccd006d3b30e8b3bb63c39af737c7f87daa1d"
 
 [[package]]
 name = "fearless_simd"
-version = "0.5.0"
+version = "0.6.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a847f35d37ef14f89ccd8028d7d98a43a59d3c9bfae690ca7a8a95a5937ff9b5"
+checksum = "e0f5f895dac0865bc235f1364793899569a7db538137f1024dccea56bf41c78d"
 
 [[package]]
 name = "glob"
-version = "0.3.3"
+version = "0.3.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0cc23270f6e1808e30a928bdc84dea0b9b4136a8bc82338574f23baf47bbd280"
+checksum = "e4eba85ea1d0a966a983acd07deee566e67395d2d96b6fb39e62b5a833f1eb0b"
 
 [[package]]
 name = "itertools"
@@ -96,9 +96,9 @@ checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
 
 [[package]]
 name = "libc"
-version = "0.2.186"
+version = "0.2.189"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "68ab91017fe16c622486840e4c83c9a37afeff978bd239b5293d61ece587de66"
+checksum = "3eaf3ede3fee6db1a4c2ee091bf8a8b4dccdc6d17f656fb07896ee72867612f2"
 
 [[package]]
 name = "libloading"
@@ -110,34 +110,11 @@ dependencies = [
  "windows-link",
 ]
 
-[[package]]
-name = "magnus"
-version = "0.8.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "3b36a5b126bbe97eb0d02d07acfeb327036c6319fd816139a49824a83b7f9012"
-dependencies = [
- "magnus-macros",
- "rb-sys",
- "rb-sys-env",
- "seq-macro",
-]
-
-[[package]]
-name = "magnus-macros"
-version = "0.8.0"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "47607461fd8e1513cb4f2076c197d8092d921a1ea75bd08af97398f593751892"
-dependencies = [
- "proc-macro2",
- "quote",
- "syn",
-]
-
 [[package]]
 name = "memchr"
-version = "2.8.2"
+version = "2.8.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "88904434abc2901f197fe8cc55f0445e7ded921dba5911dad2e2b39b48e663c4"
+checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98"
 
 [[package]]
 name = "minimal-lexical"
@@ -157,18 +134,18 @@ dependencies = [
 
 [[package]]
 name = "proc-macro2"
-version = "1.0.106"
+version = "1.0.107"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8fd00f0bb2e90d81d1044c2b32617f68fcb9fa3bb7640c23e9c748e53fb30934"
+checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9"
 dependencies = [
  "unicode-ident",
 ]
 
 [[package]]
 name = "quote"
-version = "1.0.46"
+version = "1.0.47"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dfbc457d0c7a0759a614551b11a6409e5951f6c7537be1f1b7682b9ae9230368"
+checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001"
 dependencies = [
  "proc-macro2",
 ]
@@ -197,17 +174,11 @@ dependencies = [
  "syn",
 ]
 
-[[package]]
-name = "rb-sys-env"
-version = "0.2.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cca7ad6a7e21e72151d56fe2495a259b5670e204c3adac41ee7ef676ea08117a"
-
 [[package]]
 name = "regex"
-version = "1.12.4"
+version = "1.13.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f1292b7759ae1cb9ec195452d1390a074f0cd8541ab7a5a8c31cd6db45d4a6ba"
+checksum = "f020237b6c8eed93db2e2cb53c00c60a8e1bc73da7d073199a1180401450218d"
 dependencies = [
  "aho-corasick",
  "memchr",
@@ -217,9 +188,9 @@ dependencies = [
 
 [[package]]
 name = "regex-automata"
-version = "0.4.14"
+version = "0.4.18"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6e1dd4122fc1595e8162618945476892eefca7b88c52820e74af6262213cae8f"
+checksum = "ad8553b9b26413251cbf30e620595c7a41b3887f03da04579c0e6b0d6a06b4b2"
 dependencies = [
  "aho-corasick",
  "memchr",
@@ -234,15 +205,9 @@ checksum = "d6f6ff9a378485b298a5286656da665ba74413d36db0979633275d2e708145d4"
 
 [[package]]
 name = "rustc-hash"
-version = "2.1.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "94300abf3f1ae2e2b8ffb7b58043de3d399c73fa6f4b73826402a5c457614dbe"
-
-[[package]]
-name = "seq-macro"
-version = "0.3.6"
+version = "2.1.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1bc711410fbe7399f390ca1c3b60ad0f53f80e95c5eb935e52268a0e2cd49acc"
+checksum = "6b1e7f9a428571be2dc5bc0505c13fb6bf936822b894ec87abf8a08a4e51742d"
 
 [[package]]
 name = "shell-words"
@@ -258,9 +223,9 @@ checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 
 [[package]]
 name = "syn"
-version = "2.0.118"
+version = "2.0.119"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1b9ae57f904213ebb649ce6895b8a66c66f0203b9319718f69a5612a065b1422"
+checksum = "872831b642d1a07999a962a351ed35b955ea2cfc8f3862091e2a240a84f17297"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -281,18 +246,17 @@ checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
 
 [[package]]
 name = "zrip"
-version = "0.1.1"
+version = "0.1.2"
 dependencies = [
- "magnus",
  "rb-sys",
- "zrip 0.8.0",
+ "zrip 0.8.5",
 ]
 
 [[package]]
 name = "zrip"
-version = "0.8.0"
+version = "0.8.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f45ef53f6849751ac6caa094deeb7f9dd4f0fa58838e24744ada867da4ab1bd3"
+checksum = "fa05c09787b3aaaaa57870dca9fd9f3b4934018cbb5dde1b112017e2e70ec491"
 dependencies = [
  "zrip-core",
  "zrip-decode",
@@ -301,15 +265,15 @@ dependencies = [
 
 [[package]]
 name = "zrip-core"
-version = "0.8.0"
+version = "0.9.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7a0c812248efd23053c750008d5bd9ae287b9ff3c9e3a403e5a258370dc397cc"
+checksum = "9335acd94c1f09f729178fc339f9d49790254c1e98ba076f88df3a3f534c4e7d"
 
 [[package]]
 name = "zrip-decode"
-version = "0.8.0"
+version = "0.8.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2f9e2b1bc7b08420138c4d4c0b96b6602c2880957c81eb13641c32d897c086c6"
+checksum = "1801cd8b5d374e2bc31cd8a231182dd47e621492fa0bf68ca7d3033e001cd06b"
 dependencies = [
  "fearless_simd",
  "zrip-core",
@@ -317,9 +281,9 @@ dependencies = [
 
 [[package]]
 name = "zrip-encode"
-version = "0.8.0"
+version = "0.8.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ba9ec8f4d4d266fc4f50713b0fdcf8feb554d319d2ae85086a271c9f68fb309f"
+checksum = "38e7e22b665b947f0240b44805713e87a15c34e86d0891cbe2856c575c5cda1d"
 dependencies = [
  "zrip-core",
 ]

data/README.md

@@ -1,13 +1,13 @@
-# zrip — Ractor-safe Zstandard for Ruby
+# zrip: Ractor-safe Zstandard for Ruby
 
 [![CI](https://github.com/paddor/zrip-rb/actions/workflows/ci.yml/badge.svg)](https://github.com/paddor/zrip-rb/actions/workflows/ci.yml)
 [![Gem Version](https://img.shields.io/gem/v/zrip?color=e9573f)](https://rubygems.org/gems/zrip)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
-[![Ruby](https://img.shields.io/badge/Ruby-%3E%3D%204.0-CC342D?logo=ruby&logoColor=white)](https://www.ruby-lang.org)
+[![Ruby](https://img.shields.io/badge/Ruby-%3E%3D%203.4-CC342D?logo=ruby&logoColor=white)](https://www.ruby-lang.org)
 
 Ruby bindings for [zrip](https://crates.io/crates/zrip), a pure-Rust Zstandard
-implementation. Built with [magnus](https://github.com/matsadler/magnus) and
-declared Ractor-safe so you can compress from any Ractor without a global lock.
+implementation. Built as an `rb-sys` native extension and declared Ractor-safe
+so you can compress from any Ractor without a global lock.
 
 ## Features
 
@@ -22,7 +22,7 @@ declared Ractor-safe so you can compress from any Ractor without a global lock.
 
 ## Install
 
-Requires Ruby >= 4.0 and a Rust toolchain (for building the native extension):
+Requires Ruby >= 3.4 and a Rust toolchain (for building the native extension):
 
 ```sh
 gem install zrip
@@ -66,8 +66,8 @@ strong = Zrip::FrameCodec.new(level: 19)    # higher = smaller output
 ```ruby
 codec = Zrip::FrameCodec.new
 
-# Limit output size to 1 MiB
-codec.decompress(compressed, max_output_size: 1_048_576)
+# Limit total output size to 1 MiB
+codec.decompress(compressed, max_output_size: 1024 * 1024)
 
 # Read frame content size from header (without decompressing)
 Zrip::FrameCodec.get_frame_content_size(compressed)  #=> 12000
@@ -96,6 +96,9 @@ codec = Zrip::FrameCodec.new(dict: dict)
 
 ### Ractor safety
 
+On Ruby VMs without Ractor support, the codecs still work normally; the
+Ractor-specific guarantees and examples do not apply.
+
 ```ruby
 codec = Zrip::FrameCodec.new
 
@@ -111,39 +114,9 @@ end
 ractors.each { |r| p r.value }  # => :ok, :ok, :ok, :ok
 ```
 
-## API
-
-| Class / Module | Method | Description |
-|---|---|---|
-| `Zrip::FrameCodec` | `.new(dict: nil, level: 1)` | Create a frame codec, optionally with a `Dictionary`, raw `String` dict, or compression level |
-| | `.get_frame_content_size(string)` | Read Frame_Content_Size from a Zstd frame header |
-| | `#compress(string)` | Compress to Zstd frame |
-| | `#decompress(string, max_output_size: nil)` | Decompress a Zstd frame, optionally bounded |
-| | `#has_dict?` | Whether a dictionary is loaded |
-| | `#id` | Dictionary ID (nil without dict) |
-| | `#size` | Dictionary size in bytes (0 without dict) |
-| | `#level` | Compression level |
-| `Zrip::BlockCodec` | `.new(dict: nil, level: 1)` | Create a block codec, optionally with a dict |
-| | `#compress(string)` | Compress to Zstd block |
-| | `#decompress(string, max_output_size: nil)` | Decompress a Zstd block, optionally bounded |
-| | `#has_dict?` | Whether a dictionary is loaded |
-| | `#size` | Dictionary size in bytes (0 without dict) |
-| | `#level` | Compression level |
-| `Zrip::Dictionary` | `.new(bytes:, id: nil)` | Immutable dictionary value object (`Data.define`) |
-| | `#bytes` | Frozen binary dict bytes |
-| | `#id` | 32-bit dictionary ID (auto-detected from ZDICT header or SHA-256) |
-| | `#size` | Dictionary size in bytes |
-| `Zrip::DictTrainer` | `.new(max_dict_size)` | Create a trainer |
-| | `#add_sample(string)` | Feed a training sample (skips < 4 bytes) |
-| | `#train` | Consume the trainer, return dict bytes |
-| | `#sample_count` | Number of accepted samples |
-| | `#total_bytes` | Total bytes of accepted samples |
-| | `#trained?` | Whether `#train` has been called |
-| | `#max_dict_size` | Configured max dict size |
-| `Zrip::DecompressError` | | Raised on decompression failure |
-| `Zrip::CompressError` | | Raised on compression failure |
-| `Zrip::MissingContentSizeError` | | Raised when Frame_Content_Size is absent (subclass of `DecompressError`) |
-| `Zrip::OutputSizeLimitError` | | Raised when declared content size exceeds limit (subclass of `DecompressError`) |
+## Documentation
+
+Reference: <https://rubydoc.info/gems/zrip>
 
 ## License
 

data/ext/zrip/Cargo.toml

@@ -1,15 +1,15 @@
 [package]
 name    = "zrip"
-version = "0.1.1"
+version = "0.1.2"
 edition = "2021"
+build   = "build.rs"
 
 [lib]
 name       = "zrip"
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-zstd   = { version = "0.8", package = "zrip", features = ["frame", "dict_builder"] }
-magnus = "0.8"
+zstd   = { version = "0.8.5", package = "zrip", features = ["frame", "dict_builder"] }
 rb-sys = "0.9"
 
 [build-dependencies]

data/ext/zrip/build.rs

@@ -0,0 +1,23 @@
+use std::process::Command;
+
+fn main() {
+    println!("cargo:rerun-if-env-changed=RUBY");
+    println!("cargo:rustc-check-cfg=cfg(ruby_engine, values(\"mri\", \"truffleruby\"))");
+
+    let ruby = std::env::var("RUBY").unwrap_or_else(|_| "ruby".to_string());
+    let output = Command::new(&ruby)
+        .arg("-rrbconfig")
+        .arg("-e")
+        .arg("print RbConfig::CONFIG.fetch('ruby_install_name')")
+        .output()
+        .unwrap_or_else(|err| panic!("failed to run {ruby}: {err}"));
+
+    if !output.status.success() {
+        panic!("failed to query Ruby engine with {ruby}");
+    }
+
+    match String::from_utf8_lossy(&output.stdout).trim() {
+        "truffleruby" => println!("cargo:rustc-cfg=ruby_engine=\"truffleruby\""),
+        _ => println!("cargo:rustc-cfg=ruby_engine=\"mri\""),
+    }
+}