budget_tracker_tui 1.4.1

A feature rich TUI budget tracker app
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

use crate::app::state::{App, AppMode};
use crate::ui::ui;
use crossterm::event::{self, Event, KeyCode, KeyEvent, KeyEventKind, KeyModifiers};
use ratatui::Terminal;
use ratatui::prelude::Backend;
use std::result::Result as StdResult;
use std::time::Duration;

use super::{
    add_edit_mode, budget_mode, category_manager_mode, filter_mode, fuzzy_search_mode, help_mode,
    normal_mode, recurring_mode, selection_mode, settings_mode, summary_mode, transaction_io_mode,
};

pub fn run_app<B: Backend>(
    terminal: &mut Terminal<B>,
    app: &mut App,
) -> StdResult<(), Box<dyn std::error::Error>>
where
    <B as ratatui::backend::Backend>::Error: 'static,
{
    while !app.should_quit {
        // Check for status expiry
        if let Some(expiry) = app.status_expiry
            && std::time::Instant::now() > expiry
        {
            app.clear_status_message();
        }

        // Check for update in background channel
        if let Ok(Some(version)) = app.update_rx.try_recv() {
            app.update_available_version = Some(version);
            app.show_update_popup = true;
        }

        terminal.draw(|f| ui(f, app))?;

        if event::poll(Duration::from_millis(250))? {
            let event = match event::read()? {
                Event::Key(key) => Event::Key(normalize_key(key)),
                other => other,
            };
            match event {
                Event::Paste(text) => app.handle_paste(&text),
                Event::Key(key)
                    if key.kind == KeyEventKind::Press
                        && (key.modifiers == KeyModifiers::NONE
                                || (app.mode == AppMode::Settings && key.modifiers == KeyModifiers::CONTROL && matches!(key.code, KeyCode::Char('d') | KeyCode::Char('u') | KeyCode::Char('v')))
                                // Let Shift+Char pass through for typing capitals/symbols in settings path
                                || (app.mode == AppMode::Settings && key.modifiers == KeyModifiers::SHIFT && matches!(key.code, KeyCode::Char(_)))
                                // Import/Export path prompt: allow Shift+Char and Ctrl+D/U
                                || ((app.mode == AppMode::ImportTransactions || app.mode == AppMode::ExportTransactions) && key.modifiers == KeyModifiers::SHIFT && matches!(key.code, KeyCode::Char(_)))
                                || ((app.mode == AppMode::ImportTransactions || app.mode == AppMode::ExportTransactions) && key.modifiers == KeyModifiers::CONTROL && matches!(key.code, KeyCode::Char('d') | KeyCode::Char('u') | KeyCode::Char('v')))
                                // Allow Shift+Char in Adding, Editing and FuzzyFinding modes
                                || ((app.mode == AppMode::Adding || app.mode == AppMode::Editing || app.mode == AppMode::FuzzyFinding || app.mode == AppMode::CategoryEditor || app.mode == AppMode::CategoryCatalogFilter) && key.modifiers == KeyModifiers::SHIFT && matches!(key.code, KeyCode::Char(_)))
                                // Allow Shift+Arrow in date-like navigation modes
                                || ((app.mode == AppMode::Adding || app.mode == AppMode::Editing || app.mode == AppMode::AdvancedFiltering || app.mode == AppMode::RecurringSettings || app.mode == AppMode::Budget)
                                    && key.modifiers == KeyModifiers::SHIFT
                                    && matches!(key.code, KeyCode::Left | KeyCode::Right))
                                // Allow Ctrl+F/R in simple Filtering mode and Ctrl+R in AdvancedFiltering mode
                                || (app.mode == AppMode::Filtering && key.modifiers == KeyModifiers::CONTROL && matches!(key.code, KeyCode::Char('f') | KeyCode::Char('r')))
                                || (app.mode == AppMode::AdvancedFiltering && key.modifiers == KeyModifiers::CONTROL && matches!(key.code, KeyCode::Char('r')))
                                || (app.mode == AppMode::CategoryCatalogFilter && key.modifiers == KeyModifiers::CONTROL && matches!(key.code, KeyCode::Char('r')))
                                || ((app.mode == AppMode::Filtering || app.mode == AppMode::AdvancedFiltering) && key.modifiers == KeyModifiers::SHIFT && matches!(key.code, KeyCode::Char(_)))
                                // Allow Ctrl+Up/Down for jump navigation, Ctrl+C for copy, and Ctrl+F for advanced filter in Normal mode
                                || (app.mode == AppMode::Normal && key.modifiers == KeyModifiers::CONTROL && matches!(key.code, KeyCode::Up | KeyCode::Down | KeyCode::Char('c') | KeyCode::Char('f')))
                                // Allow Ctrl+Up/Down for jump navigation in the category catalog
                                || (app.mode == AppMode::CategoryCatalog && key.modifiers == KeyModifiers::CONTROL && matches!(key.code, KeyCode::Up | KeyCode::Down))
                                // Allow Ctrl+H for Help Toggle
                                || (key.modifiers == KeyModifiers::CONTROL && key.code == KeyCode::Char('h'))) =>
                {
                    if app.mode != AppMode::ConfirmDelete
                        && app.mode != AppMode::SelectingCategory
                        && app.mode != AppMode::SelectingSubcategory
                        && app.mode != AppMode::KeybindingsInfo
                    {
                        app.clear_status_message();
                    }
                    update(app, key);
                }
                _ => {}
            }
        }
    }
    Ok(())
}

// Shift has no distinct meaning for these keys, but is often still held when
// pressing them while typing capitals; treat them as their unmodified forms.
fn normalize_key(mut key: KeyEvent) -> KeyEvent {
    if key.modifiers == KeyModifiers::SHIFT
        && matches!(
            key.code,
            KeyCode::Backspace | KeyCode::Delete | KeyCode::Enter
        )
    {
        key.modifiers = KeyModifiers::NONE;
    }
    key
}

// Main input handler, dispatching based on mode
fn update(app: &mut App, key_event: KeyEvent) {
    if app.show_update_popup {
        if key_event.kind == KeyEventKind::Press {
            match key_event.code {
                KeyCode::Enter | KeyCode::Char('o') => {
                    let _ = crate::app::util::open_url(
                        "https://github.com/Feromond/budget_tracker_tui/releases",
                    );
                    app.show_update_popup = false;
                }
                _ => {
                    app.show_update_popup = false;
                }
            }
        }
        return;
    }

    // Global Toggle for Keybindings Help
    if key_event.modifiers == KeyModifiers::CONTROL && key_event.code == KeyCode::Char('h') {
        if app.mode == AppMode::KeybindingsInfo || app.mode == AppMode::KeybindingDetail {
            let prev = app.previous_mode.unwrap_or(AppMode::Normal);
            app.mode = prev;
            app.previous_mode = None;
        } else {
            app.previous_mode = Some(app.mode);
            app.mode = AppMode::KeybindingsInfo;
            app.help_table_state.select(Some(0));
            app.type_to_select.clear();
        }
        return;
    }

    match app.mode {
        AppMode::KeybindingsInfo | AppMode::KeybindingDetail => {
            help_mode::handle_help_mode(app, key_event)
        }
        AppMode::Normal => normal_mode::handle_normal_mode(app, key_event),
        AppMode::Adding | AppMode::Editing => add_edit_mode::handle_add_edit_mode(app, key_event),
        AppMode::ConfirmDelete => add_edit_mode::handle_confirm_delete(app, key_event),
        AppMode::Filtering | AppMode::AdvancedFiltering => {
            filter_mode::handle_filter_mode(app, key_event)
        }
        AppMode::FuzzyFinding => fuzzy_search_mode::handle_fuzzy_search_mode(app, key_event),
        AppMode::Summary | AppMode::CategorySummary => {
            summary_mode::handle_summary_mode(app, key_event)
        }
        AppMode::Budget => budget_mode::handle_budget_mode(app, key_event),
        AppMode::SelectingCategory
        | AppMode::SelectingSubcategory
        | AppMode::SelectingFilterCategory
        | AppMode::SelectingFilterSubcategory
        | AppMode::SelectingRecurrenceFrequency => {
            selection_mode::handle_selection_mode(app, key_event)
        }
        AppMode::Settings => settings_mode::handle_settings_mode(app, key_event),
        AppMode::ImportTransactions | AppMode::ExportTransactions => {
            transaction_io_mode::handle_transaction_io_mode(app, key_event)
        }
        AppMode::RecurringSettings => recurring_mode::handle_recurring_mode(app, key_event),
        AppMode::CategoryCatalog
        | AppMode::CategoryCatalogFilter
        | AppMode::CategoryEditor
        | AppMode::ConfirmCategoryDelete => {
            category_manager_mode::handle_category_manager_mode(app, key_event)
        }
    }
}