Merge pull request #2240 from cruessler/add-gix-repository-blame-options

fix!: respect `diff.algorithm` in `Repository::blame_file`

Sebastian Thiel committed 1 year ago

Commit 385ab162 parents 663b41e adc36245 files · +50 −7Browse files

Unified · Split

5 files

@@ -145,7 +145,7 @@ blob-diff = ["gix-diff/blob", "attributes"] · 144 unmodified lines
145	merge = ["tree-editor", "blob-diff", "dep:gix-merge", "attributes"]	145	merge = ["tree-editor", "blob-diff", "dep:gix-merge", "attributes"]
146		146
147	## Add blame command similar to `git blame`.	147	## Add blame command similar to `git blame`.
148	blame = ["dep:gix-blame"]	148	blame = ["dep:gix-blame", "blob-diff"]
149		149
150	## Make it possible to turn a tree into a stream of bytes, which can be decoded to entries and turned into various other formats.	150	## Make it possible to turn a tree into a stream of bytes, which can be decoded to entries and turned into various other formats.
151	worktree-stream = ["gix-worktree-stream", "attributes"]	151	worktree-stream = ["gix-worktree-stream", "attributes"]

@@ -13,11 +13,30 @@ impl Repository { · 12 unmodified lines
13	&self,	13	&self,
14	file_path: &BStr,	14	file_path: &BStr,
15	suspect: impl Into<ObjectId>,	15	suspect: impl Into<ObjectId>,
16	options: gix_blame::Options,	16	options: blame_file::Options,
17	) -> Result<gix_blame::Outcome, blame_file::Error> {	17	) -> Result<gix_blame::Outcome, blame_file::Error> {
18	let cache: Option<gix_commitgraph::Graph> = self.commit_graph_if_enabled()?;	18	let cache = self.commit_graph_if_enabled()?;
19	let mut resource_cache = self.diff_resource_cache_for_tree_diff()?;	19	let mut resource_cache = self.diff_resource_cache_for_tree_diff()?;
20		20
		21	let blame_file::Options {
		22	diff_algorithm,
		23	ranges,
		24	since,
		25	rewrites,
		26	} = options;
		27	let diff_algorithm = match diff_algorithm {
		28	Some(diff_algorithm) => diff_algorithm,
		29	None => self.diff_algorithm()?,
		30	};
		31
		32	let options = gix_blame::Options {
		33	diff_algorithm,
		34	ranges,
		35	since,
		36	rewrites,
		37	debug_track_path: false,
		38	};
		39
21	let outcome = gix_blame::file(	40	let outcome = gix_blame::file(
22	&self.objects,	41	&self.objects,
23	suspect.into(),	42	suspect.into(),

 #[cfg(any(feature = "attributes", feature = "excludes"))]
 pub mod attributes;
+///
 #[cfg(feature = "blame")]
 mod blame;
 mod cache;
 ///
 #[cfg(feature = "blame")]
 pub mod blame_file {
+    /// Options to be passed to [Repository::blame_file()](crate::Repository::blame_file()).
+    #[derive(Default, Debug, Clone)]
+    pub struct Options {
+        /// The algorithm to use for diffing. If `None`, `diff.algorithm` will be used.
+        pub diff_algorithm: Option<gix_diff::blob::Algorithm>,
+        /// The ranges to blame in the file.
+        pub ranges: gix_blame::BlameRanges,
+        /// Don't consider commits before the given date.
+        pub since: Option<gix_date::Time>,
+        /// Determine if rename tracking should be performed, and how.
+        pub rewrites: Option<gix_diff::Rewrites>,
+    }
     /// The error returned by [Repository::blame_file()](crate::Repository::blame_file()).
     #[derive(Debug, thiserror::Error)]
     #[allow(missing_docs)]
         #[error(transparent)]
         CommitGraphIfEnabled(#[from] super::commit_graph_if_enabled::Error),
         #[error(transparent)]
+        DiffAlgorithm(#[from] crate::config::diff::algorithm::Error),
+        #[error(transparent)]
         DiffResourceCache(#[from] super::diff_resource_cache::Error),
         #[error(transparent)]
         Blame(#[from] gix_blame::Error),

@@ -17,7 +17,7 @@ fn simple() -> crate::Result { · 16 unmodified lines
17	fn with_options() -> crate::Result {	17	fn with_options() -> crate::Result {
18	let repo = crate::named_repo("make_blame_repo.sh")?;	18	let repo = crate::named_repo("make_blame_repo.sh")?;
19		19
20	let options = gix::blame::Options {	20	let options = gix::repository::blame_file::Options {
21	ranges: gix::blame::BlameRanges::from_one_based_inclusive_range(1..=2)?,	21	ranges: gix::blame::BlameRanges::from_one_based_inclusive_range(1..=2)?,
22	..Default::default()	22	..Default::default()
23	};	23	};

 # Must be sourced into the main journey test
+function remove-thread-id {
+  sed -E 's/ \([0-9]+\)//'
+}
 if test "$kind" = "max" || test "$kind" = "max-pure"; then
 title "Porcelain ${kind}"
 (
     (with "the --quiet option set"
       it "fails as expected" && {
         WITH_SNAPSHOT="$snapshot/expected-failure" \
-        expect_run_sh 101 "$exe -q panic"
+        SNAPSHOT_FILTER=remove-thread-id \
+        expect_run_sh 0 "$exe -q panic"
       }
     )
     (with "NO --quiet option set"
       it "fails as expected" && {
         WITH_SNAPSHOT="$snapshot/expected-failure-in-thread" \
-        expect_run_sh 101 "$exe panic"
+        SNAPSHOT_FILTER=remove-thread-id \
+        expect_run_sh 0 "$exe panic"
       }
     )
     (not_on_ci # due to different TTY settings, the output differs, it's OK for now
       (with "progress option set"
         it "fails as expected" && {
           WITH_SNAPSHOT="$snapshot/expected-failure-in-thread-with-progress" \
-          expect_run_sh 101 "$exe --progress panic"
+        SNAPSHOT_FILTER=remove-thread-id \
+          expect_run_sh 0 "$exe --progress panic"
         }
       )
     )