tiptap-rusty-parser 0.3.3

Fast schema-agnostic parser and manipulator for Tiptap/ProseMirror JSONContent documents
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
//! Structural diff/apply tests. The central invariant is the round-trip
//! property: `apply(&mut a.clone(), &a.diff(b)) == b`.

use serde_json::json;
use tiptap_rusty_parser::{apply, Change, Mark, Node};

/// Assert the round-trip property and return the change list for inspection.
/// Also asserts the undo (invert) property: inverting the diff and applying it
/// to the target restores the source.
fn roundtrip(a: &Node, b: &Node) -> Vec<Change> {
    let changes = a.diff(b);
    let mut got = a.clone();
    apply(&mut got, &changes).unwrap();
    assert_eq!(&got, b, "diff+apply did not reproduce target");

    // undo: invert relative to the pre-image, apply to `b`, expect `a`.
    let undo = a.invert(&changes).unwrap();
    let mut back = b.clone();
    apply(&mut back, &undo).unwrap();
    assert_eq!(&back, a, "invert+apply did not restore source");
    changes
}

fn p(text: &str) -> Node {
    Node::element("paragraph").with_child(Node::text(text))
}

// ---- identity / fields --------------------------------------------------

#[test]
fn identical_is_empty() {
    let a = Node::element("doc").with_children([p("one"), p("two")]);
    let changes = roundtrip(&a, &a.clone());
    assert!(changes.is_empty());
}

#[test]
fn attr_add_change_remove() {
    let base = Node::element("heading");
    let with = base.clone().with_attr("level", 1);
    let changed = base.clone().with_attr("level", 2);

    let c = roundtrip(&base, &with);
    assert_eq!(
        c,
        vec![Change::SetAttr {
            path: vec![],
            key: "level".into(),
            value: json!(1)
        }]
    );
    roundtrip(&with, &changed); // change value
    let c = roundtrip(&with, &base); // remove last attr -> attrs back to None
    assert_eq!(
        c,
        vec![Change::RemoveAttr {
            path: vec![],
            key: "level".into()
        }]
    );
}

#[test]
fn text_some_none_transitions() {
    let mut a = Node::text("hello");
    let mut b = Node::text("world");
    roundtrip(&a, &b); // Some -> Some

    b.text = None;
    let c = roundtrip(&a, &b); // Some -> None (clear)
    assert_eq!(
        c,
        vec![Change::SetText {
            path: vec![],
            text: None
        }]
    );

    a.text = None;
    let b2 = Node::text("added");
    roundtrip(&a, &b2); // None -> Some
}

#[test]
fn marks_via_setmarks() {
    let plain = Node::text("x");
    let bold = Node::text("x").with_mark(Mark::new("bold"));
    let link_a = Node::text("x").with_mark(Mark::new("link").attr("href", "a"));
    let link_b = Node::text("x").with_mark(Mark::new("link").attr("href", "b"));

    // add
    let c = roundtrip(&plain, &bold);
    assert!(matches!(c.as_slice(), [Change::SetMarks { .. }]));
    // remove (back to None)
    let c = roundtrip(&bold, &plain);
    assert_eq!(
        c,
        vec![Change::SetMarks {
            path: vec![],
            marks: None
        }]
    );
    // change a mark's attr
    roundtrip(&link_a, &link_b);

    // reorder marks
    let ab = Node::text("x")
        .with_mark(Mark::new("bold"))
        .with_mark(Mark::new("italic"));
    let ba = Node::text("x")
        .with_mark(Mark::new("italic"))
        .with_mark(Mark::new("bold"));
    roundtrip(&ab, &ba);
}

// ---- children -----------------------------------------------------------

#[test]
fn child_insert_positions() {
    let two = Node::element("doc").with_children([p("a"), p("b")]);
    // start
    roundtrip(
        &two,
        &Node::element("doc").with_children([p("x"), p("a"), p("b")]),
    );
    // middle
    roundtrip(
        &two,
        &Node::element("doc").with_children([p("a"), p("x"), p("b")]),
    );
    // end
    roundtrip(
        &two,
        &Node::element("doc").with_children([p("a"), p("b"), p("x")]),
    );
    // into empty (content None -> Some)
    roundtrip(
        &Node::element("doc"),
        &Node::element("doc").with_child(p("a")),
    );
}

#[test]
fn child_remove_positions() {
    let three = Node::element("doc").with_children([p("a"), p("b"), p("c")]);
    roundtrip(
        &three,
        &Node::element("doc").with_children([p("b"), p("c")]),
    ); // start
    roundtrip(
        &three,
        &Node::element("doc").with_children([p("a"), p("c")]),
    ); // middle
    roundtrip(
        &three,
        &Node::element("doc").with_children([p("a"), p("b")]),
    ); // end
       // remove last child -> content back to None
    let one = Node::element("doc").with_child(p("a"));
    roundtrip(&one, &Node::element("doc"));
}

#[test]
fn interleaved_inserts_and_removes() {
    // a: [a b c d]   b: [x b d e]
    // keep b, d; remove a, c; insert x (front), e (end). Stresses the
    // live-list index contract.
    let a = Node::element("doc").with_children([p("a"), p("b"), p("c"), p("d")]);
    let b = Node::element("doc").with_children([p("x"), p("b"), p("d"), p("e")]);
    roundtrip(&a, &b);
}

#[test]
fn nested_change_leaves_siblings_untouched() {
    let a = Node::element("doc").with_children([p("keep"), p("old"), p("keep2")]);
    let b = Node::element("doc").with_children([p("keep"), p("new"), p("keep2")]);
    let changes = roundtrip(&a, &b);
    // Only the middle paragraph's text node changes -> one SetText at [1,0].
    assert_eq!(
        changes,
        vec![Change::SetText {
            path: vec![1, 0],
            text: Some("new".into())
        }]
    );
}

#[test]
fn aligned_modify_vs_type_replace() {
    // same type between anchors -> recurse (SetText), not remove+insert
    let a = Node::element("doc").with_children([p("a"), p("b")]);
    let b = Node::element("doc").with_children([p("a"), p("B")]);
    let c = roundtrip(&a, &b);
    assert!(matches!(c.as_slice(), [Change::SetText { .. }]));

    // different type -> Replace of the child
    let a2 =
        Node::element("doc").with_child(Node::element("paragraph").with_child(Node::text("t")));
    let b2 = Node::element("doc").with_child(Node::element("heading").with_child(Node::text("t")));
    let c2 = roundtrip(&a2, &b2);
    assert!(matches!(c2.as_slice(), [Change::Replace { path, .. }] if path == &vec![0]));
}

#[test]
fn node_type_replace_at_root_and_child() {
    // root replace (empty path)
    let a = Node::element("doc").with_child(p("x"));
    let b = Node::element("section").with_child(p("x"));
    let c = roundtrip(&a, &b);
    assert_eq!(
        c,
        vec![Change::Replace {
            path: vec![],
            node: b.clone()
        }]
    );
}

#[test]
fn long_list_single_middle_insert() {
    let kids_a: Vec<Node> = (0..200).map(|i| p(&format!("n{i}"))).collect();
    let mut kids_b = kids_a.clone();
    kids_b.insert(100, p("inserted"));
    let a = Node::element("doc").with_children(kids_a);
    let b = Node::element("doc").with_children(kids_b);
    let c = roundtrip(&a, &b);
    // Prefix/suffix trim + LCS should yield exactly one Insert.
    assert_eq!(
        c,
        vec![Change::Insert {
            path: vec![],
            index: 100,
            node: p("inserted")
        }]
    );
}

// ---- move detection -----------------------------------------------------

fn count<F: Fn(&Change) -> bool>(c: &[Change], f: F) -> usize {
    c.iter().filter(|x| f(x)).count()
}

#[test]
fn move_single_child_rotation() {
    // [a,b,c] -> [b,c,a]: one node relocated -> exactly one Move, no clone
    // (no Insert/Replace/Remove).
    let a = Node::element("doc").with_children([p("a"), p("b"), p("c")]);
    let b = Node::element("doc").with_children([p("b"), p("c"), p("a")]);
    let c = roundtrip(&a, &b);
    assert_eq!(count(&c, |x| matches!(x, Change::Move { .. })), 1, "{c:?}");
    assert_eq!(count(&c, |x| matches!(x, Change::Insert { .. })), 0);
    assert_eq!(count(&c, |x| matches!(x, Change::Replace { .. })), 0);
    assert_eq!(count(&c, |x| matches!(x, Change::Remove { .. })), 0);
}

#[test]
fn move_drag_past_anchors_is_one_move() {
    // Drag one node past two others -> a single Move, not three remove/inserts.
    let a = Node::element("doc").with_children([p("A"), p("B"), p("C"), p("D"), p("E")]);
    let b = Node::element("doc").with_children([p("A"), p("C"), p("D"), p("B"), p("E")]);
    let c = roundtrip(&a, &b);
    assert_eq!(count(&c, |x| matches!(x, Change::Move { .. })), 1, "{c:?}");
    assert_eq!(count(&c, |x| matches!(x, Change::Insert { .. })), 0);
}

#[test]
fn move_reversal_no_clones() {
    // Full reversal: all relocations, never a clone (no Insert/Replace).
    let a = Node::element("doc").with_children([p("A"), p("B"), p("C"), p("D")]);
    let b = Node::element("doc").with_children([p("D"), p("C"), p("B"), p("A")]);
    let c = roundtrip(&a, &b);
    assert!(
        count(&c, |x| matches!(x, Change::Move { .. })) >= 1,
        "{c:?}"
    );
    assert_eq!(count(&c, |x| matches!(x, Change::Insert { .. })), 0);
    assert_eq!(count(&c, |x| matches!(x, Change::Replace { .. })), 0);
}

#[test]
fn move_interleaved_with_insert_and_remove() {
    // a: [a,b,c,d]  b: [c,a,x,y]  -> c moves before a, plus surrounding edits.
    // The relocation of `c` is detected as a Move regardless of how the rest is
    // expressed; the round-trip is the correctness gate.
    let a = Node::element("doc").with_children([p("a"), p("b"), p("c"), p("d")]);
    let b = Node::element("doc").with_children([p("c"), p("a"), p("x"), p("y")]);
    let c = roundtrip(&a, &b);
    assert!(
        count(&c, |x| matches!(x, Change::Move { .. })) >= 1,
        "{c:?}"
    );
}

#[test]
fn move_duplicate_equal_children() {
    // Equal duplicates: greedy/FIFO pairing must still reproduce exactly.
    let a = Node::element("doc").with_children([p("x"), p("x"), p("y")]);
    let b = Node::element("doc").with_children([p("y"), p("x"), p("x")]);
    roundtrip(&a, &b);
}

#[test]
fn move_with_nested_modify() {
    // A relocated node alongside an in-place text edit on a kept sibling.
    let a = Node::element("doc").with_children([p("one"), p("two"), p("three")]);
    let b = Node::element("doc").with_children([p("three"), p("one"), p("TWO")]);
    roundtrip(&a, &b);
}

#[test]
fn move_invert_restores() {
    let a = Node::element("doc").with_children([p("a"), p("b"), p("c")]);
    let b = Node::element("doc").with_children([p("c"), p("a"), p("b")]);
    let fwd = a.diff(&b);
    let inv = a.invert(&fwd).unwrap();
    let mut doc = a.clone();
    apply(&mut doc, &fwd).unwrap();
    assert_eq!(doc, b);
    apply(&mut doc, &inv).unwrap();
    assert_eq!(doc, a);
}

#[test]
fn fuzz_shuffle_is_pure_moves() {
    // Permuting distinct children must round-trip with ONLY Move ops (no clones,
    // no removes/inserts), and the inverse must restore the original.
    let mut rng = Rng(0xD1B54A32D192ED03);
    for _ in 0..1000 {
        let n = 1 + rng.below(8);
        let kids: Vec<Node> = (0..n).map(|i| p(&format!("n{i}"))).collect();
        let mut shuffled = kids.clone();
        // Fisher-Yates with the test PRNG.
        for i in (1..shuffled.len()).rev() {
            shuffled.swap(i, rng.below(i + 1));
        }
        let a = Node::element("doc").with_children(kids);
        let b = Node::element("doc").with_children(shuffled);
        let c = roundtrip(&a, &b);
        assert_eq!(
            count(&c, |x| matches!(x, Change::Insert { .. })),
            0,
            "{c:?}"
        );
        assert_eq!(
            count(&c, |x| matches!(x, Change::Remove { .. })),
            0,
            "{c:?}"
        );
        assert_eq!(
            count(&c, |x| matches!(x, Change::Replace { .. })),
            0,
            "{c:?}"
        );
    }
}

// ---- extra (unknown fields), lossless -----------------------------------

#[test]
fn extra_fields_roundtrip() {
    let mut a = Node::element("doc");
    a.extra.insert("docId".into(), json!("abc"));
    let mut b = Node::element("doc");
    b.extra.insert("docId".into(), json!("xyz")); // change
    b.extra.insert("version".into(), json!(3)); // add
    let c = roundtrip(&a, &b);
    assert!(c
        .iter()
        .any(|ch| matches!(ch, Change::SetExtra { key, .. } if key == "version")));

    // remove an extra
    roundtrip(&b, &a);
}

#[test]
fn extra_from_parsed_json() {
    use tiptap_rusty_parser::Document;
    let a = Document::from_json_str(
        r#"{"type":"doc","customField":1,"content":[{"type":"paragraph","textAlign":"left"}]}"#,
    )
    .unwrap();
    let b = Document::from_json_str(
        r#"{"type":"doc","customField":2,"content":[{"type":"paragraph","textAlign":"center"}]}"#,
    )
    .unwrap();
    let changes = a.diff(&b);
    let mut got = a.clone();
    got.apply(&changes).unwrap();
    assert_eq!(got, b);
}

// ---- empty-vs-absent container shapes -----------------------------------

#[test]
fn empty_container_shapes_roundtrip() {
    use tiptap_rusty_parser::Document;
    // `content: Some([])` vs `None` — distinct, parseable, must round-trip.
    let empty = Document::from_json_str(r#"{"type":"doc","content":[]}"#).unwrap();
    let absent = Document::from_json_str(r#"{"type":"doc"}"#).unwrap();
    assert_ne!(empty, absent);
    roundtrip(&empty, &absent); // Some([]) -> None
    roundtrip(&absent, &empty); // None -> Some([])

    // `attrs: Some({})` vs `None`.
    let attrs_empty = Document::from_json_str(r#"{"type":"paragraph","attrs":{}}"#).unwrap();
    let attrs_absent = Document::from_json_str(r#"{"type":"paragraph"}"#).unwrap();
    assert_ne!(attrs_empty, attrs_absent);
    roundtrip(&attrs_empty, &attrs_absent);
    roundtrip(&attrs_absent, &attrs_empty);

    // present-empty -> non-empty still reconciles via inserts (no Replace needed).
    let with_kids =
        Document::from_json_str(r#"{"type":"doc","content":[{"type":"paragraph"}]}"#).unwrap();
    roundtrip(&empty, &with_kids);
}

#[test]
fn apply_rejects_out_of_range_insert() {
    let doc = Node::element("doc").with_child(p("a")); // 1 child
    let bad = vec![Change::Insert {
        path: vec![],
        index: 5, // out of range
        node: p("x"),
    }];
    let mut got = doc.clone();
    assert!(apply(&mut got, &bad).is_err());
    assert_eq!(got, doc); // unchanged on error
                          // boundary: index == len is valid (append)
    let ok = vec![Change::Insert {
        path: vec![],
        index: 1,
        node: p("x"),
    }];
    let mut got2 = doc.clone();
    apply(&mut got2, &ok).unwrap();
    assert_eq!(got2.child_count(), 2);
}

// ---- hand-rolled fuzz (no extra deps) -----------------------------------

/// Tiny xorshift PRNG — deterministic, dependency-free.
struct Rng(u64);
impl Rng {
    fn next(&mut self) -> u64 {
        self.0 ^= self.0 << 13;
        self.0 ^= self.0 >> 7;
        self.0 ^= self.0 << 17;
        self.0
    }
    fn below(&mut self, n: usize) -> usize {
        (self.next() % n as u64) as usize
    }
}

fn random_tree(rng: &mut Rng, depth: usize) -> Node {
    let types = ["doc", "paragraph", "heading", "list", "item"];
    let mut n = Node::element(types[rng.below(types.len())]);
    if rng.below(2) == 0 {
        n = n.with_attr("k", rng.below(3) as i64);
    }
    if depth == 0 || rng.below(3) == 0 {
        // leaf-ish: maybe a text child
        if rng.below(2) == 0 {
            let words = ["a", "bb", "ccc", "dd"];
            n = n.with_child(Node::text(words[rng.below(words.len())]));
        }
        return n;
    }
    let count = rng.below(4);
    for _ in 0..count {
        n = n.with_child(random_tree(rng, depth - 1));
    }
    // Occasionally force present-but-empty containers to exercise the
    // empty-vs-absent shape handling (Replace fallback).
    if rng.below(6) == 0 {
        n.content = Some(Vec::new());
    }
    if rng.below(6) == 0 {
        n.attrs = Some(serde_json::Map::new());
    }
    n
}

#[test]
fn fuzz_roundtrip_and_undo() {
    let mut rng = Rng(0x9E3779B97F4A7C15);
    for _ in 0..2000 {
        let a = random_tree(&mut rng, 4);
        let b = random_tree(&mut rng, 4);
        let changes = a.diff(&b);

        let mut got = a.clone();
        apply(&mut got, &changes).unwrap();
        assert_eq!(got, b, "fuzz round-trip failed\n a={a:?}\n b={b:?}");

        // undo: invert relative to `a`, apply to `b`, expect `a`.
        let undo = a.invert(&changes).unwrap();
        let mut back = b.clone();
        apply(&mut back, &undo).unwrap();
        assert_eq!(back, a, "fuzz undo failed\n a={a:?}\n b={b:?}");
    }
}

#[test]
fn invert_apply_forward_then_undo() {
    // The other common undo flow: apply forward, then apply the inverse to the
    // same (now-mutated) doc to get back to the start.
    let a = Node::element("doc").with_children([p("a"), p("b")]);
    let b = Node::element("doc").with_children([p("a"), p("B"), p("c")]);
    let fwd = a.diff(&b);
    let inv = a.invert(&fwd).unwrap();
    let mut doc = a.clone();
    apply(&mut doc, &fwd).unwrap();
    assert_eq!(doc, b);
    apply(&mut doc, &inv).unwrap();
    assert_eq!(doc, a);
}

#[test]
fn invert_empty_is_empty() {
    let a = Node::element("doc").with_child(p("x"));
    assert!(a.invert(&[]).unwrap().is_empty());
}