tui-journal 0.17.0

Tui app allows writing and managing journals/notes from within the terminal With different local back-ends
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

use ratatui::style::{Color, Modifier, Style as RataStyle};
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Copy, Eq, PartialEq, Serialize, Deserialize, Default)]
/// Represents the style elements as they defined in [`ratatui`] lib but with more simple
/// definitions for serialization so it's less confusing for users to define in custom themes.
pub struct Style {
    pub fg: Option<Color>,
    pub bg: Option<Color>,
    #[serde(default)]
    pub modifiers: Modifier,
    pub underline_color: Option<Color>,
}

impl From<Style> for RataStyle {
    fn from(style: Style) -> Self {
        let mut rata_style = RataStyle {
            bg: style.bg,
            fg: style.fg,
            underline_color: style.underline_color,
            add_modifier: Modifier::empty(),
            sub_modifier: Modifier::all(),
        };

        // Modifiers needed to be added via this method to be involved in both add and sub modifier
        rata_style = rata_style.add_modifier(style.modifiers);
        rata_style
    }
}

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

    #[test]
    fn serialize_style_json() {
        let style_json = r##"{
  "fg": "LightCyan",
  "bg": "#4F11BA",
  "modifiers": "DIM | UNDERLINED",
  "underline_color": "#0A1432"
}"##;

        let style = Style {
            fg: Some(Color::LightCyan),
            bg: Some(Color::from_u32(0x004F11BA)),
            underline_color: Some(Color::Rgb(10, 20, 50)),
            modifiers: Modifier::UNDERLINED | Modifier::DIM,
        };

        let serialized = serde_json::from_str(style_json).unwrap();
        assert_eq!(style, serialized);
    }

    #[test]
    fn serialize_style_toml() {
        let style_toml = r##"
fg = "LightCyan"
bg = "#4F11BA"
modifiers = ""
underline_color = "#0A1432"
"##;

        let style = Style {
            fg: Some(Color::LightCyan),
            bg: Some(Color::from_u32(0x004F11BA)),
            underline_color: Some(Color::Rgb(10, 20, 50)),
            modifiers: Modifier::empty(),
        };

        let serialized = toml::from_str(style_toml).unwrap();
        assert_eq!(style, serialized);
    }

    #[test]
    fn serialized_style_missing() {
        let style_toml = r##"
fg = "LightCyan"
bg = "#4F11BA"
"##;

        let style = Style {
            fg: Some(Color::LightCyan),
            bg: Some(Color::from_u32(0x004F11BA)),
            underline_color: None,
            modifiers: Modifier::empty(),
        };

        let serialized = toml::from_str(style_toml).unwrap();

        assert_eq!(style, serialized);
    }

    #[test]
    fn convert_to_ratatui_style() {
        let style = Style {
            fg: Some(Color::Yellow),
            bg: Some(Color::Blue),
            modifiers: Modifier::BOLD | Modifier::UNDERLINED,
            underline_color: Some(Color::Red),
        };

        let rata_style: RataStyle = style.into();

        assert_eq!(rata_style.fg, Some(Color::Yellow));
        assert_eq!(rata_style.bg, Some(Color::Blue));
        assert_eq!(rata_style.underline_color, Some(Color::Red));
        assert_eq!(
            rata_style.add_modifier,
            Modifier::BOLD | Modifier::UNDERLINED
        );
    }
}