lz4rip 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57c8a45c7f389dd4f6b324e147fcbf7cbfec93ca2746226120ea3290741ba761
-  data.tar.gz: b651348f2fce6405b8dabdb7208359eebdd28565a44bf9948a1ca4dcc1317e62
+  metadata.gz: 2f66c12c967a06a207c9e8e742fac306280863bf655bd7b4318a2265d08c1cdf
+  data.tar.gz: be95ea7eb336509e7077737f0d4703dc500931f1608fdc2f52dc3b170904b16d
 SHA512:
-  metadata.gz: 170650658b63413bd2b03659b168a9f77b5e434db3a8cbca52a7155282e5b7f7b0e16123e6ccbcb4aa48e15cc13d17993f902477a501cb80100b3f3375b14add
-  data.tar.gz: f8b9b5c1fa3f9fdc043af195137999f8d301ae2b4b984a4cc780f190dbc49dad21256fbf5a056804b86f5fea56c0c3fc7e97602ae384765bcb35afd88bb91f28
+  metadata.gz: 2fc02b8f797989ca99f23e97658dab9442c4fbb70ab03ff3436a73b5026b78d20c1bbf240e4febba0baed905863b225655f03c627d6db4ddee128224b419c82c
+  data.tar.gz: 92b2aa66f6282317c5b805f77cf47715288c8debc013520e5dffc78fb7d9c102f62f330906042b062b93aa2104ca21c5b1b0830edd87852b585f6451f4146efd

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 `lz4rip` crate dependency to 0.11.3.
+- Replace Magnus with direct `rb-sys` bindings, add TruffleRuby build support,
+  and lower the Ruby requirement to 3.4.
+- Add `max_decompressed_size:` to `Lz4rip::FrameCodec#decompress`, with the
+  cap enforced across concatenated frame output.
+- Add RubyDoc metadata and move API reference details from `README.md` into
+  YARD comments.
+
 ## [0.1.2] - 2026-08-05
 
 - Update `lz4rip` crate dependency from 0.11.1 to 0.11.2.

data/Cargo.lock

@@ -108,16 +108,15 @@ dependencies = [
 name = "lz4rip"
 version = "0.1.2"
 dependencies = [
- "lz4rip 0.11.2",
- "magnus",
+ "lz4rip 0.11.3",
  "rb-sys",
 ]
 
 [[package]]
 name = "lz4rip"
-version = "0.11.2"
+version = "0.11.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2cb69a12f600139f42d2c63d929b60733582f8bb706da4d2cd951e5beb6c649c"
+checksum = "55bde261679fd1d14bcae126094d7afb98c63c1a5018d0718741b658b686e950"
 dependencies = [
  "lz4rip-core",
  "lz4rip-decode",
@@ -149,29 +148,6 @@ dependencies = [
  "lz4rip-core",
 ]
 
-[[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"
@@ -236,12 +212,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"
@@ -277,12 +247,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"

data/README.md

@@ -1,13 +1,13 @@
-# lz4rip — Ractor-safe LZ4 for Ruby
+# lz4rip: Ractor-safe LZ4 for Ruby
 
 [![CI](https://github.com/paddor/lz4rip-rb/actions/workflows/ci.yml/badge.svg)](https://github.com/paddor/lz4rip-rb/actions/workflows/ci.yml)
 [![Gem Version](https://img.shields.io/gem/v/lz4rip?color=e9573f)](https://rubygems.org/gems/lz4rip)
 [![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 [lz4rip](https://crates.io/crates/lz4rip), a pure-Rust LZ4
-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
 
@@ -20,7 +20,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 lz4rip
@@ -42,6 +42,7 @@ require "lz4rip"
 codec = Lz4rip::FrameCodec.new
 compressed = codec.compress("hello world " * 1000)
 original   = codec.decompress(compressed)
+bounded    = codec.decompress(compressed, max_decompressed_size: 12_000)
 ```
 
 ### Block codec (raw LZ4 blocks)
@@ -78,6 +79,9 @@ codec = Lz4rip::BlockCodec.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 = Lz4rip::FrameCodec.new
 
@@ -93,35 +97,9 @@ end
 ractors.each { |r| p r.value }  # => :ok, :ok, :ok, :ok
 ```
 
-## API
-
-| Class / Module | Method | Description |
-|---|---|---|
-| `Lz4rip::FrameCodec` | `.new(dict: nil)` | Create a frame codec, optionally with a `Dictionary` or raw `String` dict |
-| | `#compress(string)` | Compress to LZ4 frame |
-| | `#decompress(string)` | Decompress an LZ4 frame |
-| | `#has_dict?` | Whether a dictionary is loaded |
-| | `#id` | Dictionary ID (nil without dict) |
-| | `#size` | Dictionary size in bytes (0 without dict) |
-| `Lz4rip::BlockCodec` | `.new(dict: nil)` | Create a block codec, optionally with a dict `String` |
-| | `#compress(string)` | Compress to raw LZ4 block |
-| | `#decompress(string, decompressed_size:)` | Decompress a raw LZ4 block |
-| | `#has_dict?` | Whether a dictionary is loaded |
-| | `#size` | Internal state size in bytes |
-| `Lz4rip::Dictionary` | `.new(bytes:, id: auto)` | Immutable dictionary value object |
-| | `#bytes` | Frozen binary dict bytes |
-| | `#id` | 32-bit dictionary ID |
-| | `#size` | Dictionary size in bytes |
-| `Lz4rip::DictTrainer` | `.new(max_dict_size)` | Create a trainer (capped at 65535) |
-| | `#add_sample(string)` | Feed a training sample |
-| | `#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 |
-| `Lz4rip` | `.compress_bound(size)` | Max compressed output size for a given input size |
-| | `.block_stream_size` | Internal compressor heap size |
-| `Lz4rip::DecompressError` | | Raised on decompression failure (subclass of `StandardError`) |
+## Documentation
+
+Reference: <https://rubydoc.info/gems/lz4rip>
 
 ## License
 

data/ext/lz4rip/Cargo.toml

@@ -2,14 +2,14 @@
 name    = "lz4rip"
 version = "0.1.2"
 edition = "2021"
+build   = "build.rs"
 
 [lib]
 name       = "lz4rip"
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-lz4    = { version = "0.11.2", package = "lz4rip" }
-magnus = "0.8"
+lz4    = { version = "0.11.3", package = "lz4rip" }
 rb-sys = "0.9"
 
 [build-dependencies]

data/ext/lz4rip/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\""),
+    }
+}