dbcrab 0.5.0

Modern REPL-first PostgreSQL client.
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

use std::io;

use crossterm::{
    clipboard::CopyToClipboard,
    event::{self, Event, KeyEventKind},
    execute,
    terminal::{self as crossterm_terminal, EnterAlternateScreen, LeaveAlternateScreen},
};
use ratatui::{DefaultTerminal, Terminal, backend::CrosstermBackend};
use sqlx::PgPool;

use crate::{
    config::{KeyRemaps, TuiKeybindings},
    errors::AppResult,
    render::ResultGrid,
};

mod ansi;
mod edit;
mod preview;
mod render;
mod state;
mod update;

#[cfg(test)]
mod tests;

use render::render_result_grid;
use state::{GridViewState, TuiRequest};
use update::update_selected_row;

pub async fn show_result_grid(
    grid: &mut ResultGrid,
    keybindings: &TuiKeybindings,
    key_remaps: &KeyRemaps,
) -> AppResult<()> {
    show_result_grid_with_updates(grid, keybindings, key_remaps, None).await
}

pub async fn show_result_grid_with_updates(
    grid: &mut ResultGrid,
    keybindings: &TuiKeybindings,
    key_remaps: &KeyRemaps,
    pool: Option<&PgPool>,
) -> AppResult<()> {
    let mut session = TerminalSession::start()?;
    let result = run_result_grid(&mut session.terminal, grid, keybindings, key_remaps, pool).await;
    let restore_result = session.restore();

    match (result, restore_result) {
        (Err(err), _) => Err(err),
        (Ok(()), Err(err)) => Err(err.into()),
        (Ok(()), Ok(())) => Ok(()),
    }
}

struct TerminalSession {
    terminal: DefaultTerminal,
    restored: bool,
}

impl TerminalSession {
    fn start() -> io::Result<Self> {
        crossterm_terminal::enable_raw_mode()?;
        if let Err(err) = execute!(io::stdout(), EnterAlternateScreen) {
            let _ = crossterm_terminal::disable_raw_mode();
            return Err(err);
        }

        let backend = CrosstermBackend::new(io::stdout());
        let terminal = match Terminal::new(backend) {
            Ok(terminal) => terminal,
            Err(err) => {
                let _ = restore_terminal();
                return Err(err);
            }
        };

        Ok(Self {
            terminal,
            restored: false,
        })
    }

    fn restore(&mut self) -> io::Result<()> {
        self.restored = true;
        restore_terminal()
    }
}

impl Drop for TerminalSession {
    fn drop(&mut self) {
        if !self.restored {
            let _ = restore_terminal();
        }
    }
}

fn restore_terminal() -> io::Result<()> {
    let raw_result = crossterm_terminal::disable_raw_mode();
    let screen_result = execute!(io::stdout(), LeaveAlternateScreen);

    match (raw_result, screen_result) {
        (Err(err), _) => Err(err),
        (Ok(()), Err(err)) => Err(err),
        (Ok(()), Ok(())) => Ok(()),
    }
}

async fn run_result_grid(
    terminal: &mut DefaultTerminal,
    grid: &mut ResultGrid,
    keybindings: &TuiKeybindings,
    key_remaps: &KeyRemaps,
    pool: Option<&PgPool>,
) -> AppResult<()> {
    let mut state = GridViewState::new();
    state.clamp_to_grid(grid);

    loop {
        terminal.draw(|frame| render_result_grid(frame, grid, &mut state, keybindings))?;

        let Event::Key(key) = event::read()? else {
            continue;
        };

        if key.kind != KeyEventKind::Press {
            continue;
        }

        let key = if state.is_editing() {
            key_remaps.remap_text_input_key_event(key)
        } else {
            key_remaps.remap_key_event(key)
        };

        match state.handle_key(key, grid, keybindings) {
            TuiRequest::Continue => {}
            TuiRequest::Quit => break,
            TuiRequest::YankCell(value) => {
                let message = match yank_cell_to_clipboard(&value) {
                    Ok(()) => "yanked cell",
                    Err(_) => "yank failed",
                };
                state.set_toast(message);
            }
            TuiRequest::UpdateSelectedRow => {
                state.set_toast("updating row...");
                terminal.draw(|frame| render_result_grid(frame, grid, &mut state, keybindings))?;
                let result =
                    update_selected_row(grid, state.selected_row, &mut state.staged, pool).await;
                if result.updated {
                    state.invalidate_preview();
                }
                state.set_toast(result.message);
            }
        }
    }

    Ok(())
}

fn yank_cell_to_clipboard(value: &str) -> io::Result<()> {
    execute!(io::stdout(), CopyToClipboard::to_clipboard_from(value))
}