lex-core 0.17.0

Parser 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
426
427
428
429
430
431
432
433
434
435
//! Unit tests for isolated definition elements
//!
//! Tests definition parsing in isolation following the on-lexplore.lex guidelines:
//! - Use Lexplore to load centralized test files
//! - Use assert_ast for deep structure verification
//! - Test isolated elements (one element per test)
//! - Verify content and structure, not just counts

use lex_core::lex::testing::assert_ast;
use lex_core::lex::testing::lexplore::Lexplore;
use lex_core::lex::testing::workspace_path;

#[test]
fn test_definition_01_flat_simple() {
    // definition-01-flat-simple.lex: Definition with single paragraph content
    let doc = Lexplore::definition(1).parse().unwrap();

    // Document: Definition + trailing paragraph "Something to finish the element"
    assert_ast(&doc)
        .item_count(2)
        .item(0, |item| {
            item.assert_definition()
                .subject("Cache")
                .child_count(1)
                .child(0, |child| {
                    child
                        .assert_paragraph()
                        .text_contains("Temporary storage for frequently accessed data");
                });
        })
        .item(1, |item| {
            item.assert_paragraph()
                .text_contains("Something to finish the element");
        });
}

#[test]
fn test_definition_02_flat_multi_paragraph() {
    // definition-02-flat-multi-paragraph.lex: Definition with multiple paragraphs
    let doc = Lexplore::definition(2).parse().unwrap();

    assert_ast(&doc)
        .item_count(2)
        .item(0, |item| {
            item.assert_definition()
                .subject("Microservice")
                .child_count(2) // Two paragraphs in definition
                .child(0, |child| {
                    child
                        .assert_paragraph()
                        .text_contains("architectural style");
                })
                .child(1, |child| {
                    child
                        .assert_paragraph()
                        .text_contains("independently deployable");
                });
        })
        .item(1, |item| {
            item.assert_paragraph()
                .text_contains("Something to finish the element");
        });
}

#[test]
fn test_definition_03_flat_with_list() {
    // definition-03-flat-with-list.lex: Due to blank line after "HTTP Methods:",
    // parser treats this as an unnumbered Session, not a Definition.
    // Definitions require content immediately after the colon (no blank line).
    let doc = Lexplore::definition(3).parse().unwrap();

    assert_ast(&doc)
        .item_count(2)
        .item(0, |item| {
            // Parsed as Session because of blank line after colon
            item.assert_session()
                .label("HTTP Methods:")
                .child_count(1)
                .child(0, |child| {
                    child
                        .assert_list()
                        .item_count(4)
                        .item(0, |list_item| {
                            list_item.text_contains("GET: Retrieve resources");
                        })
                        .item(1, |list_item| {
                            list_item.text_contains("POST: Create resources");
                        })
                        .item(2, |list_item| {
                            list_item.text_contains("PUT: Update resources");
                        })
                        .item(3, |list_item| {
                            list_item.text_contains("DELETE: Remove resources");
                        });
                });
        })
        .item(1, |item| {
            item.assert_paragraph()
                .text_contains("Something to finish the element");
        });
}

#[test]
fn test_definition_05_nested_with_list() {
    // definition-05-nested-with-list.lex: Definition with paragraphs + list content
    let doc = Lexplore::definition(5).parse().unwrap();

    assert_ast(&doc).item_count(1).item(0, |item| {
        item.assert_definition()
            .subject("Programming Concepts")
            .child_count(3)
            .child(0, |child| {
                child
                    .assert_paragraph()
                    .text_contains("fundamental ideas in programming");
            })
            .child(1, |child| {
                child
                    .assert_list()
                    .item_count(3)
                    .item(0, |li| {
                        li.text_contains("Variables");
                    })
                    .item(1, |li| {
                        li.text_contains("Functions");
                    })
                    .item(2, |li| {
                        li.text_contains("Loops");
                    });
            })
            .child(2, |child| {
                child
                    .assert_paragraph()
                    .text_contains("core building blocks");
            });
    });
}

#[test]
fn test_definition_06_nested_definitions() {
    // definition-06-nested-definitions.lex: Nested definition hierarchy (Authentication -> OAuth -> OAuth 2.0)
    let doc = Lexplore::definition(6).parse().unwrap();

    assert_ast(&doc).item_count(1).item(0, |item| {
        item.assert_definition()
            .subject("Authentication")
            .child(0, |child| {
                child.assert_paragraph().text_contains("verifying identity");
            })
            .child(1, |child| {
                child
                    .assert_definition()
                    .subject("OAuth")
                    .child(0, |grandchild| {
                        grandchild
                            .assert_paragraph()
                            .text_contains("access delegation");
                    })
                    .child(1, |grandchild| {
                        grandchild
                            .assert_definition()
                            .subject("OAuth 2.0")
                            .child(0, |leaf| {
                                leaf.assert_paragraph().text_contains("current version");
                            });
                    });
            })
            .child(2, |child| {
                child.assert_definition().subject("JWT").child(0, |leaf| {
                    leaf.assert_paragraph().text_contains("JSON Web Tokens");
                });
            });
    });
}

#[test]
fn test_definition_07_nested_deep_only() {
    // definition-07-nested-deep-only.lex: Deeply nested definitions chain
    let doc = Lexplore::definition(7).parse().unwrap();

    assert_ast(&doc).item_count(1).item(0, |item| {
        item.assert_definition()
            .subject("Computer Science")
            .child(0, |child| {
                child
                    .assert_paragraph()
                    .text_contains("computation and information");
            })
            .child(1, |child| {
                child
                    .assert_definition()
                    .subject("Algorithms")
                    .child(0, |grandchild| {
                        grandchild
                            .assert_paragraph()
                            .text_contains("Step-by-step procedures");
                    })
                    .child(1, |grandchild| {
                        grandchild
                            .assert_definition()
                            .subject("Sorting")
                            .child(0, |leaf| {
                                leaf.assert_paragraph().text_contains("Organizing data");
                            })
                            .child(1, |leaf| {
                                leaf.assert_definition()
                                    .subject("QuickSort")
                                    .child(0, |detail| {
                                        detail
                                            .assert_paragraph()
                                            .text_contains("divide-and-conquer");
                                    });
                            });
                    });
            });
    });
}

#[test]
fn test_definition_90_document_simple() {
    let doc = Lexplore::definition(90).parse().unwrap();

    // Ensemble document: title paragraph, description paragraph, definition, 3 sessions,
    // trailing paragraph, trailing definition, final paragraph
    assert_ast(&doc)
        .title("Ensemble Test with Definitions {{paragraph}}")
        .item(0, |item| {
            item.assert_paragraph()
                .text_contains("tests all core elements");
        })
        .item(1, |item| {
            item.assert_definition()
                .subject("Introduction")
                .child_count(2)
                .child(0, |child| {
                    child
                        .assert_paragraph()
                        .text_contains("demonstrates how definitions integrate");
                })
                .child(1, |child| {
                    child
                        .assert_list()
                        .item_count(4)
                        .item(0, |li| {
                            li.text_contains("Paragraphs provide narrative content");
                        })
                        .item(3, |li| {
                            li.text_contains("Definitions explain terms");
                        });
                });
        })
        .item(2, |item| {
            // "1. Simple Elements Section"
            item.assert_session()
                .label("1. Simple Elements Section {{session}}")
                .child(0, |child| {
                    child
                        .assert_paragraph()
                        .text_contains("each element in isolation");
                })
                .child(1, |child| {
                    child
                        .assert_definition()
                        .subject("API Endpoint")
                        .child(0, |def_para| {
                            def_para
                                .assert_paragraph()
                                .text_contains("URL that provides access");
                        });
                })
                .child(2, |child| {
                    child
                        .assert_definition()
                        .subject("Database Types")
                        .child(0, |def_list| {
                            def_list.assert_list().item_count(3).item(0, |li| {
                                li.text_contains("Relational databases");
                            });
                        });
                })
                .child(3, |child| {
                    child
                        .assert_paragraph()
                        .text_contains("simple list at the session level");
                })
                .child(4, |child| {
                    child.assert_list().item_count(3).item(0, |li| {
                        li.text_contains("First item");
                    });
                });
        })
        .item(3, |item| {
            // "2. Nested Elements Section"
            item.assert_session()
                .label("2. Nested Elements Section {{session}}")
                .child(0, |child| {
                    child
                        .assert_paragraph()
                        .text_contains("more complex nesting patterns");
                })
                .child(1, |child| {
                    // "2.1. Subsection with Definitions"
                    child
                        .assert_session()
                        .label("2.1. Subsection with Definitions {{session}}")
                        .child(0, |sc| {
                            sc.assert_definition()
                                .subject("Microservice")
                                .child(0, |p| {
                                    p.assert_paragraph().text_contains("architectural style");
                                });
                        });
                });
        })
        .item(4, |item| {
            // "3. Deep Nesting Section"
            item.assert_session()
                .label("3. Deep Nesting Section {{session}}")
                .child(0, |child| {
                    child
                        .assert_paragraph()
                        .text_contains("deeper nesting levels");
                })
                .child(1, |child| {
                    child
                        .assert_session()
                        .label("3.1. Level One {{session}}")
                        .child(1, |grandchild| {
                            grandchild
                                .assert_definition()
                                .subject("Design Pattern")
                                .child(0, |p| {
                                    p.assert_paragraph().text_contains("reusable solution");
                                });
                        });
                });
        });
}

#[test]
fn test_definitions_overview_document() {
    // definitions.lex: Specification overview covering syntax/disambiguation
    let doc = Lexplore::from_path(workspace_path("comms/specs/elements/definition.lex"))
        .parse()
        .unwrap();

    // Verify the document parses successfully with expected structure
    assert_ast(&doc)
        .item_count(6)
        .item(0, |item| {
            item.assert_session().label("Introduction");
        })
        .item(1, |item| {
            item.assert_session().label("Syntax");
        })
        .item(2, |item| {
            item.assert_session().label("Disambiguation from Sessions");
        })
        .item(3, |item| {
            item.assert_session().label("Content Structure");
        })
        .item(4, |item| {
            item.assert_session().label("Block Termination");
        })
        .item(5, |item| {
            item.assert_session().label("Examples");
        });
}

#[test]
fn test_definition_10_session_nesting_issue() {
    // Minimal reproduction for "Definition cannot contain Session" error
    // Mimics structure from definitions.lex: Session containing multiple Definitions
    let doc = Lexplore::definition(10).parse().unwrap();

    // Expected structure:
    // Item 0: Session("Syntax") containing:
    //   - Definition("Subject") with content
    //   - Paragraph("Key rule...")
    //   - Definition("Subject line") with list
    //   - Definition("Content") with list
    // Item 1: Session("Disambiguation from Sessions") with paragraph
    assert_ast(&doc)
        .item_count(2)
        .item(0, |item| {
            item.assert_session().label("Syntax");
        })
        .item(1, |item| {
            item.assert_session()
                .label("Disambiguation from Sessions")
                .child_count(1)
                .child(0, |child| {
                    child.assert_paragraph().text_contains("Some content here");
                });
        });
}

#[test]
fn test_definition_100_document_nested_sessions() {
    // Tests that sessions require blank lines BEFORE the subject (not just after)
    // This prevents incorrect Session parsing inside Definitions
    let doc = Lexplore::definition(100).parse().unwrap();

    // Expected structure:
    // Session("Disambiguation from Sessions") containing:
    //   - Paragraph("Definitions vs Sessions - the blank line rule:")
    //   - BlankLineGroup
    //   - Definition("Definition (no blank line)") containing:
    //     - Definition("API Endpoint") with paragraph
    //   - Definition("Session (has blank line)") containing:
    //     - Paragraph("API Endpoint:") - correctly NOT a Session!
    assert_ast(&doc).item_count(1).item(0, |item| {
        item.assert_session()
            .label("Disambiguation from Sessions")
            .child_count(3) // Paragraph, Definition, Definition
            .child(0, |child| {
                child
                    .assert_paragraph()
                    .text_contains("Definitions vs Sessions")
                    .text_contains("blank line rule");
            })
            .child(1, |child| {
                // "Definition (no blank line):" — is a definition
                child
                    .assert_definition()
                    .subject("Definition (no blank line)");
            })
            .child(2, |child| {
                // "Session (has blank line):" — also a definition at this level
                child
                    .assert_definition()
                    .subject("Session (has blank line)");
            });
    });
}