rig-tui 0.45.0

A rig-harness plugin: the terminal view, with panels and tool renderers other plugins add to.
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

use super::*;

#[test]
fn every_band_is_its_own_color_on_dark_and_light_terminals() {
    for background in [DARK, (0xfa, 0xfa, 0xfa)] {
        for truecolor in [true, false] {
            let theme = Theme::on(background, truecolor);
            let bands = [
                theme.user,
                theme.tool,
                theme.added,
                theme.added_word,
                theme.removed,
                theme.removed_word,
                theme.selected,
                theme.panel_surface,
                theme.raised_surface,
                theme.call_waiting,
                theme.call_running,
                theme.call_done,
                theme.call_failed,
                theme.input,
                theme.code,
                theme.note,
                theme.important,
            ];
            let mut distinct = bands.to_vec();
            distinct.sort_by_key(|color| format!("{color:?}"));
            distinct.dedup();
            assert_eq!(distinct.len(), bands.len(), "{theme:?}");
        }
    }
}

#[test]
fn a_band_is_a_tint_of_the_background() {
    let Color::Rgb(r, g, b) = Theme::on((0, 0, 0), true).tool else {
        return;
    };
    assert!(r < 40 && g < 40 && b < 40, "{r} {g} {b}");
    let Color::Rgb(r, g, b) = Theme::on((0xff, 0xff, 0xff), true).tool else {
        return;
    };
    assert!(r > 215 && g > 215 && b > 215, "{r} {g} {b}");
}

#[test]
fn a_surface_leaves_what_a_border_would() {
    let area = ratatui::layout::Rect::new(0, 0, 20, 10);
    let bordered = Block::bordered().inner(area);
    let theme = Theme::default();
    assert_eq!(theme.panel("files").inner(area), bordered);
    assert_eq!(theme.raised("").inner(area), bordered);
}

#[test]
fn a_plain_theme_marks_with_reverse_and_underline_instead_of_tints() {
    use ratatui::style::Modifier;

    let theme = Theme::default();
    assert_eq!(theme.selection().bg, Some(theme.selected));
    let plain = theme.without_color();
    assert!(plain.selection().add_modifier.contains(Modifier::REVERSED));
    assert_eq!(plain.selection().bg, None);
    let word = plain.changed_word(plain.added_word);
    assert!(word.add_modifier.contains(Modifier::UNDERLINED));
}

/// WCAG's relative luminance of `rgb`.
fn luminance((r, g, b): Rgb) -> f64 {
    let channel = |value: u8| {
        let value = f64::from(value) / 255.0;
        match value <= 0.039_28 {
            true => value / 12.92,
            false => ((value + 0.055) / 1.055).powf(2.4),
        }
    };
    0.2126 * channel(r) + 0.7152 * channel(g) + 0.0722 * channel(b)
}

/// WCAG's contrast ratio of `a` and `b`, from 1 to 21.
fn contrast(a: Rgb, b: Rgb) -> f64 {
    let (a, b) = (luminance(a), luminance(b));
    (a.max(b) + 0.05) / (a.min(b) + 0.05)
}

#[test]
fn text_reads_on_every_tint_of_dark_and_light_terminals() {
    let backgrounds = [
        DARK,
        (0, 0, 0),
        (0x28, 0x2c, 0x34),
        (0xfa, 0xfa, 0xfa),
        (0xff, 0xff, 0xff),
        (0xfd, 0xf6, 0xe3),
    ];
    for background in backgrounds {
        let theme = Theme::on(background, true);
        let toward = match lightness(background) < 0.5 {
            true => (0xff, 0xff, 0xff),
            false => (0, 0, 0),
        };
        // A terminal's own foreground: most of the way from its background.
        let text = mix(background, toward, 0.8);
        let tints = [
            theme.user,
            theme.tool,
            theme.added,
            theme.added_word,
            theme.removed,
            theme.removed_word,
            theme.selected,
            theme.panel_surface,
            theme.raised_surface,
            theme.input,
            theme.call_waiting,
            theme.call_running,
            theme.call_done,
            theme.call_failed,
            theme.code,
            theme.note,
            theme.important,
        ];
        for tint in tints {
            let Color::Rgb(r, g, b) = tint else {
                continue;
            };
            let ratio = contrast(text, (r, g, b));
            assert!(
                ratio >= 4.5,
                "{background:?}: {text:?} on {tint:?} is {ratio:.2}"
            );
        }
    }
}

#[test]
fn a_shade_leans_from_the_background_toward_the_far_lightness() {
    let level = |color: Color| match color {
        Color::Rgb(r, _, _) => i32::from(r),
        _ => -1,
    };
    let dark = Theme::on(DARK, true);
    assert!(level(dark.shade(0.2)) < level(dark.shade(0.8)));
    let light = Theme::on((0xfa, 0xfa, 0xfa), true);
    assert!(level(light.shade(0.2)) > level(light.shade(0.8)));
    let indexed = Theme::on(DARK, false).shade(0.85);
    assert!(matches!(indexed, Color::Indexed(232..=255)), "{indexed:?}");
}