eddacraft-tui 0.2.3

Shared Ratatui component library for the eddacraft product family
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

use ratatui::style::Color;

use super::traits::Theme;

/// The `eddacraft` Terminal Standard palette.
///
/// Colour names follow the brand design system:
/// - The Void (bg), Structure (border)
/// - Off-White (fg), Ghost Grey (muted)
/// - anvil Ember (accent), edda Growth (success)
/// - Brick Red (error), Dull Amber (warning)
pub struct EddaCraftTheme;

const VOID: Color = Color::Rgb(13, 13, 15);
const STRUCTURE: Color = Color::Rgb(42, 42, 46);
const OFF_WHITE: Color = Color::Rgb(235, 235, 235);
const GHOST_GREY: Color = Color::Rgb(133, 133, 138);
const ANVIL_EMBER: Color = Color::Rgb(204, 85, 0);
const EDDA_GROWTH: Color = Color::Rgb(46, 139, 87);
const BRICK_RED: Color = Color::Rgb(201, 74, 74);
const DULL_AMBER: Color = Color::Rgb(208, 140, 56);

impl Theme for EddaCraftTheme {
    fn bg(&self) -> Color {
        VOID
    }

    fn fg(&self) -> Color {
        OFF_WHITE
    }

    fn accent(&self) -> Color {
        ANVIL_EMBER
    }

    fn success(&self) -> Color {
        EDDA_GROWTH
    }

    fn error(&self) -> Color {
        BRICK_RED
    }

    fn warning(&self) -> Color {
        DULL_AMBER
    }

    fn muted(&self) -> Color {
        GHOST_GREY
    }

    fn border(&self) -> Color {
        STRUCTURE
    }
}

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

    #[test]
    fn theme_colours_are_distinct() {
        let theme = EddaCraftTheme;
        let colours = [
            theme.bg(),
            theme.fg(),
            theme.accent(),
            theme.success(),
            theme.error(),
            theme.warning(),
            theme.muted(),
            theme.border(),
        ];

        for (i, a) in colours.iter().enumerate() {
            for (j, b) in colours.iter().enumerate() {
                if i != j {
                    assert_ne!(a, b, "colour {i} and {j} should be distinct");
                }
            }
        }
    }

    #[test]
    fn base_style_uses_fg_and_bg() {
        let theme = EddaCraftTheme;
        let style = theme.base();
        assert_eq!(style.fg, Some(OFF_WHITE));
        assert_eq!(style.bg, Some(VOID));
    }

    #[test]
    fn role_style_resolves_each_variant() {
        use crate::theme::Role;
        let theme = EddaCraftTheme;
        for role in [
            Role::Primary,
            Role::Secondary,
            Role::Accent,
            Role::Highlight,
            Role::HighlightInactive,
            Role::Success,
            Role::Warning,
            Role::Error,
            Role::BorderSubtle,
            Role::BorderEmphasis,
        ] {
            let style = theme.role_style(role);
            assert!(
                style.fg.is_some() || style.bg.is_some(),
                "role {role:?} should resolve to a non-empty style"
            );
        }
    }

    #[test]
    fn role_style_matches_individual_methods() {
        use crate::theme::Role;
        let theme = EddaCraftTheme;
        assert_eq!(theme.role_style(Role::Primary), theme.base());
        assert_eq!(theme.role_style(Role::Highlight), theme.highlighted());
        assert_eq!(
            theme.role_style(Role::HighlightInactive),
            theme.highlight_inactive(),
        );
        assert_eq!(theme.role_style(Role::Error), theme.status_error());
        assert_eq!(
            theme.role_style(Role::BorderSubtle),
            theme.border_unfocused()
        );
    }
}