markdown-builder 1.0.0

Opinionated Rust crate for programmatically building markdown documents
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

use crate::traits::{AsFooter, MarkdownElement};
use std::fmt;

/// A markdown link.
#[derive(Clone, Debug, Default)]
pub struct Link {
    /// The url of the link.
    pub url: String,
    /// The text of the link.
    pub text: String,
    /// Whether the `Link`'s url should be rendered as a footer.
    pub footer: bool,
    /// Whether the link should be inlined (no new line).
    pub inlined: bool,
}

impl Link {
    /// Creates a new default `Link`.
    pub fn new() -> Self {
        Self::default()
    }

    /// Creates a new `Link` with the given values.
    pub fn from(
        url: impl Into<String>,
        text: impl Into<String>,
        footer: bool,
        inlined: bool,
    ) -> Self {
        Self {
            url: url.into(),
            text: text.into(),
            footer,
            inlined,
        }
    }
}

impl AsFooter for Link {
    fn as_footer(&self) -> Box<dyn MarkdownElement> {
        Box::new(format!("[{}]: {}", self.text, self.url))
    }
}

impl fmt::Display for Link {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let text = if self.footer {
            format!("[{}][{}]", self.text, self.text)
        } else {
            format!("[{}]({})", self.text, self.url)
        };

        if self.inlined {
            write!(f, "{}", text)
        } else {
            writeln!(f, "{}", text)
        }
    }
}

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

    #[test]
    fn test_link_default() {
        let link = Link::new();
        assert_eq!(link.url, "");
        assert_eq!(link.text, "");
        assert_eq!(link.footer, false);
        assert_eq!(link.inlined, false);
    }

    #[test]
    fn test_link_from() {
        let link = Link::from("https://example.com", "example.com", false, true);
        assert_eq!(link.url, "https://example.com");
        assert_eq!(link.text, "example.com");
        assert_eq!(link.footer, false);
        assert_eq!(link.inlined, true);
    }

    #[test]
    fn test_link_url_text() {
        assert_eq!(
            Link::from("https://example.com", "example.com", false, false).render(),
            "[example.com](https://example.com)\n"
        );
    }

    #[test]
    fn test_link_url_text_inline() {
        assert_eq!(
            Link::from("https://example.com", "example.com", false, true).render(),
            "[example.com](https://example.com)"
        );
    }

    #[test]
    fn test_link_url_text_footer() {
        let link = Link::from("https://example.com", "example.com", true, false);

        assert_eq!(link.render(), "[example.com][example.com]\n");
        assert_eq!(
            link.as_footer().render(),
            "[example.com]: https://example.com"
        )
    }
}