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

use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use ratatui::style::Style;
use ratatui::text::{Line, Span};
use ratatui::widgets::Widget;

use crate::theme::Theme;

#[derive(Debug, Clone, Copy)]
#[non_exhaustive]
pub enum BadgeStatus {
    Success,
    Error,
    Warning,
    Info,
    Running,
    Skipped,
}

impl BadgeStatus {
    /// Resolve the severity to a [`Style`] using the supplied theme. Shared
    /// between widgets that surface badge status (currently `Modal` and
    /// `Toast`) so the mapping stays in one place.
    #[must_use]
    pub fn severity_style<T: Theme>(self, theme: &T) -> Style {
        match self {
            Self::Success => theme.status_ok(),
            Self::Error => theme.status_error(),
            Self::Warning => theme.status_warning(),
            Self::Info | Self::Running => theme.title(),
            Self::Skipped => theme.disabled(),
        }
    }
}

pub struct StatusBadge<'a, T: Theme> {
    theme: &'a T,
    status: BadgeStatus,
    label: Option<&'a str>,
}

impl<'a, T: Theme> StatusBadge<'a, T> {
    pub fn new(status: BadgeStatus, theme: &'a T) -> Self {
        Self {
            theme,
            status,
            label: None,
        }
    }

    #[must_use]
    pub fn label(mut self, label: &'a str) -> Self {
        self.label = label.into();
        self
    }

    fn status_config(&self) -> (char, Style, &'a str) {
        match self.status {
            BadgeStatus::Success => ('◆', self.theme.status_ok(), "Passed"),
            BadgeStatus::Error => ('✖', self.theme.status_error(), "Failed"),
            BadgeStatus::Warning => ('◈', self.theme.status_warning(), "Warning"),
            BadgeStatus::Info => ('◇', self.theme.disabled(), "Info"),
            BadgeStatus::Running => ('●', self.theme.title(), "Running"),
            BadgeStatus::Skipped => ('○', self.theme.disabled(), "Skipped"),
        }
    }
}

impl<T: Theme> Widget for StatusBadge<'_, T> {
    fn render(self, area: Rect, buf: &mut Buffer) {
        if area.height == 0 || area.width == 0 {
            return;
        }

        let (icon, style, default_label) = self.status_config();
        let label = self.label.unwrap_or(default_label);

        let line = Line::from(vec![
            Span::styled(icon.to_string(), style),
            Span::raw(" "),
            Span::styled(label, style),
        ]);
        line.render(Rect::new(area.x, area.y, area.width, 1), buf);
    }
}

#[cfg(test)]
mod tests {
    use ratatui::widgets::Widget;

    use super::*;
    use crate::theme::EddaCraftTheme;

    fn icon_for(status: BadgeStatus) -> String {
        let theme = EddaCraftTheme;
        let mut buf = Buffer::empty(Rect::new(0, 0, 12, 1));
        StatusBadge::new(status, &theme).render(Rect::new(0, 0, 12, 1), &mut buf);
        buf[(0, 0)].symbol().to_string()
    }

    #[test]
    fn renders_expected_icons_for_positive_statuses() {
        assert_eq!(icon_for(BadgeStatus::Success), "◆");
        assert_eq!(icon_for(BadgeStatus::Info), "◇");
        assert_eq!(icon_for(BadgeStatus::Running), "●");
    }

    #[test]
    fn renders_expected_icons_for_other_statuses() {
        assert_eq!(icon_for(BadgeStatus::Error), "✖");
        assert_eq!(icon_for(BadgeStatus::Warning), "◈");
        assert_eq!(icon_for(BadgeStatus::Skipped), "○");
    }
}