envision 0.15.1

A ratatui framework for collaborative TUI development with headless testing support
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

use super::*;
use ratatui::widgets::Paragraph;

// Test component implementation
struct TestCounter;

#[derive(Clone, Default)]
struct TestCounterState {
    value: i32,
    visible: bool,
}

#[derive(Clone)]
enum TestCounterMsg {
    Increment,
    Decrement,
}

#[derive(Clone, PartialEq, Debug)]
enum TestCounterOutput {
    Changed(i32),
}

impl Component for TestCounter {
    type State = TestCounterState;
    type Message = TestCounterMsg;
    type Output = TestCounterOutput;

    fn init() -> Self::State {
        TestCounterState {
            value: 0,
            visible: true,
        }
    }

    fn update(state: &mut Self::State, msg: Self::Message) -> Option<Self::Output> {
        match msg {
            TestCounterMsg::Increment => state.value += 1,
            TestCounterMsg::Decrement => state.value -= 1,
        }
        Some(TestCounterOutput::Changed(state.value))
    }

    fn view(state: &Self::State, ctx: &mut RenderContext<'_, '_>) {
        let text = format!("Count: {}", state.value);
        ctx.frame.render_widget(Paragraph::new(text), ctx.area);
    }
}

impl Toggleable for TestCounter {
    fn is_visible(state: &Self::State) -> bool {
        state.visible
    }

    fn set_visible(state: &mut Self::State, visible: bool) {
        state.visible = visible;
    }
}

// Component trait tests

#[test]
fn test_component_init() {
    let state = TestCounter::init();
    assert_eq!(state.value, 0);
    assert!(state.visible);
}

#[test]
fn test_component_update() {
    let mut state = TestCounter::init();

    let output = TestCounter::update(&mut state, TestCounterMsg::Increment);
    assert_eq!(state.value, 1);
    assert_eq!(output, Some(TestCounterOutput::Changed(1)));

    let output = TestCounter::update(&mut state, TestCounterMsg::Increment);
    assert_eq!(state.value, 2);
    assert_eq!(output, Some(TestCounterOutput::Changed(2)));

    let output = TestCounter::update(&mut state, TestCounterMsg::Decrement);
    assert_eq!(state.value, 1);
    assert_eq!(output, Some(TestCounterOutput::Changed(1)));
}

#[test]
fn test_component_view() {
    let state = TestCounter::init();
    let (mut terminal, theme) = crate::component::test_utils::setup_render(80, 24);

    terminal
        .draw(|frame| {
            TestCounter::view(&state, &mut RenderContext::new(frame, frame.area(), &theme));
        })
        .unwrap();

    let text = terminal.backend().to_string();
    assert!(text.contains("Count: 0"));
}

// Toggleable trait tests

#[test]
fn test_toggleable_is_visible() {
    let state = TestCounter::init();
    assert!(TestCounter::is_visible(&state));
}

#[test]
fn test_toggleable_set_visible() {
    let mut state = TestCounter::init();

    TestCounter::set_visible(&mut state, false);
    assert!(!TestCounter::is_visible(&state));

    TestCounter::set_visible(&mut state, true);
    assert!(TestCounter::is_visible(&state));
}

#[test]
fn test_toggleable_toggle() {
    let mut state = TestCounter::init();
    assert!(TestCounter::is_visible(&state));

    TestCounter::toggle(&mut state);
    assert!(!TestCounter::is_visible(&state));

    TestCounter::toggle(&mut state);
    assert!(TestCounter::is_visible(&state));
}

#[test]
fn test_toggleable_show_hide() {
    let mut state = TestCounter::init();

    TestCounter::hide(&mut state);
    assert!(!TestCounter::is_visible(&state));

    TestCounter::show(&mut state);
    assert!(TestCounter::is_visible(&state));
}