yrby 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93704595e7dd617d4eccd0645a3dbc99bc798e11ec2591c86f47f0da08381d2c
-  data.tar.gz: 3f4fb67f5fc0368fe31a74cdae2104b9cea8bc44e349b398efc20f84fca7061a
+  metadata.gz: c7e0200b53061315ddc075bbd337a5d9ead543f99617cac94d53180242a80bbd
+  data.tar.gz: 956ec491daabcafc73009e40df573e9c01e5b7587be9d3001d32a7b0a4092f01
 SHA512:
-  metadata.gz: fbe8957a8298efdb2991fa2de86a184e3395cb4315f7e467c2ee1dc1c37e750404468e9a2e71bf55967a44ca281424e4310fc4d985503171ca50a10bb3341e90
-  data.tar.gz: a29fd67645ef0b5312e34213eaf13c42e0eb8628a4e1da1d6af08ff6a68b77673f0f6e32c74f52da5797a3b802573ca78559e4a94a0c36da5b22331102a0ade6
+  metadata.gz: afae1336b4e184f1ecf1d878202023123cee10fa7ea47642c7f6f2b7d48eee7201f2b2198aed217b08434228904178bddaf3d46058e6da7b5b27ad7450a0ef87
+  data.tar.gz: 48a7bd917201e4df0858a08ce0d1eab132fc160a507dc88bfcd1c390cae9a0a8b11a9132894e5f91889f946f69e4366455fb8257e0165c9f1d82da4c367547ed

data/CHANGELOG.md

@@ -4,21 +4,66 @@ All notable changes to this project are documented here. The format is based on
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project aims
 to follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.0] - 2026-08-11
+
+### Added
+
+- `Y::Decoder` ships in the core gem and loads with `require "y"`. It was
+  scaffolded as a separate `yrby-decoder` gem, but it is 66 lines of pure
+  Ruby over `Doc#read_text` / `read_xml`, requires the native core either
+  way, and the separate gem was never published, so the split left the
+  module in no gem at all. The `yrby-decoder` name is retired unused.
+
+### Changed
+
+- `Doc#handle_sync_message` answers a SyncStep1 with the doc's full state,
+  pending included, matching Y.js's `encodeStateAsUpdate`. It previously
+  served integrated-only state. A peer parks a served pending struct the
+  same way the doc did and heals it when the missing dependency arrives
+  from its sender's ack-driven retransmit. `compacted_state_update` still
+  excludes pending, so compaction cannot freeze a gap into a snapshot.
+
+### Fixed
+
+- **`Doc#update_advances?` no longer misreads a gappy merged update carrying
+  novel content as a no-op.** A crafted frame can hide an internal gap behind
+  a Skip block while its post-gap blocks still integrate (yrs plants a Skip
+  hole in the store). That moves neither the doc's public state vector nor
+  pending, so the probe comparison reported genuinely novel content as
+  "doesn't advance"; `update_ready?` accepted the frame and the doc applied
+  it, but it was never recorded to the durable log or broadcast. Any
+  insertion past the update's own (Skip-capped) `state_vector()` now
+  conservatively reports as advancing. Not reachable through standard Yjs
+  providers (a client's own updates and diffs are gap-free), so this closes
+  a hostile-input hole, not a real-world regression.
+
+## [0.6.1] - 2026-08-04
+
+### Fixed
+
+- `Y::Lexxy` emits the attachment tag the node was created with instead of
+  a hardcoded `<action-text-attachment>`. Lexxy makes the tag configurable
+  (`Lexxy.configure`'s `attachmentTagName`, paired with
+  `ActionText::Attachment.tag_name` in Rails), and each attachment node
+  stores its tag, so a custom-tag app's rendered HTML now matches its
+  editor. A stored value that doesn't look like a tag name falls back to
+  the default; documents from before the tag was stored render unchanged.
+
 ## [0.6.0] - 2026-07-11
 
 ### Added
 
 - **Custom render rules for `Y::Lexical` and `Y::ProseMirror`.** Both
-  renderers now take a block registering rules per node type —
+  renderers now take a block registering rules per node type:
   `rules.node "callout", tag: "aside"` for markup-as-data, a Ruby block for
-  logic — plus `nodes:`/`marks:` keywords as the equivalent data form, to
+  logic, plus `nodes:`/`marks:` keywords as the equivalent data form, to
   render node types the pinned schemas don't know or to override how a
   built-in renders.
   Declarative rules (`tag`/`attrs`/`text`/`contains`, with templates mixing
   literals and attribute references) render natively at full speed. Callback
   rules run a Ruby block per node, receiving its type, attributes,
   already-rendered children, and `child_types` (its element/block children by
-  type — the structural facts behind gallery counts and nested-list classes).
+  type, the structural facts behind gallery counts and nested-list classes).
   The block runs after the document read has finished, never while the doc is
   locked, so it can safely read or write the same doc. Blocks are proven
   sufficient for whole schemas: the gem's own editor schemas (`Y::Lexxy`,
@@ -26,13 +71,13 @@ to follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   output byte-identical to a live editor's. With no callback rules the
   render path is unchanged, byte for byte. See "Custom nodes and marks" in
   the README.
-- **`Y::Lexical#node_types` / `Y::ProseMirror#node_types` — schema
+- **`Y::Lexical#node_types` / `Y::ProseMirror#node_types`: schema
   discovery.** Ask a real document which node types it holds and what they
   look like: counts, attribute names as stored, child types, whether text
   runs appear, and whether a builtin or one of your rules already handles
   each ("handled" nil marks what still needs a rule). Editors store names
   you'd never guess; this is how you find them.
-- `Y::RenderRules.escape_text` / `escape_attr` — the exact escaping the
+- `Y::RenderRules.escape_text` / `escape_attr`: the exact escaping the
   native renderers use, for blocks that build markup from stored values
   (ERB's `html_escape` also rewrites apostrophes, which breaks byte parity
   with editor output).
@@ -42,15 +87,15 @@ to follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 - **Lexical rendering is now two classes: `Y::Lexical` (core Lexical) and
   `Y::Lexxy` (core plus the Lexxy schema as render rules).** Stock Lexical
   has no canonical serializer, so the editor-specific class carries the
-  editor's name — `Y::Lexxy.new(doc).to_html` is the byte-parity call for
+  editor's name; `Y::Lexxy.new(doc).to_html` is the byte-parity call for
   Lexxy/Rails apps, and `Y::Lexical` is the base any other Lexical editor
   extends with its own rules. The
-  native side renders core structure — paragraphs, headings, quotes, code,
+  native side renders core structure (paragraphs, headings, quotes, code,
   lists, tables, links, the full text-format model. Lexxy's own node types
   (attachments, galleries, `early_escape_code`, `horizontal_divider`) and its
   decorations of core nodes (the table figure wrapper, header-cell styling,
   the nested-list-item class) are rules applied beneath the app's, on the
-  same extension API — the gem's Lexxy support is the API's first consumer.
+  same extension API; the gem's Lexxy support is the API's first consumer.
   Output is unchanged: the fixture tests still hold `to_html` byte-identical
   to a live editor's serialized value, now through the extension path. An
   unknown Lexical container also degrades better: its block children render
@@ -59,8 +104,8 @@ to follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   ProseMirror) and `Y::Tiptap` (core plus Tiptap's extension nodes as render
   rules).** `Y::Tiptap.new(doc).to_html` is the byte-parity call for Tiptap
   apps. The native side renders prosemirror-schema-basic plus the
-  prosemirror-tables family; Tiptap's extension nodes — task lists, mentions,
-  the details family — are `Y::Tiptap::NODES` rules. Marks stay native in the
+  prosemirror-tables family; Tiptap's extension nodes (task lists, mentions,
+  the details family) are `Y::Tiptap::NODES` rules. Marks stay native in the
   base class: mark rendering (nesting order, `textStyle` CSS, `code`
   exclusivity) runs through text-run machinery node rules don't reach, so
   `Y::ProseMirror` still renders Tiptap's full mark set and `rules.mark`
@@ -71,7 +116,7 @@ to follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Added
 
-- **`Y::Lexical` — render Lexical/Lexxy documents to HTML.**
+- **`Y::Lexical`: render Lexical/Lexxy documents to HTML.**
   `Y::Lexical.new(doc).to_html` turns a Lexxy document into HTML on the server,
   with no Node process or headless editor. The output is identical to the HTML
   a `lexxy-editor` submits to Rails; the tests check it byte-for-byte against a
@@ -89,12 +134,12 @@ to follow [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ### Added
 
-- **`Y::ProseMirror` — render ProseMirror/Tiptap documents to HTML.**
+- **`Y::ProseMirror`: render ProseMirror/Tiptap documents to HTML.**
   `Y::ProseMirror.new(doc).to_html` turns a Tiptap document into HTML on the
   server, with no Node process or headless editor. The output matches Tiptap's
   own `getHTML()`; the tests check it byte-for-byte against a document captured
   from a real editor. It follows `ueberdosis/tiptap-php` and reads both name
-  styles editors use — Tiptap's `bulletList`/`bold` and prosemirror-schema-basic's
+  styles editors use: Tiptap's `bulletList`/`bold` and prosemirror-schema-basic's
   `bullet_list`/`strong`. Covers paragraphs, headings, blockquotes,
   bullet/ordered/task lists, code blocks, links, images, mentions, details,
   hard breaks, horizontal rules, tables, text styles (color, font family), and
@@ -110,8 +155,8 @@ Fixes from a full source review.
 
 - **`Doc#update_ready?` is now exact.** It previously checked only the
   per-client clock lower bound, but yrs's real integration gate also requires
-  every block referenced by an item's origin / right-origin / parent — which
-  routinely belong to *other* clients — and post-Skip blocks in a merged update
+  every block referenced by an item's origin / right-origin / parent (which
+  routinely belong to *other* clients) and post-Skip blocks in a merged update
   sit above the lower bound. An update could pass the clock check yet park as
   pending; downstream, `update_advances?` then misread the parked update as an
   already-applied retry (pending doesn't move a state vector) and the sync
@@ -135,7 +180,7 @@ Fixes from a full source review.
 ### Changed
 
 - `update_advances?` skips its full-document probe when the update carries
-  blocks beyond the doc's state vector (a novel update trivially advances) —
+  blocks beyond the doc's state vector (a novel update trivially advances);
   the common case no longer pays O(doc) per frame.
 - The gem no longer packages the `yrby-decoder` gem's files (they ship in that
   gem; the duplicate copy could shadow a newer standalone release), and now
@@ -146,7 +191,7 @@ Fixes from a full source review.
 ### Fixed
 
 - **Sync no longer serves un-integrable pending structs.** When a doc holds a
-  *pending* struct (a gappy update whose causally-prior update is missing — e.g.
+  *pending* struct (a gappy update whose causally-prior update is missing, e.g.
   legacy data recorded before the `update_ready?` gate existed), its integrated
   state vector is empty but `encode_state_as_update` merges the pending bytes back
   in. Answering a peer's `SyncStep1` with that state handed the peer content it
@@ -154,18 +199,18 @@ Fixes from a full source review.
   non-empty-content mismatch drove endless resync traffic (observed as a browser
   re-sending frames several times a second). `handle_sync_message` now answers
   `SyncStep1` with **integrated-only** state, so a server never serves a struct it
-  can't integrate itself. Neutralizes existing poisoned server state on deploy —
+  can't integrate itself. Neutralizes existing poisoned server state on deploy;
   no migration needed. The server's own pending is untouched and still heals if
   the missing dependency later arrives (only then does the content become
   visible in sync). Live delta relay (`Update` frames) is unchanged.
 
 ### Added
 
-- `Doc#pending?` — true if the doc holds un-integrable pending structs or a
+- `Doc#pending?`: true if the doc holds un-integrable pending structs or a
   pending delete set (content waiting on a missing causally-prior update).
-- `Doc#compacted_state_update` — like `encode_state_as_update` (full state) but
+- `Doc#compacted_state_update`: like `encode_state_as_update` (full state) but
   **gap-free**: excludes pending structs/delete set. Use it when persisting or
-  serving state other peers will apply. Non-destructive — the doc keeps its
+  serving state other peers will apply. Non-destructive; the doc keeps its
   pending (so it can still heal), and `encode_state_as_update` stays lossless for
   raw-update recovery.
 
@@ -183,13 +228,13 @@ Fixes from a full source review.
   before vs. after a trial apply on an isolated probe: a genuinely new deletion
   changes it (`true`); an already-applied retry re-encodes identically (`false`).
   Insert/format-only updates keep the cheaper state-vector path, so only
-  delete-bearing frames — a minority — pay for the exact comparison. The exactly-
+  delete-bearing frames (a minority) pay for the exact comparison. The exactly-
   once guarantee is unchanged in the safe direction: a real deletion is never
   dropped.
 
   This lets `yrby-actioncable` (and any caller gating `on_change` on
-  `update_advances?`) settle a duplicate pure-delete frame as `:applied` — acked,
-  but not stored or relayed — so apps no longer need an app-level
+  `update_advances?`) settle a duplicate pure-delete frame as `:applied` (acked,
+  but not stored or relayed), so apps no longer need an app-level
   encode-and-compare guard around their durable writes.
 
 ## [0.2.2] - 2026-06-30
@@ -200,7 +245,7 @@ Fixes from a full source review.
   embeds child blocks (list items, table cells, nested lists) as `Y.XmlText`
   embeds that `get_string` silently drops, so lists and tables previously came
   back empty. `read_xml` now walks the embeds: text runs build a line, inline
-  children (links) join it, and nested block children flush and recurse — so a
+  children (links) join it, and nested block children flush and recurse, so a
   document with headings, formatted text, links, bullet/numbered/check/nested
   lists, blockquotes, code blocks and tables extracts every piece of text.
   Lexical decorator elements (horizontal rule, image) are skipped instead of
@@ -211,17 +256,17 @@ Fixes from a full source review.
 
 ### Changed
 - **Internal:** renamed the native extension crate `y_ruby` → `yrby` (now loads
-  from `lib/y/yrby.bundle`). No public API change — `require "y"` and `Y::Doc`
+  from `lib/y/yrby.bundle`). No public API change: `require "y"` and `Y::Doc`
   are unchanged.
 
 ## [0.2.0] - 2026-06-28
 
 First release. The public Ruby interface is the top-level module **`Y`**
-(`Y::Doc`, `Y::Error`, `Y::VERSION`), loaded with `require "y"` — mirroring the
+(`Y::Doc`, `Y::Error`, `Y::VERSION`), loaded with `require "y"`, mirroring the
 `y-rb` gem's `Y::Doc` interface.
 
 ### Added
-- Native `Doc#read_text` and `Doc#read_map` readers — reconstruct plain text and
+- Native `Doc#read_text` and `Doc#read_map` readers: reconstruct plain text and
   a JSON map from the stored CRDT state in-process, server-side, with no Node or
   subprocess.
 

data/Cargo.lock

@@ -617,6 +617,9 @@ dependencies = [
  "rb-sys-env 0.1.2",
  "serde_json",
  "yrs",
+ "yrs-html-core",
+ "yrs-lexical-html",
+ "yrs-prosemirror-html",
 ]
 
 [[package]]
@@ -637,6 +640,32 @@ dependencies = [
  "thiserror",
 ]
 
+[[package]]
+name = "yrs-html-core"
+version = "0.1.0"
+dependencies = [
+ "serde_json",
+ "yrs",
+]
+
+[[package]]
+name = "yrs-lexical-html"
+version = "0.1.0"
+dependencies = [
+ "serde_json",
+ "yrs",
+ "yrs-html-core",
+]
+
+[[package]]
+name = "yrs-prosemirror-html"
+version = "0.1.0"
+dependencies = [
+ "serde_json",
+ "yrs",
+ "yrs-html-core",
+]
+
 [[package]]
 name = "zmij"
 version = "1.0.14"