asciidoc-parser 0.28.0

Parser for AsciiDoc 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

use std::ops::Deref;

use crate::{blocks::ContentModel, tests::prelude::*, warnings::MatchAndWarnings};

#[test]
fn simplest_toc_macro() {
    let mut parser = Parser::default();

    let mi = crate::blocks::Block::parse(crate::Span::new("toc::[]"), &mut parser)
        .unwrap_if_no_warnings()
        .unwrap();

    assert_eq!(
        mi.item,
        Block::Toc(TocBlock {
            macro_attrlist: Attrlist {
                attributes: &[],
                anchor: None,
                source: Span {
                    data: "",
                    line: 1,
                    col: 7,
                    offset: 6,
                }
            },
            source: Span {
                data: "toc::[]",
                line: 1,
                col: 1,
                offset: 0,
            },
            title_source: None,
            title: None,
            anchor: None,
            anchor_reftext: None,
            attrlist: None,
        })
    );

    assert_eq!(
        mi.item.span(),
        Span {
            data: "toc::[]",
            line: 1,
            col: 1,
            offset: 0,
        }
    );

    assert_eq!(mi.item.content_model(), ContentModel::Empty);
    assert_eq!(mi.item.raw_context().deref(), "toc");
    assert_eq!(mi.item.resolved_context().deref(), "toc");

    // Exercise the remaining `Block::Toc` accessor delegations.
    assert!(mi.item.rendered_content().is_none());
    assert!(mi.item.declared_style().is_none());
    assert!(mi.item.title_source().is_none());
    assert!(mi.item.title().is_none());
    assert!(mi.item.caption().is_none());
    assert!(mi.item.number().is_none());
    assert!(mi.item.id().is_none());
    assert!(mi.item.roles().is_empty());
    assert!(mi.item.options().is_empty());
    assert!(mi.item.anchor().is_none());
    assert!(mi.item.anchor_reftext().is_none());
    assert!(mi.item.attrlist().is_none());
    assert_eq!(mi.item.substitution_group(), SubstitutionGroup::Normal);
}

#[test]
fn not_a_toc_macro_becomes_paragraph() {
    // `toc::foo[]` carries a target, which the `toc` block macro does not take,
    // so it is not recognized as a TOC block and falls through to a paragraph.
    let mut parser = Parser::default();

    let mi = crate::blocks::Block::parse(crate::Span::new("toc::foo[]"), &mut parser)
        .unwrap_if_no_warnings()
        .unwrap();

    assert_eq!(mi.item.raw_context().deref(), "paragraph");
}

#[test]
fn macro_attrlist_warning_is_surfaced() {
    // A warning raised while parsing the macro's attribute list (here, an empty
    // attribute value from the doubled comma) is propagated even though the TOC
    // block still parses.
    let mut parser = Parser::default();

    let MatchAndWarnings { item: mi, warnings } =
        crate::blocks::Block::parse(crate::Span::new("toc::[blah,,blap]"), &mut parser);

    let mi = mi.unwrap();
    assert_eq!(mi.item.raw_context().deref(), "toc");

    assert_eq!(
        warnings,
        vec![Warning {
            source: Span {
                data: "blah,,blap",
                line: 1,
                col: 7,
                offset: 6,
            },
            warning: WarningType::EmptyAttributeValue,
        }]
    );
}

#[test]
fn parses_in_preamble() {
    // `toc::[]` on its own line parses to a block whose resolved context is
    // `toc`, rather than a paragraph containing the literal text `toc::[]`.
    let doc = Parser::default()
        .parse("= Article\n:toc: macro\n\npre\n\ntoc::[]\n\n== Section One\n\nbody\n");

    let toc_contexts: Vec<String> = doc
        .descendant_blocks()
        .map(|b| b.resolved_context().as_ref().to_string())
        .filter(|c| c == "toc")
        .collect();

    assert_eq!(toc_contexts, vec!["toc".to_string()]);
}

#[test]
fn block_title_overrides_toc_title() {
    // A block title above the macro is surfaced through `title()` so a backend
    // can use it to override `toc-title`.
    let doc = Parser::default().parse("= Article\n:toc: macro\n\n.Contents\ntoc::[]\n");

    let toc = doc
        .descendant_blocks()
        .find(|b| b.resolved_context().as_ref() == "toc")
        .unwrap();

    assert_eq!(toc.title(), Some("Contents"));
}