inkling 0.12.5

Limited implementation of the Ink markup language.
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

//! Parse gathers as marked up `ParsedLineKind::Gather` objects.

use crate::{
    consts::GATHER_MARKER,
    error::{parse::line::LineErrorKind, utils::MetaData},
    line::{
        parse::{parse_internal_line, parse_markers_and_text, split_at_divert_marker},
        ParsedLineKind,
    },
};

/// Parse a `ParsedLineKind::Gather` from a line if the line represents a gather point.
pub fn parse_gather(
    content: &str,
    meta_data: &MetaData,
) -> Result<Option<ParsedLineKind>, LineErrorKind> {
    let (line_without_divert, line_from_divert) = split_at_divert_marker(content);

    parse_markers_and_text(line_without_divert, GATHER_MARKER)
        .map(|(level, remaining_text)| (level, format!("{}{}", remaining_text, line_from_divert)))
        .map(|(level, line)| {
            parse_internal_line(&line, meta_data).map(|line| ParsedLineKind::Gather { level, line })
        })
        .transpose()
}

#[cfg(test)]
pub mod tests {
    use super::*;

    use crate::{
        knot::Address,
        line::{parse_line, Content, InternalLine},
    };

    #[test]
    fn line_with_gather_markers_sets_line_text() {
        match parse_line("- Hello, World!", &().into()).unwrap() {
            ParsedLineKind::Gather { line, .. } => {
                assert_eq!(line, InternalLine::from_string("Hello, World!"))
            }
            other => panic!("expected `ParsedLineKind::Gather` but got {:?}", other),
        }

        match parse_line("-- Hello, World!", &().into()).unwrap() {
            ParsedLineKind::Gather { level, .. } => assert_eq!(level, 2),
            other => panic!("expected `ParsedLineKind::Gather` but got {:?}", other),
        }

        match parse_line("------ Hello, World!", &().into()).unwrap() {
            ParsedLineKind::Gather { level, .. } => assert_eq!(level, 6),
            other => panic!("expected `ParsedLineKind::Gather` but got {:?}", other),
        }
    }

    #[test]
    fn line_with_gather_markers_counts_them() {
        match parse_line("- Hello, World!", &().into()).unwrap() {
            ParsedLineKind::Gather { level, .. } => assert_eq!(level, 1),
            other => panic!("expected `ParsedLineKind::Gather` but got {:?}", other),
        }

        match parse_line("-- Hello, World!", &().into()).unwrap() {
            ParsedLineKind::Gather { level, .. } => assert_eq!(level, 2),
            other => panic!("expected `ParsedLineKind::Gather` but got {:?}", other),
        }

        match parse_line("------ Hello, World!", &().into()).unwrap() {
            ParsedLineKind::Gather { level, .. } => assert_eq!(level, 6),
            other => panic!("expected `ParsedLineKind::Gather` but got {:?}", other),
        }
    }

    #[test]
    fn line_with_gather_markers_ignores_whitespace() {
        match parse_line("   - - -- Hello, World!", &().into()).unwrap() {
            ParsedLineKind::Gather { level, .. } => assert_eq!(level, 4),
            other => panic!("expected `ParsedLineKind::Gather` but got {:?}", other),
        }
    }

    #[test]
    fn gather_markers_do_not_require_text() {
        match parse_line("-", &().into()).unwrap() {
            ParsedLineKind::Gather { line, .. } => {
                assert_eq!(line.chunk.items.len(), 0);
            }
            other => panic!("expected `ParsedLineKind::Gather` but got {:?}", other),
        }

        match parse_line(" - -  ", &().into()).unwrap() {
            ParsedLineKind::Gather { line, .. } => {
                assert_eq!(line.chunk.items.len(), 0);
            }
            other => panic!("expected `ParsedLineKind::Gather` but got {:?}", other),
        }
    }

    #[test]
    fn diverts_can_come_directly_after_gathers() {
        match parse_line("- -> world", &().into()).unwrap() {
            ParsedLineKind::Gather { line, .. } => {
                assert_eq!(line.chunk.items[0], Content::Empty);
                assert_eq!(
                    line.chunk.items[1],
                    Content::Divert(Address::Raw("world".to_string()))
                );
            }
            other => panic!("expected `ParsedLineKind::Gather` but got {:?}", other),
        }
    }

    #[test]
    fn line_with_beginning_divert_parses_into_line_instead_of_gather() {
        match parse_line("  -> world", &().into()).unwrap() {
            ParsedLineKind::Line(line) => {
                assert_eq!(
                    line.chunk.items[1],
                    Content::Divert(Address::Raw("world".to_string()))
                );
            }
            other => panic!("expected `ParsedLineKind::Gather` but got {:?}", other),
        }
    }
}