polytypo 1.6.3 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6776ba2390f63971edcd4f09cd84dbb3f1fc3e9678feee541a7f1667694fdbf
-  data.tar.gz: 7a6657ca0e43963c3c9f8509a0727a6dc9bbaed2f648b3fd4f295aca1c7bdf03
+  metadata.gz: ccb6d56b095a38220c09cb15089edea24d1805b97a2db708f2d9528f5496d563
+  data.tar.gz: e3302e7bc38ffaa8605de7b46bec1160dd0fab40013179eec5fe4423458c0c2f
 SHA512:
-  metadata.gz: 33d644b27e332aef05d2857a9e95598ab05ef5ff56b29a81ba077b5c1d32f0538a8e0d5718a9e5109710227e3559ad67081d3a418910e8cab9a4bc8c242b14c0
-  data.tar.gz: e8b828b749cfe12d719590ace28fb24a5f296bc52b14c959c74f24176921eca9c4ba583509198f56a4d9e4f684e3878dcb577add5c554a5c8b593a5680530fe9
+  metadata.gz: fe0ecd00e6252bc23a36c198b8320a23eb031b85ab418ef40f482afb4ae888ee9bb0e4b858a0d4d97cda2ed5f263152478e028d0162e4dd8be3a1162c8e95244
+  data.tar.gz: e464ca53c2c8f4d7e15bcb3209520ca68e30b2237fd7994aad179dc50a6a691b6363780718d4c15f3c184e6eba4d7e6d67bde3594502d2b44ddc7757ee2f0f19

data/README.md

@@ -85,6 +85,31 @@ chomping indicator are never decoded and rewritten — the file is located, not
 trailing newlines of a `|+` block come back exactly as you wrote them. An empty `keys:` array is
 legal and processes nothing, and `yaml` mode needs no parser at all.
 
+In `markdown` mode frontmatter is skipped whole by default, delimiters included — it is a
+machine-read block, and `fr` would put a narrow no-break space in front of the colon of every
+field in it. On a site whose frontmatter carries the headline that leaves the most visible string
+on the page untouched, so name the keys you want processed:
+
+```ruby
+Polytypo.transform(
+  %(---\ntitle: He said "hello" once\nslug: "he-said-hello"\n---\n\nThe body was typeset all along.\n),
+  locale: "en-US", mode: "markdown", dialect: "commonmark", frontmatter_keys: ["title"]
+)
+# ---
+# title: He said “hello” once
+# slug: "he-said-hello"
+# ---
+#
+# The body was typeset all along.
+```
+
+Without `frontmatter_keys:` nothing in the block changes, and a key you do not name never does. The
+block is read with the same scan `yaml` mode uses, so it refuses the same constructs — a
+single-quoted scalar containing `''` among them, which is how an apostrophe is written inside single
+quotes, so `title: 'It''s a test'` comes back untouched. The block is also processed separately from
+the body, which shows up in exactly one place: an unbalanced quotation mark in `title` cannot pair
+with a mark in your first paragraph.
+
 `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

data/lib/polytypo/data/.not-vendored

@@ -0,0 +1,11 @@
+# Paths under canonical polytypo's spec/ that this repository deliberately does not vendor, so
+# check-vendored-spec.sh must not expect them here. Every other file canonical has at tag
+# spec-v$(cat VERSION) must be present here, or the check fails naming it — which is how a
+# vendored file that was deleted, or a canonical file that was never copied, is caught.
+#
+# An entry canonical does not have at that tag is an error, and so is an entry that is also
+# present here: this list records deliberate omissions, not exemptions.
+#
+# CONFORMANCE.md is canonical's own conformance matrix, written after a release. Nothing here
+# reads it, and it is the one canonical file a released spec version may still gain.
+CONFORMANCE.md

data/lib/polytypo/data/README.md

@@ -18,17 +18,22 @@ one copy, shipped as part of the gem's own `lib/` payload and loaded via `File.r
 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.
 
-CI checks that it was done. `script/check-vendored-spec.sh` compares every file in this
-directory against canonical `polytypo/polytypo` at tag `spec-v` + this directory's own
-`VERSION`, and fails on any difference. Three details. The files this repository authors
-itself are listed in `.not-canonical` and skipped — and a listed path that canonical *does*
-have is an error, so that list cannot be used to keep a forked copy of a canonical file. A
-`locales/*.json` file is compared in full when it carries its `sources` array, and against
-canonical minus that array when it does not, which is the shipped form three of the five
-runtimes vendor; the script reads which case it is off the file rather than being told. And a
-file here with no canonical counterpart is a failure, so a canonical rename cannot pass
-unnoticed. Completeness is deliberately not checked — each runtime vendors its own subset,
-and the subsets differ.
+CI checks that it was done. `script/check-vendored-spec.sh` compares every file in this directory
+against canonical `polytypo/polytypo` at tag `spec-v` + this directory's own `VERSION`, and fails
+on any difference. Five details. The files this repository authors itself are listed in
+`.not-canonical` and skipped — and a listed path that canonical *does* have is an error, so that
+list cannot be used to keep a forked copy of a canonical file. A `locales/*.json` file is compared
+in full when it carries its `sources` array, and against canonical minus that array when it does
+not, which is the shipped form three of the five runtimes vendor; the script reads which case it
+is off the file rather than being told. A file here with no canonical counterpart is a failure, so
+a canonical rename cannot pass unnoticed. Completeness is checked from canonical's side rather
+than this one: every file canonical has at that tag must be here unless `.not-vendored` names it,
+so a vendored file that was deleted, or a canonical file that arrived later and was never copied,
+fails naming itself, and an entry canonical does not have at that tag, or one that is also present
+here, fails too. Here that list names `CONFORMANCE.md`, and nothing else. And the version itself
+is checked: a tree faithful to the tag it claims while canonical has tagged a newer one is a
+warning in CI and, with `--require-current`, a refusal in the release job, because a package must
+not be published claiming a spec version canonical has moved past.
 
 Before that check existed, this half of the tree went stale unnoticed in four of the five
 ports at once: the data half is proved by the test suite, and nothing at all read the prose.

data/lib/polytypo/data/VERSION

@@ -1 +1 @@
-1.6.3
+1.8.0

data/lib/polytypo/data/fixtures/cs.json

@@ -1,5 +1,5 @@
 {
-  "spec": "1.6.3",
+  "spec": "1.8.0",
   "locale": "cs",
   "cases": [
     {

data/lib/polytypo/data/fixtures/de-CH.json

@@ -1,5 +1,5 @@
 {
-  "spec": "1.6.3",
+  "spec": "1.8.0",
   "locale": "de-CH",
   "cases": [
     {

data/lib/polytypo/data/fixtures/de-DE.json

@@ -1,5 +1,5 @@
 {
-  "spec": "1.6.3",
+  "spec": "1.8.0",
   "locale": "de-DE",
   "cases": [
     {
@@ -763,6 +763,19 @@
       "in": "description: a---#b\n",
       "out": "description: a---#b\n",
       "note": "modes.md §3.8.6 with §3.4's character clause: without it this became `description: a – #b`, and everything from the hash became a comment — the value silently truncated to `a –`."
+    },
+    {
+      "id": "de-de-markdown-commonmark-frontmatter-keys",
+      "rule": "quotes",
+      "mode": "markdown",
+      "dialect": "commonmark",
+      "frontmatterKeys": [
+        "title",
+        "summary"
+      ],
+      "in": "---\ntitle: Er sagte \"hallo\" laut\nsummary: Noch \"eins\" hier\nslug: \"er-sagte-hallo\"\n---\n\nIm Text \"so\" hier.\n",
+      "out": "---\ntitle: Er sagte „hallo“ laut\nsummary: Noch „eins“ hier\nslug: \"er-sagte-hallo\"\n---\n\nIm Text „so“ hier.\n",
+      "note": "modes.md §3.7.4: two listed plain scalars in a locale whose quote glyphs differ from English, with an unlisted slug between the block and the body. Each listed scalar is its own span and the marks pair inside it, so the German pair appears three times and the slug keeps its straight quotes."
     }
   ]
 }

data/lib/polytypo/data/fixtures/el.json

@@ -1,5 +1,5 @@
 {
-  "spec": "1.6.3",
+  "spec": "1.8.0",
   "locale": "el",
   "cases": [
     {

data/lib/polytypo/data/fixtures/en-GB.json

@@ -1,5 +1,5 @@
 {
-  "spec": "1.6.3",
+  "spec": "1.8.0",
   "locale": "en-GB",
   "cases": [
     {