term_tools 0.1.0

Colorize Your Terminal with Term-Tools: A Rust-powered Formatting Tool
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

/// A module for working with styles and colors.
///
/// This module provides a set of types and traits for representing
///  different styles and colors,
/// as well as a way to generate styles based on a given paint type.

// =======================================================================

use basic_color::BasicColor;
use formatter::Formatter;
use paint_type::PaintType;
use palette::PaletteColor;
use rgb::Rgb;

// =======================================================================
pub mod paint_type;
pub mod formatter;
pub mod basic_color;
pub mod rgb;
pub mod palette;

// =======================================================================

/// An enum representing different styles.
///
/// This enum has five variants, each representing a different type of style:
/// `StyleRgb`, `StyleBasicColor`, `StylePaletteColor`, `StylePaintType`, and `StyleFormatter`.
#[derive(Debug, Clone)]
pub enum Styles {
    /// A style represented by an RGB color.
    StyleRgb(Rgb),
    /// A style represented by a basic color.
    StyleBasicColor(BasicColor),
    /// A style represented by a palette color.
    StylePaletteColor(PaletteColor),
    /// A style represented by a paint type.
    StylePaintType(PaintType),
    /// A style represented by a formatter.
    StyleFormatter(Formatter),
}

impl Styles {
    /// Generates String styles based on the given paint type.
    ///
    /// This method takes an optional `paint_type` parameter, which is used to determine the styles to generate.
    /// It returns a string representing the generated styles.
    pub fn make_styles(&self, paint_type: Option<&PaintType>) -> String {
        match self {
            Styles::StyleBasicColor(c) => c.make_styles(paint_type),
            Styles::StylePaintType(c) => c.make_styles(paint_type),
            Styles::StylePaletteColor(c) => c.make_styles(paint_type),
            Styles::StyleRgb(c) => c.make_styles(paint_type),
            Styles::StyleFormatter(c) => c.make_styles(paint_type),
        }
    }
}

/// A trait for types that can generate styles based on a given paint type.
pub trait Stylify {
    /// Generates String styles based on the given paint type.
    ///
    /// This method takes an optional `paint_type` parameter, which is used to determine the styles to generate.
    /// It returns a string representing the generated styles.
    fn make_styles(&self, paint_type: Option<&PaintType>) -> String;
}

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

    #[test]
    fn test_make_styles() {
        let style = Styles::StyleRgb(Rgb { r: 255, g: 0, b: 0 });
        let styles_default = style.make_styles(None);
        let styles_fg = style.make_styles(Some(&PaintType::FG));
        let styles_bg = style.make_styles(Some(&PaintType::BG));
        assert_eq!(styles_default, "38;2;255;0;0");
        assert_eq!(styles_fg, "38;2;255;0;0");
        assert_eq!(styles_bg, "48;2;255;0;0");

        //
        let style = Styles::StyleBasicColor(BasicColor { fg: 34, bg: 44 });
        let styles_default = style.make_styles(None);
        let styles_fg = style.make_styles(Some(&PaintType::FG));
        let styles_bg = style.make_styles(Some(&PaintType::BG));
        assert_eq!(styles_default, "34");
        assert_eq!(styles_fg, "34");
        assert_eq!(styles_bg, "44");

        //
        let style = Styles::StylePaletteColor(PaletteColor { index: 44 });
        let styles_default = style.make_styles(None);
        let styles_fg = style.make_styles(Some(&PaintType::FG));
        let styles_bg = style.make_styles(Some(&PaintType::BG));
        assert_eq!(styles_default, "38;5;44");
        assert_eq!(styles_fg, "38;5;44");
        assert_eq!(styles_bg, "48;5;44");

        //
        let style = Styles::StylePaintType(PaintType::BG);
        let styles_default = style.make_styles(None);
        let styles_fg = style.make_styles(Some(&PaintType::FG));
        let styles_bg = style.make_styles(Some(&PaintType::BG));
        assert_eq!(styles_default, "");
        assert_eq!(styles_fg, "");
        assert_eq!(styles_bg, "");

        //
        let style = Styles::StyleFormatter(Formatter { code: 3 });
        let styles_default = style.make_styles(None);
        let styles_fg = style.make_styles(Some(&PaintType::FG));
        let styles_bg = style.make_styles(Some(&PaintType::BG));
        assert_eq!(styles_default, "3");
        assert_eq!(styles_fg, "3");
        assert_eq!(styles_bg, "3");
    }
}