Add range_in_original_file to BlameEntry

Author: cruessler

gix-blame/tests/blame.rs

@@ -117,32 +117,50 @@ impl From<LineRange> for Range<u32> {
 #[derive(Debug, PartialEq)]
 struct BlameEntry {
     range_in_blamed_file: Range<u32>,
+    range_in_original_file: Range<u32>,
     commit_id: ObjectId,
 }
 
 impl BlameEntry {
-    fn new(range: Range<u32>, commit_id: ObjectId) -> Self {
-        assert!(range.end > range.start, "{range:?}");
+    fn new(range_in_blamed_file: Range<u32>, range_in_original_file: Range<u32>, commit_id: ObjectId) -> Self {
+        assert!(
+            range_in_blamed_file.end > range_in_blamed_file.start,
+            "{range_in_blamed_file:?}"
+        );
+        assert!(
+            range_in_original_file.end > range_in_original_file.start,
+            "{range_in_original_file:?}"
+        );
 
         Self {
-            range_in_blamed_file: range.clone(),
+            range_in_blamed_file: range_in_blamed_file.clone(),
+            range_in_original_file: range_in_original_file.clone(),
             commit_id,
         }
     }
 
-    fn with_offset(range: Range<u32>, commit_id: ObjectId, offset: Offset) -> Self {
-        assert!(range.end > range.start, "{range:?}");
+    fn with_offset(range_in_original_file: Range<u32>, commit_id: ObjectId, offset: Offset) -> Self {
+        assert!(
+            range_in_original_file.end > range_in_original_file.start,
+            "{range_in_original_file:?}"
+        );
 
         match offset {
             Offset::Added(added) => Self {
-                range_in_blamed_file: (range.start + added)..(range.end + added),
+                range_in_blamed_file: (range_in_original_file.start + added)..(range_in_original_file.end + added),
+                range_in_original_file,
                 commit_id,
             },
             Offset::Deleted(deleted) => {
-                assert!(range.start >= deleted, "{range:?} {offset:?}");
+                assert!(
+                    range_in_original_file.start >= deleted,
+                    "{range_in_original_file:?} {offset:?}"
+                );
 
                 Self {
-                    range_in_blamed_file: (range.start - deleted)..(range.end - deleted),
+                    range_in_blamed_file: (range_in_original_file.start - deleted)
+                        ..(range_in_original_file.end - deleted),
+                    range_in_original_file,
                     commit_id,
                 }
             }
@@ -653,7 +671,8 @@ mod baseline {
         type Item = BlameEntry;
 
         fn next(&mut self) -> Option<Self::Item> {
-            let mut range = Range::default();
+            let mut range_in_blamed_file = Range::default();
+            let mut range_in_original_file = Range::default();
             let mut commit_id = ObjectId::null(gix_hash::Kind::Sha1);
             let mut skip_lines: u32 = 0;
 
@@ -688,14 +707,18 @@ mod baseline {
 
                     commit_id = result.unwrap();
 
+                    let line_number_in_original_file = fields[1].parse::<u32>().unwrap();
                     let line_number_in_final_file = fields[2].parse::<u32>().unwrap();
                     // The last field indicates the number of lines this group contains info for
                     // (this is not equal to the number of lines in git blame’s porcelain output).
                     let number_of_lines_in_group = fields[3].parse::<u32>().unwrap();
 
                     skip_lines = number_of_lines_in_group;
 
-                    range = (line_number_in_final_file - 1)..(line_number_in_final_file + number_of_lines_in_group - 1);
+                    range_in_original_file = (line_number_in_original_file - 1)
+                        ..(line_number_in_original_file + number_of_lines_in_group - 1);
+                    range_in_blamed_file =
+                        (line_number_in_final_file - 1)..(line_number_in_final_file + number_of_lines_in_group - 1);
                 }
             }
 
@@ -704,7 +727,7 @@ mod baseline {
                 return None;
             }
 
-            Some(BlameEntry::new(range, commit_id))
+            Some(BlameEntry::new(range_in_blamed_file, range_in_original_file, commit_id))
         }
     }
 }
@@ -801,11 +824,16 @@ fn blame_file(worktree_path: PathBuf, file_path: &BStr) -> Vec<BlameEntry> {
             // remaining lines to it, even though we don’t explicitly check whether that is true
             // here. We could perhaps use `needed_to_obtain` to compare `suspect` against an empty
             // tree to validate this assumption.
-            lines_blamed.extend(
-                lines_to_blame
-                    .iter()
-                    .map(|hunk| BlameEntry::new(hunk.range_in_blamed_file.clone(), suspect)),
-            );
+            lines_blamed.extend(lines_to_blame.iter().map(|hunk| {
+                BlameEntry::new(
+                    hunk.range_in_blamed_file.clone(),
+                    // TODO
+                    // I don’t know whether it is correct to use `range_in_destination` for
+                    // this purpose.
+                    hunk.range_in_destination.clone(),
+                    suspect,
+                )
+            }));
 
             lines_to_blame = vec![];
 
@@ -860,11 +888,16 @@ fn blame_file(worktree_path: PathBuf, file_path: &BStr) -> Vec<BlameEntry> {
             if matches!(modification, gix_diff::tree::recorder::Change::Addition { .. }) {
                 // Every line that has not been blamed yet on a commit, is expected to have been
                 // added when the file was added to the repository.
-                lines_blamed.extend(
-                    lines_to_blame
-                        .iter()
-                        .map(|hunk| BlameEntry::new(hunk.range_in_blamed_file.clone(), suspect)),
-                );
+                lines_blamed.extend(lines_to_blame.iter().map(|hunk| {
+                    BlameEntry::new(
+                        hunk.range_in_blamed_file.clone(),
+                        // TODO
+                        // I don’t know whether it is correct to use `range_in_destination` for
+                        // this purpose.
+                        hunk.range_in_destination.clone(),
+                        suspect,
+                    )
+                }));
 
                 lines_to_blame = vec![];
 
@@ -995,6 +1028,7 @@ fn process_change_works_added_hunk() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 0..3,
+            range_in_original_file: 0..3,
             commit_id: suspect
         }]
     );
@@ -1030,6 +1064,7 @@ fn process_change_works_added_hunk_2() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 2..3,
+            range_in_original_file: 2..3,
             commit_id: suspect
         }]
     );
@@ -1071,6 +1106,7 @@ fn process_change_works_added_hunk_3() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 12..13,
+            range_in_original_file: 12..13,
             commit_id: suspect
         }]
     );
@@ -1113,6 +1149,7 @@ fn process_change_works_added_hunk_4() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 14..15,
+            range_in_original_file: 9..10,
             commit_id: suspect
         }]
     );
@@ -1154,6 +1191,7 @@ fn process_change_works_added_hunk_5() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 0..3,
+            range_in_original_file: 0..3,
             commit_id: suspect
         }]
     );
@@ -1190,6 +1228,7 @@ fn process_change_works_added_hunk_6() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 1..4,
+            range_in_original_file: 0..3,
             commit_id: suspect
         }]
     );
@@ -1226,6 +1265,7 @@ fn process_change_works_added_hunk_7() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 4..6,
+            range_in_original_file: 3..5,
             commit_id: suspect
         }]
     );
@@ -1262,6 +1302,7 @@ fn process_change_works_added_hunk_8() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 23..24,
+            range_in_original_file: 25..26,
             commit_id: suspect
         }]
     );
@@ -1536,6 +1577,7 @@ fn process_changes_works_added_hunk() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 0..4,
+            range_in_original_file: 0..4,
             commit_id: suspect
         }]
     );
@@ -1554,6 +1596,7 @@ fn process_changes_works_added_hunk_2() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 0..4,
+            range_in_original_file: 0..4,
             commit_id: suspect
         }]
     );
@@ -1572,6 +1615,7 @@ fn process_changes_works_added_hunk_3() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 2..4,
+            range_in_original_file: 2..4,
             commit_id: suspect
         }]
     );
@@ -1597,10 +1641,12 @@ fn process_changes_works_added_hunk_4_0() {
         vec![
             BlameEntry {
                 range_in_blamed_file: 0..1,
+                range_in_original_file: 0..1,
                 commit_id: suspect
             },
             BlameEntry {
                 range_in_blamed_file: 1..4,
+                range_in_original_file: 1..4,
                 commit_id: suspect
             }
         ]
@@ -1620,6 +1666,7 @@ fn process_changes_works_added_hunk_4_1() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 0..1,
+            range_in_original_file: 0..1,
             commit_id: suspect
         }]
     );
@@ -1629,24 +1676,28 @@ fn process_changes_works_added_hunk_4_1() {
 #[test]
 fn process_changes_works_added_hunk_4_2() {
     let suspect = ObjectId::null(gix_hash::Kind::Sha1);
+    let suspect_2 = ObjectId::from_hex(b"2222222222222222222222222222222222222222").unwrap();
     let mut lines_blamed: Vec<BlameEntry> = vec![BlameEntry {
         range_in_blamed_file: 0..2,
+        range_in_original_file: 0..2,
         commit_id: suspect,
     }];
     let hunks_to_blame: Vec<UnblamedHunk> = vec![UnblamedHunk::new(2..6, Offset::Added(2))];
     let changes: Vec<Change> = vec![Change::Added(0..1, 0)];
-    let new_hunks_to_blame = process_changes(&mut lines_blamed, hunks_to_blame, changes, suspect);
+    let new_hunks_to_blame = process_changes(&mut lines_blamed, hunks_to_blame, changes, suspect_2);
 
     assert_eq!(
         lines_blamed,
         vec![
             BlameEntry {
                 range_in_blamed_file: 0..2,
+                range_in_original_file: 0..2,
                 commit_id: suspect
             },
             BlameEntry {
                 range_in_blamed_file: 2..3,
-                commit_id: suspect
+                range_in_original_file: 0..1,
+                commit_id: suspect_2
             }
         ]
     );
@@ -1665,6 +1716,7 @@ fn process_changes_works_added_hunk_5() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 0..4,
+            range_in_original_file: 0..4,
             commit_id: suspect
         }]
     );
@@ -1686,24 +1738,28 @@ fn process_changes_works_added_hunk_6() {
 #[test]
 fn process_changes_works_added_hunk_7() {
     let suspect = ObjectId::null(gix_hash::Kind::Sha1);
+    let suspect_2 = ObjectId::from_hex(b"2222222222222222222222222222222222222222").unwrap();
     let mut lines_blamed: Vec<BlameEntry> = vec![BlameEntry {
         range_in_blamed_file: 0..1,
+        range_in_original_file: 0..1,
         commit_id: suspect,
     }];
     let hunks_to_blame: Vec<UnblamedHunk> = vec![UnblamedHunk::new(1..3, Offset::Added(1))];
     let changes: Vec<Change> = vec![Change::Added(0..1, 2)];
-    let new_hunks_to_blame = process_changes(&mut lines_blamed, hunks_to_blame, changes, suspect);
+    let new_hunks_to_blame = process_changes(&mut lines_blamed, hunks_to_blame, changes, suspect_2);
 
     assert_eq!(
         lines_blamed,
         vec![
             BlameEntry {
                 range_in_blamed_file: 0..1,
+                range_in_original_file: 0..1,
                 commit_id: suspect
             },
             BlameEntry {
                 range_in_blamed_file: 1..2,
-                commit_id: suspect
+                range_in_original_file: 0..1,
+                commit_id: suspect_2
             }
         ]
     );
@@ -1723,10 +1779,12 @@ fn process_changes_works_added_hunk_8() {
         vec![
             BlameEntry {
                 range_in_blamed_file: 0..2,
+                range_in_original_file: 0..2,
                 commit_id: suspect
             },
             BlameEntry {
                 range_in_blamed_file: 3..4,
+                range_in_original_file: 3..4,
                 commit_id: suspect
             }
         ]
@@ -1739,6 +1797,7 @@ fn process_changes_works_added_hunk_9() {
     let suspect = ObjectId::null(gix_hash::Kind::Sha1);
     let mut lines_blamed: Vec<BlameEntry> = vec![BlameEntry {
         range_in_blamed_file: 30..31,
+        range_in_original_file: 30..31,
         commit_id: suspect,
     }];
     let hunks_to_blame: Vec<UnblamedHunk> = vec![
@@ -1765,10 +1824,12 @@ fn process_changes_works_added_hunk_9() {
         vec![
             BlameEntry {
                 range_in_blamed_file: 16..17,
+                range_in_original_file: 16..17,
                 commit_id: suspect
             },
             BlameEntry {
                 range_in_blamed_file: 30..31,
+                range_in_original_file: 30..31,
                 commit_id: suspect
             }
         ]
@@ -1807,6 +1868,7 @@ fn process_changes_works_deleted_hunk() {
         lines_blamed,
         vec![BlameEntry {
             range_in_blamed_file: 0..4,
+            range_in_original_file: 0..4,
             commit_id: suspect
         }]
     );