zrip 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a2a6ebe092e7300362703f683d2716ffc66750bd51e4b4f9cd62d1e6aef1a5c
-  data.tar.gz: ea416eb330e63ba0f228bc2f5cf43f217d03f5e87cf57df0c6c0ae5c4e9c4e11
+  metadata.gz: 50caa1679bd74290e01032b2564ab2ac083633f00ad7070f2e3e597572ffe22b
+  data.tar.gz: d89a94b7221aba11a0084f8ffeab771428f682ddf19908a647c2bce862b43ffe
 SHA512:
-  metadata.gz: 5b5a2ee2834a146ccd72b7c08bbf20fbe60409377055bf4be840338baa3101f21fd3fc800e5bf2faee5fc211600ea5d853088d9f78702e59876acd0fcc18cf27
-  data.tar.gz: 25ecf73ec1e2d9874672ef06f4fc55e5e9a09eb522b1c3c55c4ee87032d4572330725c555fd54e4314f4e3454f78daf076ebac43ddeb03c44014d9d79d7e1d57
+  metadata.gz: 74bc8d13edae353144da41a66e80d41440157dc11c9555726c2c01659d88a02c8ffd0a7410b0157fb011a45677c54448a808ed463a1f9b1d99bd9a2769e42926
+  data.tar.gz: 91c282a2f5275e2e0cd72a9a2cf089a0582e47d256acce3c9bf67be6f494ab89a046bfece175d23f9543e7162b90b8bf66cc0dd97e5ebd5c9a695c3462e23d01

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ## [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.

data/Cargo.lock

@@ -110,29 +110,6 @@ 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.3"
@@ -197,12 +174,6 @@ 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.13.1"
@@ -238,12 +209,6 @@ version = "2.1.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "6b1e7f9a428571be2dc5bc0505c13fb6bf936822b894ec87abf8a08a4e51742d"
 
-[[package]]
-name = "seq-macro"
-version = "0.3.6"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1bc711410fbe7399f390ca1c3b60ad0f53f80e95c5eb935e52268a0e2cd49acc"
-
 [[package]]
 name = "shell-words"
 version = "1.1.1"
@@ -283,16 +248,15 @@ checksum = "f0805222e57f7521d6a62e36fa9163bc891acd422f971defe97d64e70d0a4fe5"
 name = "zrip"
 version = "0.1.2"
 dependencies = [
- "magnus",
  "rb-sys",
- "zrip 0.8.4",
+ "zrip 0.8.5",
 ]
 
 [[package]]
 name = "zrip"
-version = "0.8.4"
+version = "0.8.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1d6514da35b51d81bfc515782396980ac909fe46925fd19701b36329ddec46e8"
+checksum = "fa05c09787b3aaaaa57870dca9fd9f3b4934018cbb5dde1b112017e2e70ec491"
 dependencies = [
  "zrip-core",
  "zrip-decode",
@@ -307,9 +271,9 @@ checksum = "9335acd94c1f09f729178fc339f9d49790254c1e98ba076f88df3a3f534c4e7d"
 
 [[package]]
 name = "zrip-decode"
-version = "0.8.4"
+version = "0.8.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "16c26a2ea54a97d013b6f2a430b659fb77e0d5feb0aa3f80cb8c141d6827beba"
+checksum = "1801cd8b5d374e2bc31cd8a231182dd47e621492fa0bf68ca7d3033e001cd06b"
 dependencies = [
  "fearless_simd",
  "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

@@ -2,14 +2,14 @@
 name    = "zrip"
 version = "0.1.2"
 edition = "2021"
+build   = "build.rs"
 
 [lib]
 name       = "zrip"
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-zstd   = { version = "0.8.4", 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\""),
+    }
+}