liblevenshtein 4.0.0.rc.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5e0447f4c670e2d48cb721bfb330831b320ef57f3580feb840ef9adc364be2e8
+  data.tar.gz: b0786629ebef0234f71b2447407382223c41d1ecdd74b3855698c8606b59f9d6
+SHA512:
+  metadata.gz: ca25c7833979b3bfb28c27482df10b0b66d27c1579f82428fb5546cec1d17d733144410c75d5954ca4a258ecd10c91a44c279128c94191f0afbf2f1d8a703b9e
+  data.tar.gz: 37f91fceaa43d5b75e9690a59cac3d8d63e2b701e32b31c64957f69b847810ac2be57c2d6d60b6cc628babc20b154bf3a47ed0b34817d9a9eed480c25fb9b8dd

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 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 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 those 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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,146 @@
+# Vinary Tree liblevenshtein for Ruby
+
+This gem supports maintained Ruby 3.3 through the latest Ruby release. Queries
+are one-shot `Enumerable` objects backed by a native cursor; only a bounded
+batch is leased and each yielded `Match` owns its term. A query captures its
+dictionary revision at construction and can outlive the source dictionary.
+
+Any modular dictionary gem can implement `with_resource { |context, vtable| }
+to participate in O(1) retained-resource handoff. The libdictenstein gem does
+so without serialization or an object-format conversion.
+
+Set `LIBLEVENSHTEIN_LIBRARY` for a source-tree build. Release gems contain the
+platform shared library under `lib/vinary_tree/native/<platform>/`; a system
+installation remains a supported loader fallback.
+
+<!-- BEGIN GENERATED BINDING OPERATIONS; DO NOT EDIT -->
+
+## Support and package contract
+
+| Property | Contract |
+|---|---|
+| Binding | Ruby |
+| Languages/runtime | Ruby 3.3+ |
+| Support tier | Tier 2 |
+| Distribution | RubyGems package `liblevenshtein` |
+| Native boundary | Ruby Fiddle calls the stable C ABI; modular producers yield the two-word resource without serialization. |
+| Canonical facade source | [`bindings/ruby/lib/vinary_tree/liblevenshtein`](../../bindings/ruby/lib/vinary_tree/liblevenshtein) |
+
+The support tier controls release gating, not semantic quality: every tier has
+the same snapshot, ownership, status, and ABI compatibility laws. Consult the
+[binding architecture](../../docs/language-bindings.md) before implementing a custom provider
+and the [family hub](../../docs/bindings/README.md) when combining independently packaged projects.
+
+![The host-language facade crosses one project ABI and retains a versioned family resource rather than sharing Rust object layouts.](../../docs/diagrams/bindings/three-layer-architecture.svg)
+
+## Executable example and verification
+
+The repository's canonical executable example is
+[`bindings/ruby/test/test_liblevenshtein.rb`](../../bindings/ruby/test/test_liblevenshtein.rb). It exercises the same public package a user
+installs and is run by the binding CI with:
+
+```sh
+ruby -Ibindings/ruby/lib bindings/ruby/test/test_liblevenshtein.rb
+```
+
+Examples deliberately construct or receive resources through public project
+packages. They never import private Rust modules, depend on object layout, or
+reach behind the stable C/resource ABIs.
+
+## Public API and data model
+
+The idiomatic facade groups the stable surface into these concepts:
+
+| Concept | Semantics |
+|---|---|
+| Dictionary resource | A retained `vt.dictionary.v1` capability. Construction and mutation belong to a producer such as libdictenstein. |
+| Transducer | Immutable query configuration plus a retained dictionary provider; construction is constant-time with respect to dictionary size. |
+| Query cursor | A one-shot traversal over the immutable dictionary revision captured at query start. |
+| Match/batch | Owned matches are stable host values; a borrowed batch is valid only inside its documented callback or lease interval. |
+
+Ruby strings use explicit encoding rules; byte strings and integer arrays select non-Unicode domains. Empty terms, embedded zero bytes, non-ASCII text, and the full
+unsigned 64-bit identifier range are represented explicitly; no facade may use
+a sentinel value that removes a valid input from the domain.
+
+For the exhaustive native function contract—including exact preconditions,
+returnable statuses, complexity, and thread-safety—use the
+[`llev_*` C ABI reference](../../docs/bindings/c-abi-reference.md). The facade
+source linked above is the authoritative idiomatic symbol inventory; its
+exhaustive coverage is governed by [`bindings/api-surface-map.json`](../../bindings/api-surface-map.json) and the [generated completeness matrix](../../bindings/conformance/completeness-matrix.tsv).
+
+## Ownership, snapshots, and resource handoff
+
+Prefer block forms and `ensure { cursor.close }`; finalizers only prevent permanent leaks.
+
+A transducer retains the provider resource, and a query retains the revision
+visible at query start. Closing the original dictionary or publishing later
+mutations cannot invalidate that query. Acquisition either completes with one
+owned retain or fails with no ownership transfer. Teardown order is therefore
+free across dictionary, transducer, and completed query handles.
+
+Borrowed results are intentionally lexical. Copy data that must outlive the
+callback; retaining a raw address, slice, memory segment, or foreign pointer is
+an API violation even when the next operation happens to reuse the same arena.
+
+## Errors and failure containment
+
+Non-OK statuses become typed Ruby exceptions exposing the status symbol and native diagnostic.
+
+Malformed utf-8, unsupported unit domains, incompatible resource versions, closed handles, invalid bounds, allocation failures, provider faults, and contained rust panics are distinct failures. Never parse diagnostic prose to
+branch on an error: inspect the typed status/exception first and treat the
+message as human context. Diagnostics must be copied before another native
+call on the same thread.
+
+## Concurrency and reentrancy
+
+Separate native handles are reentrant. Enumerate one cursor on one fiber/thread and never retain callback-scoped buffers.
+
+Snapshot capture is a linearization point, not a dictionary-wide query lock.
+First-party immutable snapshots can be walked concurrently. A foreign provider
+that does not advertise parallel callbacks is serialized at its callback gate;
+the host language must not add a weaker promise.
+
+## Performance and marshalling
+
+- Reuse transducers for repeated queries against the same resource.
+- Prefer streaming cursors to whole-result materialization.
+- Prefer batch/reducer APIs when per-match boundary crossings dominate.
+- Keep Unicode, byte, and token domains explicit to avoid transcoding.
+- Measure native, WASM, and WASI paths independently; they have different
+  startup and marshalling costs but identical query semantics.
+
+No host wrapper should cache unbounded query results. Applications that add a
+memo use a revision key and a hard entry/weight bound; eviction may be
+approximate because all values remain derivable from the retained snapshot.
+
+## Security model
+
+Treat a foreign resource provider and all user-controlled queries as untrusted
+inputs. Validate lengths before allocation, preserve paging bounds, reject
+unknown enum values, contain callbacks/panics at the boundary, and never trust
+capability flags until interface negotiation succeeds. The normative duties
+are in the [binding trust model](../../docs/security/binding-trust-model.md).
+
+## Compatibility and troubleshooting
+
+The project ABI revision, family ABI version, interface identity/version,
+package version, and umbrella-runtime version are independent counters. Follow
+the [ABI evolution policy](https://github.com/vinary-tree/vinary-tree-interop/blob/master/docs/abi-evolution.md); never infer compatibility from a
+package version alone.
+
+When loading fails, check—in order—the documented runtime/toolchain version,
+CPU/OS artifact, native-access permission, loader search path, dependent
+interop package pin, and process-wide JavaScript runtime identity. When a query
+fails after construction, report the typed status and copied diagnostic before
+reducing the case to the smallest dictionary/query pair.
+
+## Maintainer checklist
+
+1. Update the machine-readable binding model before changing a public symbol.
+2. Regenerate headers/constants and the API coverage matrix.
+3. Extend the canonical executable example and negative-path tests.
+4. Run the language package, snapshot, leak, property, and cross-project suites.
+5. Verify package staging contains this guide and uses coherent sibling pins.
+6. Render diagrams headlessly and run the documentation/link/math gates.
+
+<!-- END GENERATED BINDING OPERATIONS -->

data/lib/vinary_tree/liblevenshtein/native.rb

@@ -0,0 +1,92 @@
+require "fiddle/import"
+require "rbconfig"
+
+module VinaryTree
+  module Liblevenshtein
+    module Native
+      extend Fiddle::Importer
+
+      def self.library_candidates
+        explicit = ENV["LIBLEVENSHTEIN_LIBRARY"]
+        os, extension, filename = case RbConfig::CONFIG["host_os"]
+                                  when /darwin/ then ["darwin", "dylib", "libliblevenshtein.dylib"]
+                                  when /mswin|mingw/ then ["windows", "dll", "liblevenshtein.dll"]
+                                  else ["linux", "so", "libliblevenshtein.so"]
+                                  end
+        cpu = case RbConfig::CONFIG["host_cpu"]
+              when /x86_64|amd64/ then "x64"
+              when /aarch64|arm64/ then "arm64"
+              else RbConfig::CONFIG["host_cpu"]
+              end
+        platform = "#{os}-#{cpu}"
+        bundled = File.expand_path("native/#{platform}/#{filename}", __dir__)
+        [explicit, bundled, filename, "liblevenshtein.#{extension}"].compact
+      end
+
+      loaded = library_candidates.find do |candidate|
+        begin
+          dlload candidate
+          true
+        rescue Fiddle::DLError
+          false
+        end
+      end
+      raise Fiddle::DLError, "unable to load liblevenshtein (tried #{library_candidates.join(', ')})" unless loaded
+
+      VtResource = struct ["void* context", "void* vtable"]
+      Match = struct [
+        "void* term_data", "size_t term_len", "size_t byte_len",
+        "size_t distance", "uint64_t id", "uint32_t unit_domain",
+        "uint8_t has_id", "uint8_t reserved[3]"
+      ]
+      Batch = struct ["void* matches", "size_t len", "uint64_t generation"]
+      OwnedString = struct ["void* data", "size_t len"]
+
+      extern "const char* llev_last_error_message(void)"
+      extern "size_t llev_distance(const char*, size_t, const char*, size_t)"
+      extern "size_t llev_distance_threshold(const char*, size_t, const char*, size_t, size_t)"
+      extern "size_t llev_damerau_distance(const char*, size_t, const char*, size_t)"
+      extern "size_t llev_damerau_distance_threshold(const char*, size_t, const char*, size_t, size_t)"
+      extern "size_t llev_true_damerau_distance(const char*, size_t, const char*, size_t)"
+      extern "size_t llev_true_damerau_distance_threshold(const char*, size_t, const char*, size_t, size_t)"
+      extern "uint32_t llev_transducer_new(const void*, uint32_t, void*)"
+      extern "void llev_transducer_free(void*)"
+      extern "uint32_t llev_transducer_query_utf8(void*, const char*, size_t, size_t, uint32_t, void*)"
+      extern "uint32_t llev_transducer_query_bytes(void*, const void*, size_t, size_t, uint32_t, void*)"
+      extern "uint32_t llev_transducer_query_u64(void*, const void*, size_t, size_t, uint32_t, void*)"
+      extern "uint32_t llev_query_cursor_next_batch(void*, size_t, void*)"
+      extern "uint32_t llev_query_cursor_release_batch(void*, uint64_t)"
+      extern "uint32_t llev_query_cursor_free(void*)"
+      extern "uint32_t llev_phonetic_pattern_compile_regex(const char*, size_t, void*)"
+      extern "uint32_t llev_phonetic_pattern_compile_llre(const char*, size_t, void*)"
+      extern "void llev_phonetic_pattern_free(void*)"
+      extern "uint32_t llev_phonetic_pattern_size(void*, void*, void*)"
+      extern "uint32_t llev_phonetic_pattern_matches(void*, const char*, size_t, void*)"
+      extern "uint32_t llev_transducer_query_pattern(void*, void*, uint8_t, void*)"
+      extern "uint32_t llev_phonetic_rules_parse(const char*, size_t, void*)"
+      extern "uint32_t llev_phonetic_rules_builtin(uint32_t, void*)"
+      extern "void llev_phonetic_rules_free(void*)"
+      extern "uint32_t llev_phonetic_rules_len(void*, void*)"
+      extern "uint32_t llev_phonetic_rules_apply(void*, const char*, size_t, void*)"
+      extern "void llev_owned_string_free(void*)"
+
+      module_function
+
+      def pointer_output
+        Fiddle::Pointer.malloc(Fiddle::SIZEOF_VOIDP, Fiddle::RUBY_FREE)
+      end
+
+      def read_pointer(output)
+        output[0, Fiddle::SIZEOF_VOIDP].unpack1("J")
+      end
+
+      def size_output
+        Fiddle::Pointer.malloc(Fiddle::SIZEOF_SIZE_T, Fiddle::RUBY_FREE)
+      end
+
+      def read_size(output)
+        output[0, Fiddle::SIZEOF_SIZE_T].unpack1("J")
+      end
+    end
+  end
+end

data/lib/vinary_tree/liblevenshtein/version.rb

@@ -0,0 +1,5 @@
+module VinaryTree
+  module Liblevenshtein
+    VERSION = "4.0.0.rc.4"
+  end
+end

data/lib/vinary_tree/liblevenshtein.rb

@@ -0,0 +1,287 @@
+require "thread"
+require_relative "liblevenshtein/version"
+require_relative "liblevenshtein/native"
+
+module VinaryTree
+  module Liblevenshtein
+    OK = 0
+    END_STATUS = 1
+    BYTE_DOMAIN = 1
+    UNICODE_DOMAIN = 2
+    U64_DOMAIN = 3
+
+    class Error < StandardError
+      attr_reader :status
+      def initialize(status)
+        @status = status
+        super("liblevenshtein status #{status}: #{Native.llev_last_error_message.to_s}")
+      end
+    end
+
+    def self.check(status)
+      raise Error, status unless status == OK
+    end
+
+    class << self
+      def distance(source, target) = Native.llev_distance(source.b, source.bytesize, target.b, target.bytesize)
+      def distance_threshold(source, target, threshold) = Native.llev_distance_threshold(source.b, source.bytesize, target.b, target.bytesize, threshold)
+      def damerau_distance(source, target) = Native.llev_damerau_distance(source.b, source.bytesize, target.b, target.bytesize)
+      def damerau_distance_threshold(source, target, threshold) = Native.llev_damerau_distance_threshold(source.b, source.bytesize, target.b, target.bytesize, threshold)
+      def true_damerau_distance(source, target) = Native.llev_true_damerau_distance(source.b, source.bytesize, target.b, target.bytesize)
+      def true_damerau_distance_threshold(source, target, threshold) = Native.llev_true_damerau_distance_threshold(source.b, source.bytesize, target.b, target.bytesize, threshold)
+    end
+
+    Match = Data.define(:term, :distance, :id, :domain)
+
+    module Finalizer
+      module_function
+      def for(box, function)
+        proc do
+          pointer = box[0]
+          function.call(pointer) unless pointer.nil? || pointer.zero?
+          box[0] = 0
+        rescue StandardError
+          nil
+        end
+      end
+    end
+
+    # A lifetime gate that permits concurrent native calls and only coordinates
+    # close with in-flight operations. It never serializes ordinary reads.
+    class ConcurrentHandle
+      def initialize(pointer, releaser)
+        @pointer = pointer
+        @releaser = releaser
+        @active = 0
+        @closing = false
+        @mutex = Mutex.new
+        @condition = ConditionVariable.new
+      end
+
+      def with_pointer
+        pointer = @mutex.synchronize do
+          raise IOError, "native handle is closed" if @closing || @pointer.zero?
+          @active += 1
+          @pointer
+        end
+        yield pointer
+      ensure
+        @mutex.synchronize do
+          @active -= 1
+          @condition.broadcast if @active.zero?
+        end if pointer
+      end
+
+      def close
+        pointer = @mutex.synchronize do
+          return 0 if @pointer.zero?
+          @closing = true
+          @condition.wait(@mutex) until @active.zero?
+          result = @pointer
+          @pointer = 0
+          result
+        end
+        @releaser.call(pointer) unless pointer.zero?
+        pointer
+      end
+
+      def self.finalizer(handle) = proc { handle.close rescue nil }
+    end
+
+    class Transducer
+      STANDARD = 0
+      TRANSPOSITION = 1
+      MERGE_AND_SPLIT = 2
+      DAMERAU_LEVENSHTEIN = 3
+
+      def initialize(dictionary, algorithm: STANDARD)
+        raise ArgumentError, "dictionary must respond to with_resource" unless dictionary.respond_to?(:with_resource)
+        output = Native.pointer_output
+        dictionary.with_resource do |context, vtable|
+          resource = Native::VtResource.malloc
+          resource.context = context
+          resource.vtable = vtable
+          Liblevenshtein.check(Native.llev_transducer_new(resource, algorithm, output))
+        end
+        @handle = ConcurrentHandle.new(Native.read_pointer(output), Native.method(:llev_transducer_free))
+        ObjectSpace.define_finalizer(self, ConcurrentHandle.finalizer(@handle))
+      end
+
+      def query(text, maximum_distance, order: 0)
+        start_query(:llev_transducer_query_utf8, text.b, maximum_distance, order)
+      end
+
+      def query_bytes(bytes, maximum_distance)
+        start_query(:llev_transducer_query_bytes, bytes.b, maximum_distance, 0)
+      end
+
+      def query_u64(tokens, maximum_distance)
+        packed = tokens.pack("Q*")
+        start_query(:llev_transducer_query_u64, packed, maximum_distance, 0, tokens.length)
+      end
+
+      def query_pattern(pattern, maximum_distance)
+        with_pointer do |pointer|
+          pattern.__send__(:with_pointer) do |pattern_pointer|
+            output = Native.pointer_output
+            Liblevenshtein.check(Native.llev_transducer_query_pattern(pointer, pattern_pointer, maximum_distance, output))
+            Query.new(Native.read_pointer(output))
+          end
+        end
+      end
+
+      def close
+        @handle.close
+        ObjectSpace.undefine_finalizer(self)
+        nil
+      end
+
+      private
+
+      def with_pointer
+        @handle.with_pointer { |pointer| yield pointer }
+      end
+
+      def start_query(function, input, maximum_distance, order, units = input.bytesize)
+        with_pointer do |pointer|
+          output = Native.pointer_output
+          Liblevenshtein.check(Native.public_send(function, pointer, input, units, maximum_distance, order, output))
+          Query.new(Native.read_pointer(output))
+        end
+      end
+    end
+
+    class Query
+      include Enumerable
+      BATCH_SIZE = 256
+
+      def initialize(pointer)
+        @box = [pointer]
+        @claimed = false
+        @mutex = Mutex.new
+        ObjectSpace.define_finalizer(self, Finalizer.for(@box, proc { |value| Native.llev_query_cursor_free(value) }))
+      end
+
+      def each
+        return enum_for(__method__) unless block_given?
+        @mutex.synchronize do
+          raise IOError, "query is one-shot" if @claimed
+          @claimed = true
+        end
+        begin
+          loop do
+            batch = Native::Batch.malloc
+            status = Native.llev_query_cursor_next_batch(@box[0], BATCH_SIZE, batch)
+            break if status == END_STATUS
+            Liblevenshtein.check(status)
+            begin
+              batch.len.times do |index|
+                item = Native::Match.new(batch.matches + index * Native::Match.size)
+                yield materialize(item)
+              end
+            ensure
+              Liblevenshtein.check(Native.llev_query_cursor_release_batch(@box[0], batch.generation))
+            end
+          end
+        ensure
+          close
+        end
+      end
+
+      def close
+        @mutex.synchronize do
+          return if @box[0].zero?
+          Liblevenshtein.check(Native.llev_query_cursor_free(@box[0]))
+          @box[0] = 0
+          ObjectSpace.undefine_finalizer(self)
+        end
+      end
+
+      private
+
+      def materialize(item)
+        pointer = Fiddle::Pointer.new(item.term_data)
+        term = case item.unit_domain
+               when BYTE_DOMAIN then pointer[0, item.byte_len].b
+               when UNICODE_DOMAIN then pointer[0, item.byte_len].dup.force_encoding(Encoding::UTF_8)
+               when U64_DOMAIN then pointer[0, item.term_len * 8].unpack("Q*")
+               else raise IOError, "unknown native term domain #{item.unit_domain}"
+               end
+        Match.new(term, item.distance, item.has_id.zero? ? nil : item.id, item.unit_domain)
+      end
+    end
+
+    class PhoneticPattern
+      def self.compile_regex(source) = compile(source, false)
+      def self.compile_llre(source) = compile(source, true)
+      def self.compile(source, llre)
+        output = Native.pointer_output
+        status = llre ? Native.llev_phonetic_pattern_compile_llre(source.b, source.bytesize, output) : Native.llev_phonetic_pattern_compile_regex(source.b, source.bytesize, output)
+        Liblevenshtein.check(status)
+        new(Native.read_pointer(output))
+      end
+
+      def initialize(pointer)
+        @handle = ConcurrentHandle.new(pointer, Native.method(:llev_phonetic_pattern_free))
+        ObjectSpace.define_finalizer(self, ConcurrentHandle.finalizer(@handle))
+      end
+      def matches?(text)
+        with_pointer do |pointer|
+          output = Fiddle::Pointer.malloc(1, Fiddle::RUBY_FREE)
+          Liblevenshtein.check(Native.llev_phonetic_pattern_matches(pointer, text.b, text.bytesize, output))
+          output[0].positive?
+        end
+      end
+      def size
+        with_pointer do |pointer|
+          states = Native.size_output; transitions = Native.size_output
+          Liblevenshtein.check(Native.llev_phonetic_pattern_size(pointer, states, transitions))
+          [Native.read_size(states), Native.read_size(transitions)]
+        end
+      end
+      def close
+        @handle.close; ObjectSpace.undefine_finalizer(self); nil
+      end
+      private
+      def with_pointer
+        @handle.with_pointer { |pointer| yield pointer }
+      end
+    end
+
+    class PhoneticRuleSet
+      ENGLISH_ORTHOGRAPHY = 0
+      ENGLISH_PHONETIC = 1
+      def self.parse(source)
+        output = Native.pointer_output; Liblevenshtein.check(Native.llev_phonetic_rules_parse(source.b, source.bytesize, output)); new(Native.read_pointer(output))
+      end
+      def self.builtin(kind)
+        output = Native.pointer_output; Liblevenshtein.check(Native.llev_phonetic_rules_builtin(kind, output)); new(Native.read_pointer(output))
+      end
+      def initialize(pointer)
+        @handle = ConcurrentHandle.new(pointer, Native.method(:llev_phonetic_rules_free))
+        ObjectSpace.define_finalizer(self, ConcurrentHandle.finalizer(@handle))
+      end
+      def length
+        with_pointer do |pointer|
+          output = Native.size_output; Liblevenshtein.check(Native.llev_phonetic_rules_len(pointer, output)); Native.read_size(output)
+        end
+      end
+      def apply(text)
+        with_pointer do |pointer|
+          output = Native::OwnedString.malloc
+          Liblevenshtein.check(Native.llev_phonetic_rules_apply(pointer, text.b, text.bytesize, output))
+          begin Fiddle::Pointer.new(output.data)[0, output.len].force_encoding(Encoding::UTF_8)
+          ensure Native.llev_owned_string_free(output)
+          end
+        end
+      end
+      def close
+        @handle.close; ObjectSpace.undefine_finalizer(self); nil
+      end
+      private
+      def with_pointer
+        @handle.with_pointer { |pointer| yield pointer }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: liblevenshtein
+version: !ruby/object:Gem::Version
+  version: 4.0.0.rc.4
+platform: ruby
+authors:
+- Dylon Edwards
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Idiomatic Ruby bindings to Vinary Tree's high-performance liblevenshtein
+  native ABI
+email:
+- dylon.devo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/vinary_tree/liblevenshtein.rb
+- lib/vinary_tree/liblevenshtein/native.rb
+- lib/vinary_tree/liblevenshtein/native/darwin-arm64/libliblevenshtein.dylib
+- lib/vinary_tree/liblevenshtein/native/linux-arm64/libliblevenshtein.so
+- lib/vinary_tree/liblevenshtein/native/linux-x64/libliblevenshtein.so
+- lib/vinary_tree/liblevenshtein/native/windows-x64/liblevenshtein.dll
+- lib/vinary_tree/liblevenshtein/version.rb
+homepage: https://github.com/vinary-tree/liblevenshtein-rust
+licenses:
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/vinary-tree/liblevenshtein-rust
+  changelog_uri: https://github.com/vinary-tree/liblevenshtein-rust/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.0.dev
+specification_version: 4
+summary: Snapshot-consistent streaming Levenshtein search
+test_files: []