kp_anydoc 0.2.4-aarch64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ab1dc44d68d9daa04bfa05e92871ec6d69e42b4e1aa2732e7f7ba5acd48aef0
+  data.tar.gz: e01881b5fe262fbcd8bc68c3db1726064c6f51cb86f4f10ae0d379d01ddd4bd1
+SHA512:
+  metadata.gz: 9435472b176e04f9a110adcbe8904dc9a686b7dce27a9e560ba5d4f558b9ad39a8a7e2e54e4517c8789e1dd08bd4a155971bbdd344c649ec05d191ab5fd7fe28
+  data.tar.gz: d1ac9167e82614703680fe3bd059cb19be7165c4ef46f69b45dcb4fb124c5f289893822eebe8a3ea4cbdb7e9c9a456fd41f327faba3f71113b358dfffa8f4585

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+Versions track the [`anydoc`](https://crates.io/crates/anydoc) Rust crate this gem wraps: `kp_anydoc` 0.2.4 wraps `anydoc` 0.2.4.
+
+## [0.2.4] - Unreleased
+
+- Initial release of `kp_anydoc`, wrapping the `anydoc` Rust crate 0.2.4.
+- `Anydoc.to_markdown(bytes, filename:)` converts document bytes to Markdown.
+- Typed errors: `Anydoc::UnsupportedError`, `MalformedError`, `EncryptedError`, `ResourceLimitError`, `MissingPartError`, `IoError`.
+- Precompiled native gems published for `x86_64-linux`, `aarch64-linux`, `x86_64-linux-musl`, and `arm64-darwin`, each carrying a Ruby 3.4 and 4.0 extension, with a source gem fallback.
+- Bundles `THIRD-PARTY-LICENSES.txt`, generated from the Rust dependency tree, so the compiled extension ships its linked-in dependencies' attribution.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KirkpatrickPrice
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# kp_anydoc
+
+Ruby bindings for the [`anydoc`](https://crates.io/crates/anydoc) Rust library. Converts documents (PDF, XLSX, CSV, and more) to Markdown in-process — no external service, conversions complete in milliseconds.
+
+The gem is published on RubyGems as **`kp_anydoc`** but is required as **`anydoc`** and exposes the **`Anydoc`** module.
+
+## Installation
+
+```ruby
+gem "kp_anydoc"
+```
+
+Requires **Ruby 3.4 or newer**. The gem version tracks the [`anydoc`](https://crates.io/crates/anydoc) Rust crate it wraps — `kp_anydoc` 0.2.4 wraps `anydoc` 0.2.4. Precompiled native gems are published for the platforms below, each carrying a Ruby 3.4 and 4.0 extension, so installs need no Rust toolchain:
+
+- `x86_64-linux`
+- `aarch64-linux`
+- `x86_64-linux-musl`
+- `arm64-darwin`
+
+On any other platform, the source gem compiles on install and requires a Rust toolchain (`cargo`) plus `libclang`.
+
+## Usage
+
+```ruby
+require "anydoc"
+
+markdown = Anydoc.to_markdown(File.binread("report.pdf"), filename: "report.pdf")
+```
+
+`filename:` is used to detect the format from its extension. On failure a typed error is raised:
+
+| Error | Meaning |
+| --- | --- |
+| `Anydoc::UnsupportedError` | The format isn't recognized or supported. |
+| `Anydoc::MalformedError` | The file is corrupt or unparseable. |
+| `Anydoc::EncryptedError` | The file is password-protected. |
+| `Anydoc::ResourceLimitError` | The file exceeded a processing limit. |
+| `Anydoc::MissingPartError` | A required internal part was missing. |
+| `Anydoc::IoError` | An I/O error occurred while reading. |
+
+All inherit from `Anydoc::Error`.
+
+## Development
+
+```bash
+bin/setup        # bundle install
+bundle exec rake compile   # build the Rust extension
+bundle exec rake spec      # run the tests (compiles first)
+```
+
+Requires a Rust toolchain (`cargo`, `rustc`) and `libclang`.
+
+## Releasing
+
+Precompiled native gems are cross-compiled and published by the `Release` workflow. The per-platform binaries can only be built in CI (you can't build a Linux/musl gem on a Mac), so releasing runs through GitHub Actions rather than a local `gem push`.
+
+One-time setup: on RubyGems.org, register a [trusted publisher](https://guides.rubygems.org/trusted-publishing/) for `kp_anydoc` pointing at this repository (`kirkpatrickprice/anydoc`) and the `release.yml` workflow. RubyGems lets you register a publisher for a gem that does not exist yet; the first release claims the name. No API key or repository secret is stored, and your account MFA can stay at "UI and API".
+
+To cut a release:
+
+1. Bump `anydoc_core` in `ext/anydoc/Cargo.toml` to the crate version you're wrapping, set `Anydoc::VERSION` in `lib/anydoc/version.rb` to that same version, and update `CHANGELOG.md`. The gem version always mirrors the crate version.
+2. Commit, tag, and create a GitHub Release for the tag.
+3. The `Release` workflow generates `THIRD-PARTY-LICENSES.txt` from the Rust dependency tree, builds a native gem per platform (`arm64-darwin`, `aarch64-linux`, `x86_64-linux`, `x86_64-linux-musl`, each carrying a Ruby 3.4 and 4.0 extension — see `CROSS_RUBIES` in the Rakefile for why more than one ABI is built), builds a source-gem fallback, smoke-tests the native gems, and pushes them all to RubyGems via OIDC.
+
+Run the workflow manually (`workflow_dispatch`) for a dry run: it builds and tests everything but skips publishing.
+
+## License
+
+`kp_anydoc` is released under the MIT license (`LICENSE.txt`). The compiled extension statically links third-party Rust crates (MIT, Apache-2.0, BSD-3-Clause, ISC, Zlib, Unicode-3.0); their attribution is reproduced in `THIRD-PARTY-LICENSES.txt`, generated at release time and bundled into every published gem. Regenerate it locally with `cargo about generate -c about.toml -m ext/anydoc/Cargo.toml -o THIRD-PARTY-LICENSES.txt about.hbs`.