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
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
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
//! State debugger for reactive signals

use super::helpers::{draw_separator, draw_text_overlay};
use super::DevToolsConfig;
use crate::layout::Rect;
use crate::render::Buffer;
use crate::style::Color;
use std::collections::HashMap;

/// Helper context for rendering devtools panels
struct RenderCtx<'a> {
    buffer: &'a mut Buffer,
    x: u16,
    width: u16,
    config: &'a DevToolsConfig,
}

impl<'a> RenderCtx<'a> {
    fn new(buffer: &'a mut Buffer, x: u16, width: u16, config: &'a DevToolsConfig) -> Self {
        Self {
            buffer,
            x,
            width,
            config,
        }
    }

    fn draw_text(&mut self, y: u16, text: &str, color: Color) {
        draw_text_overlay(self.buffer, self.x, y, text, color);
    }

    fn draw_separator(&mut self, y: u16) {
        draw_separator(self.buffer, self.x, y, self.width, self.config.accent_color);
    }
}

/// State value representation
#[derive(Debug, Clone)]
pub enum StateValue {
    /// String value
    String(String),
    /// Integer value
    Int(i64),
    /// Float value
    Float(f64),
    /// Boolean value
    Bool(bool),
    /// List of values
    List(Vec<StateValue>),
    /// Map of values
    Map(HashMap<String, StateValue>),
    /// Null/None
    Null,
}

impl StateValue {
    /// Format value for display
    pub fn display(&self) -> String {
        match self {
            Self::String(s) => format!("\"{}\"", s),
            Self::Int(i) => i.to_string(),
            Self::Float(f) => format!("{:.2}", f),
            Self::Bool(b) => b.to_string(),
            Self::List(items) => format!("[{} items]", items.len()),
            Self::Map(items) => format!("{{{}  keys}}", items.len()),
            Self::Null => "null".to_string(),
        }
    }

    /// Get type name
    pub fn type_name(&self) -> &'static str {
        match self {
            Self::String(_) => "String",
            Self::Int(_) => "i64",
            Self::Float(_) => "f64",
            Self::Bool(_) => "bool",
            Self::List(_) => "Vec",
            Self::Map(_) => "Map",
            Self::Null => "null",
        }
    }
}

/// State entry for debugging
#[derive(Debug, Clone)]
pub struct StateEntry {
    /// Signal/state name
    pub name: String,
    /// Type name
    pub type_name: String,
    /// Current value
    pub value: StateValue,
    /// Number of subscribers
    pub subscribers: usize,
    /// Update count
    pub update_count: u64,
    /// Is computed (derived)
    pub is_computed: bool,
}

impl StateEntry {
    /// Create new state entry
    pub fn new(name: impl Into<String>, value: StateValue) -> Self {
        Self {
            name: name.into(),
            type_name: value.type_name().to_string(),
            value,
            subscribers: 0,
            update_count: 0,
            is_computed: false,
        }
    }

    /// Set as computed
    pub fn computed(mut self) -> Self {
        self.is_computed = true;
        self
    }

    /// Set subscribers count
    pub fn subscribers(mut self, count: usize) -> Self {
        self.subscribers = count;
        self
    }

    /// Increment update count
    pub fn updated(&mut self) {
        self.update_count += 1;
    }
}

/// State debugger
#[derive(Debug, Default)]
pub struct StateDebugger {
    /// Tracked states
    states: Vec<StateEntry>,
    /// Selected index
    selected: Option<usize>,
    /// Scroll offset
    scroll: usize,
    /// Filter text
    filter: String,
    /// Show computed values
    show_computed: bool,
    /// Show update counts (for future UI)
    _show_updates: bool,
}

impl StateDebugger {
    /// Create new state debugger
    pub fn new() -> Self {
        Self {
            show_computed: true,
            _show_updates: true,
            ..Default::default()
        }
    }

    /// Clear all states
    pub fn clear(&mut self) {
        self.states.clear();
        self.selected = None;
    }

    /// Add a state entry
    pub fn add(&mut self, entry: StateEntry) {
        self.states.push(entry);
    }

    /// Update a state value
    pub fn update(&mut self, name: &str, value: StateValue) {
        if let Some(entry) = self.states.iter_mut().find(|e| e.name == name) {
            entry.value = value;
            entry.updated();
        }
    }

    /// Remove a state
    pub fn remove(&mut self, name: &str) {
        self.states.retain(|e| e.name != name);
    }

    /// Get filtered states
    fn filtered(&self) -> Vec<&StateEntry> {
        self.states
            .iter()
            .filter(|e| {
                if !self.show_computed && e.is_computed {
                    return false;
                }
                if !self.filter.is_empty() {
                    return e.name.to_lowercase().contains(&self.filter.to_lowercase());
                }
                true
            })
            .collect()
    }

    /// Select next
    pub fn select_next(&mut self) {
        let count = self.filtered().len();
        if count == 0 {
            return;
        }

        self.selected = Some(match self.selected {
            Some(i) => (i + 1).min(count - 1),
            None => 0,
        });
    }

    /// Select previous
    pub fn select_prev(&mut self) {
        let count = self.filtered().len();
        if count == 0 {
            return;
        }

        self.selected = Some(match self.selected {
            Some(i) => i.saturating_sub(1),
            None => 0,
        });
    }

    /// Set filter
    pub fn set_filter(&mut self, filter: impl Into<String>) {
        self.filter = filter.into();
        self.selected = None;
    }

    /// Render state debugger content
    pub fn render_content(&self, buffer: &mut Buffer, area: Rect, config: &DevToolsConfig) {
        let mut ctx = RenderCtx::new(buffer, area.x, area.width, config);
        let mut y = area.y;
        let max_y = area.y + area.height;

        // Header
        let header = format!("{} signals tracked", self.states.len());
        ctx.draw_text(y, &header, config.accent_color);
        y += 2;

        // States list
        let filtered = self.filtered();
        for (i, entry) in filtered.iter().enumerate().skip(self.scroll) {
            if y >= max_y - 2 {
                break;
            }

            let is_selected = self.selected == Some(i);
            Self::render_entry(&mut ctx, y, entry, is_selected);
            y += 1;
        }

        // Selected details
        if let Some(idx) = self.selected {
            if let Some(entry) = filtered.get(idx) {
                if y + 2 < max_y {
                    y = max_y - 3;
                    ctx.draw_separator(y);
                    y += 1;
                    Self::render_details(&mut ctx, y, entry);
                }
            }
        }
    }

    fn render_entry(ctx: &mut RenderCtx<'_>, y: u16, entry: &StateEntry, selected: bool) {
        let prefix = if entry.is_computed { "" } else { "" };
        let line = format!("{}{}: {}", prefix, entry.name, entry.value.display());

        let fg = if selected {
            ctx.config.bg_color
        } else {
            ctx.config.fg_color
        };
        let bg = if selected {
            Some(ctx.config.accent_color)
        } else {
            None
        };

        for (i, ch) in line.chars().enumerate() {
            if (i as u16) < ctx.width {
                if let Some(cell) = ctx.buffer.get_mut(ctx.x + i as u16, y) {
                    cell.symbol = ch;
                    cell.fg = Some(fg);
                    if let Some(b) = bg {
                        cell.bg = Some(b);
                    }
                }
            }
        }
    }

    fn render_details(ctx: &mut RenderCtx<'_>, y: u16, entry: &StateEntry) {
        let details = format!(
            "Type: {} | Subs: {} | Updates: {}",
            entry.type_name, entry.subscribers, entry.update_count
        );
        ctx.draw_text(y, &details, ctx.config.fg_color);
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_state_value_display() {
        assert_eq!(StateValue::Int(42).display(), "42");
        assert_eq!(StateValue::Bool(true).display(), "true");
        assert_eq!(StateValue::String("hello".into()).display(), "\"hello\"");
    }

    #[test]
    fn test_state_entry() {
        let entry = StateEntry::new("count", StateValue::Int(0))
            .computed()
            .subscribers(3);

        assert!(entry.is_computed);
        assert_eq!(entry.subscribers, 3);
    }

    #[test]
    fn test_state_debugger_add() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("test", StateValue::Int(1)));

        assert_eq!(debugger.states.len(), 1);
    }

    #[test]
    fn test_state_debugger_update() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("count", StateValue::Int(0)));
        debugger.update("count", StateValue::Int(5));

        assert!(matches!(debugger.states[0].value, StateValue::Int(5)));
        assert_eq!(debugger.states[0].update_count, 1);
    }

    #[test]
    fn test_state_value_display_all_types() {
        assert_eq!(StateValue::Float(3.14159).display(), "3.14");
        assert_eq!(StateValue::Null.display(), "null");
        assert_eq!(
            StateValue::List(vec![StateValue::Int(1), StateValue::Int(2)]).display(),
            "[2 items]"
        );

        let mut map = HashMap::new();
        map.insert("key".to_string(), StateValue::Int(1));
        assert_eq!(StateValue::Map(map).display(), "{1  keys}");
    }

    #[test]
    fn test_state_value_type_name() {
        assert_eq!(StateValue::String("test".into()).type_name(), "String");
        assert_eq!(StateValue::Int(42).type_name(), "i64");
        assert_eq!(StateValue::Float(1.0).type_name(), "f64");
        assert_eq!(StateValue::Bool(true).type_name(), "bool");
        assert_eq!(StateValue::List(vec![]).type_name(), "Vec");
        assert_eq!(StateValue::Map(HashMap::new()).type_name(), "Map");
        assert_eq!(StateValue::Null.type_name(), "null");
    }

    #[test]
    fn test_state_debugger_remove() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("a", StateValue::Int(1)));
        debugger.add(StateEntry::new("b", StateValue::Int(2)));

        assert_eq!(debugger.states.len(), 2);
        debugger.remove("a");
        assert_eq!(debugger.states.len(), 1);
        assert_eq!(debugger.states[0].name, "b");
    }

    #[test]
    fn test_state_debugger_clear() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("a", StateValue::Int(1)));
        debugger.selected = Some(0);

        debugger.clear();
        assert!(debugger.states.is_empty());
        assert!(debugger.selected.is_none());
    }

    #[test]
    fn test_state_debugger_select_next() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("a", StateValue::Int(1)));
        debugger.add(StateEntry::new("b", StateValue::Int(2)));

        assert!(debugger.selected.is_none());
        debugger.select_next();
        assert_eq!(debugger.selected, Some(0));
        debugger.select_next();
        assert_eq!(debugger.selected, Some(1));
        // Should not go beyond last
        debugger.select_next();
        assert_eq!(debugger.selected, Some(1));
    }

    #[test]
    fn test_state_debugger_select_prev() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("a", StateValue::Int(1)));
        debugger.add(StateEntry::new("b", StateValue::Int(2)));

        debugger.selected = Some(1);
        debugger.select_prev();
        assert_eq!(debugger.selected, Some(0));
        // Should not go below 0
        debugger.select_prev();
        assert_eq!(debugger.selected, Some(0));
    }

    #[test]
    fn test_state_debugger_set_filter() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("count", StateValue::Int(1)));
        debugger.add(StateEntry::new("name", StateValue::String("test".into())));
        debugger.selected = Some(0);

        debugger.set_filter("name");
        assert!(debugger.selected.is_none()); // Selection cleared on filter change

        let filtered = debugger.filtered();
        assert_eq!(filtered.len(), 1);
        assert_eq!(filtered[0].name, "name");
    }

    #[test]
    fn test_state_debugger_filter_computed() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("signal", StateValue::Int(1)));
        debugger.add(StateEntry::new("computed", StateValue::Int(2)).computed());

        // By default show_computed is true
        assert_eq!(debugger.filtered().len(), 2);

        debugger.show_computed = false;
        assert_eq!(debugger.filtered().len(), 1);
    }

    #[test]
    fn test_state_debugger_select_empty() {
        let mut debugger = StateDebugger::new();
        // Should not panic on empty list
        debugger.select_next();
        debugger.select_prev();
        assert!(debugger.selected.is_none());
    }

    #[test]
    fn test_state_entry_updated() {
        let mut entry = StateEntry::new("test", StateValue::Int(0));
        assert_eq!(entry.update_count, 0);
        entry.updated();
        assert_eq!(entry.update_count, 1);
        entry.updated();
        assert_eq!(entry.update_count, 2);
    }

    // Tests for RenderCtx
    #[test]
    fn test_render_ctx_new() {
        let buffer = &mut Buffer::new(10, 5);
        let config = DevToolsConfig::default();
        let ctx = RenderCtx::new(buffer, 5, 10, &config);

        assert_eq!(ctx.x, 5);
        assert_eq!(ctx.width, 10);
    }

    // Tests for render_content
    #[test]
    fn test_render_content_empty() {
        let debugger = StateDebugger::new();
        let mut buffer = Buffer::new(20, 10);
        let area = Rect::new(0, 0, 20, 10);
        let config = DevToolsConfig::default();

        // Should not panic on empty debugger
        debugger.render_content(&mut buffer, area, &config);
    }

    #[test]
    fn test_render_content_with_states() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("test", StateValue::Int(42)));

        let mut buffer = Buffer::new(20, 10);
        let area = Rect::new(0, 0, 20, 10);
        let config = DevToolsConfig::default();

        debugger.render_content(&mut buffer, area, &config);
        // Should render header and state entry
    }

    #[test]
    fn test_render_content_with_selection() {
        let mut debugger = StateDebugger::new();
        debugger.add(
            StateEntry::new("test", StateValue::Int(42))
                .subscribers(3)
                .computed(),
        );

        debugger.selected = Some(0);

        let mut buffer = Buffer::new(20, 10);
        let area = Rect::new(0, 0, 20, 10);
        let config = DevToolsConfig::default();

        debugger.render_content(&mut buffer, area, &config);
        // Should render with selection highlighting and details
    }

    #[test]
    fn test_render_content_scroll_limit() {
        let mut debugger = StateDebugger::new();
        for i in 0..20 {
            debugger.add(StateEntry::new(format!("state_{}", i), StateValue::Int(i)));
        }
        debugger.scroll = 10; // Skip first 10 entries

        let mut buffer = Buffer::new(20, 5);
        let area = Rect::new(0, 0, 20, 5);
        let config = DevToolsConfig::default();

        debugger.render_content(&mut buffer, area, &config);
        // Should render starting from scrolled position
    }

    #[test]
    fn test_render_content_truncates_at_bottom() {
        let mut debugger = StateDebugger::new();
        for i in 0..10 {
            debugger.add(StateEntry::new(format!("state_{}", i), StateValue::Int(i)));
        }

        let mut buffer = Buffer::new(20, 3);
        let area = Rect::new(0, 0, 20, 3);
        let config = DevToolsConfig::default();

        debugger.render_content(&mut buffer, area, &config);
        // Should only fit a few entries in small area
    }

    #[test]
    fn test_render_entry_non_computed() {
        let entry = StateEntry::new("signal", StateValue::Int(42));
        let mut buffer = Buffer::new(20, 5);
        let config = DevToolsConfig::default();
        let mut ctx = RenderCtx::new(&mut buffer, 0, 20, &config);

        // Should render with ● prefix for non-computed
        StateDebugger::render_entry(&mut ctx, 0, &entry, false);
    }

    #[test]
    fn test_render_entry_selected() {
        let entry = StateEntry::new("signal", StateValue::Int(42));
        let mut buffer = Buffer::new(20, 5);
        let config = DevToolsConfig::default();
        let mut ctx = RenderCtx::new(&mut buffer, 0, 20, &config);

        // Should render with inverted colors for selected
        StateDebugger::render_entry(&mut ctx, 0, &entry, true);
    }

    #[test]
    fn test_render_entry_long_name_truncates() {
        let entry = StateEntry::new(
            "very_long_signal_name_that_exceeds_width",
            StateValue::Int(42),
        );
        let mut buffer = Buffer::new(10, 5);
        let config = DevToolsConfig::default();
        let mut ctx = RenderCtx::new(&mut buffer, 0, 10, &config);

        // Should not panic on long names
        StateDebugger::render_entry(&mut ctx, 0, &entry, false);
    }

    #[test]
    fn test_render_details() {
        let mut entry = StateEntry::new("test", StateValue::Int(42)).subscribers(5);
        entry.updated();
        entry.updated();

        let mut buffer = Buffer::new(30, 5);
        let config = DevToolsConfig::default();
        let mut ctx = RenderCtx::new(&mut buffer, 0, 30, &config);

        // Should render type, subscribers, and update count
        StateDebugger::render_details(&mut ctx, 0, &entry);
    }

    #[test]
    fn test_filter_case_insensitive() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("MySignal", StateValue::Int(1)));
        debugger.add(StateEntry::new("OtherSignal", StateValue::Int(2)));

        debugger.set_filter("mysignal");
        let filtered = debugger.filtered();
        assert_eq!(filtered.len(), 1);
        assert_eq!(filtered[0].name, "MySignal");
    }

    #[test]
    fn test_filter_empty_string_shows_all() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("a", StateValue::Int(1)));
        debugger.add(StateEntry::new("b", StateValue::Int(2)));

        debugger.set_filter("");
        let filtered = debugger.filtered();
        assert_eq!(filtered.len(), 2);
    }

    #[test]
    fn test_select_next_with_filter() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("signal_a", StateValue::Int(1)));
        debugger.add(StateEntry::new("signal_b", StateValue::Int(2)));
        debugger.add(StateEntry::new("computed", StateValue::Int(3)).computed());

        debugger.show_computed = false;
        debugger.select_next();
        assert_eq!(debugger.selected, Some(0));

        debugger.select_next();
        assert_eq!(debugger.selected, Some(1)); // Only non-computed states
    }

    #[test]
    fn test_select_prev_with_filter() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("signal_a", StateValue::Int(1)));
        debugger.add(StateEntry::new("signal_b", StateValue::Int(2)));

        debugger.selected = Some(1);
        debugger.select_prev();
        assert_eq!(debugger.selected, Some(0));
    }

    #[test]
    fn test_update_nonexistent_state() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("a", StateValue::Int(1)));

        // Should not panic or add new state
        debugger.update("b", StateValue::Int(2));
        assert_eq!(debugger.states.len(), 1);
    }

    #[test]
    fn test_remove_nonexistent_state() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("a", StateValue::Int(1)));

        // Should not panic
        debugger.remove("b");
        assert_eq!(debugger.states.len(), 1);
    }

    #[test]
    fn test_state_debugger_default() {
        let debugger = StateDebugger::default();
        assert!(debugger.states.is_empty());
        assert!(debugger.selected.is_none());
        // Default from derive sets show_computed to false
        assert!(!debugger.show_computed);
    }

    #[test]
    fn test_select_next_clamps_to_filtered_length() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("a", StateValue::Int(1)));
        debugger.add(StateEntry::new("b", StateValue::Int(2)));
        debugger.add(StateEntry::new("c", StateValue::Int(3)).computed());

        debugger.show_computed = false;
        debugger.selected = Some(1);

        // With computed hidden, only 2 items
        debugger.select_next();
        assert_eq!(debugger.selected, Some(1)); // Should clamp
    }

    #[test]
    fn test_filter_match_substring() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("user_count", StateValue::Int(1)));
        debugger.add(StateEntry::new("user_name", StateValue::Int(2)));
        debugger.add(StateEntry::new("total_count", StateValue::Int(3)));

        debugger.set_filter("count");
        let filtered = debugger.filtered();
        assert_eq!(filtered.len(), 2); // user_count and total_count
    }

    #[test]
    fn test_render_content_no_room_for_details() {
        let mut debugger = StateDebugger::new();
        debugger.add(StateEntry::new("test", StateValue::Int(42)));
        debugger.selected = Some(0);

        let mut buffer = Buffer::new(20, 2);
        let area = Rect::new(0, 0, 20, 2);
        let config = DevToolsConfig::default();

        // Not enough room for details panel
        debugger.render_content(&mut buffer, area, &config);
    }
}