#![allow(clippy::unwrap_used)]
use rustik_diff::{
ContextChange, Decode, DiffAction, DiffDecorator, DiffDocument, DiffFocus, DiffOptions,
DiffSide, DiffViewer, FileDecoration, FileId, FileTreeMode, HighlightResult, HunkDecoration,
HunkFocus, HunkId, ReviewProgress,
};
use rustik_tui::{Buffer, Color, Label, Line, Paint, Rect, Scroll, Style, colors};
#[derive(Clone, Debug)]
struct ReviewDecorator;
impl DiffDecorator for ReviewDecorator {
fn file(&self, _file: FileId) -> FileDecoration {
FileDecoration {
status: Some(Paint::new('✔').fg(colors::rgb::GREEN)),
progress: Some(ReviewProgress {
accepted: 2,
total: 2,
}),
..FileDecoration::default()
}
}
fn hunk(&self, _file: FileId, hunk: HunkId) -> HunkDecoration {
if hunk != HunkId::new(0) {
return HunkDecoration::default();
}
HunkDecoration {
gutter: Some(Paint::new('▏').fg(colors::rgb::GREEN)),
corner: Line::new(Label::new("2 🗩").fg(colors::rgb::DIM)),
style: Some(Style::default().dim()),
}
}
}
#[test]
fn expanded_file_card_matches_golden_frame() {
assert_golden(
"expanded_file_card_64x9.txt",
include_str!("golden/expanded_file_card_64x9.txt"),
sample_viewer(),
64,
9,
);
}
#[test]
fn multi_hunk_gap_matches_golden_frame() {
assert_golden(
"multi_hunk_gap_64x12.txt",
include_str!("golden/multi_hunk_gap_64x12.txt"),
two_hunk_viewer(),
64,
12,
);
}
#[test]
fn review_hunk_gutter_matches_golden_frame() {
let mut viewer = two_hunk_viewer();
viewer.set_decorator(ReviewDecorator);
assert_golden(
"review_hunk_gutter_64x12.txt",
include_str!("golden/review_hunk_gutter_64x12.txt"),
viewer,
64,
12,
);
}
#[test]
fn file_summary_ignores_visible_hunks_and_context() {
let mut viewer = two_hunk_viewer();
viewer
.load_file_sources(|_| Ok::<_, ()>(b"one\ntwo\nthree\nfour\nfive\nsix\n".to_vec()))
.unwrap();
let mut replacement = DiffDocument::decode_str(
"\
diff --git a/a.rs b/a.rs
index 1111111111111111111111111111111111111111..2222222222222222222222222222222222222222 100644
--- a/a.rs
+++ b/a.rs
@@ -7,5 +7,5 @@ fn second
context1
context2
context3
context4
-before
+after
",
)
.unwrap()
.files
.remove(0);
replacement.id = viewer.document().files[0].id;
viewer.replace_file_diffs([replacement]);
assert_golden(
"stable_file_summary_64x9.txt",
include_str!("golden/stable_file_summary_64x9.txt"),
viewer,
64,
9,
);
}
#[test]
fn expanded_context_preserves_focused_hunk() {
let mut viewer = viewer_from_str_with_options(
include_str!("golden/two_hunks.diff"),
DiffOptions {
hunk_focus: HunkFocus::DimUnfocused,
..DiffOptions::default()
},
);
viewer.set_focus(Some(DiffFocus::Hunk(HunkId::new(0))));
let request = viewer.context_request(ContextChange::Increase).unwrap();
let update = request
.decode(include_bytes!("golden/expanded_context.diff"))
.unwrap()
.unwrap();
let area = Rect::new(0, 0, 64, 8);
viewer.apply_context_update(update, area);
assert_eq!(viewer.state().focus, Some(DiffFocus::Hunk(HunkId::new(0))));
viewer.apply(DiffAction::NextHunk, area);
assert_golden(
"expanded_context_focus_64x8.txt",
include_str!("golden/expanded_context_focus_64x8.txt"),
viewer,
64,
8,
);
}
#[test]
fn focused_second_file_matches_golden_frame() {
let mut viewer = two_file_viewer();
viewer.apply(DiffAction::FocusNext, Rect::new(0, 0, 64, 6));
viewer.apply(DiffAction::FocusNext, Rect::new(0, 0, 64, 6));
assert_golden(
"focused_second_file_64x6.txt",
include_str!("golden/focused_second_file_64x6.txt"),
viewer,
64,
6,
);
}
#[test]
fn sticky_header_starting_matches_golden_frame() {
let mut viewer = sample_viewer();
viewer.apply(DiffAction::Scroll(Scroll::Lines(1)), Rect::new(0, 0, 64, 5));
assert_golden(
"sticky_header_starting_64x5.txt",
include_str!("golden/sticky_header_starting_64x5.txt"),
viewer,
64,
5,
);
}
#[test]
fn sticky_header_inside_file_matches_golden_frame() {
let mut viewer = sample_viewer();
viewer.apply(DiffAction::Scroll(Scroll::Lines(4)), Rect::new(0, 0, 64, 5));
assert_golden(
"sticky_header_inside_file_64x5.txt",
include_str!("golden/sticky_header_inside_file_64x5.txt"),
viewer,
64,
5,
);
}
#[test]
fn sticky_header_replaces_chrome_matches_golden_frame() {
let mut viewer = sample_viewer();
viewer.apply(DiffAction::Scroll(Scroll::Lines(3)), Rect::new(0, 0, 64, 5));
assert_golden(
"sticky_header_replaces_chrome_64x5.txt",
include_str!("golden/sticky_header_replaces_chrome_64x5.txt"),
viewer,
64,
5,
);
}
#[test]
fn sticky_header_before_next_file_matches_golden_frame() {
let mut viewer = two_file_viewer();
viewer.apply(DiffAction::Scroll(Scroll::Lines(8)), Rect::new(0, 0, 64, 5));
assert_golden(
"sticky_header_before_next_file_64x5.txt",
include_str!("golden/sticky_header_before_next_file_64x5.txt"),
viewer,
64,
5,
);
}
#[test]
fn sticky_header_full_corner_boundary_matches_golden_frame() {
let mut viewer = two_file_viewer();
viewer.apply(DiffAction::Scroll(Scroll::Lines(5)), Rect::new(0, 0, 64, 5));
assert_golden(
"sticky_header_full_corner_boundary_64x5.txt",
include_str!("golden/sticky_header_full_corner_boundary_64x5.txt"),
viewer,
64,
5,
);
}
#[test]
fn sticky_header_file_end_boundary_matches_golden_frame() {
let mut viewer = two_file_viewer();
viewer.apply(DiffAction::Scroll(Scroll::Lines(6)), Rect::new(0, 0, 64, 5));
assert_golden(
"sticky_header_file_end_boundary_64x5.txt",
include_str!("golden/sticky_header_file_end_boundary_64x5.txt"),
viewer,
64,
5,
);
}
#[test]
fn bottom_of_file_matches_golden_frame() {
let mut viewer = sample_viewer();
viewer.apply(DiffAction::Scroll(Scroll::Bottom), Rect::new(0, 0, 64, 5));
assert_golden(
"bottom_of_file_64x5.txt",
include_str!("golden/bottom_of_file_64x5.txt"),
viewer,
64,
5,
);
}
#[test]
fn narrow_view_matches_golden_frame() {
assert_golden(
"narrow_view_14x8.txt",
include_str!("golden/narrow_view_14x8.txt"),
sample_viewer(),
14,
8,
);
}
#[test]
fn preamble_and_no_newline_matches_golden_frame() {
assert_golden(
"preamble_and_no_newline_64x17.txt",
include_str!("golden/preamble_and_no_newline_64x17.txt"),
preamble_no_newline_viewer(),
64,
17,
);
}
#[test]
fn file_kinds_match_golden_frame() {
assert_golden(
"file_kinds_80x24.txt",
include_str!("golden/file_kinds_80x24.txt"),
file_kinds_viewer(),
80,
24,
);
}
#[test]
fn wide_file_tree_matches_golden_frame() {
assert_golden(
"wide_file_tree_120x12.txt",
include_str!("golden/wide_file_tree_120x12.txt"),
two_file_tree_viewer(),
120,
12,
);
}
#[test]
fn file_tree_is_hidden_at_eighty_columns() {
let actual = render_frame(two_file_tree_viewer(), 80, 4);
assert!(actual.starts_with('╭'));
}
#[test]
fn highlighted_source_matches_golden_frame() {
let mut viewer = sample_viewer();
let request = viewer
.highlight_requests(Rect::new(0, 0, 64, 5))
.into_iter()
.next()
.unwrap();
viewer.apply_highlights([HighlightResult::new(
request,
Line::new(Label::new("highlighted context").fg(Color::Red)),
)]);
assert_golden(
"highlighted_source_64x5.txt",
include_str!("golden/highlighted_source_64x5.txt"),
viewer,
64,
5,
);
}
#[test]
fn source_tabs_render_as_four_cells_with_diff_background() {
let palette = DiffOptions::default().diff_palette;
let mut viewer = viewer_from_str(
"\
diff --git a/a.rs b/a.rs
index 1111111111111111111111111111111111111111..2222222222222222222222222222222222222222 100644
--- a/a.rs
+++ b/a.rs
@@ -1 +1 @@
-\told
+\tnew
",
);
let request = viewer
.highlight_requests(Rect::new(0, 0, 80, 6))
.into_iter()
.find(|request| request.key.side == DiffSide::New)
.unwrap();
viewer.apply_highlights([HighlightResult::new(
request,
Line::new(Label::new("\tnew").fg(Color::Red)),
)]);
let buffer = render_buffer(viewer, 80, 6);
assert!(buffer.line(3).contains("· old"));
assert!(buffer.line(4).contains("· new"));
assert_eq!(
buffer.get(17, 3).map(|cell| cell.style().fg_color()),
Some(colors::FAINT)
);
assert_eq!(
buffer.get(17, 4).map(|cell| cell.style().fg_color()),
Some(colors::FAINT)
);
for x in 17..21 {
assert_eq!(
buffer.get(x, 3).map(|cell| cell.style().bg_color()),
Some(palette.negative_row_bg)
);
assert_eq!(
buffer.get(x, 4).map(|cell| cell.style().bg_color()),
Some(palette.positive_row_bg)
);
}
}
fn assert_golden(name: &str, expected: &str, viewer: DiffViewer, cols: usize, rows: usize) {
let actual = render_frame(viewer, cols, rows);
if std::env::var_os("UPDATE_GOLDEN").is_some() {
let path = std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
.join("tests/golden")
.join(name);
std::fs::write(path, actual + "\n").unwrap();
return;
}
assert_eq!(actual, expected.trim_end_matches('\n'), "{name}");
}
fn render_frame(viewer: DiffViewer, cols: usize, rows: usize) -> String {
render_buffer(viewer, cols, rows).lines().join("\n")
}
fn render_buffer(mut viewer: DiffViewer, cols: usize, rows: usize) -> Buffer {
let area = Rect::new(0, 0, cols, rows);
let mut buffer = Buffer::empty(area);
viewer.render(area, &mut buffer);
buffer
}
fn sample_viewer() -> DiffViewer {
viewer_from_str(include_str!("golden/sample.diff"))
}
fn two_file_viewer() -> DiffViewer {
viewer_from_str(include_str!("golden/two_files.diff"))
}
fn two_file_tree_viewer() -> DiffViewer {
viewer_from_str_with_options(
include_str!("golden/two_files.diff"),
DiffOptions {
file_tree: FileTreeMode::Auto,
file_tree_root: "rustik".to_owned(),
..DiffOptions::default()
},
)
}
fn two_hunk_viewer() -> DiffViewer {
viewer_from_str(include_str!("golden/two_hunks.diff"))
}
fn preamble_no_newline_viewer() -> DiffViewer {
viewer_from_str(include_str!("golden/preamble_no_newline.diff"))
}
fn file_kinds_viewer() -> DiffViewer {
viewer_from_str(include_str!("golden/file_kinds.diff"))
}
fn viewer_from_str(input: &str) -> DiffViewer {
viewer_from_str_with_options(input, DiffOptions::default())
}
fn viewer_from_str_with_options(input: &str, options: DiffOptions) -> DiffViewer {
let document = DiffDocument::decode_str(input).unwrap();
DiffViewer::new(document, options)
}