yamd 0.19.0

Yet Another Markdown Document (flavour)
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

use std::fmt::Display;

#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

use super::{Paragraph, paragraph::escape_leading_block_marker};

/// # Highlight
///
/// Must start and end with [Bang](type@crate::lexer::TokenKind::Bang) of length 2.
///
/// [Title](Highlight::title) is sequence of tokens between first
/// [Bang](type@crate::lexer::TokenKind::Bang) of length 2 followed by
/// [Space](type@crate::lexer::TokenKind::Space) and [Eol](type@crate::lexer::TokenKind::Eol).
/// Can be omitted.
///
/// [Icon](Highlight::icon) is sequence of tokens between
/// [Bang](type@crate::lexer::TokenKind::Bang) of length 1 followed by
/// [Space](type@crate::lexer::TokenKind::Space) and [Eol](type@crate::lexer::TokenKind::Eol).
/// Can be omitted.
///
/// [Title](Highlight::title) and [Icon](Highlight::icon) can not contain
/// [Terminator](type@crate::lexer::TokenKind::Terminator).
///
/// [Body](Highlight::body) is one or more [Paragraph]'s.
///
/// Example:
///
/// ```text
/// !! Tile
/// ! Icon
/// body
/// !!
/// ```
///
/// Example without title:
///
/// ```text
/// !!
/// ! Icon
/// body
/// !!
/// ```
///
/// Example without icon:
///
/// ```text
/// !! Tile
/// body
/// !!
/// ```
///
#[derive(Debug, PartialEq, Clone, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Highlight {
    pub title: Option<String>,
    pub icon: Option<String>,
    pub body: Vec<Paragraph>,
}

impl Highlight {
    pub fn new<T: Into<String>, I: Into<String>>(
        title: Option<T>,
        icon: Option<I>,
        body: Vec<Paragraph>,
    ) -> Self {
        Self {
            title: title.map(|title| title.into()),
            icon: icon.map(|icon| icon.into()),
            body,
        }
    }
}

impl Display for Highlight {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let title = self
            .title
            .as_ref()
            .map_or("".to_string(), |t| format!(" {}", t.replace("\\", "\\\\")));
        let icon = self.icon.as_ref().map_or("".to_string(), |i| {
            format!("! {}\n", i.replace("\\", "\\\\"))
        });
        write!(
            f,
            "!!{}\n{}{}\n!!",
            title,
            icon,
            self.body
                .iter()
                .map(|p| escape_leading_block_marker(p.to_string().replace("!!", "\\!!")))
                .collect::<Vec<_>>()
                .join("\n\n")
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::nodes::Paragraph;

    #[test]
    fn highlight() {
        let highlight = Highlight::new(
            Some("title"),
            Some("icon"),
            vec![Paragraph::new(vec!["body".to_string().into()])],
        );
        assert_eq!(highlight.to_string(), "!! title\n! icon\nbody\n!!");
    }

    #[test]
    fn highlight_without_title() {
        let highlight = Highlight::new::<&str, &str>(
            None,
            Some("icon"),
            vec![Paragraph::new(vec!["body".to_string().into()])],
        );
        assert_eq!(highlight.to_string(), "!!\n! icon\nbody\n!!");
    }

    #[test]
    fn highlight_without_icon() {
        let highlight = Highlight::new::<&str, &str>(
            Some("title"),
            None,
            vec![Paragraph::new(vec!["body".to_string().into()])],
        );
        assert_eq!(highlight.to_string(), "!! title\nbody\n!!");
    }

    #[test]
    fn highlight_with_double_bang_in_the_middle() {
        let highlight = Highlight::new::<&str, &str>(
            Some("title"),
            Some("icon"),
            vec![
                Paragraph::new(vec!["body".to_string().into()]),
                Paragraph::new(vec!["a\n!!".to_string().into()]),
            ],
        );
        assert_eq!(
            highlight.to_string(),
            "!! title\n! icon\nbody\n\na\n\\!!\n!!"
        );
    }
}