clankerdiff-ratatui 0.1.0

Embeddable Ratatui diff review widget
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
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
#![allow(missing_docs, unused_must_use)]

mod support;

use clankerdiff_core::{
    DiffDocument, DiffReviewEvent, DiffScope, DiffSide, FileDiff, Layout, LineAnchor, PatchLine,
    PatchLineKind, RepositoryAction, Review, RowKind, SourceUnavailable, StageState, ViewMode,
    testing::DocumentBuilder,
};
use clankerdiff_ratatui::{
    DiffReviewInput, DiffReviewState, DiffReviewWidget, FocusPane, RatatuiTheme,
};
use clankerdiff_theme::DiffTheme;
use crossterm::event::{KeyCode, KeyModifiers, MouseButton, MouseEvent, MouseEventKind};
use ratatui::{Terminal, backend::TestBackend, layout::Position};
use std::{fmt::Write, sync::Arc};
use support::{key, key_with, mouse};

fn changed_document() -> Arc<DiffDocument> {
    DocumentBuilder::new()
        .changed("src/main.rs", "fn old() {}\n", "fn new() {}\n")
        .changed("README.md", "old\n", "new\n")
        .build()
}

fn draw(state: &mut DiffReviewState, width: u16, height: u16) -> String {
    support::render_review(state, width, height)
}

fn type_text(state: &mut DiffReviewState, text: &str) {
    support::type_review_text(state, text);
}

#[allow(clippy::format_collect)]
fn full_file_fixture() -> Arc<DiffDocument> {
    let old = (1..=80).fold(String::new(), |mut text, line| {
        use std::fmt::Write;
        let _ = writeln!(text, "line {line}");
        text
    });
    let new = old.replace("line 41\n", "changed 41\n");
    DocumentBuilder::new()
        .changed_with_hunk_window("src/main.rs", &old, &new, 38..=44)
        .build()
}

#[test]
fn context_and_full_file_keys_use_eager_sources_and_keep_expanded_rows_non_commentable() {
    let fixture = full_file_fixture();
    let mut state = DiffReviewState::new(fixture);
    state.session_mut().set_view_mode(ViewMode::Unified);
    state.handle_input(key(KeyCode::Tab));
    assert_eq!(state.focus(), FocusPane::Diff);
    state.handle_input(key(KeyCode::Char('f')));
    let expanded = state
        .presentation()
        .rows(0..state.presentation().row_count())
        .iter()
        .position(|row| row.kind == RowKind::ExpandedContext)
        .unwrap();
    assert!(state.session_mut().select_row(expanded));
    state.handle_input(key(KeyCode::Char('c')));
    assert!(state.session().draft().is_none());

    state.handle_input(key(KeyCode::Char('f')));
    state.handle_input(key(KeyCode::Char('o')));
    let before = state
        .presentation()
        .rows(0..state.presentation().row_count())
        .iter()
        .filter(|row| row.kind == RowKind::ExpandedContext)
        .count();
    assert!(before > 0);
    let gap = state
        .presentation()
        .rows(0..state.presentation().row_count())
        .iter()
        .position(|row| row.kind == RowKind::ExpandGap)
        .unwrap();
    assert!(state.session_mut().select_row(gap));
    state.handle_input(key(KeyCode::Enter));
    let after = state
        .presentation()
        .rows(0..state.presentation().row_count())
        .iter()
        .filter(|row| row.kind == RowKind::ExpandedContext)
        .count();
    assert!(after > before);
}

#[test]
fn unavailable_sources_render_a_deterministic_inline_reason() {
    let old = (1..=80).fold(String::new(), |mut text, line| {
        use std::fmt::Write;
        let _ = writeln!(text, "line {line}");
        text
    });
    let new = old.replace("line 41\n", "changed 41\n");
    let fixture = DocumentBuilder::new()
        .changed_with_hunk_window("src/main.rs", &old, &new, 38..=44)
        .source(
            "src/main.rs",
            DiffSide::Old,
            Err::<Arc<str>, _>(SourceUnavailable::TooLarge { bytes: 9_000_000 }),
        )
        .source(
            "src/main.rs",
            DiffSide::New,
            Err::<Arc<str>, _>(SourceUnavailable::TooLarge { bytes: 9_000_000 }),
        )
        .build();
    let mut state = DiffReviewState::new(fixture);
    state.handle_input(key(KeyCode::Tab));
    state.handle_input(key(KeyCode::Char('f')));
    let rendered = draw(&mut state, 100, 80);
    assert!(
        rendered.contains("source is too large to expand"),
        "{rendered}"
    );
}

#[test]
fn narrow_and_wide_views_share_core_presentation() {
    let mut state = DiffReviewState::new(changed_document());
    let narrow = draw(&mut state, 60, 12);
    assert!(narrow.contains("src/main.rs"), "{narrow}");
    assert!(narrow.contains("fn old() {}"), "{narrow}");
    assert!(narrow.contains("fn new() {}"), "{narrow}");
    assert_eq!(state.layout(), Layout::Unified);
    assert!(!narrow.contains(''), "narrow view must hide the drawer");

    let wide = draw(&mut state, 140, 12);
    assert!(wide.contains("M main.rs +1 -1"), "{wide}");
    assert!(wide.contains("▾ src/"), "{wide}");
    assert!(wide.contains(''), "{wide}");
    assert_eq!(state.layout(), Layout::Split);
}

#[test]
fn drawer_stage_markers_share_a_trailing_column() {
    let mut document = (*DocumentBuilder::new()
        .changed("src/nested/main.rs", "old\n", "new\n")
        .changed("src/lib.rs", "old\n", "new\n")
        .changed("README.md", "old\n", "new\n")
        .build())
    .clone();
    document.files[0].staged = StageState::Staged;
    document.files[1].staged = StageState::Unstaged;
    let mut state = DiffReviewState::new(Arc::new(document));

    let rendered = draw(&mut state, 100, 12);
    let marker_columns = rendered
        .lines()
        .filter_map(|line| {
            line.chars()
                .position(|character| matches!(character, '' | '' | ''))
        })
        .collect::<Vec<_>>();

    assert!(marker_columns.len() >= 5, "{rendered}");
    assert!(
        marker_columns
            .iter()
            .all(|column| *column == marker_columns[0]),
        "stage markers must share one column: {marker_columns:?}\n{rendered}"
    );
}

#[test]
fn trailing_drawer_stage_column_is_clickable_for_directories_and_files() {
    let document = DocumentBuilder::new()
        .changed("src/main.rs", "old\n", "new\n")
        .changed("src/lib.rs", "old\n", "new\n")
        .build();
    let expected_directory_paths = document
        .files
        .iter()
        .map(|file| file.path.clone())
        .collect::<Vec<_>>();
    let mut state = DiffReviewState::new(document.clone());
    let rendered = draw(&mut state, 100, 8);
    let lines = rendered.lines().collect::<Vec<_>>();
    let directory_row = lines
        .iter()
        .position(|line| line.contains("▾ src/"))
        .expect("directory row");
    let stage_column = lines[directory_row]
        .chars()
        .position(|character| character == '')
        .expect("directory stage marker");

    assert_eq!(
        state.handle_input(mouse(
            MouseEventKind::Down(MouseButton::Left),
            u16::try_from(stage_column).unwrap(),
            u16::try_from(directory_row).unwrap(),
        )),
        Some(DiffReviewEvent::RepositoryAction(
            RepositoryAction::StagePaths(expected_directory_paths)
        ))
    );

    let mut state = DiffReviewState::new(document.clone());
    let rendered = draw(&mut state, 100, 8);
    let lines = rendered.lines().collect::<Vec<_>>();
    let file_row = lines
        .iter()
        .position(|line| line.contains("M main.rs"))
        .expect("file row");
    let stage_column = lines[file_row]
        .chars()
        .position(|character| character == '')
        .expect("file stage marker");

    assert_eq!(
        state.handle_input(mouse(
            MouseEventKind::Down(MouseButton::Left),
            u16::try_from(stage_column).unwrap(),
            u16::try_from(file_row).unwrap(),
        )),
        Some(DiffReviewEvent::RepositoryAction(
            RepositoryAction::StagePaths(vec![document.files[0].path.clone()])
        ))
    );
}

#[test]
fn changed_rows_use_semantic_gutter_bars_and_line_numbers() {
    let width = 60;
    let mut state = DiffReviewState::new(changed_document());
    let mut terminal = Terminal::new(TestBackend::new(width, 12)).expect("test terminal");
    terminal
        .draw(|frame| {
            frame.render_stateful_widget(DiffReviewWidget::new(), frame.area(), &mut state);
        })
        .expect("draw widget");

    let buffer = terminal.backend().buffer();
    let theme = RatatuiTheme::from(&DiffTheme::default());
    for (source, foreground) in [
        ("fn old() {}", theme.deletion),
        ("fn new() {}", theme.addition),
    ] {
        let row = buffer
            .content()
            .chunks(usize::from(width))
            .find(|row| {
                row.iter()
                    .map(ratatui::buffer::Cell::symbol)
                    .collect::<String>()
                    .contains(source)
            })
            .expect("changed source row");
        let indicator = row
            .iter()
            .position(|cell| cell.symbol() == "")
            .expect("changed-row indicator");
        assert_eq!(row[indicator].fg, foreground);
        assert_eq!(row[indicator + 4].symbol(), "1");
        assert_eq!(row[indicator + 4].fg, foreground);
    }
}

#[test]
fn comment_crud_and_host_events_are_structured() {
    let mut state = DiffReviewState::new(changed_document());
    state.handle_input(key(KeyCode::Enter));
    assert_eq!(state.focus(), FocusPane::Diff);
    state.handle_input(key(KeyCode::Char('c')));
    type_text(&mut state, "please fix 界");
    state.handle_input(key(KeyCode::Enter));
    assert_eq!(state.review().len(), 1);
    assert_eq!(
        state.review().comments()[0].context.line_text,
        "fn old() {}"
    );

    let rendered = draw(&mut state, 100, 12);
    assert!(rendered.contains("please fix 界"), "{rendered}");

    let Some(DiffReviewEvent::SubmitReview(submission)) =
        state.handle_input(key(KeyCode::Char('s')))
    else {
        panic!("expected a review submission");
    };
    assert_eq!(submission.comments.len(), 1);
    assert!(submission.formatted.contains("please fix 界"));

    let copied = state.handle_input(key(KeyCode::Char('y')));
    assert!(
        matches!(copied, Some(DiffReviewEvent::CopyFormattedReview(ref text)) if text.contains("please fix"))
    );

    state.handle_input(key(KeyCode::Char('e')));
    state.handle_input(key(KeyCode::End));
    type_text(&mut state, " now");
    state.handle_input(key(KeyCode::Enter));
    assert_eq!(state.review().comments()[0].body, "please fix 界 now");
    state.handle_input(key(KeyCode::Char('x')));
    assert!(state.review().is_empty());

    assert_eq!(
        state.handle_input(key(KeyCode::Esc)),
        Some(DiffReviewEvent::Cancel)
    );
    assert_eq!(
        state.handle_input(key_with(KeyCode::Char('g'), KeyModifiers::CONTROL)),
        Some(DiffReviewEvent::Cancel)
    );
}

#[test]
fn split_view_can_comment_on_the_removed_side() {
    let mut state = DiffReviewState::new(changed_document());
    state.set_view_mode(ViewMode::Split);
    draw(&mut state, 140, 12);
    state.handle_input(key(KeyCode::Enter));

    state.handle_input(key(KeyCode::Left));
    assert_eq!(state.selected_side(), DiffSide::Old);
    state.handle_input(key(KeyCode::Char('c')));
    type_text(&mut state, "removed side");
    state.handle_input(key(KeyCode::Enter));

    state.handle_input(key(KeyCode::Right));
    assert_eq!(state.selected_side(), DiffSide::New);
    state.handle_input(key(KeyCode::Char('c')));
    type_text(&mut state, "added side");
    state.handle_input(key(KeyCode::Enter));

    let comments = state.review().comments();
    assert_eq!(comments.len(), 2);
    assert_eq!(comments[0].anchor.side, DiffSide::Old);
    assert_eq!(comments[0].context.line_text, "fn old() {}");
    assert_eq!(comments[1].anchor.side, DiffSide::New);
    assert_eq!(comments[1].context.line_text, "fn new() {}");

    state.handle_input(key(KeyCode::Char('h')));
    assert_eq!(state.focus(), FocusPane::Files);
}

/// A patch long enough to scroll, in a fresh `Arc` on every call so a swap
/// exercises real snapshot replacement rather than pointer equality.
fn scrollable_fixture() -> Arc<DiffDocument> {
    let old = (1..=200).fold(String::new(), |mut text, line| {
        let _ = writeln!(text, "let value_{line} = {line};");
        text
    });
    let new = old.replace(';', " + 1;");
    DocumentBuilder::new()
        .changed("src/large.rs", &old, &new)
        .build()
}

#[test]
fn snapshot_replacement_preserves_scroll_selection_and_draft() {
    let mut harness = support::ReviewHarness::new(scrollable_fixture(), 100, 24);
    harness.draw();
    harness.press(KeyCode::Tab);
    for _ in 0..40 {
        harness.press(KeyCode::Down);
    }
    harness.press(KeyCode::Char('c'));
    harness.type_text("keep me");
    harness.draw();

    let scroll = harness.state().scroll_offset();
    let selected = harness.state().selected_row();
    assert!(scroll > 0, "the test must scroll away from the top");

    harness.state_mut().set_document(scrollable_fixture());
    harness.draw();

    assert_eq!(harness.state().scroll_offset(), scroll);
    assert_eq!(harness.state().selected_row(), selected);
    assert_eq!(
        harness
            .state()
            .session()
            .draft()
            .map(clankerdiff_core::CommentDraft::body),
        Some("keep me")
    );
}

#[test]
fn replacements_and_background_health_preserve_command_state() {
    let mut state = DiffReviewState::new(changed_document());
    state.set_repository_pending();
    state.set_document(changed_document());
    state.set_document(scrollable_fixture());
    assert!(state.repository_pending());
    state.set_background_error(Some("refresh failed".into()));
    assert!(state.repository_pending());
    assert!(draw(&mut state, 100, 12).contains("refresh failed"));
    state.set_background_error(None);
    assert!(draw(&mut state, 100, 12).contains("Git operation in progress…"));
    state.clear_repository_pending();
    assert!(!state.repository_pending());
    state.set_repository_error("command failed");
    state.set_background_error(Some("refresh failed".into()));
    state.set_background_error(None);
    state.set_document(changed_document());
    assert_eq!(state.repository_error(), Some("command failed"));
}

#[test]
fn clearing_a_pending_repository_operation_restores_the_idle_hint() {
    let mut state = DiffReviewState::new(changed_document());
    state.set_repository_pending();
    assert!(draw(&mut state, 100, 12).contains("Git operation in progress…"));

    state.clear_repository_pending();

    let rendered = draw(&mut state, 100, 12);
    assert!(
        !rendered.contains("Git operation in progress…"),
        "{rendered}"
    );
    assert!(rendered.contains("[t] theme"), "{rendered}");
}

#[test]
fn document_replacement_retains_outdated_comments() {
    let before = changed_document();
    let anchor = LineAnchor::for_line(&before.files[0], DiffSide::Old, 0, 0).expect("anchor");
    let mut review = Review::default();
    review.add_comment_with_context(anchor, "fn old() {}", "still relevant");
    let mut state = DiffReviewState::new(before);
    *state.review_mut() = review;

    state.set_document(
        DocumentBuilder::new()
            .changed("other.rs", "a\n", "b\n")
            .build(),
    );
    assert_eq!(state.review().len(), 1);
    assert!(state.review().comments()[0].outdated);
    let rendered = draw(&mut state, 100, 8);
    assert!(rendered.contains("1 comment (1 outdated)"), "{rendered}");
}

#[test]
fn loading_error_empty_and_binary_states_render() {
    let mut loading = DiffReviewState::loading();
    assert!(draw(&mut loading, 50, 6).contains("Loading diff"));
    loading.set_error("host failed");
    assert!(draw(&mut loading, 50, 6).contains("host failed"));
    loading.set_document(DocumentBuilder::new().build());
    assert!(draw(&mut loading, 50, 6).contains("No changes"));

    let mut binary = DiffReviewState::new(DocumentBuilder::new().binary("data.bin").build());
    assert!(draw(&mut binary, 50, 7).contains("Binary file changed"));
}

#[test]
fn paging_mouse_selection_and_visible_highlighting_are_bounded() {
    let old = (0..200).fold(String::new(), |mut output, line| {
        writeln!(output, "let old_{line} = {line};").expect("write fixture");
        output
    });
    let new = (0..200).fold(String::new(), |mut output, line| {
        writeln!(output, "let new_{line} = {line};").expect("write fixture");
        output
    });
    let document = DocumentBuilder::new()
        .changed("many.rs", &old, &new)
        .changed("second.rs", "old\n", "new\n")
        .build();
    let mut state = DiffReviewState::new(document);
    draw(&mut state, 80, 10);
    assert!(
        state.highlight_stats().calls <= 8,
        "only visible rows should highlight"
    );

    state.handle_input(key(KeyCode::Enter));
    let before = state.selected_row().expect("selected row");
    state.handle_input(key(KeyCode::PageDown));
    assert_eq!(state.selected_row(), Some(before));
    assert!(state.scroll_offset() > 0);

    state.handle_input(DiffReviewInput::Mouse(MouseEvent {
        kind: MouseEventKind::Down(MouseButton::Left),
        column: 2,
        row: 2,
        modifiers: KeyModifiers::NONE,
    }));
    assert_eq!(state.focus(), FocusPane::Files);
    assert_eq!(state.selected_file(), Some(1));
}

#[test]
fn draft_editing_is_utf8_safe_and_escape_cancels() {
    let mut state = DiffReviewState::new(changed_document());
    state.handle_input(key(KeyCode::Enter));
    state.handle_input(key(KeyCode::Char('c')));
    type_text(&mut state, "a界");
    state.handle_input(key(KeyCode::Left));
    state.handle_input(key(KeyCode::Backspace));
    state.handle_input(key(KeyCode::Enter));
    assert_eq!(state.review().comments()[0].body, "");

    state.handle_input(key(KeyCode::Char('c')));
    type_text(&mut state, "discard");
    state.handle_input(key(KeyCode::Esc));
    assert_eq!(state.review().len(), 1);
}

#[test]
fn draft_cursor_uses_terminal_display_width() {
    let mut state = DiffReviewState::new(changed_document());
    state.handle_input(key(KeyCode::Enter));
    state.handle_input(key(KeyCode::Char('c')));
    type_text(&mut state, "ab");

    draw(&mut state, 60, 12);
    let ascii = state.cursor_position().expect("visible draft cursor");
    assert_eq!(ascii, Position::new(7, 5));

    type_text(&mut state, "");
    draw(&mut state, 60, 12);
    let wide = state.cursor_position().expect("visible wide draft cursor");
    assert_eq!(wide, Position::new(9, 5));

    state.handle_input(key(KeyCode::Left));
    draw(&mut state, 60, 12);
    assert_eq!(state.cursor_position(), Some(ascii));

    state.handle_input(key(KeyCode::Esc));
    assert_eq!(state.cursor_position(), None);
}

#[test]
fn comments_render_as_padded_themed_boxes() {
    let mut state = DiffReviewState::new(changed_document());
    let anchor = state.session().selected_anchor().expect("selected anchor");
    state
        .review_mut()
        .add_comment(anchor, "Please include the path in the error.");

    let rendered = draw(&mut state, 80, 12);

    assert!(rendered.contains("╭─ Comment "), "{rendered}");
    assert!(rendered.contains("│ Please include the path"), "{rendered}");
    assert!(rendered.contains(''), "{rendered}");

    let mut terminal = Terminal::new(TestBackend::new(80, 12)).expect("test terminal");
    terminal
        .draw(|frame| {
            frame.render_stateful_widget(DiffReviewWidget::new(), frame.area(), &mut state);
        })
        .expect("draw comment box");
    let border = terminal
        .backend()
        .buffer()
        .content()
        .iter()
        .find(|cell| cell.symbol() == "")
        .expect("top-left comment border");
    let expected = RatatuiTheme::from(&DiffTheme::default()).ui.accent;
    assert_eq!(border.fg, expected);
}

#[test]
fn tall_comment_boxes_can_be_paged_line_by_line() {
    let mut state = DiffReviewState::new(changed_document());
    let anchor = state.session().selected_anchor().expect("selected anchor");
    let body = (0..14)
        .map(|index| format!("comment line {index:02}"))
        .collect::<Vec<_>>()
        .join("\n");
    state.review_mut().add_comment(anchor, body);
    let top = draw(&mut state, 80, 8);
    assert!(top.contains("comment line 00"), "{top}");
    assert!(!top.contains("comment line 13"), "{top}");

    for _ in 0..5 {
        state.handle_input(key(KeyCode::PageDown));
    }
    let bottom = draw(&mut state, 80, 8);

    assert!(bottom.contains("comment line 13"), "{bottom}");
    assert!(
        bottom.contains(''),
        "the closing border must be reachable: {bottom}"
    );
}

#[test]
fn file_drawer_scrolls_and_mouse_selection_uses_its_offset() {
    let mut state = DiffReviewState::new(DocumentBuilder::new().generated_files(12, 1).build());
    draw(&mut state, 100, 8);

    for _ in 0..8 {
        state.handle_input(key(KeyCode::Down));
    }
    assert_eq!(state.selected_file(), Some(8));
    let scrolled = draw(&mut state, 100, 8);
    assert!(scrolled.contains("src/file_08.rs"), "{scrolled}");
    assert!(!scrolled.contains("src/file_00.rs"), "{scrolled}");

    state.handle_input(DiffReviewInput::Mouse(MouseEvent {
        kind: MouseEventKind::Down(MouseButton::Left),
        column: 2,
        row: 1,
        modifiers: KeyModifiers::NONE,
    }));
    assert_eq!(state.selected_file(), Some(4));
}

#[test]
fn directory_entries_navigate_collapse_and_expand_without_losing_the_patch_file() {
    let document = DocumentBuilder::new()
        .changed("src/lib.rs", "old\n", "new\n")
        .changed("src/bin/main.rs", "old\n", "new\n")
        .changed("README.md", "old\n", "new\n")
        .build();
    let mut state = DiffReviewState::new(document);
    let initial = draw(&mut state, 100, 12);
    assert!(initial.contains("▾ src/"), "{initial}");
    assert!(initial.contains("▾ bin/"), "{initial}");
    assert!(initial.contains("main.rs"), "{initial}");

    state.handle_input(key(KeyCode::Up));
    assert_eq!(state.selected_file(), Some(1));
    state.handle_input(key(KeyCode::Up));
    assert_eq!(
        state.selected_file(),
        Some(1),
        "directory selection must leave the patch file unchanged"
    );
    state.handle_input(key(KeyCode::Left));
    let collapsed = draw(&mut state, 100, 12);
    assert!(collapsed.contains("▸ bin/"), "{collapsed}");
    assert!(!collapsed.contains("M main.rs +1 -1"), "{collapsed}");
    assert!(
        collapsed.contains("src/bin/main.rs"),
        "active patch remains visible"
    );

    state.handle_input(key(KeyCode::Enter));
    let expanded = draw(&mut state, 100, 12);
    assert!(expanded.contains("▾ bin/"), "{expanded}");
    assert!(expanded.contains("M main.rs +1 -1"), "{expanded}");
    assert_eq!(state.focus(), FocusPane::Files);
}

#[test]
fn initial_file_selection_is_scrolled_into_a_sorted_drawer() {
    let mut builder = DocumentBuilder::new().changed("z.rs", "old\n", "new\n");
    for index in 0..12 {
        builder = builder.changed(&format!("dir_{index:02}/file.rs"), "old\n", "new\n");
    }
    let mut state = DiffReviewState::new(builder.build());

    let rendered = draw(&mut state, 100, 8);

    assert_eq!(state.selected_file(), Some(0));
    assert!(rendered.contains("M z.rs +1 -1"), "{rendered}");
}

#[test]
fn document_replacement_expands_the_selected_files_ancestors() {
    let document = DocumentBuilder::new()
        .changed("src/lib.rs", "old\n", "new\n")
        .build();
    let mut state = DiffReviewState::new(document);
    draw(&mut state, 100, 8);
    state.handle_input(key(KeyCode::Up));
    state.handle_input(key(KeyCode::Left));
    assert!(draw(&mut state, 100, 8).contains("▸ src/"));

    state.set_document(
        DocumentBuilder::new()
            .changed("src/lib.rs", "older\n", "newer\n")
            .build(),
    );
    let replaced = draw(&mut state, 100, 8);
    assert!(replaced.contains("▾ src/"), "{replaced}");
    assert!(replaced.contains("M lib.rs +1 -1"), "{replaced}");
}

#[test]
fn diff_and_drawer_render_scrollbars_without_covering_content() {
    let mut state = DiffReviewState::new(DocumentBuilder::new().generated_files(40, 400).build());
    let top = draw(&mut state, 100, 24);
    assert!(
        top.contains(''),
        "drawer and patch tracks should have top arrows: {top}"
    );
    assert!(
        top.contains(''),
        "drawer and patch tracks should have bottom arrows: {top}"
    );
    assert!(top.contains("let file_00_rs_value_1"), "{top}");

    state.handle_input(key(KeyCode::Enter));
    let selected = state.selected_row();
    for _ in 0..10 {
        state.handle_input(mouse(MouseEventKind::ScrollDown, PATCH_COLUMN, 5));
    }
    let scrolled = draw(&mut state, 100, 24);
    assert_ne!(
        top, scrolled,
        "scrolling should move patch content and its thumb"
    );
    assert_ne!(state.selected_row(), selected);
    assert!(
        scrolled.contains('') || scrolled.contains(''),
        "{scrolled}"
    );
}

#[test]
fn help_popup_and_explicit_view_mode_cycle_render() {
    let mut state = DiffReviewState::new(changed_document());
    assert_eq!(state.view_mode(), ViewMode::Auto);

    state.handle_input(key(KeyCode::Char('v')));
    assert_eq!(state.view_mode(), ViewMode::Unified);
    draw(&mut state, 140, 12);
    assert_eq!(state.layout(), Layout::Unified);

    state.handle_input(key(KeyCode::Char('v')));
    assert_eq!(state.view_mode(), ViewMode::Split);
    draw(&mut state, 60, 12);
    assert_eq!(state.layout(), Layout::Split);

    state.handle_input(key(KeyCode::Char('v')));
    assert_eq!(state.view_mode(), ViewMode::Auto);
    draw(&mut state, 60, 12);
    assert_eq!(state.layout(), Layout::Unified);

    state.handle_input(key(KeyCode::Char('?')));
    let help = draw(&mut state, 80, 16);
    assert!(help.contains("Review shortcuts"), "{help}");
    assert!(help.contains("Navigation"), "{help}");
    state.handle_input(key(KeyCode::Esc));
    let closed = draw(&mut state, 80, 16);
    assert!(!closed.contains("Navigation"), "{closed}");
}

#[test]
fn unusual_patch_metadata_does_not_become_commentable() {
    let mut file = FileDiff::from_texts("meta.txt", "old", "new").expect("fixture");
    file.hunks[0].lines.push(PatchLine {
        kind: PatchLineKind::Meta,
        text: "metadata".into(),
        old_line_no: None,
        new_line_no: None,
        no_newline: false,
    });
    let mut state = DiffReviewState::new(DocumentBuilder::new().file(file).build());
    state.handle_input(key(KeyCode::Enter));
    state.handle_input(key(KeyCode::End));
    state.handle_input(key(KeyCode::Char('c')));
    type_text(&mut state, "comment");
    state.handle_input(key(KeyCode::Enter));
    assert_eq!(
        state.review().len(),
        1,
        "End selects the last source row, not metadata"
    );
}

/// At 100 columns the bordered body gives the drawer columns 1..33 and the
/// patch everything past the separator at column 33.
const DRAWER_COLUMN: u16 = 5;
const PATCH_COLUMN: u16 = 60;

#[test]
fn the_wheel_over_the_diff_moves_one_selected_row_per_notch() {
    let document = DocumentBuilder::new().generated_files(40, 60).build();
    let mut keyboard = DiffReviewState::new(document.clone());
    draw(&mut keyboard, 100, 24);
    keyboard.handle_input(key(KeyCode::Enter));
    let first_row = keyboard.selected_row();
    keyboard.handle_input(key(KeyCode::Down));
    let next_row = keyboard.selected_row();

    let mut state = DiffReviewState::new(document);
    draw(&mut state, 100, 24);
    assert_eq!(state.focus(), FocusPane::Files);
    assert_eq!(state.selected_row(), first_row);

    state.handle_input(mouse(MouseEventKind::ScrollDown, PATCH_COLUMN, 5));
    draw(&mut state, 100, 24);
    assert_eq!(state.selected_row(), next_row);
    assert_eq!(state.selected_file(), Some(0), "no file switch");
    assert_eq!(
        state.focus(),
        FocusPane::Files,
        "scrolling must not steal focus"
    );

    state.handle_input(mouse(MouseEventKind::ScrollUp, PATCH_COLUMN, 5));
    draw(&mut state, 100, 24);
    assert_eq!(state.selected_row(), first_row);
}

#[test]
fn the_wheel_over_the_drawer_scrolls_one_file_at_a_time() {
    let mut state = DiffReviewState::new(DocumentBuilder::new().generated_files(40, 4).build());
    // The status plus basename distinguishes a drawer row from the patch header,
    // which keeps naming the selected file.
    let first = draw(&mut state, 100, 24);
    assert!(first.contains("A file_00.rs"), "{first}");
    assert!(first.contains("▾ src/"), "{first}");

    state.handle_input(mouse(MouseEventKind::ScrollDown, DRAWER_COLUMN, 5));
    let one_entry = draw(&mut state, 100, 24);
    assert!(!one_entry.contains("▾ src/"), "{one_entry}");
    assert!(one_entry.contains("A file_00.rs"), "{one_entry}");

    state.handle_input(mouse(MouseEventKind::ScrollDown, DRAWER_COLUMN, 5));
    let scrolled = draw(&mut state, 100, 24);
    assert!(!scrolled.contains("A file_00.rs"), "{scrolled}");
    assert!(scrolled.contains("A file_01.rs"), "{scrolled}");
    assert_eq!(
        state.selected_file(),
        Some(0),
        "scrolling the drawer must not select a different file"
    );
}

#[test]
fn events_that_change_nothing_do_not_ask_for_a_frame() {
    let mut state = DiffReviewState::new(changed_document());
    assert!(state.is_dirty(), "the first frame always draws");
    draw(&mut state, 100, 24);
    assert!(!state.is_dirty(), "a drawn frame settles the state");

    for kind in [
        MouseEventKind::Moved,
        MouseEventKind::Up(MouseButton::Left),
        MouseEventKind::Drag(MouseButton::Left),
    ] {
        state.handle_input(mouse(kind, PATCH_COLUMN, 5));
        assert!(!state.is_dirty(), "{kind:?} changes nothing that is drawn");
    }

    state.handle_input(mouse(MouseEventKind::ScrollUp, PATCH_COLUMN, 5));
    assert!(
        !state.is_dirty(),
        "the patch is already at the top of the file"
    );

    state.handle_input(key(KeyCode::Down));
    assert!(state.is_dirty(), "moving the selection needs a frame");
}

#[test]
fn repository_actions_follow_file_and_directory_stage_state() {
    let document = changed_document();
    let mut state = DiffReviewState::new(document.clone());

    assert_eq!(
        state.handle_input(key(KeyCode::Char(' '))),
        Some(DiffReviewEvent::RepositoryAction(
            RepositoryAction::StagePaths(vec![document.files[0].path.clone(),])
        ))
    );
    assert_eq!(
        state.handle_input(key(KeyCode::Char('a'))),
        Some(DiffReviewEvent::RepositoryAction(
            RepositoryAction::StageAll
        ))
    );
    assert_eq!(
        state.handle_input(key(KeyCode::Char('A'))),
        Some(DiffReviewEvent::RepositoryAction(
            RepositoryAction::UnstageAll
        ))
    );

    let mut staged = (*document).clone();
    staged.files[0].staged = StageState::Staged;
    state.set_document(Arc::new(staged.clone()));
    assert_eq!(
        state.handle_input(key(KeyCode::Char(' '))),
        Some(DiffReviewEvent::RepositoryAction(
            RepositoryAction::UnstagePaths(vec![staged.files[0].path.clone(),])
        ))
    );
}

#[test]
fn commit_and_discard_require_explicit_input() {
    let mut document = (*changed_document()).clone();
    document.files[0].staged = StageState::Staged;
    let path = document.files[0].path.clone();
    let status = document.files[0].status;
    let mut state = DiffReviewState::new(Arc::new(document));

    state.handle_input(key(KeyCode::Char('C')));
    type_text(&mut state, "ship it");
    assert_eq!(
        state.handle_input(key(KeyCode::Enter)),
        Some(DiffReviewEvent::RepositoryAction(
            RepositoryAction::Commit {
                message: "ship it".to_owned(),
            }
        ))
    );

    state.handle_input(key(KeyCode::Char('d')));
    assert_eq!(
        state.handle_input(key(KeyCode::Char('y'))),
        Some(DiffReviewEvent::RepositoryAction(
            RepositoryAction::Discard { path, status }
        ))
    );
}

#[test]
fn keyboard_navigation_brings_a_scrolled_away_selection_back() {
    let mut state =
        DiffReviewState::new(DocumentBuilder::new().generated("src/long.rs", 400).build());
    draw(&mut state, 100, 24);
    state.handle_input(key(KeyCode::Enter));
    draw(&mut state, 100, 24);
    let selected = state.selected_row().expect("selected row");

    for _ in 0..20 {
        state.handle_input(key(KeyCode::PageDown));
    }
    draw(&mut state, 100, 24);
    assert!(
        state.scroll_offset() > selected,
        "the selection should be above the viewport"
    );

    state.handle_input(key(KeyCode::Down));
    draw(&mut state, 100, 24);
    let followed = state.selected_row().expect("selected row");
    assert!(
        state.scroll_offset() <= followed,
        "{followed} is off screen"
    );
}

#[test]
fn scope_key_cycles_from_both_to_unstaged() {
    let mut state = DiffReviewState::new(changed_document());
    assert_eq!(state.scope(), DiffScope::Both);
    let event = state.handle_input(key(KeyCode::Char('S')));
    assert_eq!(event, Some(DiffReviewEvent::SetScope(DiffScope::Unstaged)));
    state.set_scope(DiffScope::Unstaged);
    let event = state.handle_input(key(KeyCode::Char('S')));
    assert_eq!(event, Some(DiffReviewEvent::SetScope(DiffScope::Staged)));
}

#[test]
fn empty_document_renders_scope_pill() -> Result<(), String> {
    let mut state = DiffReviewState::new(Arc::new(DiffDocument::empty()));
    state.set_scope(DiffScope::Staged);
    let rendered = draw(&mut state, 100, 20);
    if !rendered.contains("scope: staged") {
        return Err(format!(
            "expected scope pill in empty state, got: {rendered}"
        ));
    }
    Ok(())
}