lex-babel 0.19.2

Format conversion library for the lex format
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
use super::*;

#[test]
fn test_empty_document() {
    let events = vec![Event::StartDocument, Event::EndDocument];

    let doc = events_to_tree(&events).unwrap();
    assert_eq!(doc.children.len(), 0);
}

#[test]
fn test_simple_paragraph() {
    let events = vec![
        Event::StartDocument,
        Event::StartParagraph,
        Event::Inline(InlineContent::Text("Hello world".to_string())),
        Event::EndParagraph,
        Event::EndDocument,
    ];

    let doc = events_to_tree(&events).unwrap();
    assert_eq!(doc.children.len(), 1);

    match &doc.children[0] {
        DocNode::Paragraph(para) => {
            assert_eq!(para.content.len(), 1);
            assert!(matches!(&para.content[0], InlineContent::Text(t) if t == "Hello world"));
        }
        _ => panic!("Expected Paragraph"),
    }
}

#[test]
fn test_heading_with_content() {
    let events = vec![
        Event::StartDocument,
        Event::StartHeading(1),
        Event::Inline(InlineContent::Text("Title".to_string())),
        Event::EndHeading(1),
        Event::EndDocument,
    ];

    let doc = events_to_tree(&events).unwrap();
    assert_eq!(doc.children.len(), 1);

    match &doc.children[0] {
        DocNode::Heading(heading) => {
            assert_eq!(heading.level, 1);
            assert_eq!(heading.content.len(), 1);
            assert!(heading.children.is_empty());
        }
        _ => panic!("Expected Heading"),
    }
}

#[test]
fn test_nested_heading_with_paragraph() {
    let events = vec![
        Event::StartDocument,
        Event::StartHeading(1),
        Event::Inline(InlineContent::Text("Title".to_string())),
        Event::StartParagraph,
        Event::Inline(InlineContent::Text("Content".to_string())),
        Event::EndParagraph,
        Event::EndHeading(1),
        Event::EndDocument,
    ];

    let doc = events_to_tree(&events).unwrap();
    assert_eq!(doc.children.len(), 1);

    match &doc.children[0] {
        DocNode::Heading(heading) => {
            assert_eq!(heading.level, 1);
            assert_eq!(heading.children.len(), 1);
            assert!(matches!(&heading.children[0], DocNode::Paragraph(_)));
        }
        _ => panic!("Expected Heading"),
    }
}

#[test]
fn test_list_with_items() {
    let events = vec![
        Event::StartDocument,
        Event::StartList {
            ordered: false,
            style: ListStyle::Bullet,
            form: ListForm::Short,
        },
        Event::StartListItem,
        Event::Inline(InlineContent::Text("Item 1".to_string())),
        Event::EndListItem,
        Event::StartListItem,
        Event::Inline(InlineContent::Text("Item 2".to_string())),
        Event::EndListItem,
        Event::EndList,
        Event::EndDocument,
    ];

    let doc = events_to_tree(&events).unwrap();
    assert_eq!(doc.children.len(), 1);

    match &doc.children[0] {
        DocNode::List(list) => {
            assert_eq!(list.items.len(), 2);
        }
        _ => panic!("Expected List"),
    }
}

#[test]
fn test_definition() {
    let events = vec![
        Event::StartDocument,
        Event::StartDefinition,
        Event::StartDefinitionTerm,
        Event::Inline(InlineContent::Text("Term".to_string())),
        Event::EndDefinitionTerm,
        Event::StartDefinitionDescription,
        Event::StartParagraph,
        Event::Inline(InlineContent::Text("Description".to_string())),
        Event::EndParagraph,
        Event::EndDefinitionDescription,
        Event::EndDefinition,
        Event::EndDocument,
    ];

    let doc = events_to_tree(&events).unwrap();
    assert_eq!(doc.children.len(), 1);

    match &doc.children[0] {
        DocNode::Definition(def) => {
            assert_eq!(def.term.len(), 1);
            assert_eq!(def.description.len(), 1);
        }
        _ => panic!("Expected Definition"),
    }
}

#[test]
fn test_verbatim() {
    let events = vec![
        Event::StartDocument,
        Event::StartVerbatim {
            language: Some("rust".to_string()),
            subject: None,
            subject_href: None,
            parameters: Vec::new(),
        },
        Event::Inline(InlineContent::Text("fn main() {}".to_string())),
        Event::EndVerbatim,
        Event::EndDocument,
    ];

    let doc = events_to_tree(&events).unwrap();
    assert_eq!(doc.children.len(), 1);

    match &doc.children[0] {
        DocNode::Verbatim(verb) => {
            assert_eq!(verb.language, Some("rust".to_string()));
            assert_eq!(verb.content, "fn main() {}");
        }
        _ => panic!("Expected Verbatim"),
    }
}

#[test]
fn test_annotation() {
    let events = vec![
        Event::StartDocument,
        Event::StartAnnotation {
            label: "note".to_string(),
            parameters: vec![("type".to_string(), "warning".to_string())],
            form: LabelForm::Canonical,
        },
        Event::StartParagraph,
        Event::Inline(InlineContent::Text("Warning text".to_string())),
        Event::EndParagraph,
        Event::EndAnnotation {
            label: "note".to_string(),
        },
        Event::EndDocument,
    ];

    let doc = events_to_tree(&events).unwrap();
    assert_eq!(doc.children.len(), 1);

    match &doc.children[0] {
        DocNode::Annotation(anno) => {
            assert_eq!(anno.label, "note");
            assert_eq!(anno.parameters.len(), 1);
            assert_eq!(anno.content.len(), 1);
        }
        _ => panic!("Expected Annotation"),
    }
}

#[test]
fn test_complex_nested_document() {
    let events = vec![
        Event::StartDocument,
        Event::StartHeading(1),
        Event::Inline(InlineContent::Text("Chapter 1".to_string())),
        Event::StartHeading(2),
        Event::Inline(InlineContent::Text("Section 1.1".to_string())),
        Event::StartParagraph,
        Event::Inline(InlineContent::Text("Some text".to_string())),
        Event::EndParagraph,
        Event::StartList {
            ordered: false,
            style: ListStyle::Bullet,
            form: ListForm::Short,
        },
        Event::StartListItem,
        Event::Inline(InlineContent::Text("Item".to_string())),
        Event::EndListItem,
        Event::EndList,
        Event::EndHeading(2),
        Event::EndHeading(1),
        Event::EndDocument,
    ];

    let doc = events_to_tree(&events).unwrap();
    assert_eq!(doc.children.len(), 1);

    match &doc.children[0] {
        DocNode::Heading(h1) => {
            assert_eq!(h1.level, 1);
            assert_eq!(h1.children.len(), 1);

            match &h1.children[0] {
                DocNode::Heading(h2) => {
                    assert_eq!(h2.level, 2);
                    assert_eq!(h2.children.len(), 2); // paragraph and list
                }
                _ => panic!("Expected nested Heading"),
            }
        }
        _ => panic!("Expected top Heading"),
    }
}

#[test]
fn test_error_mismatched_end() {
    let events = vec![
        Event::StartDocument,
        Event::StartParagraph,
        Event::EndHeading(1), // Wrong end!
    ];

    let result = events_to_tree(&events);
    assert!(matches!(
        result,
        Err(ConversionError::MismatchedEvents { .. })
    ));
}

#[test]
fn test_error_unclosed_container() {
    let events = vec![
        Event::StartDocument,
        Event::StartParagraph,
        Event::EndDocument, // Missing EndParagraph
    ];

    let result = events_to_tree(&events);
    assert!(matches!(
        result,
        Err(ConversionError::UnclosedContainers(_))
    ));
}

#[test]
fn test_error_extra_events() {
    let events = vec![
        Event::StartDocument,
        Event::EndDocument,
        Event::StartParagraph, // Extra after end!
    ];

    let result = events_to_tree(&events);
    assert!(matches!(result, Err(ConversionError::ExtraEvents)));
}

#[test]
fn test_error_mismatched_heading_level() {
    let events = vec![
        Event::StartDocument,
        Event::StartHeading(1),
        Event::EndHeading(2), // Wrong level!
        Event::EndDocument,
    ];

    let result = events_to_tree(&events);
    assert!(matches!(
        result,
        Err(ConversionError::MismatchedEvents { .. })
    ));
}

#[test]
fn document_annotations_survive_tree_events_round_trip() {
    // Phase 3b (#614): `document_annotations` is carried through
    // the IR without being flattened into the event stream as a
    // synthetic `frontmatter` annotation. `tree_to_events` →
    // `events_to_tree` is a structural round-trip on `children`,
    // but `document_annotations` is intentionally invisible to
    // the event layer (format-specific serializers read it from
    // the IR directly). The round-trip rebuilds an empty slot;
    // we lock that contract here so a regression to the old
    // synthesis is caught.
    use crate::ir::nodes::Annotation;
    use crate::ir::to_events::tree_to_events;

    let original = Document {
        title: None,
        subtitle: None,
        children: vec![DocNode::Paragraph(Paragraph {
            content: vec![InlineContent::Text("Body.".to_string())],
        })],
        document_annotations: vec![Annotation {
            label: "lex.metadata.author".to_string(),
            parameters: vec![],
            content: vec![DocNode::Paragraph(Paragraph {
                content: vec![InlineContent::Text("Alice".to_string())],
            })],
            form: LabelForm::Canonical,
        }],
    };

    let events = tree_to_events(&DocNode::Document(original.clone()));

    // No synthetic `frontmatter` annotation event leaks into the
    // stream — the Phase 3b flip retired that synthesis.
    let has_frontmatter = events.iter().any(|e| {
        matches!(
            e,
            Event::StartAnnotation { label, .. } if label == "frontmatter"
        )
    });
    assert!(
        !has_frontmatter,
        "Phase 3b: tree_to_events must not synthesize a frontmatter event"
    );

    // Body events still round-trip through events_to_tree.
    let rebuilt = events_to_tree(&events).expect("events_to_tree");
    assert_eq!(rebuilt.children, original.children);
}

#[test]
fn test_round_trip() {
    use crate::ir::to_events::tree_to_events;

    let original_doc = Document {
        title: None,
        subtitle: None,
        children: vec![DocNode::Heading(Heading {
            level: 1,
            content: vec![InlineContent::Text("Title".to_string())],
            children: vec![DocNode::Paragraph(Paragraph {
                content: vec![InlineContent::Text("Content".to_string())],
            })],
        })],
        document_annotations: vec![],
    };

    // Convert to events
    let events = tree_to_events(&DocNode::Document(original_doc.clone()));

    // Convert back to tree
    let reconstructed = events_to_tree(&events).unwrap();

    // Should match
    assert_eq!(original_doc, reconstructed);
}

#[test]
fn test_round_trip_complex() {
    use crate::ir::to_events::tree_to_events;

    let original_doc = Document {
        title: None,
        subtitle: None,
        children: vec![DocNode::Heading(Heading {
            level: 1,
            content: vec![
                InlineContent::Text("Title ".to_string()),
                InlineContent::Bold(vec![InlineContent::Text("bold".to_string())]),
            ],
            children: vec![
                DocNode::List(List {
                    items: vec![
                        ListItem {
                            content: vec![InlineContent::Text("Item 1".to_string())],
                            children: vec![],
                        },
                        ListItem {
                            content: vec![InlineContent::Text("Item 2".to_string())],
                            children: vec![DocNode::Paragraph(Paragraph {
                                content: vec![InlineContent::Text("Nested".to_string())],
                            })],
                        },
                    ],
                    ordered: false,
                    style: ListStyle::Bullet,
                    form: ListForm::Short,
                }),
                DocNode::Definition(Definition {
                    term: vec![InlineContent::Text("Term".to_string())],
                    description: vec![DocNode::Paragraph(Paragraph {
                        content: vec![InlineContent::Text("Desc".to_string())],
                    })],
                }),
            ],
        })],
        document_annotations: vec![],
    };

    let events = tree_to_events(&DocNode::Document(original_doc.clone()));
    let reconstructed = events_to_tree(&events).unwrap();

    assert_eq!(original_doc, reconstructed);
}