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
//! A searchable log viewer with severity filtering.
//!
//! [`LogViewer`] composes a [`StatusLog`](super::StatusLog) with an
//! [`InputField`](super::InputField) search bar and severity-level toggle
//! filters. Press `/` to focus the search bar, `Escape` to clear and return
//! to the log, and `1`-`4` to toggle Info/Success/Warning/Error filters.
//!
//! Features include follow mode for auto-scrolling to new entries, regex
//! search (when the `regex` feature is enabled), and search history
//! navigation with Up/Down arrow keys.
//!
//! State is stored in [`LogViewerState`], updated via [`LogViewerMessage`],
//! and produces [`LogViewerOutput`].
//!
//!
//! # Example
//!
//! ```rust
//! use envision::component::{
//!     Component, LogViewer, LogViewerState,
//!     LogViewerMessage, LogViewerOutput,
//! };
//!
//! let mut state = LogViewerState::new();
//! state.push_info("Application started");
//! state.push_warning("Disk space low");
//! state.push_error("Connection failed");
//!
//! assert_eq!(state.visible_entries().len(), 3);
//!
//! // Filter to errors only (toggle off Info, Success, Warning)
//! LogViewer::update(&mut state, LogViewerMessage::ToggleInfo);
//! LogViewer::update(&mut state, LogViewerMessage::ToggleSuccess);
//! LogViewer::update(&mut state, LogViewerMessage::ToggleWarning);
//! assert_eq!(state.visible_entries().len(), 1);
//! ```

mod state;
mod view;

use std::marker::PhantomData;

use ratatui::prelude::*;

use super::{
    Component, EventContext, InputFieldMessage, InputFieldState, RenderContext, StatusLogEntry,
    StatusLogLevel,
};
use crate::input::{Event, Key};

pub use state::LogViewerState;

/// Internal focus target for the log viewer.
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
enum Focus {
    /// The log list is focused.
    #[default]
    Log,
    /// The search bar is focused.
    Search,
}

/// Messages that can be sent to a LogViewer.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum LogViewerMessage {
    /// Scroll the log up by one line.
    ScrollUp,
    /// Scroll the log down by one line.
    ScrollDown,
    /// Scroll to the top of the log.
    ScrollToTop,
    /// Scroll to the bottom of the log.
    ScrollToBottom,
    /// Focus the search bar.
    FocusSearch,
    /// Return focus to the log (and optionally clear search).
    FocusLog,
    /// Type a character in the search bar.
    SearchInput(char),
    /// Delete character before cursor in search bar.
    SearchBackspace,
    /// Delete character at cursor in search bar.
    SearchDelete,
    /// Move search cursor left.
    SearchLeft,
    /// Move search cursor right.
    SearchRight,
    /// Move search cursor to start.
    SearchHome,
    /// Move search cursor to end.
    SearchEnd,
    /// Clear the search text.
    ClearSearch,
    /// Toggle the Info level filter.
    ToggleInfo,
    /// Toggle the Success level filter.
    ToggleSuccess,
    /// Toggle the Warning level filter.
    ToggleWarning,
    /// Toggle the Error level filter.
    ToggleError,
    /// Add an entry to the log.
    Push {
        /// The message text.
        message: String,
        /// The severity level.
        level: StatusLogLevel,
        /// Optional timestamp.
        timestamp: Option<String>,
    },
    /// Clear all log entries.
    Clear,
    /// Remove a specific entry by ID.
    Remove(u64),
    /// Toggle follow mode (auto-scroll to bottom on new entries).
    ToggleFollow,
    /// Toggle regex search mode.
    ToggleRegex,
    /// Confirm search and save to history.
    ConfirmSearch,
    /// Navigate to previous search history entry.
    SearchHistoryUp,
    /// Navigate to next search history entry.
    SearchHistoryDown,
}

/// Output messages from a LogViewer.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum LogViewerOutput {
    /// A log entry was added.
    Added(u64),
    /// A log entry was removed.
    Removed(u64),
    /// All entries were cleared.
    Cleared,
    /// An old entry was evicted due to max_entries limit.
    Evicted(u64),
    /// The search text changed.
    SearchChanged(String),
    /// A filter toggle changed.
    FilterChanged,
    /// Follow mode was toggled.
    FollowToggled(bool),
    /// Regex mode was toggled.
    RegexToggled(bool),
}

/// A searchable log viewer with severity filtering.
///
/// Composes a log display with a search input field and severity-level
/// toggle filters. The search is case-insensitive and matches against
/// entry messages. Supports follow mode for auto-scrolling, regex search
/// (with the `regex` feature), and search history.
///
/// # Key Bindings (Log Mode)
///
/// - `Up` / `k` — Scroll up (disables follow mode)
/// - `Down` / `j` — Scroll down (disables follow mode)
/// - `Home` — Scroll to top (newest)
/// - `End` — Scroll to bottom (oldest)
/// - `/` — Focus search bar
/// - `f` — Toggle follow mode
/// - `1` — Toggle Info filter
/// - `2` — Toggle Success filter
/// - `3` — Toggle Warning filter
/// - `4` — Toggle Error filter
///
/// # Key Bindings (Search Mode)
///
/// - `Escape` — Clear search and return to log
/// - `Enter` — Confirm search (save to history) and return to log
/// - `Up` — Previous search history entry
/// - `Down` — Next search history entry
/// - `Ctrl+r` — Toggle regex search mode
/// - Standard text editing keys
pub struct LogViewer(PhantomData<()>);

impl Component for LogViewer {
    type State = LogViewerState;
    type Message = LogViewerMessage;
    type Output = LogViewerOutput;

    fn init() -> Self::State {
        LogViewerState::default()
    }

    fn handle_event(
        state: &Self::State,
        event: &Event,
        ctx: &EventContext,
    ) -> Option<Self::Message> {
        if !ctx.focused || ctx.disabled {
            return None;
        }

        let key = event.as_key()?;

        match state.focus {
            Focus::Log => match key.code {
                Key::Up | Key::Char('k') => Some(LogViewerMessage::ScrollUp),
                Key::Down | Key::Char('j') => Some(LogViewerMessage::ScrollDown),
                Key::Home => Some(LogViewerMessage::ScrollToTop),
                Key::End => Some(LogViewerMessage::ScrollToBottom),
                Key::Char('/') => Some(LogViewerMessage::FocusSearch),
                Key::Char('f') => Some(LogViewerMessage::ToggleFollow),
                Key::Char('1') => Some(LogViewerMessage::ToggleInfo),
                Key::Char('2') => Some(LogViewerMessage::ToggleSuccess),
                Key::Char('3') => Some(LogViewerMessage::ToggleWarning),
                Key::Char('4') => Some(LogViewerMessage::ToggleError),
                _ => None,
            },
            Focus::Search => match key.code {
                Key::Esc => Some(LogViewerMessage::ClearSearch),
                Key::Enter => Some(LogViewerMessage::ConfirmSearch),
                Key::Up => Some(LogViewerMessage::SearchHistoryUp),
                Key::Down => Some(LogViewerMessage::SearchHistoryDown),
                Key::Char(c) => {
                    if key.modifiers.ctrl() {
                        match c {
                            'r' => Some(LogViewerMessage::ToggleRegex),
                            _ => None,
                        }
                    } else {
                        Some(LogViewerMessage::SearchInput(c))
                    }
                }
                Key::Backspace => Some(LogViewerMessage::SearchBackspace),
                Key::Delete => Some(LogViewerMessage::SearchDelete),
                Key::Left => Some(LogViewerMessage::SearchLeft),
                Key::Right => Some(LogViewerMessage::SearchRight),
                Key::Home => Some(LogViewerMessage::SearchHome),
                Key::End => Some(LogViewerMessage::SearchEnd),
                _ => None,
            },
        }
    }

    fn update(state: &mut Self::State, msg: Self::Message) -> Option<Self::Output> {
        match msg {
            LogViewerMessage::ScrollUp => {
                state.follow = false;
                let len = state.visible_entries().len();
                state.scroll.set_content_length(len);
                state.scroll.set_viewport_height(1.min(len));
                state.scroll.scroll_up();
                None
            }
            LogViewerMessage::ScrollDown => {
                state.follow = false;
                let len = state.visible_entries().len();
                state.scroll.set_content_length(len);
                state.scroll.set_viewport_height(1.min(len));
                state.scroll.scroll_down();
                None
            }
            LogViewerMessage::ScrollToTop => {
                let len = state.visible_entries().len();
                state.scroll.set_content_length(len);
                state.scroll.set_viewport_height(1.min(len));
                state.scroll.scroll_to_start();
                None
            }
            LogViewerMessage::ScrollToBottom => {
                let len = state.visible_entries().len();
                state.scroll.set_content_length(len);
                state.scroll.set_viewport_height(1.min(len));
                state.scroll.scroll_to_end();
                None
            }
            LogViewerMessage::FocusSearch => {
                state.focus = Focus::Search;
                None
            }
            LogViewerMessage::FocusLog => {
                state.focus = Focus::Log;
                state.history_index = None;
                None
            }
            LogViewerMessage::SearchInput(c) => {
                state.search.update(InputFieldMessage::Insert(c));
                state.search_text = state.search.value().to_string();
                state.scroll.set_offset(0);
                Some(LogViewerOutput::SearchChanged(state.search_text.clone()))
            }
            LogViewerMessage::SearchBackspace => {
                state.search.update(InputFieldMessage::Backspace);
                state.search_text = state.search.value().to_string();
                state.scroll.set_offset(0);
                Some(LogViewerOutput::SearchChanged(state.search_text.clone()))
            }
            LogViewerMessage::SearchDelete => {
                state.search.update(InputFieldMessage::Delete);
                state.search_text = state.search.value().to_string();
                state.scroll.set_offset(0);
                Some(LogViewerOutput::SearchChanged(state.search_text.clone()))
            }
            LogViewerMessage::SearchLeft => {
                state.search.update(InputFieldMessage::Left);
                None
            }
            LogViewerMessage::SearchRight => {
                state.search.update(InputFieldMessage::Right);
                None
            }
            LogViewerMessage::SearchHome => {
                state.search.update(InputFieldMessage::Home);
                None
            }
            LogViewerMessage::SearchEnd => {
                state.search.update(InputFieldMessage::End);
                None
            }
            LogViewerMessage::ClearSearch => {
                state.search.update(InputFieldMessage::Clear);
                state.search_text.clear();
                state.scroll.set_offset(0);
                state.focus = Focus::Log;
                state.history_index = None;
                Some(LogViewerOutput::SearchChanged(String::new()))
            }
            LogViewerMessage::ToggleInfo => {
                state.show_info = !state.show_info;
                state.scroll.set_offset(0);
                Some(LogViewerOutput::FilterChanged)
            }
            LogViewerMessage::ToggleSuccess => {
                state.show_success = !state.show_success;
                state.scroll.set_offset(0);
                Some(LogViewerOutput::FilterChanged)
            }
            LogViewerMessage::ToggleWarning => {
                state.show_warning = !state.show_warning;
                state.scroll.set_offset(0);
                Some(LogViewerOutput::FilterChanged)
            }
            LogViewerMessage::ToggleError => {
                state.show_error = !state.show_error;
                state.scroll.set_offset(0);
                Some(LogViewerOutput::FilterChanged)
            }
            LogViewerMessage::Push {
                message,
                level,
                timestamp,
            } => {
                let id = state.push_entry(message, level, timestamp);
                // Auto-scroll to top (newest) when follow mode is enabled
                if state.follow {
                    state.scroll.set_offset(0);
                }
                Some(LogViewerOutput::Added(id))
            }
            LogViewerMessage::Clear => {
                state.clear();
                Some(LogViewerOutput::Cleared)
            }
            LogViewerMessage::Remove(id) => {
                if state.remove(id) {
                    Some(LogViewerOutput::Removed(id))
                } else {
                    None
                }
            }
            LogViewerMessage::ToggleFollow => {
                state.follow = !state.follow;
                if state.follow {
                    // When enabling follow, scroll to top (newest)
                    state.scroll.set_offset(0);
                }
                Some(LogViewerOutput::FollowToggled(state.follow))
            }
            LogViewerMessage::ToggleRegex => {
                state.use_regex = !state.use_regex;
                state.scroll.set_offset(0);
                Some(LogViewerOutput::RegexToggled(state.use_regex))
            }
            LogViewerMessage::ConfirmSearch => {
                // Save non-empty search text to history
                if !state.search_text.is_empty() {
                    // Remove duplicate if it already exists in history
                    state.search_history.retain(|h| h != &state.search_text);
                    state.search_history.push(state.search_text.clone());
                    // Enforce max history size
                    while state.search_history.len() > state.max_history {
                        state.search_history.remove(0);
                    }
                }
                state.history_index = None;
                state.focus = Focus::Log;
                None
            }
            LogViewerMessage::SearchHistoryUp => {
                if state.search_history.is_empty() {
                    return None;
                }
                let new_index = match state.history_index {
                    None => state.search_history.len().saturating_sub(1),
                    Some(idx) => idx.saturating_sub(1),
                };
                state.history_index = Some(new_index);
                let text = state.search_history[new_index].clone();
                // Update the search field with the history entry
                state.search.update(InputFieldMessage::Clear);
                for c in text.chars() {
                    state.search.update(InputFieldMessage::Insert(c));
                }
                state.search_text = text;
                state.scroll.set_offset(0);
                Some(LogViewerOutput::SearchChanged(state.search_text.clone()))
            }
            LogViewerMessage::SearchHistoryDown => {
                if state.search_history.is_empty() {
                    return None;
                }
                match state.history_index {
                    None => None,
                    Some(idx) => {
                        if idx + 1 >= state.search_history.len() {
                            // Past the end of history, clear to empty
                            state.history_index = None;
                            state.search.update(InputFieldMessage::Clear);
                            state.search_text.clear();
                            state.scroll.set_offset(0);
                            Some(LogViewerOutput::SearchChanged(String::new()))
                        } else {
                            let new_index = idx + 1;
                            state.history_index = Some(new_index);
                            let text = state.search_history[new_index].clone();
                            state.search.update(InputFieldMessage::Clear);
                            for c in text.chars() {
                                state.search.update(InputFieldMessage::Insert(c));
                            }
                            state.search_text = text;
                            state.scroll.set_offset(0);
                            Some(LogViewerOutput::SearchChanged(state.search_text.clone()))
                        }
                    }
                }
            }
        }
    }

    fn view(state: &Self::State, ctx: &mut RenderContext<'_, '_>) {
        if ctx.area.height < 3 {
            return;
        }

        crate::annotation::with_registry(|reg| {
            reg.register(
                ctx.area,
                crate::annotation::Annotation::container("log_viewer")
                    .with_focus(ctx.focused)
                    .with_disabled(ctx.disabled),
            );
        });

        // Layout: search bar (1 line) + filter bar (1 line) + log ctx.area
        let chunks = Layout::default()
            .direction(Direction::Vertical)
            .constraints([
                Constraint::Length(1),
                Constraint::Length(1),
                Constraint::Min(1),
            ])
            .split(ctx.area);

        let search_area = chunks[0];
        let filter_area = chunks[1];
        let log_area = chunks[2];

        // Render search bar
        view::render_search_bar(state, &mut ctx.with_area(search_area));

        // Render filter bar
        view::render_filter_bar(state, &mut ctx.with_area(filter_area));

        // Render log entries
        view::render_log(state, &mut ctx.with_area(log_area));
    }
}

#[cfg(test)]
mod enhancement_tests;
#[cfg(test)]
mod snapshot_tests;
#[cfg(test)]
mod tests;