markterm 0.3.1

A rust library to render colored markdown to the terminal.
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
149

/// A simple struct to represent the color in the RGB format.
pub struct Color {
    /// A number between 0 and 255 which represents Red spectrum.
    pub r: u8,
    /// A number between 0 and 255 which represents Green spectrum.
    pub g: u8,
    /// A number between 0 and 255 which represents Blue spectrum.
    pub b: u8,
}

impl Color {
    /// Creates a new instance of Color with the hex code
    /// ```rust
    /// use markterm::Color;
    /// let white = Color::new("#FFF");
    /// assert_eq!(white.r, 255)
    /// ```
    pub fn new(hex_color: &str) -> Self {
        let mut color_code = hex_color.to_string();

        color_code.retain(|c| !r#"#"#.contains(c));

        if color_code.len() == 3 {
            let r = format!("{}{}", &color_code[0..1], &color_code[0..1]);
            let g = format!("{}{}", &color_code[1..2], &color_code[1..2]);
            let b = format!("{}{}", &color_code[2..3], &color_code[2..3]);

            let r = u8::from_str_radix(&r, 16);
            let g = u8::from_str_radix(&g, 16);
            let b = u8::from_str_radix(&b, 16);

            let (r, g, b) = match (r, g, b) {
                (Ok(r_val), Ok(g_val), Ok(b_val)) => (r_val, g_val, b_val),
                _ => {
                    panic!("Invalid Hex color code {hex_color}");
                }
            };

            Self { r, g, b }
        } else if color_code.len() == 6 {
            let r = u8::from_str_radix(&color_code[0..2], 16);
            let g = u8::from_str_radix(&color_code[2..4], 16);
            let b = u8::from_str_radix(&color_code[4..6], 16);

            let (r, g, b) = match (r, g, b) {
                (Ok(r), Ok(g), Ok(b)) => (r, g, b),
                _ => {
                    panic!("Invalid Hex color code {hex_color}");
                }
            };

            Self { r, g, b }
        } else {
            panic!("Invalid length of codes");
        }
    }

    /// Returns a semicolon delimited rgb value
    /// ### Example
    /// ```rust
    /// use markterm::Color;
    ///
    /// let white = Color::new("#FFF");
    /// assert_eq!("255;255;255", white.rgb());
    /// ```
    pub fn rgb(&self) -> String {
        format!("{};{};{}", &self.r, &self.g, &self.b)
    }
}

#[cfg(test)]
mod tests {
    use super::super::*;
    macro_rules! invalid_input_tests {
        ($($name:ident: $value:expr,)*) => {
        $(
            #[test]
            #[should_panic]
            fn $name() {
                let _color = Color::new($value);
            }
        )*
        }
    }

    macro_rules! valid_input_tests {
        ($($name:ident: $value:expr,)*) => {
        $(
            #[test]
            fn $name() {
                let _color = Color::new($value);
                // No Panic
            }
        )*
        }
    }

    macro_rules! conversion_test {
        ($($name:ident: $value:expr,)*) => {
            $(
                #[test]
                fn $name() {
                    let (input, r, g, b) = $value;
                    let color = Color::new(input);

                    assert_eq!(color.r, r);
                    assert_eq!(color.g, g);
                    assert_eq!(color.b, b);
                }
            )*
        }
    }

    conversion_test! {
        should_convert_000000_to_black: ("#000000", 0, 0, 0),
        should_convert_000_to_black: ("#000", 0, 0, 0),
        should_convert_ffffff_to_white: ("#FFFFFF", 255, 255, 255),
        should_convert_fff_to_white: ("#FFF", 255, 255, 255),
        should_convert_f00_to_red: ("#F00", 255, 0, 0),
        should_convert_ff0000_to_red: ("#FF0000", 255, 0, 0),
        should_convert_f00_to_green: ("#0F0", 0, 255, 0),
        should_convert_ff0000_to_green: ("#00FF00", 0, 255, 0),
        should_convert_f00_to_blue: ("#00F", 0, 0, 255),
        should_convert_ff0000_to_blue: ("#0000FF", 0, 0, 255),
    }

    invalid_input_tests! {
        input_codes_cannot_be_1_characters: "0",
        input_codes_cannot_be_1_characters_with_hash: "#0",
        input_codes_cannot_be_2_characters: "00",
        input_codes_cannot_be_2_characters_with_hash: "#00",
        input_codes_cannot_be_4_characters: "0000",
        input_codes_cannot_be_4_characters_with_hash: "#0000",
        input_codes_cannot_be_5_characters: "00000",
        input_codes_cannot_be_5_characters_with_hash: "#00000",
        input_codes_cannot_be_7_characters: "0000000",
        input_codes_cannot_be_7_characters_with_hash: "#0000000",
        should_fail_for_invalid_rgb_code_in_red: "#GG0011",
        should_fail_for_invalid_rgb_code_in_green: "#00GG11",
        should_fail_for_invalid_rgb_code_in_blue: "#00AAZZ",
    }

    valid_input_tests! {
        input_codes_can_be_3_digits: "000",
        input_codes_can_be_3_digits_with_hash: "#000",
        input_codes_can_be_6_digits: "000000",
        input_codes_can_be_6_digits_with_hash: "#000000",
    }
}