unfair 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ed1bfb1dbb89b0f3f695cd991a6c1f100b4220ebac33ac801490dc17d09fcd4d
+  data.tar.gz: b809847bba117b52b16846de3f6e4bee9fff1823591d6d069a6273fdd432316f
+SHA512:
+  metadata.gz: 19984a7df20cf9e4773edbfe0187e79a278e541c1b741c2d6285bc5c631e1678818f5aa927bfdf2dc9ed8d91824b5611a08ffabf8706ff8962a79af4c44ef205
+  data.tar.gz: 4a8ac29d76daff25b10ba0c2bbcf73691525d0dacf5aadec6d96736d724a2df72c50c5d407c596ae4ba7ea8ad21b21a879c317ff67027792c0869d4b76bcc6df

data/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in 
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

data/README.md

@@ -0,0 +1,129 @@
+# unfair
+
+`unfair` is a small, dependency-free Ruby wrapper around the **unfair native
+C ABI** — a shared library that converts office documents between formats
+(`txt`, `docx`, `odt`, `xlsx`, `pptx`, `pdf`, and more).
+
+It uses only Ruby's standard library FFI, **Fiddle**, so there is no C
+extension and no compilation step. Just load, convert, get bytes back.
+
+```ruby
+require 'unfair'
+
+engine = Unfair::Engine.new          # or: Unfair.new
+
+docx = engine.convert(plain_text, 'docx')        # input format auto-detected
+txt  = engine.convert(docx, 'docx', 'txt')       # explicit round-trip
+name = engine.detect(plain_text)                 # => "txt"
+all  = engine.formats                            # => ["...", "txt", "docx", ...]
+
+version = Unfair.version                          # => "0.1.0"
+engine.close
+```
+
+## Installation
+
+```console
+gem install unfair
+```
+
+Then, at runtime, the gem needs the native library **`unfair_ffi`** for your
+platform.
+
+| Platform                    | Library file        |
+| --------------------------- | ------------------- |
+| Windows (x86_64, x64)       | `unfair_ffi.dll`    |
+| Linux                       | `libunfair_ffi.so`  |
+| macOS                       | `libunfair_ffi.dylib` |
+
+### Loading the native library
+
+The wrapper looks for the native library in this order:
+
+1. `UNFAIR_FFI_PATH` — set it to the **directory** that contains the
+   platform library, or directly to the **file** path. This is the most
+   reliable option and the recommended way to point at your build output.
+2. `lib/unfair_ffi.{dll,so,dylib}` and `vendor/` inside the gem directory.
+
+If none is found, `Unfair.load!` (called lazily on the first operation)
+raises `Unfair::LoadError`.
+
+> **Windows-first.** The wrapper is exercised on Windows x86_64. On that
+> platform the same loader applies — for a local build, run with the build
+> directory exposed, e.g.
+>
+> ```console
+> UNFAIR_FFI_PATH=C:\path\to\cargo\release ruby your_script.rb
+> ```
+>
+> The Fiddle binding itself is platform-agnostic, but the bundled native
+> artifact is shipped platform-specifically; on Linux/macOS make the `.so`
+> / `.dylib` available the same way (env var or gem `vendor/`).
+
+## API
+
+### `Unfair::Engine`
+
+| Method | Description |
+| ------ | ----------- |
+| `Engine.new` / `Unfair.new` | Create an engine (loads the native lib lazily). |
+| `convert(input, to)` | Convert `input` (auto-detected) to `to`. |
+| `convert(input, from, to)` | Convert from an explicit `from` format. |
+| `convert(input, nil, to)` | Same as `convert(input, to)`. |
+| `detect(data)` | Return the canonical format name (e.g. `"txt"`). |
+| `formats` | All canonical format names as an `Array<String>`. |
+| `version` | `"0.1.0"`. |
+| `close` / `free` | Release the native engine. Also run by a finalizer on GC. |
+
+### `Unfair` (module)
+
+| Method | Description |
+| ------ | ----------- |
+| `Unfair.new` | Alias for `Unfair::Engine.new`. |
+| `Unfair.load!` | Explicitly load the native library. |
+| `Unfair.version` | `"0.1.0"`. |
+| `Unfair::VERSION` | Same constant. |
+
+### Return values / encodings
+
+* `convert` returns a **binary** `String` (`ASCII-8BIT`) holding the output
+  bytes — write it to a file with `File.binwrite` (e.g. `*.docx`).
+* `detect` returns a UTF-8 name.
+* Inputs are treated as raw bytes regardless of their Ruby encoding.
+
+### Errors
+
+All failures raise a subclass of `Unfair::Error`, mapped from the native
+status codes:
+
+| Class | Native status | Meaning |
+| ----- | ------------- | ------- |
+| `Unfair::LoadError` | — | Native library not found / failed to load. |
+| `Unfair::NullError` | –1 | A required argument was `NULL`. |
+| `Unfair::InvalidUtf8Error` | –2 | Invalid UTF-8 where UTF-8 was required. |
+| `Unfair::ConversionError` | –3 | Conversion failed (`message` carries `ro_last_error`). |
+| `Unfair::OutOfRangeError` | –4 | Index out of range. |
+| `Unfair::DetectError` | –5 | Format could not be detected. |
+
+```ruby
+begin
+  engine.detect('')
+rescue Unfair::DetectError => e
+  puts e.message
+end
+```
+
+## Development
+
+```console
+bundle install
+# point at your native build output, then:
+UNFAIR_FFI_PATH=/path/to/lib rake test
+```
+
+Tests live in `test/unfair_test.rb` (minitest); also run directly with
+`ruby -Ilib -Itest test/unfair_test.rb`.
+
+## License
+
+MPL-2.0. See `LICENSE`.

data/lib/unfair.rb

@@ -0,0 +1,335 @@
+# frozen_string_literal: true
+
+require 'fiddle'
+
+# Unfair — Ruby wrapper around the unfair office-conversion C ABI.
+#
+# Pure-Fiddle binding (Ruby stdlib), no compilation step and no external
+# C extension. All calls hit the native +unfair_ffi+ shared library through
+# Fiddle.
+module Unfair
+  VERSION = '0.1.0'
+
+  # Base error for everything this wrapper raises. Subclasses map the C ABI
+  # status codes so callers can rescue precisely.
+  class Error < StandardError; end
+
+  # The native +unfair_ffi+ library could not be located or loaded.
+  class LoadError < Error; end
+
+  # C ABI returned NULL for an engine that must not be NULL.
+  class NullError < Error; end
+
+  # Input was not valid UTF-8 where UTF-8 was required.
+  class InvalidUtf8Error < Error; end
+
+  # A conversion or detection failed; see #message / +detail+ for the
+  # native +ro_last_error+ message.
+  class ConversionError < Error; end
+
+  # An index was out of range.
+  class OutOfRangeError < Error; end
+
+  # The input format could not be detected.
+  class DetectError < Error; end
+
+  class << self
+    # Convenience factory: Unfair.new == Unfair::Engine.new
+    def new(*args, **kwargs)
+      Engine.new(*args, **kwargs)
+    end
+
+    # Load the native library and return it (idempotent).
+    # Raises Unfair::LoadError if the library cannot be found or loaded.
+    def load!(*)
+      FFI.load!
+    end
+
+    # Gem version string ("0.1.0").
+    def version
+      VERSION
+    end
+
+    # Private helper: locate the native library on this platform.
+    def find_library
+      name = FFI.platform_lib_name
+      paths = []
+      env = ENV['UNFAIR_FFI_PATH'].to_s
+      unless env.empty?
+        paths << (File.file?(env) ? env : File.join(env, name))
+      end
+      gem_root = File.expand_path('..', __dir__)
+      paths << File.join(gem_root, 'lib', name)
+      paths << File.join(gem_root, 'vendor', name)
+      paths << File.join(gem_root, 'ext', name)
+      paths << File.join(gem_root, name)
+      hit = paths.find { |p| p && File.file?(p) }
+      return hit if hit
+      raise LoadError, "could not locate #{name} (set UNFAIR_FFI_PATH to its directory or file)"
+    end
+  end
+
+  # Thin, internal Fiddle binding. Public methods on Unfair::Engine delegate
+  # here. The raw symbols are bound once after the native library is loaded.
+  module FFI
+    SIZE_T = Fiddle::TYPE_SIZE_T
+    VOIDP  = Fiddle::TYPE_VOIDP
+    INT    = Fiddle::TYPE_INT
+    VOID   = Fiddle::TYPE_VOID
+
+    class << self
+      attr_reader :handle
+
+      def load!
+        return if defined?(@loaded) && @loaded
+        path = Unfair.find_library
+        @handle = Fiddle.dlopen(path)
+        bind!
+        @loaded = true
+      end
+      alias ensure_loaded load!
+
+      def platform_lib_name
+        case RUBY_PLATFORM
+        when /mswin|mingw|cygwin/ then 'unfair_ffi.dll'
+        when /darwin/             then 'libunfair_ffi.dylib'
+        else                           'libunfair_ffi.so'
+        end
+      end
+
+      # --- engine lifecycle ---
+      def engine_new
+        load!
+        @engine_new.call
+      end
+
+      def engine_free(ptr)
+        @engine_free.call(ptr)
+      end
+
+      # --- conversion ---
+      # Returns [status, data_string_or_nil].
+      def convert(eng, input, from, to)
+        load!
+        bin  = input.b
+        inbuf = buf(bin)
+        inflag = cstr(from)
+        outflag = cstr(to)
+        out_p = Fiddle::Pointer.malloc(Fiddle::SIZEOF_VOIDP)
+        len_p = Fiddle::Pointer.malloc(Fiddle::SIZEOF_SIZE_T)
+        status = @convert.call(eng, inbuf, bin.bytesize, inflag, outflag, out_p, len_p)
+        if status.zero?
+          len = len_p[0, Fiddle::SIZEOF_SIZE_T].unpack1(size_pack)
+          data = nil
+          if len.positive?
+            addr = out_p[0, Fiddle::SIZEOF_VOIDP].unpack1(ptr_pack)
+            data = Fiddle::Pointer.new(addr).to_s(len)
+          end
+          @buffer_free.call(out_p[0, Fiddle::SIZEOF_VOIDP].unpack1(ptr_pack), len)
+          [0, data]
+        else
+          [status, nil]
+        end
+      end
+
+      # --- detect ---
+      # Returns [status, name_or_nil].
+      def detect(eng, data)
+        load!
+        bin  = data.b
+        inbuf = buf(bin)
+        cap = 128
+        loop do
+          out = Fiddle::Pointer.malloc(cap)
+          status = @detect.call(eng, inbuf, bin.bytesize, out, cap)
+          return [status, nil] if status.negative?
+          return [status, out.to_s] if status.zero?
+          cap = status if status.positive?
+        end
+      end
+
+      # --- formats ---
+      def formats_count(eng)
+        load!
+        @formats_count.call(eng)
+      end
+
+      # Returns [status, name_or_nil].
+      def format_at(eng, idx)
+        load!
+        cap = 64
+        loop do
+          out = Fiddle::Pointer.malloc(cap)
+          status = @formats_nth.call(eng, idx, out, cap)
+          return [status, nil] if status.negative?
+          return [status, out.to_s] if status.zero?
+          cap = status if status.positive?
+        end
+      end
+
+      # --- last error ---
+      def last_error(eng)
+        load!
+        len = @last_error_len.call(eng)
+        return '' if len.zero?
+        buf = Fiddle::Pointer.malloc(len)
+        @last_error.call(eng, buf, len)
+        buf.to_s
+      end
+
+      private
+
+      def bind!
+        @engine_new     = Fiddle::Function.new(@handle['ro_engine_new'], [], VOIDP)
+        @engine_free    = Fiddle::Function.new(@handle['ro_engine_free'], [VOIDP], VOID)
+        @convert        = Fiddle::Function.new(
+          @handle['ro_convert'],
+          [VOIDP, VOIDP, SIZE_T, VOIDP, VOIDP, VOIDP, VOIDP], INT)
+        @detect         = Fiddle::Function.new(
+          @handle['ro_detect'],
+          [VOIDP, VOIDP, SIZE_T, VOIDP, SIZE_T], INT)
+        @formats_count  = Fiddle::Function.new(@handle['ro_formats_count'], [VOIDP], SIZE_T)
+        @formats_nth    = Fiddle::Function.new(
+          @handle['ro_formats_nth'],
+          [VOIDP, SIZE_T, VOIDP, SIZE_T], INT)
+        @buffer_free    = Fiddle::Function.new(@handle['ro_buffer_free'], [VOIDP, SIZE_T], VOID)
+        @last_error_len = Fiddle::Function.new(@handle['ro_last_error_len'], [VOIDP], SIZE_T)
+        @last_error     = Fiddle::Function.new(
+          @handle['ro_last_error'],
+          [VOIDP, VOIDP, SIZE_T], INT)
+      end
+
+      # Copy of a String's bytes into a Fiddle::Pointer of exactly that size.
+      def buf(s)
+        p = Fiddle::Pointer.malloc(s.bytesize)
+        p[0, s.bytesize] = s unless s.empty?
+        p
+      end
+
+      # NUL-terminated C string, or the NULL pointer (0) for nil.
+      def cstr(s)
+        return 0 if s.nil?
+        b = s.to_s.b
+        p = Fiddle::Pointer.malloc(b.bytesize + 1)
+        p[0, b.bytesize] = b
+        p[b.bytesize] = 0
+        p
+      end
+
+      def size_pack
+        Fiddle::SIZEOF_SIZE_T == 8 ? 'Q<' : 'L<'
+      end
+
+      def ptr_pack
+        Fiddle::SIZEOF_VOIDP == 8 ? 'Q<' : 'L<'
+      end
+    end
+  end
+
+  # A handle to one native conversion engine. Create it, convert documents
+  # with it, and it frees the native engine when garbage collected
+  # (or when #close is called explicitly).
+  class Engine
+    # @return [String] gem version this engine is built from.
+    def version
+      Unfair::VERSION
+    end
+
+    def initialize
+      Unfair::FFI.load!
+      @pointer = Unfair::FFI.engine_new
+      @closed  = false
+      raise Unfair::NullError, 'ro_engine_new returned NULL' if @pointer.null?
+      ObjectSpace.define_finalizer(self, self.class.finalizer(@pointer.to_i))
+    end
+
+    # Convert +input_bytes+ (String, any encoding — treated as bytes) from
+    # +from+ to +to+ and return the resulting bytes as a String.
+    #
+    # Usage:
+    #   engine.convert(txt, 'docx')        # from auto-detected
+    #   engine.convert(txt, nil, 'docx')   # same, explicit
+    #   engine.convert(docx, 'docx', 'txt')
+    #
+    # +from+ may be nil (autodetect). Returns a binary String (ASCII-8BIT).
+    # Raises a subclass of Unfair::Error on failure.
+    def convert(input_bytes, from = nil, to = nil)
+      to, from = from, nil if to.nil?
+      ensure_open!
+      status, data = Unfair::FFI.convert(pointer, input_bytes, from, to)
+      check_status!(status)
+      data.to_s.b
+    end
+
+    # Detect the canonical format name of +data+ (String). Returns a String
+    # such as "txt", "docx", "odt", ... Raises Unfair::DetectError if the
+    # format cannot be identified.
+    def detect(data)
+      ensure_open!
+      status, name = Unfair::FFI.detect(pointer, data)
+      check_status!(status)
+      name.to_s
+    end
+
+    # All formats this engine reports, as an Array of canonical names.
+    # @return [Array<String>]
+    def formats
+      ensure_open!
+      count = Unfair::FFI.formats_count(pointer)
+      (0...count).filter_map do |idx|
+        status, name = Unfair::FFI.format_at(pointer, idx)
+        check_status!(status)
+        name
+      end
+    end
+
+    # Release the native engine immediately. Subsequent calls raise
+    # Unfair::Error. Idempotent; also run by a finalizer on GC.
+    def close
+      return if @closed
+      @closed = true
+      Unfair::FFI.engine_free(@pointer)
+      @pointer = nil
+      nil
+    end
+    alias free close
+
+    # True once #close (or the finalizer) has released the native engine.
+    def closed?
+      @closed
+    end
+
+    def self.finalizer(addr)
+      proc do |_id|
+        begin
+          Unfair::FFI.engine_free(Fiddle::Pointer.new(addr))
+        rescue StandardError
+          nil
+        end
+      end
+    end
+
+    private
+
+    attr_reader :pointer
+
+    def ensure_open!
+      raise Unfair::Error, 'engine has been closed' if @closed
+    end
+
+    def check_status!(status)
+      case status
+      when 0 then nil
+      when -1 then raise Unfair::NullError, 'null argument passed to C ABI'
+      when -2 then raise Unfair::InvalidUtf8Error, 'invalid UTF-8 where UTF-8 was required'
+      when -3
+        raise Unfair::ConversionError, "conversion failed: #{Unfair::FFI.last_error(pointer)}"
+      when -4 then raise Unfair::OutOfRangeError, 'index out of range'
+      when -5
+        raise Unfair::DetectError, "could not detect format: #{Unfair::FFI.last_error(pointer)}"
+      else
+        raise Unfair::Error, "unexpected status from C ABI: #{status}"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: unfair
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- taunio
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: |
+  unfair is a small, dependency-free Ruby wrapper around the unfair native
+  C ABI. It converts office documents between formats (txt, docx, odt, xlsx,
+  pptx, pdf and more) using only Ruby's standard-library FFI (Fiddle) - no
+  C extension, no compilation step. The native unfair_ffi shared library is
+  loaded at runtime per platform.
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/unfair.rb
+homepage: https://github.com/taunio/unfair-ruby
+licenses:
+- MPL-2.0
+metadata:
+  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.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: Office document conversion backed by the unfair native engine (pure Fiddle
+  FFI)
+test_files: []