tree-tui 0.1.3

An interactive terminal UI for visualizing directories: code, size, and git stats.
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
//! Rendering: dispatch by screen state and lay out the top-level regions.

mod detail;
mod footer;
mod header;
mod help;
mod loading;
pub mod preview;
pub mod reader;
pub mod theme;
mod tree_view;

use ratatui::Frame;
use ratatui::layout::{Alignment, Constraint, Flex, Layout, Rect};
use ratatui::style::{Modifier, Style};
use ratatui::text::{Line, Span};
use ratatui::widgets::{Block, Clear, Paragraph};

use crate::app::{App, Focus, Mode, PaneRects, Screen};

/// Minimum body width/height before the preview pane is shown; below either, it
/// folds away so the tree keeps the room.
const PREVIEW_MIN_WIDTH: u16 = 100;
const PREVIEW_MIN_HEIGHT: u16 = 20;
/// Share of the body width the preview pane takes when shown.
const PREVIEW_PCT: u16 = 40;
/// Fixed width of the detail panel when shown.
const DETAIL_WIDTH: u16 = 36;

/// Render the current frame for `app`.
pub fn render(frame: &mut Frame, app: &mut App) {
    let area = frame.area();
    if matches!(app.screen, Screen::Loaded(_)) {
        render_loaded(frame, app, area);
    } else if matches!(app.screen, Screen::Loading) {
        loading::render(frame, app, area);
    } else if let Screen::Reader(reader) = &mut app.screen {
        reader::render(frame, reader, area);
    } else if let Screen::Error(message) = &app.screen {
        render_error(frame, message, area);
    }

    if app.show_help {
        help::render(frame, area);
    }
}

fn render_loaded(frame: &mut Frame, app: &mut App, area: Rect) {
    // Copy/borrow scalar state out before borrowing `screen` mutably.
    let root_label = app.root_label.clone();
    let head_hash = app.head_hash.clone();
    let editing = app.mode == Mode::Filter;
    let Screen::Loaded(loaded) = &mut app.screen else {
        return;
    };
    let loaded = loaded.as_mut();

    let [header_area, body_area, footer_area] = Layout::vertical([
        Constraint::Length(4),
        Constraint::Min(1),
        Constraint::Length(1),
    ])
    .areas(area);

    header::render(
        frame,
        &root_label,
        head_hash.as_deref(),
        loaded,
        header_area,
    );

    // Right-side panes appear as room allows: the detail panel takes a fixed
    // column; the preview pane takes a share of the width, folding away on a
    // narrow or short terminal.
    let show_preview = loaded.show_preview
        && body_area.width >= PREVIEW_MIN_WIDTH
        && body_area.height >= PREVIEW_MIN_HEIGHT;

    let mut constraints = vec![Constraint::Min(0)];
    if loaded.show_detail {
        constraints.push(Constraint::Length(DETAIL_WIDTH));
    }
    if show_preview {
        constraints.push(Constraint::Percentage(PREVIEW_PCT));
    }
    let chunks = Layout::horizontal(constraints).split(body_area);

    let tree_area = chunks[0];
    let mut next = 1;
    if loaded.show_detail {
        detail::render(frame, loaded, chunks[next]);
        next += 1;
    }
    let preview_area = show_preview.then(|| chunks[next]);

    // Record pane rects for the next frame's mouse hit-testing, and keep focus
    // on the tree when the preview has folded away.
    loaded.panes = PaneRects {
        tree: tree_area,
        preview: preview_area,
    };
    if preview_area.is_none() && loaded.focus == Focus::Preview {
        loaded.focus = Focus::Tree;
    }

    if loaded.visible.is_empty() {
        render_empty(frame, &loaded.filter, tree_area);
    } else {
        tree_view::render(frame, loaded, tree_area);
    }

    if let Some(preview_area) = preview_area {
        // The preview content is loaded off the render path — debounced by the
        // event loop so a held key / wheel spin never pays a file read + syntax
        // highlight per frame (that synchronous cost is what made nav lurch).
        preview::render(frame, loaded, preview_area);
    }

    let computing = loaded.active_computing().then_some(loaded.active_lens);
    footer::render(
        frame,
        loaded.active_lens,
        loaded.sort_key,
        loaded.sort_dir,
        loaded.hide_zeros,
        &loaded.filter,
        editing,
        computing,
        footer_area,
    );
}

fn render_empty(frame: &mut Frame, filter: &str, area: Rect) {
    let message = if filter.is_empty() {
        "No files found here."
    } else {
        "No matches for this filter."
    };
    let block = Block::bordered()
        .border_style(Style::default().fg(theme::MUTED))
        .title(" tree ");
    let paragraph = Paragraph::new(vec![
        Line::default(),
        Line::from(Span::styled(message, Style::default().fg(theme::MUTED))),
    ])
    .alignment(Alignment::Center)
    .block(block);
    frame.render_widget(paragraph, area);
}

fn render_error(frame: &mut Frame, message: &str, area: Rect) {
    let text = vec![
        Line::from(Span::styled(
            "Error",
            Style::default()
                .fg(theme::WARN)
                .add_modifier(Modifier::BOLD),
        )),
        Line::from(Span::raw(message.to_string())),
        Line::from(Span::styled(
            "press q to quit",
            Style::default().fg(theme::MUTED),
        )),
    ];
    let [row] = Layout::vertical([Constraint::Length(5)])
        .flex(Flex::Center)
        .areas(area);
    let [popup] = Layout::horizontal([Constraint::Percentage(60)])
        .flex(Flex::Center)
        .areas(row);
    frame.render_widget(Clear, popup);
    frame.render_widget(
        Paragraph::new(text)
            .alignment(Alignment::Center)
            .block(Block::bordered().border_style(Style::default().fg(theme::WARN))),
        popup,
    );
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::app::{App, Screen};
    use crate::collect::LayerResult;
    use crate::model::{CodeData, CodeNum, Lens, build_skeleton};
    use crate::scan::ScanOutcome;
    use ratatui::Terminal;
    use ratatui::backend::TestBackend;
    use std::collections::HashMap;
    use std::path::PathBuf;
    use std::time::Duration;
    use tokei::LanguageType;

    fn code_data(lang: LanguageType, code: usize) -> CodeData {
        let num = CodeNum {
            code,
            comments: 0,
            blanks: 0,
        };
        let mut data = CodeData {
            num,
            primary_lang: Some(lang),
            ..Default::default()
        };
        data.langs.insert(lang, num);
        data
    }

    /// A loaded app for `/proj` with the code layer already computed.
    fn sample_app() -> App {
        let files = vec![
            (PathBuf::from("src/main.rs"), 4000),
            (PathBuf::from("src/app.rs"), 2000),
            (PathBuf::from("README.md"), 800),
        ];
        let dirs = vec![PathBuf::from("src")];
        let tree = build_skeleton(&files, &dirs, "proj".into());
        let mut app = App::new(PathBuf::from("/proj"), "proj".into());
        app.on_scan(ScanOutcome {
            tree,
            duration: Duration::from_millis(12),
            repo: false,
            head: None,
        });

        let mut layer = HashMap::new();
        layer.insert(
            PathBuf::from("src/main.rs"),
            code_data(LanguageType::Rust, 120),
        );
        layer.insert(
            PathBuf::from("src/app.rs"),
            code_data(LanguageType::Rust, 60),
        );
        layer.insert(
            PathBuf::from("README.md"),
            code_data(LanguageType::Markdown, 20),
        );
        app.on_layer(LayerResult::Code {
            files: layer,
            inaccurate: false,
        });
        app
    }

    #[test]
    fn renders_loaded_tree_without_panicking() {
        let mut app = sample_app();
        let mut terminal = Terminal::new(TestBackend::new(96, 16)).unwrap();
        terminal.draw(|frame| render(frame, &mut app)).unwrap();
        let view = format!("{}", terminal.backend());
        assert!(view.contains("tree"));
        assert!(view.contains("lines")); // code lens primary column
        assert!(view.contains("src"));
        assert!(view.contains("README.md"));
        assert!(view.contains("Markdown"));
    }

    #[test]
    fn renders_the_head_hash_left_of_the_loc_summary() {
        let mut app = sample_app();
        app.head_hash = Some("9ee4e1e".into());
        let mut terminal = Terminal::new(TestBackend::new(96, 16)).unwrap();
        terminal.draw(|frame| render(frame, &mut app)).unwrap();
        let view = format!("{}", terminal.backend());
        // The hash sits on the recap line, to the left of the "lines" total.
        let recap = view
            .lines()
            .find(|line| line.contains("lines"))
            .expect("the code lens recap line is rendered");
        let hash_at = recap.find("9ee4e1e").expect("the head hash is shown");
        let lines_at = recap.find("lines").unwrap();
        assert!(
            hash_at < lines_at,
            "hash must be left of the LOC summary:\n{view}"
        );
    }

    #[test]
    fn navigation_reuses_the_row_cache_but_content_changes_rebuild_it() {
        use crate::action::Action;
        let mut app = sample_app();
        let mut terminal = Terminal::new(TestBackend::new(96, 16)).unwrap();
        terminal.draw(|frame| render(frame, &mut app)).unwrap();

        let rev = |app: &App| {
            let Screen::Loaded(l) = &app.screen else {
                panic!("not loaded");
            };
            l.rebuild_rev
        };
        let first = rev(&app);

        // The render populated a cache keyed to the current content, width, and
        // computing state.
        if let Screen::Loaded(l) = &app.screen {
            let c = l.row_cache.as_ref().expect("render populates the cache");
            assert_eq!(c.rev, first);
            assert_eq!(c.width, 96);
            assert_eq!(c.computing, l.active_computing());
        }

        // Pure navigation doesn't change content, so the rev is stable and the
        // next render reuses the cache.
        app.update(Action::Down);
        assert_eq!(rev(&app), first, "navigation must not rebuild content");
        terminal.draw(|frame| render(frame, &mut app)).unwrap();

        // A content change bumps the rev; the next render rebuilds to match.
        app.update(Action::CycleSort);
        let after = rev(&app);
        assert!(after > first, "sorting changes content");
        terminal.draw(|frame| render(frame, &mut app)).unwrap();
        if let Screen::Loaded(l) = &app.screen {
            assert_eq!(l.row_cache.as_ref().unwrap().rev, after);
        }
    }

    #[test]
    fn excluding_a_directory_updates_the_rendered_header_totals() {
        use crate::action::Action;
        let mut app = sample_app();
        // Select the src directory (4000 + 2000 bytes across 2 files).
        if let Screen::Loaded(loaded) = &mut app.screen {
            let idx = loaded
                .visible
                .iter()
                .position(|&id| loaded.tree.nodes[id].name == "src")
                .expect("src is visible");
            loaded.table_state.select(Some(idx));
        }
        app.update(Action::ToggleExclude);

        let mut terminal = Terminal::new(TestBackend::new(96, 16)).unwrap();
        terminal.draw(|frame| render(frame, &mut app)).unwrap();
        let view = format!("{}", terminal.backend());
        // Only README.md remains counted, so the header drops from 3 files to 1.
        assert!(view.contains("1 files"), "totals should adjust:\n{view}");
        assert!(
            !view.contains("3 files"),
            "excluded files must not be counted:\n{view}"
        );
    }

    #[test]
    fn renders_a_sole_subdir_chain_as_one_concatenated_row() {
        // `src/main/java` is a chain of sole sub-directories: it must render as a
        // single concatenated row, never as separate `main` / `java` rows.
        let files = vec![(PathBuf::from("src/main/java/App.java"), 100)];
        let dirs = vec![
            PathBuf::from("src"),
            PathBuf::from("src/main"),
            PathBuf::from("src/main/java"),
        ];
        let tree = build_skeleton(&files, &dirs, "proj".into());
        let mut app = App::new(PathBuf::from("/proj"), "proj".into());
        app.on_scan(ScanOutcome {
            tree,
            duration: Duration::ZERO,
            repo: false,
            head: None,
        });

        let mut terminal = Terminal::new(TestBackend::new(96, 16)).unwrap();
        terminal.draw(|frame| render(frame, &mut app)).unwrap();
        let view = format!("{}", terminal.backend());
        assert!(
            view.contains("src/main/java"),
            "chain not concatenated:\n{view}"
        );
    }

    #[test]
    fn renders_size_lens_with_human_bytes() {
        let mut app = sample_app();
        app.update(crate::action::Action::JumpLens(2)); // size lens
        if let Screen::Loaded(loaded) = &app.screen {
            assert_eq!(loaded.active_lens, Lens::Size);
        }
        let mut terminal = Terminal::new(TestBackend::new(96, 16)).unwrap();
        terminal.draw(|frame| render(frame, &mut app)).unwrap();
        let view = format!("{}", terminal.backend());
        assert!(view.contains("size")); // size lens primary column
        assert!(view.contains("KB")); // human-readable bytes
    }

    #[test]
    fn preview_pane_shows_when_wide_and_folds_when_narrow() {
        let mut app = sample_app();

        // Wide and tall: the preview pane is shown (the selected dir renders a
        // short note, but the bordered " preview " title is present).
        let mut wide = Terminal::new(TestBackend::new(120, 30)).unwrap();
        wide.draw(|frame| render(frame, &mut app)).unwrap();
        let view = format!("{}", wide.backend());
        assert!(
            view.contains("preview"),
            "preview missing when wide:\n{view}"
        );

        // Narrow: it folds away so the tree keeps the room.
        let mut narrow = Terminal::new(TestBackend::new(80, 16)).unwrap();
        narrow.draw(|frame| render(frame, &mut app)).unwrap();
        let view = format!("{}", narrow.backend());
        assert!(!view.contains("preview"), "preview should fold:\n{view}");

        // Toggled off: no pane even on a wide terminal.
        if let Screen::Loaded(loaded) = &mut app.screen {
            loaded.show_preview = false;
        }
        wide.draw(|frame| render(frame, &mut app)).unwrap();
        let view = format!("{}", wide.backend());
        assert!(!view.contains("preview"), "preview should be off:\n{view}");
    }

    #[test]
    fn renders_focused_text_preview_with_line_numbers() {
        use crate::app::Focus;
        let mut app = sample_app();
        // Inject a text preview, focus the preview pane, and pin the cache key so
        // the renderer's `ensure_preview` won't overwrite our injected content.
        if let Screen::Loaded(loaded) = &mut app.screen {
            let src = b"fn main() {}\nlet x = 1;\n";
            let doc = karet_fileview::FileDoc::prepare(
                std::path::Path::new("x.rs"),
                src,
                src.len() as u64,
                &super::preview::preview_limits(),
            );
            loaded.preview = super::preview::Preview::from_doc(doc);
            loaded.preview_for = loaded.selected_id();
            loaded.focus = Focus::Preview;
        }
        let mut terminal = Terminal::new(TestBackend::new(120, 30)).unwrap();
        terminal.draw(|frame| render(frame, &mut app)).unwrap();
        let view = format!("{}", terminal.backend());
        assert!(view.contains("preview"), "preview title missing:\n{view}");
        assert!(view.contains("fn main"), "code text missing:\n{view}");
        // The line-number gutter renders "1" and "2" for the two lines.
        assert!(
            view.contains('1') && view.contains('2'),
            "gutter missing:\n{view}"
        );
    }

    #[test]
    fn renders_detail_panel_and_help_overlay() {
        let mut app = sample_app();
        if let Screen::Loaded(loaded) = &mut app.screen {
            loaded.show_detail = true;
        }
        let mut terminal = Terminal::new(TestBackend::new(110, 18)).unwrap();

        terminal.draw(|frame| render(frame, &mut app)).unwrap();
        let detail = format!("{}", terminal.backend());
        assert!(detail.contains("detail"));
        assert!(detail.contains("languages"));
        assert!(detail.contains("Rust"));

        app.show_help = true;
        terminal.draw(|frame| render(frame, &mut app)).unwrap();
        let help = format!("{}", terminal.backend());
        assert!(help.contains("keybindings"));
        assert!(help.contains("quit"));
    }
}