sabiql 1.8.0

A fast, driver-less TUI for browsing and editing PostgreSQL databases
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

use super::input_mode::InputMode;

#[derive(Debug, Clone, Default)]
pub struct ModalState {
    mode: InputMode,
    return_stack: Vec<InputMode>,
}

impl ModalState {
    pub fn active_mode(&self) -> InputMode {
        self.mode
    }

    pub fn set_mode(&mut self, mode: InputMode) {
        self.mode = mode;
        self.return_stack.clear();
    }

    pub fn push_mode(&mut self, mode: InputMode) {
        self.return_stack.push(self.mode);
        self.mode = mode;
    }

    pub fn pop_mode(&mut self) -> InputMode {
        self.mode = self.return_stack.pop().unwrap_or(InputMode::Normal);
        self.mode
    }

    pub fn replace_mode(&mut self, mode: InputMode) {
        self.mode = mode;
    }

    pub fn pop_mode_override(&mut self, target: InputMode) {
        self.return_stack.pop();
        self.mode = target;
    }

    pub fn return_destination(&self) -> InputMode {
        self.return_stack
            .last()
            .copied()
            .unwrap_or(InputMode::Normal)
    }

    pub fn is_modal_active(&self) -> bool {
        !matches!(self.mode, InputMode::Normal | InputMode::CellEdit)
    }
}

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

    #[test]
    fn default_mode_is_normal() {
        let modal = ModalState::default();

        assert_eq!(modal.active_mode(), InputMode::Normal);
        assert!(!modal.is_modal_active());
    }

    #[test]
    fn set_mode_changes_mode_and_clears_stack() {
        let mut modal = ModalState::default();
        modal.push_mode(InputMode::CommandLine);

        modal.set_mode(InputMode::TablePicker);

        assert_eq!(modal.active_mode(), InputMode::TablePicker);
        assert_eq!(modal.return_destination(), InputMode::Normal);
    }

    #[test]
    fn push_pop_preserves_return_mode() {
        let mut modal = ModalState::default();

        modal.push_mode(InputMode::CommandLine);

        assert_eq!(modal.active_mode(), InputMode::CommandLine);
        assert_eq!(modal.return_destination(), InputMode::Normal);

        let returned = modal.pop_mode();

        assert_eq!(returned, InputMode::Normal);
        assert_eq!(modal.active_mode(), InputMode::Normal);
    }

    #[test]
    fn push_from_non_normal_preserves_origin() {
        let mut modal = ModalState::default();
        modal.set_mode(InputMode::SqlModal);

        modal.push_mode(InputMode::QueryHistoryPicker);

        assert_eq!(modal.active_mode(), InputMode::QueryHistoryPicker);
        assert_eq!(modal.return_destination(), InputMode::SqlModal);

        let returned = modal.pop_mode();
        assert_eq!(returned, InputMode::SqlModal);
    }

    #[test]
    fn nested_push_pop() {
        let mut modal = ModalState::default();

        modal.push_mode(InputMode::CommandLine);
        modal.push_mode(InputMode::ConfirmDialog);

        assert_eq!(modal.active_mode(), InputMode::ConfirmDialog);

        modal.pop_mode();
        assert_eq!(modal.active_mode(), InputMode::CommandLine);

        modal.pop_mode();
        assert_eq!(modal.active_mode(), InputMode::Normal);
    }

    #[test]
    fn pop_on_empty_stack_returns_normal() {
        let mut modal = ModalState::default();
        modal.set_mode(InputMode::CommandLine);

        let returned = modal.pop_mode();

        assert_eq!(returned, InputMode::Normal);
    }

    #[test]
    fn replace_mode_keeps_stack() {
        let mut modal = ModalState::default();
        modal.set_mode(InputMode::ConnectionSelector);
        modal.push_mode(InputMode::ConnectionSetup);

        modal.replace_mode(InputMode::ConnectionError);

        assert_eq!(modal.active_mode(), InputMode::ConnectionError);
        assert_eq!(modal.return_destination(), InputMode::ConnectionSelector);
    }

    #[test]
    fn pop_mode_override_ignores_stack() {
        let mut modal = ModalState::default();
        modal.push_mode(InputMode::ConfirmDialog);

        modal.pop_mode_override(InputMode::ConnectionSetup);

        assert_eq!(modal.active_mode(), InputMode::ConnectionSetup);
        // Stack entry was consumed
        assert_eq!(modal.return_destination(), InputMode::Normal);
    }

    #[test]
    fn is_modal_active_for_various_modes() {
        let mut modal = ModalState::default();

        modal.set_mode(InputMode::Normal);
        assert!(!modal.is_modal_active());

        modal.set_mode(InputMode::CellEdit);
        assert!(!modal.is_modal_active());

        modal.set_mode(InputMode::CommandLine);
        assert!(modal.is_modal_active());

        modal.set_mode(InputMode::Help);
        assert!(modal.is_modal_active());
    }

    #[test]
    fn return_destination_with_empty_stack() {
        let modal = ModalState::default();

        assert_eq!(modal.return_destination(), InputMode::Normal);
    }

    #[test]
    fn return_destination_shows_last_pushed() {
        let mut modal = ModalState::default();
        modal.set_mode(InputMode::SqlModal);
        modal.push_mode(InputMode::QueryHistoryPicker);

        assert_eq!(modal.return_destination(), InputMode::SqlModal);
    }
}