use-friend-markdown 0.1.0

Simple markdown rendering helpers for Fellow Friends fixture records
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

#![doc = include_str!("../README.md")]

//! Simple deterministic markdown rendering for Fellow Friends records.

use use_friend::Friend;

/// Markdown rendering helpers for Fellow Friends records.
pub struct FriendMarkdown;

impl FriendMarkdown {
    /// Renders one friend as a compact markdown card.
    #[must_use]
    pub fn card(friend: &Friend) -> String {
        let mut markdown = format!(
            "### {}\n\n- Ecosystem: {}\n- Technology kind: {}\n- Identity kind: {}\n- Figure: {}",
            friend.name,
            friend.ecosystem,
            friend.technology_kind,
            friend.identity_kind,
            friend.figure_kind
        );

        if let Some(form) = friend.form {
            markdown.push_str(&format!("\n- Form: {form}"));
        }

        markdown.push('\n');
        markdown
    }

    /// Renders friends as a simple markdown table.
    #[must_use]
    pub fn table(friends: &[Friend]) -> String {
        let mut markdown = String::from(
            "| Name | Ecosystem | Technology kind | Identity kind | Figure | Form |\n| --- | --- | --- | --- | --- | --- |\n",
        );

        for friend in friends {
            markdown.push_str(&format!(
                "| {} | {} | {} | {} | {} | {} |\n",
                friend.name,
                friend.ecosystem,
                friend.technology_kind,
                friend.identity_kind,
                friend.figure_kind,
                friend.form.unwrap_or("unknown")
            ));
        }

        markdown
    }

    /// Renders friends as a simple markdown list.
    #[must_use]
    pub fn list(friends: &[Friend]) -> String {
        let mut markdown = String::new();

        for friend in friends {
            markdown.push_str(&format!("- {} ({})\n", friend.name, friend.ecosystem));
        }

        markdown
    }
}

#[cfg(test)]
mod tests {
    use super::FriendMarkdown;
    use use_friend_fixture::FriendFixtures;

    #[test]
    fn renders_card_with_expected_lines() {
        let card = FriendMarkdown::card(&FriendFixtures::tiny()[0]);

        assert_eq!(
            card,
            "### Ferris\n\n- Ecosystem: Rust\n- Technology kind: Programming language\n- Identity kind: Unofficial mascot\n- Figure: Animal\n- Form: crab\n"
        );
    }

    #[test]
    fn renders_card_for_new_friend() {
        let duke = FriendFixtures::all()
            .iter()
            .find(|friend| friend.id == "java-duke")
            .expect("Duke should be in the fixture set");
        let card = FriendMarkdown::card(duke);

        assert_eq!(
            card,
            "### Duke\n\n- Ecosystem: Java\n- Technology kind: Programming language\n- Identity kind: Mascot\n- Figure: Creature\n- Form: creature\n"
        );
    }

    #[test]
    fn renders_deterministic_table() {
        let table = FriendMarkdown::table(FriendFixtures::tiny());

        assert!(table
            .starts_with("| Name | Ecosystem | Technology kind | Identity kind | Figure | Form |"));
        assert!(table.contains(
            "| Ferris | Rust | Programming language | Unofficial mascot | Animal | crab |"
        ));
        assert!(table.contains("| Tux | Linux | Operating system | Mascot | Animal | penguin |"));
    }

    #[test]
    fn renders_deterministic_list() {
        assert_eq!(
            FriendMarkdown::list(FriendFixtures::tiny()),
            "- Ferris (Rust)\n- Go Gopher (Go)\n- Tux (Linux)\n"
        );
    }
}