iscc-lib 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cb56331f61e33a3793e9b323860a22174a611c71db426c34e80ff088e6876972
+  data.tar.gz: 7ca682d292eb7714d6ef28bfadc31089a3c62afc635e7cb86257af85bb259076
+SHA512:
+  metadata.gz: ee207ab6501c9a20937b2b04750014857a5417abb804f58a91eb7cf47624d0396d4a8c719d7d1c2a2db069f02d83a9e72eadf2e7f14375b39616f4504ff0f28f
+  data.tar.gz: 618ada4639532ac73002e739df6e5f56fa648c6f308b1f87c772356f6715bc3fe713e60538319bd022b01a78fe0b0c3f3618a4bc5c4a62e01b6ff6e49931f9be

data/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "iscc-rb"
+version.workspace = true
+edition.workspace = true
+rust-version.workspace = true
+publish = false               # Published via RubyGems, not crates.io
+
+[lib]
+name = "iscc_rb"
+crate-type = ["cdylib"]
+
+[dependencies]
+iscc-lib = { path = "../iscc-lib" }
+magnus = { workspace = true }

data/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 The Authors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,93 @@
+# iscc-lib
+
+[![CI](https://github.com/iscc/iscc-lib/actions/workflows/ci.yml/badge.svg)](https://github.com/iscc/iscc-lib/actions/workflows/ci.yml)
+[![Gem Version](https://img.shields.io/gem/v/iscc-lib.svg)](https://rubygems.org/gems/iscc-lib)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+High-performance Ruby bindings for [ISO 24138:2024](https://www.iso.org/standard/77899.html) —
+International Standard Content Code (ISCC). Built as a native Rust extension via
+[Magnus](https://github.com/matsadler/magnus) for speed, with an idiomatic Ruby API featuring
+keyword arguments and attribute-style result access.
+
+## What is ISCC
+
+The ISCC is a similarity-preserving fingerprint and identifier for digital media assets. ISCCs are
+generated algorithmically from digital content, just like cryptographic hashes. However, instead of
+using a single cryptographic hash function to identify data only, the ISCC uses various algorithms
+to create a composite identifier that exhibits similarity-preserving properties (soft hash).
+
+## Installation
+
+```bash
+gem install iscc-lib
+```
+
+Or add to your `Gemfile`:
+
+```ruby
+gem "iscc-lib"
+```
+
+Precompiled gems are available for common platforms. If no precompiled gem matches your platform,
+the gem builds from source (requires a Rust toolchain and `libclang-dev`).
+
+## Quick Start
+
+```ruby
+require "iscc_lib"
+
+# Generate a Meta-Code from content metadata
+result = IsccLib.gen_meta_code_v0("Hello World", description: "A greeting")
+puts result.iscc      # => "ISCC:..."
+puts result.name      # => "Hello World"
+puts result.metahash  # => "1e20..."
+
+# Streaming for large files
+hasher = IsccLib::DataHasher.new
+File.open("large_file.bin", "rb") do |f|
+  while (chunk = f.read(65_536))
+    hasher.update(chunk)
+  end
+end
+result = hasher.finalize
+puts result.iscc
+```
+
+## API Overview
+
+### Code Generators
+
+| Function               | Description                                  |
+| ---------------------- | -------------------------------------------- |
+| `gen_meta_code_v0`     | Generate a Meta-Code from metadata fields    |
+| `gen_text_code_v0`     | Generate a Text-Code from plain text         |
+| `gen_image_code_v0`    | Generate an Image-Code from pixel data       |
+| `gen_audio_code_v0`    | Generate an Audio-Code from Chromaprint data |
+| `gen_video_code_v0`    | Generate a Video-Code from frame signatures  |
+| `gen_mixed_code_v0`    | Generate a Mixed-Code from Content-Codes     |
+| `gen_data_code_v0`     | Generate a Data-Code from binary data        |
+| `gen_instance_code_v0` | Generate an Instance-Code from binary data   |
+| `gen_iscc_code_v0`     | Generate a composite ISCC-CODE               |
+| `gen_sum_code_v0`      | Generate an ISCC-SUM from a file path        |
+
+### Utilities
+
+- **Text processing:** `text_clean`, `text_remove_newlines`, `text_trim`, `text_collapse`
+- **Algorithm primitives:** `alg_simhash`, `alg_minhash_256`, `alg_cdc_chunks`, `sliding_window`
+- **Soft hashing:** `soft_hash_video_v0`
+- **Encoding:** `encode_base64`, `encode_component`
+- **Codec:** `iscc_decode`, `iscc_decompose`, `json_to_data_url`
+- **Streaming:** `DataHasher`, `InstanceHasher` for incremental processing
+- **Diagnostics:** `conformance_selftest`
+
+## Links
+
+- [Documentation](https://lib.iscc.codes)
+- [How-to Guide](https://lib.iscc.codes/howto/ruby/)
+- [Repository](https://github.com/iscc/iscc-lib)
+- [ISCC Specification (ISO 24138)](https://www.iso.org/standard/77899.html)
+- [ISCC Foundation](https://iscc.io)
+
+## License
+
+Apache-2.0

data/extconf.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+# Extension configuration for the iscc_lib native Ruby extension.
+# Uses rb_sys to bridge Cargo's cdylib build into Ruby's mkmf system.
+
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("iscc_lib/iscc_rb")

data/lib/iscc_lib/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Version constant for the iscc-lib gem (synced from root Cargo.toml).
+module IsccLib
+  VERSION = "0.2.0"
+end

data/lib/iscc_lib.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+# Ruby bindings for iscc-lib — ISO 24138:2024 (ISCC).
+#
+# This module provides the public API for generating ISCC codes from Ruby.
+# Result classes wrap the native Hash returns with attribute-style access.
+
+require_relative "iscc_lib/version"
+
+# Load native extension from version-specific subdirectory (precompiled gems)
+# or flat path (source-compiled).
+begin
+  RUBY_VERSION =~ /(\d+\.\d+)/
+  require_relative "iscc_lib/#{$1}/iscc_rb"
+rescue LoadError
+  require_relative "iscc_lib/iscc_rb"
+end
+
+module IsccLib
+  # Base result class providing both Hash-style and attribute-style access.
+  class Result < Hash
+    # Allow attribute-style access for hash keys (e.g., result.iscc).
+    def method_missing(name, *args)
+      key = name.to_s
+      return self[key] if key?(key)
+
+      super
+    end
+
+    # Support respond_to? for dynamic attribute access.
+    def respond_to_missing?(name, include_private = false)
+      key?(name.to_s) || super
+    end
+  end
+
+  # Result from gen_meta_code_v0.
+  class MetaCodeResult < Result; end
+
+  # Result from gen_text_code_v0.
+  class TextCodeResult < Result; end
+
+  # Result from gen_image_code_v0.
+  class ImageCodeResult < Result; end
+
+  # Result from gen_audio_code_v0.
+  class AudioCodeResult < Result; end
+
+  # Result from gen_video_code_v0.
+  class VideoCodeResult < Result; end
+
+  # Result from gen_mixed_code_v0.
+  class MixedCodeResult < Result; end
+
+  # Result from gen_data_code_v0.
+  class DataCodeResult < Result; end
+
+  # Result from gen_instance_code_v0.
+  class InstanceCodeResult < Result; end
+
+  # Result from gen_iscc_code_v0.
+  class IsccCodeResult < Result; end
+
+  # Result from gen_sum_code_v0.
+  class SumCodeResult < Result; end
+
+  # Generate a Meta-Code from name and optional metadata.
+  #
+  # @param name [String] content name (required, non-empty)
+  # @param description [String, nil] optional content description
+  # @param meta [String, nil] optional JSON metadata
+  # @param bits [Integer] bit length (default: 64)
+  # @return [MetaCodeResult] hash with iscc, name, metahash, and optionally description, meta
+  def self.gen_meta_code_v0(name, description: nil, meta: nil, bits: 64)
+    MetaCodeResult[_gen_meta_code_v0(name, description, meta, bits)]
+  end
+
+  # Generate a Text-Code from plain text content.
+  #
+  # @param text [String] plain text content
+  # @param bits [Integer] bit length (default: 64)
+  # @return [TextCodeResult] hash with iscc, characters
+  def self.gen_text_code_v0(text, bits: 64)
+    TextCodeResult[_gen_text_code_v0(text, bits)]
+  end
+
+  # Generate an Image-Code from pixel data.
+  #
+  # @param pixels [String] binary pixel data
+  # @param bits [Integer] bit length (default: 64)
+  # @return [ImageCodeResult] hash with iscc
+  def self.gen_image_code_v0(pixels, bits: 64)
+    ImageCodeResult[_gen_image_code_v0(pixels, bits)]
+  end
+
+  # Generate an Audio-Code from a Chromaprint feature vector.
+  #
+  # @param cv [Array<Integer>] Chromaprint fingerprint integers
+  # @param bits [Integer] bit length (default: 64)
+  # @return [AudioCodeResult] hash with iscc
+  def self.gen_audio_code_v0(cv, bits: 64)
+    AudioCodeResult[_gen_audio_code_v0(cv, bits)]
+  end
+
+  # Generate a Video-Code from frame signature vectors.
+  #
+  # @param frame_sigs [Array<Array<Integer>>] nested array of frame signatures
+  # @param bits [Integer] bit length (default: 64)
+  # @return [VideoCodeResult] hash with iscc
+  def self.gen_video_code_v0(frame_sigs, bits: 64)
+    VideoCodeResult[_gen_video_code_v0(frame_sigs, bits)]
+  end
+
+  # Generate a Mixed-Code from multiple ISCC content code strings.
+  #
+  # @param codes [Array<String>] ISCC unit strings
+  # @param bits [Integer] bit length (default: 64)
+  # @return [MixedCodeResult] hash with iscc, parts
+  def self.gen_mixed_code_v0(codes, bits: 64)
+    MixedCodeResult[_gen_mixed_code_v0(codes, bits)]
+  end
+
+  # Generate a Data-Code from binary data.
+  #
+  # @param data [String] binary data
+  # @param bits [Integer] bit length (default: 64)
+  # @return [DataCodeResult] hash with iscc
+  def self.gen_data_code_v0(data, bits: 64)
+    DataCodeResult[_gen_data_code_v0(data, bits)]
+  end
+
+  # Generate an Instance-Code from binary data.
+  #
+  # @param data [String] binary data
+  # @param bits [Integer] bit length (default: 64, accepted for API consistency)
+  # @return [InstanceCodeResult] hash with iscc, datahash, filesize
+  def self.gen_instance_code_v0(data, bits: 64)
+    InstanceCodeResult[_gen_instance_code_v0(data, bits)]
+  end
+
+  # Generate a composite ISCC-CODE from individual unit codes.
+  #
+  # @param codes [Array<String>] ISCC unit strings (Data-Code + Instance-Code, optional Content-Code)
+  # @param wide [Boolean] use 256-bit combination (default: false for 128-bit)
+  # @return [IsccCodeResult] hash with iscc
+  def self.gen_iscc_code_v0(codes, wide: false)
+    IsccCodeResult[_gen_iscc_code_v0(codes, wide)]
+  end
+
+  # Generate a composite ISCC-CODE from a file in a single pass.
+  #
+  # @param path [String] file path
+  # @param bits [Integer] bit length (default: 64)
+  # @param wide [Boolean] use 256-bit combination (default: false)
+  # @param add_units [Boolean] include individual unit codes (default: false)
+  # @return [SumCodeResult] hash with iscc, datahash, filesize, and optionally units
+  def self.gen_sum_code_v0(path, bits: 64, wide: false, add_units: false)
+    SumCodeResult[_gen_sum_code_v0(path, bits, wide, add_units)]
+  end
+
+  # Streaming Data-Code generator (reopens native class).
+  #
+  # Incrementally processes data with content-defined chunking and MinHash
+  # to produce results identical to gen_data_code_v0.
+  #
+  # @example
+  #   hasher = IsccLib::DataHasher.new
+  #   hasher.update(chunk1).update(chunk2)
+  #   result = hasher.finalize(bits: 64)
+  class DataHasher
+    # Push binary data into the hasher.
+    #
+    # @param data [String] binary data
+    # @return [self] for method chaining
+    def update(data)
+      _update(data)
+      self
+    end
+
+    # Consume the hasher and produce a Data-Code result.
+    #
+    # @param bits [Integer] bit length (default: 64)
+    # @return [DataCodeResult] hash with iscc
+    # @raise [RuntimeError] if called more than once
+    def finalize(bits: 64)
+      DataCodeResult[_finalize(bits)]
+    end
+  end
+
+  # Streaming Instance-Code generator (reopens native class).
+  #
+  # Incrementally hashes data with BLAKE3 to produce results identical
+  # to gen_instance_code_v0.
+  #
+  # @example
+  #   hasher = IsccLib::InstanceHasher.new
+  #   hasher.update(chunk1).update(chunk2)
+  #   result = hasher.finalize(bits: 64)
+  class InstanceHasher
+    # Push binary data into the hasher.
+    #
+    # @param data [String] binary data
+    # @return [self] for method chaining
+    def update(data)
+      _update(data)
+      self
+    end
+
+    # Consume the hasher and produce an Instance-Code result.
+    #
+    # @param bits [Integer] bit length (default: 64)
+    # @return [InstanceCodeResult] hash with iscc, datahash, filesize
+    # @raise [RuntimeError] if called more than once
+    def finalize(bits: 64)
+      InstanceCodeResult[_finalize(bits)]
+    end
+  end
+end

data/src/lib.rs

@@ -0,0 +1,521 @@
+//! Magnus bridge for iscc-lib Ruby bindings.
+//!
+//! Exposes a subset of Tier 1 ISCC functions as Ruby module functions
+//! under the `IsccLib` module. The pure Ruby wrapper in `lib/iscc_lib.rb`
+//! provides idiomatic result classes and keyword arguments.
+//!
+//! Symbols (32 of 32):
+//! - `gen_meta_code_v0`, `gen_text_code_v0`, `gen_image_code_v0`, `gen_audio_code_v0`
+//! - `gen_video_code_v0`, `gen_mixed_code_v0`, `gen_data_code_v0`
+//! - `gen_instance_code_v0`, `gen_iscc_code_v0`, `gen_sum_code_v0`
+//! - `text_clean`, `text_remove_newlines`, `text_trim`, `text_collapse`
+//! - `encode_base64`, `iscc_decompose`, `encode_component`, `iscc_decode`
+//! - `json_to_data_url`, `conformance_selftest`
+//! - `sliding_window`, `alg_simhash`, `alg_minhash_256`, `alg_cdc_chunks`,
+//!   `soft_hash_video_v0`
+//! - `DataHasher`, `InstanceHasher` (streaming classes)
+//! - Constants: META_TRIM_NAME, META_TRIM_DESCRIPTION, META_TRIM_META,
+//!   IO_READ_SIZE, TEXT_NGRAM_SIZE
+
+use magnus::{Error, RArray, RHash, RString, Ruby, TryConvert, function, method, prelude::*};
+use std::cell::RefCell;
+
+/// Map an `IsccError` to a Magnus `RuntimeError`.
+fn to_magnus_err(e: iscc_lib::IsccError) -> Error {
+    Error::new(magnus::exception::runtime_error(), e.to_string())
+}
+
+/// Generate a Meta-Code from name and optional metadata.
+///
+/// Returns a Ruby Hash with keys: `iscc`, `name`, `metahash`, and optionally
+/// `description` and `meta`.
+fn gen_meta_code_v0(
+    name: String,
+    description: Option<String>,
+    meta: Option<String>,
+    bits: u32,
+) -> Result<RHash, Error> {
+    let r = iscc_lib::gen_meta_code_v0(&name, description.as_deref(), meta.as_deref(), bits)
+        .map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let hash = ruby.hash_new();
+    hash.aset("iscc", r.iscc)?;
+    hash.aset("name", r.name)?;
+    hash.aset("metahash", r.metahash)?;
+    if let Some(desc) = r.description {
+        hash.aset("description", desc)?;
+    }
+    if let Some(meta) = r.meta {
+        hash.aset("meta", meta)?;
+    }
+    Ok(hash)
+}
+
+/// Generate a Text-Code from plain text content.
+///
+/// Returns a Ruby Hash with keys: `iscc`, `characters`.
+fn gen_text_code_v0(text: String, bits: u32) -> Result<RHash, Error> {
+    let r = iscc_lib::gen_text_code_v0(&text, bits).map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let hash = ruby.hash_new();
+    hash.aset("iscc", r.iscc)?;
+    hash.aset("characters", r.characters)?;
+    Ok(hash)
+}
+
+/// Generate an Image-Code from pixel data.
+///
+/// Accepts a binary Ruby String of raw pixel bytes.
+/// Returns a Ruby Hash with key: `iscc`.
+fn gen_image_code_v0(pixels: RString, bits: u32) -> Result<RHash, Error> {
+    // Safety: the slice is passed directly to a pure Rust function
+    // and not held across any Ruby API calls.
+    let bytes = unsafe { pixels.as_slice() };
+    let r = iscc_lib::gen_image_code_v0(bytes, bits).map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let hash = ruby.hash_new();
+    hash.aset("iscc", r.iscc)?;
+    Ok(hash)
+}
+
+/// Generate an Audio-Code from a Chromaprint feature vector.
+///
+/// Accepts a Ruby Array of integers (i32 Chromaprint fingerprints).
+/// Returns a Ruby Hash with key: `iscc`.
+fn gen_audio_code_v0(cv: Vec<i32>, bits: u32) -> Result<RHash, Error> {
+    let r = iscc_lib::gen_audio_code_v0(&cv, bits).map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let hash = ruby.hash_new();
+    hash.aset("iscc", r.iscc)?;
+    Ok(hash)
+}
+
+/// Generate a Video-Code from frame signature vectors.
+///
+/// Accepts a Ruby Array of Arrays of integers (nested `i32` frame signatures).
+/// Returns a Ruby Hash with key: `iscc`.
+fn gen_video_code_v0(frame_sigs: RArray, bits: u32) -> Result<RHash, Error> {
+    let frames: Vec<Vec<i32>> = frame_sigs
+        .into_iter()
+        .map(|frame| {
+            let arr: Vec<i32> = TryConvert::try_convert(frame)?;
+            Ok(arr)
+        })
+        .collect::<Result<Vec<_>, Error>>()?;
+    let r = iscc_lib::gen_video_code_v0(&frames, bits).map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let hash = ruby.hash_new();
+    hash.aset("iscc", r.iscc)?;
+    Ok(hash)
+}
+
+/// Generate a Mixed-Code from multiple ISCC content code strings.
+///
+/// Accepts a Ruby Array of ISCC unit strings.
+/// Returns a Ruby Hash with keys: `iscc`, `parts`.
+fn gen_mixed_code_v0(codes: Vec<String>, bits: u32) -> Result<RHash, Error> {
+    let refs: Vec<&str> = codes.iter().map(|s| s.as_str()).collect();
+    let r = iscc_lib::gen_mixed_code_v0(&refs, bits).map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let hash = ruby.hash_new();
+    hash.aset("iscc", r.iscc)?;
+    hash.aset("parts", r.parts)?;
+    Ok(hash)
+}
+
+/// Generate a Data-Code from binary data.
+///
+/// Accepts a binary Ruby String of raw bytes.
+/// Returns a Ruby Hash with key: `iscc`.
+fn gen_data_code_v0(data: RString, bits: u32) -> Result<RHash, Error> {
+    // Safety: the slice is passed directly to a pure Rust function
+    // and not held across any Ruby API calls.
+    let bytes = unsafe { data.as_slice() };
+    let r = iscc_lib::gen_data_code_v0(bytes, bits).map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let hash = ruby.hash_new();
+    hash.aset("iscc", r.iscc)?;
+    Ok(hash)
+}
+
+/// Generate an Instance-Code from binary data.
+///
+/// Accepts a binary Ruby String of raw bytes.
+/// Returns a Ruby Hash with keys: `iscc`, `datahash`, `filesize`.
+fn gen_instance_code_v0(data: RString, bits: u32) -> Result<RHash, Error> {
+    // Safety: the slice is passed directly to a pure Rust function
+    // and not held across any Ruby API calls.
+    let bytes = unsafe { data.as_slice() };
+    let r = iscc_lib::gen_instance_code_v0(bytes, bits).map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let hash = ruby.hash_new();
+    hash.aset("iscc", r.iscc)?;
+    hash.aset("datahash", r.datahash)?;
+    hash.aset("filesize", r.filesize)?;
+    Ok(hash)
+}
+
+/// Generate a composite ISCC-CODE from individual unit codes.
+///
+/// Accepts a Ruby Array of ISCC unit strings and a wide flag.
+/// Returns a Ruby Hash with key: `iscc`.
+fn gen_iscc_code_v0(codes: Vec<String>, wide: bool) -> Result<RHash, Error> {
+    let refs: Vec<&str> = codes.iter().map(|s| s.as_str()).collect();
+    let r = iscc_lib::gen_iscc_code_v0(&refs, wide).map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let hash = ruby.hash_new();
+    hash.aset("iscc", r.iscc)?;
+    Ok(hash)
+}
+
+/// Generate a composite ISCC-CODE from a file in a single pass.
+///
+/// Accepts a file path string, bit length, wide flag, and add_units flag.
+/// Returns a Ruby Hash with keys: `iscc`, `datahash`, `filesize`, and
+/// optionally `units` when `add_units` is true.
+fn gen_sum_code_v0(path: String, bits: u32, wide: bool, add_units: bool) -> Result<RHash, Error> {
+    let r = iscc_lib::gen_sum_code_v0(std::path::Path::new(&path), bits, wide, add_units)
+        .map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let hash = ruby.hash_new();
+    hash.aset("iscc", r.iscc)?;
+    hash.aset("datahash", r.datahash)?;
+    hash.aset("filesize", r.filesize)?;
+    if let Some(units) = r.units {
+        hash.aset("units", units)?;
+    }
+    Ok(hash)
+}
+
+/// Clean and normalize text for display.
+///
+/// Applies NFKC normalization, removes control characters (except newlines),
+/// normalizes `\r\n` to `\n`, collapses consecutive empty lines, and strips
+/// leading/trailing whitespace.
+fn text_clean(text: String) -> String {
+    iscc_lib::text_clean(&text)
+}
+
+/// Remove newlines and collapse whitespace to single spaces.
+///
+/// Converts multi-line text into a single normalized line.
+fn text_remove_newlines(text: String) -> String {
+    iscc_lib::text_remove_newlines(&text)
+}
+
+/// Trim text so its UTF-8 encoded size does not exceed `nbytes`.
+///
+/// Multi-byte characters that would be split are dropped entirely.
+/// Leading/trailing whitespace is stripped from the result.
+fn text_trim(text: String, nbytes: usize) -> String {
+    iscc_lib::text_trim(&text, nbytes)
+}
+
+/// Normalize and simplify text for similarity hashing.
+///
+/// Applies NFD normalization, lowercasing, removes whitespace and certain
+/// Unicode categories, then recombines with NFKC normalization.
+fn text_collapse(text: String) -> String {
+    iscc_lib::text_collapse(&text)
+}
+
+/// Encode bytes as base64url (RFC 4648 §5, no padding).
+///
+/// Accepts a Ruby String (binary data) and returns a URL-safe base64 string.
+fn encode_base64(data: RString) -> String {
+    // Safety: the slice is passed directly to a pure Rust function
+    // and not held across any Ruby API calls.
+    let bytes = unsafe { data.as_slice() };
+    iscc_lib::encode_base64(bytes)
+}
+
+/// Decompose a composite ISCC-CODE into individual ISCC-UNITs.
+///
+/// Returns a Ruby Array of base32-encoded ISCC-UNIT strings (without prefix).
+fn iscc_decompose(iscc_code: String) -> Result<Vec<String>, Error> {
+    iscc_lib::iscc_decompose(&iscc_code).map_err(to_magnus_err)
+}
+
+/// Encode raw digest components into a base32 ISCC unit string.
+///
+/// Takes integer type identifiers (mtype, stype, version), a bit_length,
+/// and a binary digest String. Returns a base32-encoded ISCC unit string.
+fn encode_component(
+    mtype: u8,
+    stype: u8,
+    version: u8,
+    bit_length: u32,
+    digest: RString,
+) -> Result<String, Error> {
+    // Safety: we copy the bytes immediately and do not hold the slice
+    // across any Ruby API calls.
+    let bytes = unsafe { digest.as_slice() }.to_vec();
+    iscc_lib::encode_component(mtype, stype, version, bit_length, &bytes).map_err(to_magnus_err)
+}
+
+/// Decode an ISCC unit string into header components and raw digest.
+///
+/// Returns a 5-element Ruby Array: `[maintype, subtype, version, length_index, digest_bytes]`
+/// where digest_bytes is a binary Ruby String.
+fn iscc_decode(iscc: String) -> Result<RArray, Error> {
+    let (mt, st, vs, li, digest) = iscc_lib::iscc_decode(&iscc).map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let arr = ruby.ary_new_capa(5);
+    arr.push(mt)?;
+    arr.push(st)?;
+    arr.push(vs)?;
+    arr.push(li)?;
+    arr.push(RString::from_slice(&digest))?;
+    Ok(arr)
+}
+
+/// Convert a JSON string into a `data:` URL with JCS canonicalization.
+///
+/// Uses `application/ld+json` media type when the JSON contains an `@context`
+/// key, otherwise `application/json`.
+fn json_to_data_url(json: String) -> Result<String, Error> {
+    iscc_lib::json_to_data_url(&json).map_err(to_magnus_err)
+}
+
+/// Run conformance self-test against vendored test vectors.
+///
+/// Returns `true` if all tests pass, `false` if any fail.
+fn conformance_selftest() -> bool {
+    iscc_lib::conformance_selftest()
+}
+
+/// Generate sliding window n-grams from a string.
+///
+/// Returns overlapping substrings of `width` Unicode characters.
+/// Raises `RuntimeError` if `width < 2`.
+fn sliding_window(seq: String, width: usize) -> Result<Vec<String>, Error> {
+    iscc_lib::sliding_window(&seq, width).map_err(to_magnus_err)
+}
+
+/// Compute a SimHash from a sequence of equal-length hash digests.
+///
+/// Accepts a Ruby Array of binary Strings, returns a binary String.
+/// Raises `RuntimeError` on mismatched digest lengths.
+fn alg_simhash(hash_digests: RArray) -> Result<RString, Error> {
+    let digests: Vec<Vec<u8>> = hash_digests
+        .into_iter()
+        .map(|val| {
+            let s: RString = TryConvert::try_convert(val)?;
+            // Safety: we copy the bytes immediately before any Ruby API calls.
+            let bytes = unsafe { s.as_slice() }.to_vec();
+            Ok(bytes)
+        })
+        .collect::<Result<Vec<_>, Error>>()?;
+    let result = iscc_lib::alg_simhash(&digests).map_err(to_magnus_err)?;
+    Ok(RString::from_slice(&result))
+}
+
+/// Compute a 256-bit MinHash digest from 32-bit integer features.
+///
+/// Returns a 32-byte binary String.
+fn alg_minhash_256(features: Vec<u32>) -> RString {
+    let result = iscc_lib::alg_minhash_256(&features);
+    RString::from_slice(&result)
+}
+
+/// Split data into content-defined chunks using gear rolling hash.
+///
+/// Accepts a binary Ruby String, a `utf32` flag, and an `avg_chunk_size`.
+/// Returns a Ruby Array of binary Strings (one per chunk).
+fn alg_cdc_chunks(data: RString, utf32: bool, avg_chunk_size: u32) -> Result<RArray, Error> {
+    // Safety: the slice is passed directly to a pure Rust function
+    // and not held across any Ruby API calls that could trigger GC.
+    let bytes = unsafe { data.as_slice() };
+    let chunks = iscc_lib::alg_cdc_chunks(bytes, utf32, avg_chunk_size).map_err(to_magnus_err)?;
+    let ruby = Ruby::get().expect("called from Ruby");
+    let arr = ruby.ary_new_capa(chunks.len());
+    for chunk in chunks {
+        arr.push(RString::from_slice(chunk))?;
+    }
+    Ok(arr)
+}
+
+/// Compute a similarity-preserving hash from video frame signatures.
+///
+/// Accepts a Ruby Array of Arrays of integers (nested `i32` frame signatures)
+/// and a bit length. Returns a binary String of length `bits / 8`.
+fn soft_hash_video_v0(frame_sigs: RArray, bits: u32) -> Result<RString, Error> {
+    let frames: Vec<Vec<i32>> = frame_sigs
+        .into_iter()
+        .map(|frame| {
+            let arr: Vec<i32> = TryConvert::try_convert(frame)?;
+            Ok(arr)
+        })
+        .collect::<Result<Vec<_>, Error>>()?;
+    let result = iscc_lib::soft_hash_video_v0(&frames, bits).map_err(to_magnus_err)?;
+    Ok(RString::from_slice(&result))
+}
+
+/// Streaming Data-Code generator for Ruby.
+///
+/// Wraps `iscc_lib::DataHasher` with `RefCell<Option<...>>` for one-shot
+/// finalize semantics (Magnus instance methods receive `&self`, not `&mut self`).
+#[magnus::wrap(class = "IsccLib::DataHasher")]
+struct RbDataHasher {
+    inner: RefCell<Option<iscc_lib::DataHasher>>,
+}
+
+impl RbDataHasher {
+    /// Create a new `RbDataHasher`.
+    fn rb_new() -> Self {
+        Self {
+            inner: RefCell::new(Some(iscc_lib::DataHasher::new())),
+        }
+    }
+
+    /// Push binary data into the hasher.
+    ///
+    /// Raises `RuntimeError` if called after `finalize`.
+    fn update(&self, data: RString) -> Result<(), Error> {
+        let mut inner = self.inner.borrow_mut();
+        let hasher = inner.as_mut().ok_or_else(|| {
+            Error::new(
+                magnus::exception::runtime_error(),
+                "DataHasher already finalized",
+            )
+        })?;
+        // Safety: the slice is passed directly to a pure Rust function
+        // and not held across any Ruby API calls.
+        let bytes = unsafe { data.as_slice() };
+        hasher.update(bytes);
+        Ok(())
+    }
+
+    /// Consume the hasher and produce a Data-Code result hash.
+    ///
+    /// Returns an `RHash` with key `"iscc"`. Raises `RuntimeError` if
+    /// called more than once.
+    fn finalize(&self, bits: u32) -> Result<RHash, Error> {
+        let hasher = self.inner.borrow_mut().take().ok_or_else(|| {
+            Error::new(
+                magnus::exception::runtime_error(),
+                "DataHasher already finalized",
+            )
+        })?;
+        let r = hasher.finalize(bits).map_err(to_magnus_err)?;
+        let ruby = Ruby::get().expect("called from Ruby");
+        let hash = ruby.hash_new();
+        hash.aset("iscc", r.iscc)?;
+        Ok(hash)
+    }
+}
+
+/// Streaming Instance-Code generator for Ruby.
+///
+/// Wraps `iscc_lib::InstanceHasher` with `RefCell<Option<...>>` for one-shot
+/// finalize semantics.
+#[magnus::wrap(class = "IsccLib::InstanceHasher")]
+struct RbInstanceHasher {
+    inner: RefCell<Option<iscc_lib::InstanceHasher>>,
+}
+
+impl RbInstanceHasher {
+    /// Create a new `RbInstanceHasher`.
+    fn rb_new() -> Self {
+        Self {
+            inner: RefCell::new(Some(iscc_lib::InstanceHasher::new())),
+        }
+    }
+
+    /// Push binary data into the hasher.
+    ///
+    /// Raises `RuntimeError` if called after `finalize`.
+    fn update(&self, data: RString) -> Result<(), Error> {
+        let mut inner = self.inner.borrow_mut();
+        let hasher = inner.as_mut().ok_or_else(|| {
+            Error::new(
+                magnus::exception::runtime_error(),
+                "InstanceHasher already finalized",
+            )
+        })?;
+        // Safety: the slice is passed directly to a pure Rust function
+        // and not held across any Ruby API calls.
+        let bytes = unsafe { data.as_slice() };
+        hasher.update(bytes);
+        Ok(())
+    }
+
+    /// Consume the hasher and produce an Instance-Code result hash.
+    ///
+    /// Returns an `RHash` with keys `"iscc"`, `"datahash"`, `"filesize"`.
+    /// Raises `RuntimeError` if called more than once.
+    fn finalize(&self, bits: u32) -> Result<RHash, Error> {
+        let hasher = self.inner.borrow_mut().take().ok_or_else(|| {
+            Error::new(
+                magnus::exception::runtime_error(),
+                "InstanceHasher already finalized",
+            )
+        })?;
+        let r = hasher.finalize(bits).map_err(to_magnus_err)?;
+        let ruby = Ruby::get().expect("called from Ruby");
+        let hash = ruby.hash_new();
+        hash.aset("iscc", r.iscc)?;
+        hash.aset("datahash", r.datahash)?;
+        hash.aset("filesize", r.filesize)?;
+        Ok(hash)
+    }
+}
+
+/// Initialize the IsccLib Ruby module with all bridge functions and constants.
+#[magnus::init]
+fn init(ruby: &Ruby) -> Result<(), Error> {
+    let module = ruby.define_module("IsccLib")?;
+
+    // Gen functions (prefixed with _ for Ruby wrapper layer)
+    module.define_module_function("_gen_meta_code_v0", function!(gen_meta_code_v0, 4))?;
+    module.define_module_function("_gen_text_code_v0", function!(gen_text_code_v0, 2))?;
+    module.define_module_function("_gen_image_code_v0", function!(gen_image_code_v0, 2))?;
+    module.define_module_function("_gen_audio_code_v0", function!(gen_audio_code_v0, 2))?;
+    module.define_module_function("_gen_video_code_v0", function!(gen_video_code_v0, 2))?;
+    module.define_module_function("_gen_mixed_code_v0", function!(gen_mixed_code_v0, 2))?;
+    module.define_module_function("_gen_data_code_v0", function!(gen_data_code_v0, 2))?;
+    module.define_module_function("_gen_instance_code_v0", function!(gen_instance_code_v0, 2))?;
+    module.define_module_function("_gen_iscc_code_v0", function!(gen_iscc_code_v0, 2))?;
+    module.define_module_function("_gen_sum_code_v0", function!(gen_sum_code_v0, 4))?;
+
+    // Text utility functions
+    module.define_module_function("text_clean", function!(text_clean, 1))?;
+    module.define_module_function("text_remove_newlines", function!(text_remove_newlines, 1))?;
+    module.define_module_function("text_trim", function!(text_trim, 2))?;
+    module.define_module_function("text_collapse", function!(text_collapse, 1))?;
+
+    // Codec and encoding functions
+    module.define_module_function("encode_base64", function!(encode_base64, 1))?;
+    module.define_module_function("iscc_decompose", function!(iscc_decompose, 1))?;
+    module.define_module_function("encode_component", function!(encode_component, 5))?;
+    module.define_module_function("iscc_decode", function!(iscc_decode, 1))?;
+    module.define_module_function("json_to_data_url", function!(json_to_data_url, 1))?;
+    module.define_module_function("conformance_selftest", function!(conformance_selftest, 0))?;
+
+    // Algorithm primitives
+    module.define_module_function("sliding_window", function!(sliding_window, 2))?;
+    module.define_module_function("alg_simhash", function!(alg_simhash, 1))?;
+    module.define_module_function("alg_minhash_256", function!(alg_minhash_256, 1))?;
+    module.define_module_function("alg_cdc_chunks", function!(alg_cdc_chunks, 3))?;
+    module.define_module_function("soft_hash_video_v0", function!(soft_hash_video_v0, 2))?;
+
+    // Streaming hasher classes (Ruby wrapper reopens to add defaults + result wrapping)
+    let data_hasher = module.define_class("DataHasher", ruby.class_object())?;
+    data_hasher.define_singleton_method("new", function!(RbDataHasher::rb_new, 0))?;
+    data_hasher.define_method("_update", method!(RbDataHasher::update, 1))?;
+    data_hasher.define_method("_finalize", method!(RbDataHasher::finalize, 1))?;
+
+    let instance_hasher = module.define_class("InstanceHasher", ruby.class_object())?;
+    instance_hasher.define_singleton_method("new", function!(RbInstanceHasher::rb_new, 0))?;
+    instance_hasher.define_method("_update", method!(RbInstanceHasher::update, 1))?;
+    instance_hasher.define_method("_finalize", method!(RbInstanceHasher::finalize, 1))?;
+
+    // Constants
+    module.const_set("META_TRIM_NAME", iscc_lib::META_TRIM_NAME)?;
+    module.const_set("META_TRIM_DESCRIPTION", iscc_lib::META_TRIM_DESCRIPTION)?;
+    module.const_set("META_TRIM_META", iscc_lib::META_TRIM_META)?;
+    module.const_set("IO_READ_SIZE", iscc_lib::IO_READ_SIZE)?;
+    module.const_set("TEXT_NGRAM_SIZE", iscc_lib::TEXT_NGRAM_SIZE)?;
+
+    Ok(())
+}

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: iscc-lib
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Titusz Pan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-05 00:00:00.000000000 Z
+dependencies: []
+description: High-performance Ruby bindings for ISO 24138:2024 (ISCC). Native Rust
+  extension via Magnus for content identification and matching.
+email:
+- tp@py7.de
+executables: []
+extensions:
+- extconf.rb
+extra_rdoc_files: []
+files:
+- Cargo.toml
+- LICENSE
+- README.md
+- extconf.rb
+- lib/iscc_lib.rb
+- lib/iscc_lib/version.rb
+- src/lib.rs
+homepage: https://github.com/iscc/iscc-lib
+licenses:
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/iscc/iscc-lib
+  source_code_uri: https://github.com/iscc/iscc-lib
+  documentation_uri: https://lib.iscc.codes
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: ISCC - International Standard Content Code (ISO 24138)
+test_files: []