lz4rip 0.1.2 → 0.2.1

data/lib/lz4rip/dict_trainer.rb

@@ -1,6 +1,38 @@
 # frozen_string_literal: true
 
 module Lz4rip
+  # COVER-based LZ4 dictionary trainer.
+  #
+  # @!method self.new(max_dict_size)
+  #   Create a dictionary trainer.
+  #   @param max_dict_size [Integer] maximum dictionary size in bytes
+  #   @return [DictTrainer]
+  #
+  # @!method self._native_new(max_dict_size)
+  #   Native constructor used by `.new`.
+  #   @param max_dict_size [Integer] maximum dictionary size in bytes
+  #   @return [DictTrainer]
+  #
+  # @!method add_sample(bytes)
+  #   Add a training sample.
+  #   @param bytes [String] sample bytes
+  #   @return [nil]
+  #
+  # @!method train
+  #   Train and consume the trainer.
+  #   @return [String] dictionary bytes
+  #
+  # @!method sample_count
+  #   @return [Integer] accepted sample count
+  #
+  # @!method total_bytes
+  #   @return [Integer] total bytes from accepted samples
+  #
+  # @!method trained?
+  #   @return [Boolean]
+  #
+  # @!method max_dict_size
+  #   @return [Integer] configured maximum dictionary size
   class DictTrainer
     def self.new(max_dict_size)
       _native_new(max_dict_size)

data/lib/lz4rip/dictionary.rb

@@ -3,12 +3,22 @@
 require "digest"
 
 module Lz4rip
+  # Immutable LZ4 dictionary value.
+  #
+  # @!attribute [r] bytes
+  #   @return [String] frozen binary dictionary bytes
+  #
+  # @!attribute [r] id
+  #   @return [Integer] dictionary ID
   Dictionary = Data.define(:bytes, :id) do
+    # @param bytes [String] dictionary bytes
+    # @param id [Integer] optional dictionary ID
     def initialize(bytes:, id: Digest::SHA256.digest(bytes).byteslice(0, 4).unpack1("V"))
       super(bytes: bytes.b.freeze, id: id)
     end
 
 
+    # @return [Integer] dictionary size in bytes
     def size
       bytes.bytesize
     end

data/lib/lz4rip/frame_codec.rb

@@ -3,6 +3,48 @@
 require_relative "dictionary"
 
 module Lz4rip
+  # LZ4 frame-format codec.
+  #
+  # `FrameCodec` is Ractor-shareable.
+  #
+  # @!method self.new(dict: nil)
+  #   Create a frame codec.
+  #   @param dict [Dictionary, String, nil] optional LZ4 dictionary
+  #   @return [FrameCodec]
+  #
+  # @!method self._native_new(dict, id)
+  #   Native constructor used by `.new`.
+  #   @param dict [String, nil] dictionary bytes
+  #   @param id [Integer] dictionary ID, or `0` without a dictionary
+  #   @return [FrameCodec]
+  #
+  # @!method compress(bytes)
+  #   Compress bytes to an LZ4 frame.
+  #   @param bytes [String] uncompressed bytes
+  #   @return [String]
+  #
+  # @!method decompress(bytes, max_decompressed_size: nil)
+  #   Decompress an LZ4 frame.
+  #   @param bytes [String] compressed LZ4 frame
+  #   @param max_decompressed_size [Integer, nil] optional output byte limit
+  #   @return [String]
+  #   @raise [DecompressError]
+  #
+  # @!method _decompress(bytes, max_decompressed_size)
+  #   Native decompression entry used by #decompress.
+  #   @param bytes [String] compressed LZ4 frame
+  #   @param max_decompressed_size [Integer, nil] optional output byte limit
+  #   @return [String]
+  #   @raise [DecompressError]
+  #
+  # @!method has_dict?
+  #   @return [Boolean]
+  #
+  # @!method id
+  #   @return [Integer, nil] dictionary ID
+  #
+  # @!method size
+  #   @return [Integer] dictionary size in bytes
   class FrameCodec
     def self.new(dict: nil)
       case dict
@@ -16,5 +58,9 @@ module Lz4rip
         raise TypeError, "expected Lz4rip::Dictionary, String, or nil; got #{dict.class}"
       end
     end
+
+    def decompress(bytes, max_decompressed_size: nil)
+      _decompress(bytes, max_decompressed_size)
+    end
   end
 end

data/lib/lz4rip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lz4rip
-  VERSION = "0.1.2"
+  VERSION = "0.2.1"
 end

data/lib/lz4rip.rb

@@ -6,3 +6,20 @@ require_relative "lz4rip/dictionary"
 require_relative "lz4rip/block_codec"
 require_relative "lz4rip/frame_codec"
 require_relative "lz4rip/dict_trainer"
+
+# Ractor-safe LZ4 compression for Ruby.
+#
+# @!method self.compress_bound(size)
+#   Return the maximum compressed output size for input bytes.
+#   @param size [Integer] input size in bytes
+#   @return [Integer]
+#
+# @!method self.block_stream_size
+#   Return the native block compressor heap size.
+#   @return [Integer]
+#
+# @!parse
+#   # Raised when LZ4 decompression fails.
+#   class DecompressError < StandardError; end
+module Lz4rip
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lz4rip
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Patrik Wenger
@@ -16,6 +16,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.130
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -23,7 +26,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: Ruby bindings (via Rust/magnus) for lz4rip, a pure-Rust LZ4 implementation.
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.130
+description: Ruby bindings (via Rust/rb-sys) for lz4rip, a pure-Rust LZ4 implementation.
   Block-format and frame-format compress/decompress with optional dictionary support
   and COVER-based dictionary training. Ractor-safe.
 email:
@@ -39,8 +45,10 @@ files:
 - LICENSE
 - README.md
 - ext/lz4rip/Cargo.toml
+- ext/lz4rip/build.rs
 - ext/lz4rip/extconf.rb
 - ext/lz4rip/src/lib.rs
+- ext/lz4rip/src/rb.rs
 - lib/lz4rip.rb
 - lib/lz4rip/block_codec.rb
 - lib/lz4rip/dict_trainer.rb
@@ -52,7 +60,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/paddor/lz4rip-rb
-  source_code_uri: https://github.com/paddor/lz4rip-rb
+  source_code_uri: https://github.com/paddor/lz4rip-rb/tree/main
+  documentation_uri: https://rubydoc.info/gems/lz4rip
   changelog_uri: https://github.com/paddor/lz4rip-rb/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
 rdoc_options: []
@@ -62,14 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 4.0.0
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Ractor-safe LZ4 compression for Ruby
 test_files: []