polytypo 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 05bb3c57adf30c19b96896ce40858128d7fee5102bee1c3b533c84fcc55d852e
+  data.tar.gz: '0088837892eb60339829d77c2f2204adc23f44fdd6587bdf9294e17885a44271'
+SHA512:
+  metadata.gz: 14d6279d9fdae3d660709dc7c0a4f5c75711befd10c74bcd8f66a4b0026cc7ddec5d83ffb67e7c6609b496322021c29c1097bf6ee24c804e233685e3a9be27c8
+  data.tar.gz: ceaf4caf52d16a2e3189916caa72272d24513e71ea2f8262bb254a1d975247be66d5eac8e46dde0f46b5a62383ee6aeaf043a1a61acc5ceab4168136c466d4d3

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Iurii Rogulia
+
+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,109 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/polytypo/polytypo/main/brand/logo/polytypo-lockup-stacked.svg" alt="polytypo" width="260">
+</p>
+
+<h1 align="center">polytypo</h1>
+
+<p align="center">
+  <a href="https://rubygems.org/gems/polytypo"><img src="https://img.shields.io/gem/v/polytypo.svg" alt="Gem version"></a>
+  <a href="https://github.com/polytypo/polytypo-ruby/actions/workflows/ci.yml"><img src="https://github.com/polytypo/polytypo-ruby/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
+</p>
+
+<p align="center">
+  Locale-correct quotes, dashes, ellipses, apostrophes, symbols and no-break spaces —<br>
+  one portable spec, designed for byte-identical output across runtimes.
+</p>
+
+<p align="center">
+  <strong>Try it live, no install: <a href="https://polytypo.dev/">polytypo.dev</a></strong>
+</p>
+
+This is the Ruby implementation. The full spec — all locales, all rules, worked examples in
+each — lives in [polytypo/polytypo](https://github.com/polytypo/polytypo). This runtime supports
+the `text` and `html` modes fully, and `markdown` for the `commonmark` dialect only — `mdx`
+returns `POLYTYPO_INVALID_DIALECT` (no MDX/JSX parser is available for Ruby; see
+[Supported dialects](#supported-dialects)).
+
+## Install
+
+```sh
+gem install polytypo
+```
+
+Or in a Gemfile:
+
+```ruby
+gem "polytypo"
+```
+
+## Usage
+
+```ruby
+require "polytypo"
+
+Polytypo.transform(%q{She said, "it's fine" -- but I wasn't sure...}, locale: "en-US")
+# => "She said, “it’s fine”—but I wasn’t sure…"
+```
+
+Same input, one locale changed — quotes, dash spacing and all follow the target locale, not a
+single hardcoded style:
+
+```ruby
+Polytypo.transform(%q{Sie sagte: "Alles gut" -- aber ich war mir nicht sicher...}, locale: "de-DE")
+# => "Sie sagte: „Alles gut“ – aber ich war mir nicht sicher…"
+```
+
+HTML and Markdown are first-class modes, not an afterthought — tags, attributes and fenced code
+are left alone; only text content is touched:
+
+```ruby
+Polytypo.transform(%q{<a title="test... wait">Wait... she said "go on."</a>}, locale: "en-US", mode: "html")
+# => "<a title=\"test... wait\">Wait… she said “go on.”</a>"
+```
+
+`locale:` has no default anywhere and must always be passed explicitly — there is no silent
+fallback to English. `mode:` defaults to `"text"` if omitted.
+
+```ruby
+Polytypo.transform(input, locale: "fr", mode: "markdown", dialect: "commonmark")
+```
+
+`require "polytypo"` never loads the native `commonmarker` extension unless you actually call
+`Polytypo.transform` with `mode: "markdown"` — the require happens lazily, inside the markdown
+pipeline only. A single `Polytypo.transform` module method (not separate
+`polytypo/text`/`html`/`markdown` gems) is the idiomatic Ruby shape for this — Ruby's dynamic
+`require` already gets you the same dependency isolation JS/Python's subpath split exists for,
+without a separate namespace per mode.
+
+### Errors
+
+Every error `Polytypo.transform` raises is a `Polytypo::Error` carrying one of seven stable
+codes — check `#code`, not the message text, which is English and informative but not part of
+the contract:
+
+```ruby
+begin
+  Polytypo.transform("x", locale: "xx-ZZ")
+rescue Polytypo::Error => e
+  e.code # => "POLYTYPO_UNKNOWN_LOCALE"
+end
+```
+
+## Supported dialects
+
+`markdown` mode requires a `dialect:`, exactly as the spec requires (no default, detection is
+forbidden). This runtime supports `dialect: "commonmark"` (CommonMark plus GFM — tables,
+strikethrough, task lists, autolink literals). `dialect: "mdx"` is a real dialect the spec names,
+but this runtime has no MDX/JSX parser for it and raises `Polytypo::Error` with
+`POLYTYPO_INVALID_DIALECT` immediately rather than silently mishandling it — a narrower, honest
+conformance claim, not a port defect.
+
+## Thread safety
+
+`Polytypo.transform` is a pure module method with no class-level mutable state: safe to call
+concurrently from any number of `Thread`s with no external synchronization.
+
+## Licence
+
+MIT. See [LICENSE](LICENSE).

data/lib/polytypo/data/README.md

@@ -0,0 +1,20 @@
+# Vendored spec subset
+
+This directory is a manually-synced copy of the subset of `polytypo/polytypo`'s canonical `spec/`
+that this gem needs at runtime: `locales/`, `fixtures/`, `rules/order.json`, `rules/dashes.md`,
+`schema/`, `VERSION`, `UNICODE`. It is **not** the canonical spec — the rest of the normative
+prose (`spec/rules/*.md` beyond `dashes.md`) and `validate-spec.mjs` live only in
+`polytypo/polytypo`.
+
+Named `lib/polytypo/data/`, not `vendor/polytypo-spec/` like the JS/Python ports: a Ruby
+gemspec's `files` list can include any path directly, so there is no need for a separate
+`vendor/` staging copy plus a second, separately-generated package-data copy the way Python
+needed (its build backend does not include arbitrary files without explicit config). This is the
+one copy, shipped as part of the gem's own `lib/` payload and loaded via `File.read` relative to
+`__dir__` at runtime — never a network or external-filesystem read.
+
+Editing a file here does not change the spec; it only drifts this copy from canonical. When
+canonical's `spec/` changes, re-copy the affected files here. How this vendoring will work
+long-term (submodule, per-ecosystem spec package, or something else) is an open decision tracked
+in `polytypo/polytypo`'s roadmap; this is the interim, manually-synced form — the same status
+every other port's vendored copy has.

data/lib/polytypo/data/UNICODE

@@ -0,0 +1 @@
+17.0

data/lib/polytypo/data/VERSION

@@ -0,0 +1 @@
+1.0.0