varar-core 0.8.1

Markdown-native BDD — pure functional core engine
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

//! Port of `StructurerTest.java` / `structurer.test.ts`.

use varar_core::ast::Block;
use varar_core::scanner::scan;
use varar_core::structurer::structure;

#[test]
fn every_paragraph_becomes_a_candidate_example_scoped_by_the_headings_above_it() {
    let source = "# Withdrawing cash\n\nGiven I have $100 in my account\n\n# Overdraft\n\nGiven I have $10 in my account";
    let doc = structure("test.md", source, scan(source));
    assert_eq!(2, doc.examples.len());
    assert_eq!(vec!["Withdrawing cash".to_string()], doc.examples[0].scope_stack);
    assert_eq!(vec!["Overdraft".to_string()], doc.examples[1].scope_stack);
}

#[test]
fn two_paragraphs_under_the_same_heading_each_become_a_separate_example() {
    let source = "## Example\n\nFirst paragraph.\n\nSecond paragraph.";
    let doc = structure("test.md", source, scan(source));
    assert_eq!(2, doc.examples.len());
    assert!(matches!(doc.examples[0].body[0], Block::Paragraph(_)));
    assert!(matches!(doc.examples[1].body[0], Block::Paragraph(_)));
    assert_eq!(vec!["Example".to_string()], doc.examples[0].scope_stack);
    assert_eq!(vec!["Example".to_string()], doc.examples[1].scope_stack);
}

#[test]
fn nested_headings_stack_into_an_outer_to_inner_scope_stack() {
    let source = "## Outer\n\nbody one\n\n### Inner\n\nbody two";
    let doc = structure("test.md", source, scan(source));
    assert_eq!(2, doc.examples.len());
    assert_eq!(vec!["Outer".to_string()], doc.examples[0].scope_stack);
    assert_eq!(vec!["Outer".to_string(), "Inner".to_string()], doc.examples[1].scope_stack);
}

#[test]
fn a_heading_at_the_same_level_pops_the_previous_sibling_off_the_scope_stack() {
    let source = "## A\n\nbody A\n\n## B\n\nbody B";
    let doc = structure("test.md", source, scan(source));
    assert_eq!(2, doc.examples.len());
    assert_eq!(vec!["A".to_string()], doc.examples[0].scope_stack);
    assert_eq!(vec!["B".to_string()], doc.examples[1].scope_stack);
}

#[test]
fn a_paragraph_with_no_enclosing_heading_has_an_empty_scope_stack() {
    let source = "standalone paragraph";
    let doc = structure("p.md", source, scan(source));
    assert_eq!(1, doc.examples.len());
    assert!(doc.examples[0].scope_stack.is_empty());
}

#[test]
fn headings_on_their_own_produce_no_examples() {
    let source = "# Title only\n\n## Sub-title\n\n### Another";
    let doc = structure("h.md", source, scan(source));
    assert_eq!(0, doc.examples.len());
}

#[test]
fn structure_preserves_the_source_string_verbatim() {
    let source = "# Hi\n\nbody";
    let doc = structure("p.md", source, scan(source));
    assert_eq!(source, doc.source);
    assert_eq!("p.md", doc.path);
}

#[test]
fn orphan_tables_and_fences_are_recorded_on_the_doc() {
    let source = "| name | age |\n|------|-----|\n| Bob  | 30  |";
    let doc = structure("o.md", source, scan(source));
    assert_eq!(1, doc.orphan_attachments.len());
    assert!(matches!(doc.orphan_attachments[0], varar_core::ast::TableOrFence::Table(_)));
}

#[test]
fn a_table_right_after_a_paragraph_attaches_to_that_paragraph_not_orphan() {
    let source =
        "## Example\n\nGiven these users:\n\n| name | age |\n|------|-----|\n| Bob  | 30  |";
    let doc = structure("o.md", source, scan(source));
    assert_eq!(0, doc.orphan_attachments.len());
    let example = &doc.examples[0];
    assert!(example.body.iter().any(|b| matches!(b, Block::Table(_))));
}

#[test]
fn a_heading_between_a_paragraph_and_a_fence_makes_the_fence_an_orphan() {
    let source = "## A\n\npara\n\n## B\n\n```\nfenced body\n```\n";
    let doc = structure("h.md", source, scan(source));
    assert_eq!(1, doc.orphan_attachments.len());
    let example = &doc.examples[0];
    assert!(!example.body.iter().any(|b| matches!(b, Block::Fence(_))));
}

#[test]
fn preceded_by_delimiter_marks_candidates_after_a_heading_or_thematic_break() {
    let source = "First para.\n\nSecond para.\n\n---\n\nThird para.\n\n## H\n\nFourth para.";
    let doc = structure("d.md", source, scan(source));
    let flags: Vec<bool> = doc
        .examples
        .iter()
        .map(|e| e.preceded_by_delimiter)
        .collect();
    assert_eq!(
        vec![
            true,  // first candidate in the file
            false, // adjacent paragraph, no delimiter between
            true,  // after `---`
            true,  // after a heading
        ],
        flags
    );
}