envision 0.16.0

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
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
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
use super::*;
use crate::component::test_utils;

fn sample_state() -> LogViewerState {
    let mut state = LogViewerState::new();
    state.push_info("Server started");
    state.push_success("Connected to database");
    state.push_warning("Disk space low");
    state.push_error("Connection timeout");
    state
}

fn focused_state() -> LogViewerState {
    sample_state()
}

// =============================================================================
// Follow mode
// =============================================================================

#[test]
fn test_default_follow_enabled() {
    let state = LogViewerState::new();
    assert!(state.follow());
}

#[test]
fn test_with_follow_builder() {
    let state = LogViewerState::new().with_follow(false);
    assert!(!state.follow());
}

#[test]
fn test_set_follow() {
    let mut state = LogViewerState::new();
    state.set_follow(false);
    assert!(!state.follow());
    state.set_follow(true);
    assert!(state.follow());
}

#[test]
fn test_toggle_follow() {
    let mut state = focused_state();
    assert!(state.follow());

    let output = LogViewer::update(&mut state, LogViewerMessage::ToggleFollow);
    assert!(!state.follow());
    assert_eq!(output, Some(LogViewerOutput::FollowToggled(false)));

    let output = LogViewer::update(&mut state, LogViewerMessage::ToggleFollow);
    assert!(state.follow());
    assert_eq!(output, Some(LogViewerOutput::FollowToggled(true)));
}

#[test]
fn test_follow_key_binding() {
    let state = focused_state();
    assert_eq!(
        LogViewer::handle_event(
            &state,
            &Event::char('f'),
            &EventContext::new().focused(true)
        ),
        Some(LogViewerMessage::ToggleFollow)
    );
}

#[test]
fn test_scroll_disables_follow() {
    let mut state = focused_state();
    assert!(state.follow());

    LogViewer::update(&mut state, LogViewerMessage::ScrollDown);
    assert!(!state.follow());
}

#[test]
fn test_scroll_up_disables_follow() {
    let mut state = focused_state();
    LogViewer::update(&mut state, LogViewerMessage::ScrollDown);
    LogViewer::update(&mut state, LogViewerMessage::ScrollDown);
    state.set_follow(true);

    LogViewer::update(&mut state, LogViewerMessage::ScrollUp);
    assert!(!state.follow());
}

#[test]
fn test_follow_auto_scroll_on_push() {
    let mut state = focused_state();
    // Scroll away from top
    LogViewer::update(&mut state, LogViewerMessage::ScrollDown);
    LogViewer::update(&mut state, LogViewerMessage::ScrollDown);
    assert_eq!(state.scroll_offset(), 2);

    // Re-enable follow
    state.set_follow(true);

    // Push new entry should auto-scroll to offset 0 (newest)
    LogViewer::update(
        &mut state,
        LogViewerMessage::Push {
            message: "new entry".into(),
            level: StatusLogLevel::Info,
            timestamp: None,
        },
    );
    assert_eq!(state.scroll_offset(), 0);
}

#[test]
fn test_no_auto_scroll_without_follow() {
    let mut state = focused_state();
    state.set_follow(false);

    // Scroll away from top
    LogViewer::update(&mut state, LogViewerMessage::ScrollDown);
    LogViewer::update(&mut state, LogViewerMessage::ScrollDown);
    let offset = state.scroll_offset();

    // Push new entry should not change scroll
    LogViewer::update(
        &mut state,
        LogViewerMessage::Push {
            message: "new entry".into(),
            level: StatusLogLevel::Info,
            timestamp: None,
        },
    );
    assert_eq!(state.scroll_offset(), offset);
}

#[test]
fn test_toggle_follow_on_scrolls_to_top() {
    let mut state = focused_state();
    // Scroll away and disable follow
    LogViewer::update(&mut state, LogViewerMessage::ScrollDown);
    LogViewer::update(&mut state, LogViewerMessage::ScrollDown);
    assert!(!state.follow());
    assert!(state.scroll_offset() > 0);

    // Toggle follow back on should scroll to top (newest)
    LogViewer::update(&mut state, LogViewerMessage::ToggleFollow);
    assert!(state.follow());
    assert_eq!(state.scroll_offset(), 0);
}

// =============================================================================
// Regex search
// =============================================================================

#[test]
fn test_default_regex_disabled() {
    let state = LogViewerState::new();
    assert!(!state.use_regex());
}

#[test]
fn test_with_use_regex_builder() {
    let state = LogViewerState::new().with_use_regex(true);
    assert!(state.use_regex());
}

#[test]
fn test_set_use_regex() {
    let mut state = LogViewerState::new();
    state.set_use_regex(true);
    assert!(state.use_regex());
    state.set_use_regex(false);
    assert!(!state.use_regex());
}

#[test]
fn test_toggle_regex() {
    let mut state = focused_state();
    assert!(!state.use_regex());

    let output = LogViewer::update(&mut state, LogViewerMessage::ToggleRegex);
    assert!(state.use_regex());
    assert_eq!(output, Some(LogViewerOutput::RegexToggled(true)));

    let output = LogViewer::update(&mut state, LogViewerMessage::ToggleRegex);
    assert!(!state.use_regex());
    assert_eq!(output, Some(LogViewerOutput::RegexToggled(false)));
}

#[test]
fn test_toggle_regex_key_binding() {
    let mut state = focused_state();
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    assert_eq!(
        LogViewer::handle_event(
            &state,
            &Event::ctrl('r'),
            &EventContext::new().focused(true)
        ),
        Some(LogViewerMessage::ToggleRegex)
    );
}

#[test]
fn test_toggle_regex_resets_scroll() {
    let mut state = focused_state();
    LogViewer::update(&mut state, LogViewerMessage::ScrollDown);
    LogViewer::update(&mut state, LogViewerMessage::ScrollDown);
    LogViewer::update(&mut state, LogViewerMessage::ToggleRegex);
    assert_eq!(state.scroll_offset(), 0);
}

#[cfg(feature = "regex")]
#[test]
fn test_regex_search_basic() {
    let mut state = focused_state();
    state.set_use_regex(true);

    // Search with regex pattern: "^Con" should match entries starting with "Con"
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "^Con".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }

    let visible = state.visible_entries();
    // "Connected to database" and "Connection timeout" match "^Con"
    assert_eq!(visible.len(), 2);
}

#[cfg(feature = "regex")]
#[test]
fn test_regex_search_alternation() {
    let mut state = focused_state();
    state.set_use_regex(true);

    // Search for "started|timeout"
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "started|timeout".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }

    let visible = state.visible_entries();
    // "Server started" and "Connection timeout" match
    assert_eq!(visible.len(), 2);
}

#[cfg(feature = "regex")]
#[test]
fn test_regex_search_case_insensitive() {
    let mut state = focused_state();
    state.set_use_regex(true);

    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "SERVER".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }

    let visible = state.visible_entries();
    // "Server started" matches case-insensitively
    assert_eq!(visible.len(), 1);
}

#[cfg(feature = "regex")]
#[test]
fn test_regex_invalid_falls_back_to_literal() {
    let mut state = focused_state();
    state.set_use_regex(true);

    // Invalid regex: unclosed bracket
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "[invalid".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }

    // Should fall back to literal match -- no entries contain "[invalid"
    let visible = state.visible_entries();
    assert!(visible.is_empty());
}

#[test]
fn test_substring_search_when_regex_disabled() {
    let mut state = focused_state();
    assert!(!state.use_regex());

    // "^Con" as literal should not match (no entry contains "^Con")
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "^Con".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }

    let visible = state.visible_entries();
    assert!(visible.is_empty());
}

// =============================================================================
// Search history
// =============================================================================

#[test]
fn test_default_search_history() {
    let state = LogViewerState::new();
    assert!(state.search_history().is_empty());
    assert_eq!(state.max_history(), 20);
}

#[test]
fn test_with_max_history_builder() {
    let state = LogViewerState::new().with_max_history(10);
    assert_eq!(state.max_history(), 10);
}

#[test]
fn test_set_max_history() {
    let mut state = LogViewerState::new();
    state.set_max_history(5);
    assert_eq!(state.max_history(), 5);
}

#[test]
fn test_confirm_search_saves_to_history() {
    let mut state = focused_state();
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    LogViewer::update(&mut state, LogViewerMessage::SearchInput('a'));
    LogViewer::update(&mut state, LogViewerMessage::SearchInput('b'));
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    assert_eq!(state.search_history(), &["ab"]);
    assert!(!state.is_search_focused());
}

#[test]
fn test_confirm_empty_search_no_history() {
    let mut state = focused_state();
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    assert!(state.search_history().is_empty());
}

#[test]
fn test_search_history_deduplication() {
    let mut state = focused_state();

    // Search for "abc" and confirm
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "abc".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    // Clear, search for "def" and confirm
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    LogViewer::update(&mut state, LogViewerMessage::ClearSearch);
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "def".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    // Clear, search for "abc" again and confirm (should move to end, not duplicate)
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    LogViewer::update(&mut state, LogViewerMessage::ClearSearch);
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "abc".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    assert_eq!(state.search_history(), &["def", "abc"]);
}

#[test]
fn test_search_history_max_limit() {
    let mut state = focused_state();
    state.set_max_history(3);

    for i in 0..5 {
        // Clear first, then focus search and type
        LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
        LogViewer::update(&mut state, LogViewerMessage::ClearSearch);
        LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
        LogViewer::update(
            &mut state,
            LogViewerMessage::SearchInput(char::from(b'a' + i)),
        );
        LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);
    }

    // Only last 3 should remain
    assert_eq!(state.search_history().len(), 3);
    assert_eq!(state.search_history(), &["c", "d", "e"]);
}

#[test]
fn test_search_history_up_key_binding() {
    let mut state = focused_state();
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    assert_eq!(
        LogViewer::handle_event(
            &state,
            &Event::key(Key::Up),
            &EventContext::new().focused(true)
        ),
        Some(LogViewerMessage::SearchHistoryUp)
    );
}

#[test]
fn test_search_history_down_key_binding() {
    let mut state = focused_state();
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    assert_eq!(
        LogViewer::handle_event(
            &state,
            &Event::key(Key::Down),
            &EventContext::new().focused(true)
        ),
        Some(LogViewerMessage::SearchHistoryDown)
    );
}

#[test]
fn test_search_history_navigation_up() {
    let mut state = focused_state();

    // Add two history entries
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "first".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    // Clear and add second entry
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    LogViewer::update(&mut state, LogViewerMessage::ClearSearch);
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "second".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    // Start a new search and navigate history
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    LogViewer::update(&mut state, LogViewerMessage::ClearSearch);
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);

    // Up should load "second" (most recent)
    LogViewer::update(&mut state, LogViewerMessage::SearchHistoryUp);
    assert_eq!(state.search_text(), "second");

    // Up again should load "first"
    LogViewer::update(&mut state, LogViewerMessage::SearchHistoryUp);
    assert_eq!(state.search_text(), "first");

    // Up again at top should stay at "first"
    LogViewer::update(&mut state, LogViewerMessage::SearchHistoryUp);
    assert_eq!(state.search_text(), "first");
}

#[test]
fn test_search_history_navigation_down() {
    let mut state = focused_state();

    // Add two history entries
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "first".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    LogViewer::update(&mut state, LogViewerMessage::ClearSearch);
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "second".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    // Start new search and navigate
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    LogViewer::update(&mut state, LogViewerMessage::ClearSearch);
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);

    // Go up to "first"
    LogViewer::update(&mut state, LogViewerMessage::SearchHistoryUp);
    LogViewer::update(&mut state, LogViewerMessage::SearchHistoryUp);
    assert_eq!(state.search_text(), "first");

    // Down should go to "second"
    LogViewer::update(&mut state, LogViewerMessage::SearchHistoryDown);
    assert_eq!(state.search_text(), "second");

    // Down past end should clear search
    LogViewer::update(&mut state, LogViewerMessage::SearchHistoryDown);
    assert_eq!(state.search_text(), "");
}

#[test]
fn test_search_history_empty_no_op() {
    let mut state = focused_state();
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);

    // Up/Down with empty history should be no-op
    let output = LogViewer::update(&mut state, LogViewerMessage::SearchHistoryUp);
    assert_eq!(output, None);

    let output = LogViewer::update(&mut state, LogViewerMessage::SearchHistoryDown);
    assert_eq!(output, None);
}

#[test]
fn test_search_history_down_without_browsing_no_op() {
    let mut state = focused_state();

    // Add a history entry
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "test".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    // Start new search, don't press Up first
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);

    // Down without first pressing Up should be no-op
    let output = LogViewer::update(&mut state, LogViewerMessage::SearchHistoryDown);
    assert_eq!(output, None);
}

#[test]
fn test_confirm_search_resets_history_index() {
    let mut state = focused_state();

    // Add a history entry
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "test".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    // Browse history
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    LogViewer::update(&mut state, LogViewerMessage::SearchHistoryUp);
    assert_eq!(state.search_text(), "test");

    // Confirm resets history browsing state
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    // Next Up should start from the most recent again
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    LogViewer::update(&mut state, LogViewerMessage::SearchHistoryUp);
    assert_eq!(state.search_text(), "test");
}

#[test]
fn test_clear_search_resets_history_index() {
    let mut state = focused_state();

    // Add a history entry
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    for c in "test".chars() {
        LogViewer::update(&mut state, LogViewerMessage::SearchInput(c));
    }
    LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);

    // Browse history
    LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
    LogViewer::update(&mut state, LogViewerMessage::SearchHistoryUp);

    // Clear search resets history browsing
    LogViewer::update(&mut state, LogViewerMessage::ClearSearch);
    assert_eq!(state.search_text(), "");
}

#[test]
fn test_set_max_history_truncates() {
    let mut state = LogViewerState::new();

    // Add 5 history entries
    for i in 0..5 {
        LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
        LogViewer::update(&mut state, LogViewerMessage::ClearSearch);
        LogViewer::update(&mut state, LogViewerMessage::FocusSearch);
        LogViewer::update(
            &mut state,
            LogViewerMessage::SearchInput(char::from(b'a' + i)),
        );
        LogViewer::update(&mut state, LogViewerMessage::ConfirmSearch);
    }
    assert_eq!(state.search_history().len(), 5);

    // Reduce max history should truncate
    state.set_max_history(3);
    assert_eq!(state.search_history().len(), 3);
    assert_eq!(state.search_history(), &["c", "d", "e"]);
}

// =============================================================================
// Rendering with new features
// =============================================================================

#[test]
fn test_render_with_follow() {
    let state = LogViewerState::new(); // follow is true by default
    let (mut terminal, theme) = test_utils::setup_render(60, 15);
    terminal
        .draw(|frame| {
            LogViewer::view(
                &state,
                &mut RenderContext::new(frame, frame.area(), &theme).focused(true),
            );
        })
        .unwrap();
}

#[test]
fn test_render_without_follow() {
    let mut state = sample_state();
    state.set_follow(false);
    let (mut terminal, theme) = test_utils::setup_render(60, 15);
    terminal
        .draw(|frame| {
            LogViewer::view(
                &state,
                &mut RenderContext::new(frame, frame.area(), &theme).focused(true),
            );
        })
        .unwrap();
}

#[test]
fn test_render_with_regex() {
    let mut state = LogViewerState::new();
    state.set_use_regex(true);
    let (mut terminal, theme) = test_utils::setup_render(60, 15);
    terminal
        .draw(|frame| {
            LogViewer::view(
                &state,
                &mut RenderContext::new(frame, frame.area(), &theme).focused(true),
            );
        })
        .unwrap();
}