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

use std::fmt::Display;

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

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

/// # Collapsible
///
/// Starts with [CollapsibleStart](type@crate::lexer::TokenKind::CollapsibleStart).
///
/// [Title](Collapsible::title) every token except
/// [Terminator](type@crate::lexer::TokenKind::Terminator) between
/// [space](type@crate::lexer::TokenKind::Space) and [EOL](type@crate::lexer::TokenKind::Eol)
///
/// [Body](Collapsible::body) Every token until [CollapsibleEnd](type@crate::lexer::TokenKind::CollapsibleEnd),
/// nested collapsible are supported.
///
/// Example:
///
/// ```text
/// {% collapsible
/// ![alt](src)
/// %}
/// ```
///
/// HTML equivalent:
///
/// ```html
/// <div class="collapsible">
///     <input type="checkbox" id="{{ node.title }}" />
///     <label for="{{ node.title }}">Or collapsible</label>
///     <div class="body">
///         <img alt="alt" src="src" />
///     </div>
/// </div>
/// ```
#[derive(Debug, PartialEq, Clone, Eq)]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct Collapsible {
    pub title: String,
    pub body: Vec<YamdNodes>,
}

impl Collapsible {
    pub fn new<S: Into<String>>(title: S, body: Vec<YamdNodes>) -> Self {
        Self {
            body,
            title: title.into(),
        }
    }
}

impl Display for Collapsible {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "{{% {}\n{}\n%}}",
            self.title.replace("\\", "\\\\").replace("%}", "\\%}"),
            self.body
                .iter()
                .map(|node| match node {
                    YamdNodes::Paragraph(p) => escape_leading_block_marker(p.to_string()),
                    other => other.to_string(),
                })
                .collect::<Vec<_>>()
                .join("\n\n")
        )
    }
}

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

    use super::*;

    #[test]
    fn test_collapsible() {
        let collapsible = Collapsible::new(
            "Collapsible title",
            vec![YamdNodes::Paragraph(Paragraph::new(vec![
                "Collapsible body".to_string().into(),
            ]))],
        );
        assert_eq!(
            collapsible.to_string(),
            "{% Collapsible title\nCollapsible body\n%}"
        );
    }
}