sabiql 1.8.2

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
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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
use std::collections::BTreeSet;
use std::time::Instant;

use super::focused_pane::FocusedPane;
use super::inspector_tab::InspectorTab;
use super::keybindings::help_content_line_count;
use super::viewport::ViewportPlan;

// header (1) + scroll indicators (2), used by rendering (border already excluded)
pub const RESULT_INNER_OVERHEAD: u16 = 3;

// border (2) + inner overhead, used by scroll limit calculation
pub const RESULT_PANE_OVERHEAD: u16 = 2 + RESULT_INNER_OVERHEAD;

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ResultNavMode {
    Scroll,
    RowActive,
    CellActive,
}

#[derive(Debug, Clone, Copy)]
pub struct YankFlash {
    pub row: usize,
    pub col: Option<usize>,
    pub until: Instant,
}

// Invariant: `cell` is `Some` only when `row` is `Some`.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct ResultSelection {
    row: Option<usize>,
    cell: Option<usize>,
}

impl ResultSelection {
    pub fn mode(&self) -> ResultNavMode {
        match (self.row, self.cell) {
            (Some(_), Some(_)) => ResultNavMode::CellActive,
            (Some(_), None) => ResultNavMode::RowActive,
            _ => ResultNavMode::Scroll,
        }
    }

    pub fn row(&self) -> Option<usize> {
        self.row
    }

    pub fn cell(&self) -> Option<usize> {
        self.cell
    }

    pub fn enter_row(&mut self, row: usize) {
        self.row = Some(row);
        self.cell = None;
    }

    pub fn move_row(&mut self, row: usize) {
        self.row = Some(row);
    }

    pub fn enter_cell(&mut self, col: usize) {
        if self.row.is_some() {
            self.cell = Some(col);
        }
    }

    pub fn exit_to_row(&mut self) {
        self.cell = None;
    }

    pub fn reset(&mut self) {
        self.row = None;
        self.cell = None;
    }

    pub fn clamp(&mut self, max_rows: usize, max_cols: usize) {
        if max_rows == 0 {
            self.reset();
            return;
        }
        if let Some(r) = self.row
            && r >= max_rows
        {
            self.reset();
            return;
        }
        if max_cols == 0 {
            self.cell = None;
            return;
        }
        if let Some(c) = self.cell
            && c >= max_cols
        {
            self.cell = Some(max_cols - 1);
        }
    }
}

#[derive(Debug, Clone, Default)]
pub struct UiState {
    pub focused_pane: FocusedPane,
    pub focus_mode: bool,
    pub focus_mode_prev_pane: Option<FocusedPane>,
    pub explorer_selected: usize,
    pub explorer_scroll_offset: usize,
    pub explorer_horizontal_offset: usize,

    pub connection_list_selected: usize,
    pub connection_list_scroll_offset: usize,
    pub connection_list_pane_height: u16,

    pub picker_selected: usize,
    pub picker_scroll_offset: usize,
    pub picker_pane_height: u16,
    pub filter_input: String,

    pub er_filter_input: String,
    pub er_picker_selected: usize,
    pub er_picker_scroll_offset: usize,
    pub er_picker_pane_height: u16,
    pub er_selected_tables: BTreeSet<String>,
    pub pending_er_picker: bool,

    pub inspector_tab: InspectorTab,
    pub inspector_scroll_offset: usize,
    pub inspector_horizontal_offset: usize,
    pub inspector_viewport_plan: ViewportPlan,
    pub inspector_pane_height: u16,

    pub explorer_pane_height: u16,

    pub result_viewport_plan: ViewportPlan,
    pub result_pane_height: u16,

    pub help_scroll_offset: usize,

    pub terminal_height: u16,

    pub pending_z: bool,
}

impl UiState {
    pub fn new() -> Self {
        Self {
            terminal_height: 24,
            ..Default::default()
        }
    }

    pub fn result_visible_rows(&self) -> usize {
        self.result_pane_height.saturating_sub(RESULT_PANE_OVERHEAD) as usize
    }

    pub fn inspector_visible_rows(&self) -> usize {
        self.inspector_pane_height.saturating_sub(5) as usize
    }

    pub fn explorer_visible_items(&self) -> usize {
        self.explorer_pane_height.saturating_sub(3) as usize
    }

    pub fn connection_list_visible_items(&self) -> usize {
        self.connection_list_pane_height as usize
    }

    pub fn picker_visible_items(&self) -> usize {
        self.picker_pane_height as usize
    }

    pub fn er_picker_visible_items(&self) -> usize {
        self.er_picker_pane_height as usize
    }

    pub fn inspector_ddl_visible_rows(&self) -> usize {
        self.inspector_pane_height.saturating_sub(3) as usize
    }

    pub fn help_max_scroll(&self) -> usize {
        let viewport = (self.terminal_height as usize * 80 / 100).saturating_sub(2);
        help_content_line_count().saturating_sub(viewport)
    }

    pub fn toggle_focus(&mut self) -> bool {
        if self.focus_mode {
            if let Some(prev) = self.focus_mode_prev_pane.take() {
                self.focused_pane = prev;
            }
            self.focus_mode = false;
        } else {
            self.focus_mode_prev_pane = Some(self.focused_pane);
            self.focused_pane = FocusedPane::Result;
            self.focus_mode = true;
        }
        true
    }

    pub fn set_explorer_selection(&mut self, index: Option<usize>) {
        match index {
            Some(i) => {
                self.explorer_scroll_offset = clamp_scroll_offset(
                    i,
                    self.explorer_scroll_offset,
                    self.explorer_visible_items(),
                );
                self.explorer_selected = i;
            }
            None => {
                self.explorer_selected = 0;
                self.explorer_scroll_offset = 0;
            }
        }
    }

    pub fn set_connection_list_selection(&mut self, index: Option<usize>) {
        match index {
            Some(i) => {
                self.connection_list_scroll_offset = clamp_scroll_offset(
                    i,
                    self.connection_list_scroll_offset,
                    self.connection_list_visible_items(),
                );
                self.connection_list_selected = i;
            }
            None => {
                self.connection_list_selected = 0;
                self.connection_list_scroll_offset = 0;
            }
        }
    }

    pub fn set_picker_selection(&mut self, index: usize) {
        self.picker_scroll_offset = clamp_scroll_offset(
            index,
            self.picker_scroll_offset,
            self.picker_visible_items(),
        );
        self.picker_selected = index;
    }

    pub fn reset_picker_selection(&mut self) {
        self.picker_selected = 0;
        self.picker_scroll_offset = 0;
    }

    pub fn set_er_picker_selection(&mut self, index: usize) {
        self.er_picker_scroll_offset = clamp_scroll_offset(
            index,
            self.er_picker_scroll_offset,
            self.er_picker_visible_items(),
        );
        self.er_picker_selected = index;
    }

    pub fn reset_er_picker_selection(&mut self) {
        self.er_picker_selected = 0;
        self.er_picker_scroll_offset = 0;
    }
}

pub fn clamp_scroll_offset(selected: usize, current_offset: usize, viewport: usize) -> usize {
    if viewport == 0 {
        return 0;
    }
    let bottom_edge = current_offset + viewport.saturating_sub(1);
    if selected > bottom_edge {
        // selected fell below viewport bottom — scroll down minimally
        selected - viewport.saturating_sub(1)
    } else if selected < current_offset {
        // selected rose above viewport top — scroll up minimally
        selected
    } else {
        current_offset
    }
}

pub fn list_scroll_offset(selected: usize, viewport: usize) -> usize {
    selected.saturating_sub(viewport.saturating_sub(1))
}

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

    #[test]
    fn default_creates_empty_state() {
        let state = UiState::default();

        assert_eq!(state.focused_pane, FocusedPane::default());
        assert!(!state.focus_mode);
        assert!(state.focus_mode_prev_pane.is_none());
        assert_eq!(state.explorer_selected, 0);
        assert!(state.filter_input.is_empty());
    }

    #[test]
    fn new_sets_terminal_height() {
        let state = UiState::new();

        assert_eq!(state.terminal_height, 24);
    }

    #[test]
    fn default_result_pane_height_returns_zero_visible_rows() {
        let state = UiState::default();

        let visible = state.result_visible_rows();

        assert_eq!(visible, 0);
    }

    #[rstest]
    #[case(10, 5)]
    #[case(15, 10)]
    #[case(20, 15)]
    #[case(30, 25)]
    fn result_pane_height_calculates_correct_visible_rows(
        #[case] pane_height: u16,
        #[case] expected: usize,
    ) {
        let state = UiState {
            result_pane_height: pane_height,
            ..Default::default()
        };

        let visible = state.result_visible_rows();

        assert_eq!(visible, expected);
    }

    #[test]
    fn small_result_pane_height_does_not_underflow() {
        let state = UiState {
            result_pane_height: 2,
            ..Default::default()
        };

        let visible = state.result_visible_rows();

        assert_eq!(visible, 0);
    }

    #[test]
    fn toggle_focus_enters_focus_mode() {
        let mut state = UiState {
            focused_pane: FocusedPane::Explorer,
            ..Default::default()
        };

        let result = state.toggle_focus();

        assert!(result);
        assert!(state.focus_mode);
        assert_eq!(state.focused_pane, FocusedPane::Result);
        assert_eq!(state.focus_mode_prev_pane, Some(FocusedPane::Explorer));
    }

    #[test]
    fn toggle_focus_exits_focus_mode_and_restores_pane() {
        let mut state = UiState {
            focused_pane: FocusedPane::Inspector,
            ..Default::default()
        };
        state.toggle_focus();

        let result = state.toggle_focus();

        assert!(result);
        assert!(!state.focus_mode);
        assert_eq!(state.focused_pane, FocusedPane::Inspector);
    }

    #[rstest]
    #[case(10, 7)]
    #[case(15, 12)]
    #[case(20, 17)]
    fn ddl_visible_rows_equals_height_minus_three(
        #[case] pane_height: u16,
        #[case] expected: usize,
    ) {
        let state = UiState {
            inspector_pane_height: pane_height,
            ..Default::default()
        };

        let visible = state.inspector_ddl_visible_rows();

        assert_eq!(visible, expected);
    }

    #[test]
    fn ddl_visible_rows_is_greater_than_standard() {
        let state = UiState {
            inspector_pane_height: 20,
            ..Default::default()
        };

        let standard = state.inspector_visible_rows();
        let ddl = state.inspector_ddl_visible_rows();

        assert_eq!(ddl - standard, 2);
    }

    #[test]
    fn set_explorer_selection_with_some_sets_index() {
        let mut state = UiState::default();

        state.set_explorer_selection(Some(5));

        assert_eq!(state.explorer_selected, 5);
    }

    #[test]
    fn set_explorer_selection_with_none_resets_to_zero() {
        let mut state = UiState::default();
        state.set_explorer_selection(Some(10));

        state.set_explorer_selection(None);

        assert_eq!(state.explorer_selected, 0);
    }

    #[test]
    fn set_connection_list_selection_with_some_sets_index() {
        let mut state = UiState::default();

        state.set_connection_list_selection(Some(3));

        assert_eq!(state.connection_list_selected, 3);
    }

    #[test]
    fn set_connection_list_selection_with_none_resets_to_zero() {
        let mut state = UiState::default();
        state.set_connection_list_selection(Some(5));

        state.set_connection_list_selection(None);

        assert_eq!(state.connection_list_selected, 0);
    }

    #[test]
    fn result_overhead_constants_are_consistent() {
        assert_eq!(RESULT_PANE_OVERHEAD, RESULT_INNER_OVERHEAD + 2);
    }

    mod help_scroll {
        use super::*;

        #[test]
        fn help_max_scroll_plus_viewport_equals_content_line_count() {
            // terminal_height=24 → viewport = 24*80/100 - 2 = 17
            // max_scroll should equal total_lines - viewport (not saturated)
            let terminal_height: u16 = 24;
            let state = UiState {
                terminal_height,
                ..Default::default()
            };
            let viewport = (terminal_height as usize * 80 / 100).saturating_sub(2);

            let max = state.help_max_scroll();

            assert_eq!(
                max + viewport,
                help_content_line_count(),
                "max_scroll({}) + viewport({}) != total_lines({})",
                max,
                viewport,
                help_content_line_count()
            );
        }

        #[test]
        fn help_max_scroll_is_zero_when_terminal_very_tall() {
            let state = UiState {
                terminal_height: 1000,
                ..Default::default()
            };

            // viewport is huge, so max_scroll saturates at 0
            let max = state.help_max_scroll();

            assert_eq!(max, 0);
        }
    }

    #[rstest]
    #[case(30, 20)]
    #[case(100, 25)]
    #[case(50, 15)]
    #[case(10, 30)]
    fn scroll_can_reach_all_rows(#[case] total_rows: usize, #[case] pane_height: u16) {
        let state = UiState {
            result_pane_height: pane_height,
            ..Default::default()
        };
        let visible = state.result_visible_rows();
        let max_scroll = total_rows.saturating_sub(visible);

        assert!(
            max_scroll + visible >= total_rows,
            "max_scroll={}, visible={}, total={}",
            max_scroll,
            visible,
            total_rows
        );
    }

    mod result_selection {
        use super::*;

        #[test]
        fn default_is_scroll_mode() {
            let sel = ResultSelection::default();

            assert_eq!(sel.mode(), ResultNavMode::Scroll);
            assert!(sel.row().is_none());
            assert!(sel.cell().is_none());
        }

        #[test]
        fn enter_row_transitions_to_row_active() {
            let mut sel = ResultSelection::default();

            sel.enter_row(5);

            assert_eq!(sel.mode(), ResultNavMode::RowActive);
            assert_eq!(sel.row(), Some(5));
            assert!(sel.cell().is_none());
        }

        #[test]
        fn enter_cell_transitions_to_cell_active() {
            let mut sel = ResultSelection::default();
            sel.enter_row(3);

            sel.enter_cell(7);

            assert_eq!(sel.mode(), ResultNavMode::CellActive);
            assert_eq!(sel.row(), Some(3));
            assert_eq!(sel.cell(), Some(7));
        }

        #[test]
        fn enter_cell_without_row_is_noop() {
            let mut sel = ResultSelection::default();

            sel.enter_cell(5);

            assert_eq!(sel.mode(), ResultNavMode::Scroll);
        }

        #[test]
        fn exit_to_row_clears_cell_only() {
            let mut sel = ResultSelection::default();
            sel.enter_row(2);
            sel.enter_cell(4);

            sel.exit_to_row();

            assert_eq!(sel.mode(), ResultNavMode::RowActive);
            assert_eq!(sel.row(), Some(2));
        }

        #[test]
        fn reset_clears_both() {
            let mut sel = ResultSelection::default();
            sel.enter_row(1);
            sel.enter_cell(2);

            sel.reset();

            assert_eq!(sel.mode(), ResultNavMode::Scroll);
        }

        #[test]
        fn enter_row_clears_previous_cell() {
            let mut sel = ResultSelection::default();
            sel.enter_row(0);
            sel.enter_cell(3);

            sel.enter_row(5);

            assert_eq!(sel.mode(), ResultNavMode::RowActive);
            assert_eq!(sel.row(), Some(5));
        }

        #[test]
        fn move_row_preserves_cell() {
            let mut sel = ResultSelection::default();
            sel.enter_row(0);
            sel.enter_cell(3);

            sel.move_row(5);

            assert_eq!(sel.mode(), ResultNavMode::CellActive);
            assert_eq!(sel.row(), Some(5));
            assert_eq!(sel.cell(), Some(3));
        }

        #[test]
        fn move_row_in_row_active_stays_row_active() {
            let mut sel = ResultSelection::default();
            sel.enter_row(2);

            sel.move_row(7);

            assert_eq!(sel.mode(), ResultNavMode::RowActive);
            assert_eq!(sel.row(), Some(7));
        }

        #[test]
        fn clamp_resets_when_zero_rows() {
            let mut sel = ResultSelection::default();
            sel.enter_row(5);

            sel.clamp(0, 10);

            assert_eq!(sel.mode(), ResultNavMode::Scroll);
        }

        #[test]
        fn clamp_resets_when_row_out_of_bounds() {
            let mut sel = ResultSelection::default();
            sel.enter_row(10);
            sel.enter_cell(2);

            sel.clamp(5, 10);

            assert_eq!(sel.mode(), ResultNavMode::Scroll);
        }

        #[test]
        fn clamp_caps_cell_to_max_cols() {
            let mut sel = ResultSelection::default();
            sel.enter_row(0);
            sel.enter_cell(9);

            sel.clamp(10, 5);

            assert_eq!(sel.cell(), Some(4));
        }

        #[test]
        fn clamp_clears_cell_when_zero_cols() {
            let mut sel = ResultSelection::default();
            sel.enter_row(0);
            sel.enter_cell(3);

            sel.clamp(10, 0);

            assert_eq!(sel.mode(), ResultNavMode::RowActive);
        }

        #[test]
        fn clamp_preserves_valid_selection() {
            let mut sel = ResultSelection::default();
            sel.enter_row(3);
            sel.enter_cell(2);

            sel.clamp(10, 10);

            assert_eq!(sel.row(), Some(3));
            assert_eq!(sel.cell(), Some(2));
        }
    }
}