revue 2.71.1

A Vue-style TUI framework for Rust with CSS styling
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
//! Menu bar and context menu widgets
//!
//! Provides horizontal menu bars and dropdown/context menus.

#![allow(dead_code)]

mod context_menu;
mod helpers;
mod menu_bar;
mod types;

pub use context_menu::ContextMenu;
pub use helpers::{context_menu, menu, menu_bar, menu_item};
pub use menu_bar::MenuBar;
pub use types::{Menu, MenuItem};

// KEEP HERE - Private implementation tests (all tests access private fields: label, shortcut, disabled, title, items, menus, selected_menu, etc.)

#[cfg(test)]
mod tests {
    //! Tests for Menu widgets

    use super::context_menu::ContextMenu;
    use super::menu_bar::MenuBar;
    use super::types::{Menu, MenuItem};
    use crate::event::Key;
    use crate::layout::Rect;
    use crate::render::Buffer;
    use crate::style::Color;
    use crate::widget::traits::{RenderContext, View};

    #[test]
    fn test_menu_item() {
        let item = MenuItem::new("Open").shortcut("Ctrl+O").disabled(false);

        assert_eq!(item.label, "Open");
        assert_eq!(item.shortcut, Some("Ctrl+O".to_string()));
        assert!(!item.disabled);
    }

    #[test]
    fn test_menu() {
        let m = Menu::new("File")
            .item(MenuItem::new("New"))
            .item(MenuItem::new("Open"))
            .separator()
            .item(MenuItem::new("Exit"));

        assert_eq!(m.title, "File");
        assert_eq!(m.items.len(), 4);
        assert!(m.items[2].separator);
    }

    #[test]
    fn test_menu_bar() {
        let mut bar = MenuBar::new()
            .menu(Menu::new("File").item(MenuItem::new("New")))
            .menu(Menu::new("Edit").item(MenuItem::new("Copy")));

        assert_eq!(bar.menus.len(), 2);
        assert!(!bar.is_open());

        bar.open_menu(0);
        assert!(bar.is_open());

        bar.next_menu();
        assert_eq!(bar.selected_menu, 1);

        bar.close();
        assert!(!bar.is_open());
    }

    #[test]
    fn test_context_menu() {
        let mut menu = ContextMenu::new()
            .item(MenuItem::new("Cut"))
            .item(MenuItem::new("Copy"))
            .item(MenuItem::new("Paste"));

        assert!(!menu.is_visible());

        menu.show(10, 10);
        assert!(menu.is_visible());

        menu.handle_key(&Key::Down);
        assert_eq!(menu.selected, 1);

        menu.hide();
        assert!(!menu.is_visible());
    }

    #[test]
    fn test_menu_bar_render() {
        let mut buffer = Buffer::new(80, 24);
        let area = Rect::new(0, 0, 80, 24);
        let mut ctx = RenderContext::new(&mut buffer, area);

        let bar = MenuBar::new()
            .menu(Menu::new("File"))
            .menu(Menu::new("Edit"));

        bar.render(&mut ctx);
        // Smoke test
    }

    #[test]
    fn test_menu_item_checked() {
        let item = MenuItem::new("Toggle").checked(true);
        assert_eq!(item.checked, Some(true));

        let item2 = MenuItem::new("Toggle2").checked(false);
        assert_eq!(item2.checked, Some(false));
    }

    #[test]
    fn test_menu_item_submenu() {
        let item = MenuItem::new("Parent")
            .submenu(vec![MenuItem::new("Child 1"), MenuItem::new("Child 2")]);
        assert!(item.has_submenu());
        assert_eq!(item.submenu.len(), 2);
    }

    #[test]
    fn test_menu_item_has_submenu() {
        let item1 = MenuItem::new("No Submenu");
        assert!(!item1.has_submenu());

        let item2 = MenuItem::new("With Submenu").submenu(vec![MenuItem::new("Child")]);
        assert!(item2.has_submenu());
    }

    #[test]
    fn test_menu_item_on_select_and_execute() {
        use std::cell::Cell;
        use std::rc::Rc;

        let called = Rc::new(Cell::new(false));
        let called_clone = called.clone();

        let item = MenuItem::new("Action").on_select(move || {
            called_clone.set(true);
        });

        item.execute();
        assert!(called.get());
    }

    #[test]
    fn test_menu_item_execute_disabled() {
        use std::cell::Cell;
        use std::rc::Rc;

        let called = Rc::new(Cell::new(false));
        let called_clone = called.clone();

        let item = MenuItem::new("Disabled Action")
            .disabled(true)
            .on_select(move || {
                called_clone.set(true);
            });

        item.execute();
        assert!(!called.get()); // Should not be called
    }

    #[test]
    fn test_menu_items() {
        let m = Menu::new("Edit").items(vec![
            MenuItem::new("Cut"),
            MenuItem::new("Copy"),
            MenuItem::new("Paste"),
        ]);
        assert_eq!(m.items.len(), 3);
    }

    #[test]
    fn test_menu_bar_colors() {
        let bar = MenuBar::new().bg(Color::BLACK).fg(Color::WHITE);
        assert_eq!(bar.bg, Color::BLACK);
        assert_eq!(bar.fg, Color::WHITE);
    }

    #[test]
    fn test_menu_bar_toggle() {
        let mut bar = MenuBar::new().menu(Menu::new("File").item(MenuItem::new("New")));

        assert!(!bar.is_open());

        bar.toggle();
        assert!(bar.is_open());

        bar.toggle();
        assert!(!bar.is_open());
    }

    #[test]
    fn test_menu_bar_prev_menu() {
        let mut bar = MenuBar::new()
            .menu(Menu::new("File"))
            .menu(Menu::new("Edit"))
            .menu(Menu::new("View"));

        bar.selected_menu = 2;
        bar.prev_menu();
        assert_eq!(bar.selected_menu, 1);

        bar.prev_menu();
        assert_eq!(bar.selected_menu, 0);

        // Wrap around
        bar.prev_menu();
        assert_eq!(bar.selected_menu, 2);
    }

    #[test]
    fn test_menu_bar_next_prev_item() {
        let mut bar = MenuBar::new().menu(
            Menu::new("File")
                .item(MenuItem::new("New"))
                .item(MenuItem::new("Open"))
                .item(MenuItem::new("Save")),
        );

        bar.open_menu(0);
        assert_eq!(bar.selected_item, Some(0));

        bar.next_item();
        assert_eq!(bar.selected_item, Some(1));

        bar.next_item();
        assert_eq!(bar.selected_item, Some(2));

        // Wrap around
        bar.next_item();
        assert_eq!(bar.selected_item, Some(0));

        bar.prev_item();
        assert_eq!(bar.selected_item, Some(2));
    }

    #[test]
    fn test_menu_bar_skip_separators() {
        let mut bar = MenuBar::new().menu(
            Menu::new("File")
                .item(MenuItem::new("New"))
                .separator()
                .item(MenuItem::new("Exit")),
        );

        bar.open_menu(0);
        bar.next_item();
        // Should skip separator and go to Exit
        assert_eq!(bar.selected_item, Some(2));
    }

    #[test]
    fn test_menu_bar_execute_selected() {
        use std::cell::Cell;
        use std::rc::Rc;

        let called = Rc::new(Cell::new(false));
        let called_clone = called.clone();

        let mut bar = MenuBar::new().menu(Menu::new("File").item(
            MenuItem::new("Action").on_select(move || {
                called_clone.set(true);
            }),
        ));

        bar.open_menu(0);
        let result = bar.execute_selected();
        assert!(result);
        assert!(called.get());
        assert!(!bar.is_open()); // Menu should close after execution
    }

    #[test]
    fn test_menu_bar_handle_key() {
        let mut bar = MenuBar::new()
            .menu(Menu::new("File").item(MenuItem::new("New")))
            .menu(Menu::new("Edit").item(MenuItem::new("Copy")));

        // Left/Right navigation
        assert!(bar.handle_key(&Key::Right));
        assert_eq!(bar.selected_menu, 1);

        assert!(bar.handle_key(&Key::Left));
        assert_eq!(bar.selected_menu, 0);

        // Vim keys
        assert!(bar.handle_key(&Key::Char('l')));
        assert_eq!(bar.selected_menu, 1);

        assert!(bar.handle_key(&Key::Char('h')));
        assert_eq!(bar.selected_menu, 0);

        // Enter to open
        assert!(bar.handle_key(&Key::Enter));
        assert!(bar.is_open());

        // Up/Down when open
        assert!(bar.handle_key(&Key::Down));
        assert!(bar.handle_key(&Key::Char('j')));
        assert!(bar.handle_key(&Key::Up));
        assert!(bar.handle_key(&Key::Char('k')));

        // Escape to close
        assert!(bar.handle_key(&Key::Escape));
        assert!(!bar.is_open());

        // Space to toggle
        assert!(bar.handle_key(&Key::Char(' ')));
        assert!(bar.is_open());

        // Unknown key
        bar.close();
        assert!(!bar.handle_key(&Key::Char('x')));
    }

    #[test]
    fn test_menu_bar_default() {
        let bar = MenuBar::default();
        assert!(bar.menus.is_empty());
        assert!(!bar.is_open());
    }

    #[test]
    fn test_context_menu_navigation() {
        let mut menu = ContextMenu::new()
            .item(MenuItem::new("Cut"))
            .item(MenuItem::new("Copy"))
            .item(MenuItem::new("Paste"));

        menu.show(10, 10);

        // Navigate down
        menu.handle_key(&Key::Down);
        assert_eq!(menu.selected, 1);

        menu.handle_key(&Key::Char('j'));
        assert_eq!(menu.selected, 2);

        // Navigate up
        menu.handle_key(&Key::Up);
        assert_eq!(menu.selected, 1);

        menu.handle_key(&Key::Char('k'));
        assert_eq!(menu.selected, 0);
    }

    #[test]
    fn test_context_menu_boundary() {
        let mut menu = ContextMenu::new()
            .item(MenuItem::new("Item 1"))
            .item(MenuItem::new("Item 2"));

        menu.show(0, 0);

        // Move down to last item
        menu.handle_key(&Key::Down);
        assert_eq!(menu.selected, 1);

        // Should stay at boundary
        menu.handle_key(&Key::Down);
        assert_eq!(menu.selected, 1);

        // Move up to first
        menu.handle_key(&Key::Up);
        assert_eq!(menu.selected, 0);

        // Should stay at boundary
        menu.handle_key(&Key::Up);
        assert_eq!(menu.selected, 0);
    }

    #[test]
    fn test_context_menu_execute() {
        use std::cell::Cell;
        use std::rc::Rc;

        let called = Rc::new(Cell::new(false));
        let called_clone = called.clone();

        let mut menu = ContextMenu::new().item(MenuItem::new("Action").on_select(move || {
            called_clone.set(true);
        }));

        menu.show(0, 0);
        let result = menu.handle_key(&Key::Enter);
        assert!(result);
        assert!(called.get());
        assert!(!menu.is_visible());
    }

    #[test]
    fn test_context_menu_escape() {
        let mut menu = ContextMenu::new().item(MenuItem::new("Item"));

        menu.show(0, 0);
        assert!(menu.is_visible());

        menu.handle_key(&Key::Escape);
        assert!(!menu.is_visible());
    }

    #[test]
    fn test_context_menu_render() {
        let mut buffer = Buffer::new(40, 20);
        let area = Rect::new(0, 0, 40, 20);
        let mut ctx = RenderContext::new(&mut buffer, area);

        let mut menu = ContextMenu::new()
            .item(MenuItem::new("Cut").shortcut("Ctrl+X"))
            .item(MenuItem::new("Copy").shortcut("Ctrl+C"))
            .item(MenuItem::separator())
            .item(MenuItem::new("Paste").shortcut("Ctrl+V"));

        menu.show(5, 5);
        menu.render(&mut ctx);
    }

    #[test]
    fn test_menu_bar_render_open() {
        let mut buffer = Buffer::new(80, 24);
        let area = Rect::new(0, 0, 80, 24);
        let mut ctx = RenderContext::new(&mut buffer, area);

        let mut bar = MenuBar::new().menu(
            Menu::new("File")
                .item(MenuItem::new("New").shortcut("Ctrl+N"))
                .item(MenuItem::new("Open").shortcut("Ctrl+O"))
                .separator()
                .item(MenuItem::new("Exit")),
        );

        bar.open_menu(0);
        bar.render(&mut ctx);
    }

    #[test]
    fn test_menu_bar_empty() {
        let mut bar = MenuBar::new();

        // Should not panic on empty menu bar
        bar.next_menu();
        bar.prev_menu();
        bar.next_item();
        bar.prev_item();
        assert!(!bar.execute_selected());
    }

    #[test]
    fn test_context_menu_separator() {
        let menu = ContextMenu::new()
            .item(MenuItem::new("Cut"))
            .item(MenuItem::separator())
            .item(MenuItem::new("Paste"));

        assert_eq!(menu.items.len(), 3);
        assert!(menu.items[1].separator);
    }

    #[test]
    fn test_context_menu_default_colors() {
        let menu = ContextMenu::new();
        // Default colors are set
        assert_eq!(menu.bg, Color::rgb(40, 40, 40));
        assert_eq!(menu.fg, Color::WHITE);
    }

    #[test]
    fn test_menu_bar_open_menu_with_items() {
        let mut bar = MenuBar::new()
            .menu(Menu::new("File").item(MenuItem::new("New")))
            .menu(Menu::new("Empty"));

        bar.open_menu(0);
        assert_eq!(bar.selected_item, Some(0));

        bar.open_menu(1);
        assert_eq!(bar.selected_item, None); // Empty menu
    }

    #[test]
    fn test_menu_bar_open_out_of_bounds() {
        let mut bar = MenuBar::new().menu(Menu::new("File"));

        bar.open_menu(10); // Out of bounds
        assert!(!bar.is_open());
    }
}