govctl 0.8.3

Project governance CLI for RFC, ADR, and Work Item management
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

//! TUI module for interactive dashboard.
//!
//! This module provides an interactive terminal UI for browsing
//! RFCs, ADRs, and Work Items.

mod app;
mod event;
mod ui;

use crate::config::Config;
use crate::diagnostic::{Diagnostic, DiagnosticCode, DiagnosticLevel};
use crate::load::load_project;
use anyhow::Result;
use crossterm::{
    event::{DisableMouseCapture, EnableMouseCapture},
    execute,
    terminal::{EnterAlternateScreen, LeaveAlternateScreen, disable_raw_mode, enable_raw_mode},
};
use ratatui::prelude::*;

pub use app::App;

fn project_load_error(diags: Vec<Diagnostic>, gov_root: &std::path::Path) -> anyhow::Error {
    let first = diags.first().cloned();
    diags
        .into_iter()
        .find(|d| d.level == DiagnosticLevel::Error)
        .or(first)
        .map(anyhow::Error::from)
        .unwrap_or_else(|| {
            Diagnostic::new(
                DiagnosticCode::E0501ConfigInvalid,
                "Failed to load project",
                gov_root.display().to_string(),
            )
            .into()
        })
}

/// Run the TUI application
pub fn run(config: &Config) -> Result<()> {
    // Load project data
    let index =
        load_project(config).map_err(|diags| project_load_error(diags, &config.gov_root))?;

    // Setup terminal
    enable_raw_mode()?;
    let mut stdout = std::io::stdout();
    execute!(stdout, EnterAlternateScreen, EnableMouseCapture)?;
    let backend = CrosstermBackend::new(stdout);
    let mut terminal = Terminal::new(backend)?;

    // Create app state
    let mut app = App::new(index);

    // Run event loop
    let result = event::run_event_loop(&mut terminal, &mut app);

    // Restore terminal
    disable_raw_mode()?;
    execute!(
        terminal.backend_mut(),
        LeaveAlternateScreen,
        DisableMouseCapture
    )?;
    terminal.show_cursor()?;

    result
}

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

    #[test]
    fn test_project_load_error_prefers_error_diagnostic() -> Result<(), Box<dyn std::error::Error>>
    {
        let err = project_load_error(
            vec![
                Diagnostic::new(DiagnosticCode::W0109WorkNoActive, "warning", "warn"),
                Diagnostic::new(DiagnosticCode::E0302AdrNotFound, "missing adr", "gov/adr"),
            ],
            std::path::Path::new("gov"),
        );

        let diag = err
            .downcast_ref::<Diagnostic>()
            .ok_or("expected Diagnostic")?;
        assert_eq!(diag.code, DiagnosticCode::E0302AdrNotFound);
        assert_eq!(diag.message, "missing adr");
        Ok(())
    }

    #[test]
    fn test_project_load_error_uses_warning_when_no_errors_exist()
    -> Result<(), Box<dyn std::error::Error>> {
        let err = project_load_error(
            vec![Diagnostic::new(
                DiagnosticCode::W0109WorkNoActive,
                "warning only",
                "gov/work",
            )],
            std::path::Path::new("gov"),
        );

        let diag = err
            .downcast_ref::<Diagnostic>()
            .ok_or("expected Diagnostic")?;
        assert_eq!(diag.code, DiagnosticCode::W0109WorkNoActive);
        assert_eq!(diag.message, "warning only");
        Ok(())
    }

    #[test]
    fn test_project_load_error_falls_back_when_empty() -> Result<(), Box<dyn std::error::Error>> {
        let err = project_load_error(vec![], std::path::Path::new("gov"));

        let diag = err
            .downcast_ref::<Diagnostic>()
            .ok_or("expected Diagnostic")?;
        assert_eq!(diag.code, DiagnosticCode::E0501ConfigInvalid);
        assert_eq!(diag.message, "Failed to load project");
        assert_eq!(diag.file, "gov");
        Ok(())
    }
}