support options for the way we calculate the status (#849)

Author: Stephan Dilly

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+**options**
+
+![options](assets/options.gif)
+
 **drop multiple stashes**
 
 ![drop-multiple-stashes](assets/drop-multiple-stashes.gif)
@@ -16,6 +20,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ![name-validation](assets/branch-validation.gif)
 
 ## Added
+- new options popup (show untracked files, diff settings) ([#849](https://github.com/extrawurst/gitui/issues/849))
 - mark and drop multiple stashes ([#854](https://github.com/extrawurst/gitui/issues/854))
 - check branch name validity while typing ([#559](https://github.com/extrawurst/gitui/issues/559))
 - support deleting remote branch [[@zcorniere](https://github.com/zcorniere)] ([#622](https://github.com/extrawurst/gitui/issues/622))

assets/options.drawio

@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2021-08-17T21:58:53.216Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.1.1 Safari/605.1.15" etag="DR-vNI6rA-1d9_EpYLQC" version="14.9.7" type="device"><diagram id="cIq82w5ce00BbVejkL92" name="Page-1">5Zldc6IwFIZ/DZfrEJCvS0Xb7exHZ9bd6WxvdlIIkGlMmBir3V+/iQQVg+12Bqm7eqHwkkB43nMCJ1puPF9fc1gWX1iKiOXY6dpyJ5bjABCG8kcpz5Xi+0El5BynutFOmOHfSIu2Vpc4RYtGQ8EYEbhsigmjFCWioUHO2arZLGOkedUS5sgQZgkkpnqHU1FUaugEO/0jwnlRXxn4UXVkDuvG+k4WBUzZak9yp5Ybc8ZEtTVfx4goeDWXqt/VkaPbgXFExd90KLNx+X10/wl4v+6/5fx28jMVH/RZniBZ6hvWgxXPNQHOljRF6iS25Y5XBRZoVsJEHV1Jz6VWiDmRe0Bu6tMhLtD66DjB9u5l2CA2R4I/yyZ1h0B30REDvGDgVcpq54AbaazFHn0n1CLUrufbs+/AyA3N5g2cnPPj5Hh+g5Njm5S2wbdPCYTeiSi5BqVZIUPesX9QwWHyKOkcUpP3L4c1hgTnVCoEZWpXgcEyCUdanuM0VT3GTcgZJiRmhPHNudxs8+mIrn9A17UNutE2MBtBeKoYHBp0JyiDSyKOQd2Lt4Xg7BHVrCij6ACflmofEokJ8ZecaAvwpjsduDC03RrxCz74bVPBqVzwDBfuFInFhoR8DhWQ5vKB1b0lr6VGL4Y4fjBwDhwJTUcA6Dc1fMOUm5wyjv7nzBgOgteN6DU1AsOFmNENccf+jKnKCh/OFQ76sCi3HC4iS1zbNCfs05zQMGd4UdnRZkCv2REZBmDFqljSRymTKj8uJx+clvepPu2oC8w9P+wT8D/jhGhxoNeEAGbxORNQLM8zDTL5KJvpIQ07cKTtTQq8e40BzEJ3gmVNdamO+O/viFlU35YCM3r+aaL2CXxAZMx4ivjBNbtwzIsOZzUQvb9jZoloWPWmxaIDdzoB11zdcD2TWuva0fBk0MwSLt6U0moAkKby/SiXm0xORfZyt5pky2BW7032DZVf9ePDtrzxNRYJoxmWvWJ1aLMQpba+oWTJF/gJWd7kWAp1uxzVZm8nJgaDenl962PLGiDwt9PavpXuyaxsqQMJWxwtxs9u7Q8EzewYAq9tBbrXOcUs32YrGeFFFezW1LGiqTUC1vTKGodWeKWUUWyF3k7pK9xPMD+1OxBEfTpg1m9f4VOFfzD4p+DWL94vh3c3cOXu7i+uzbG9Pwrd6R8=</diagram></mxfile>

assets/options.gif

@@ -1,7 +1,7 @@
 use crate::{
 	error::Result,
 	hash,
-	sync::{self, CommitId},
+	sync::{self, diff::DiffOptions, CommitId},
 	AsyncGitNotification, FileDiff, CWD,
 };
 use crossbeam_channel::Sender;
@@ -14,7 +14,7 @@ use std::{
 };
 
 ///
-#[derive(Hash, Clone, PartialEq)]
+#[derive(Debug, Hash, Clone, PartialEq)]
 pub enum DiffType {
 	/// diff in a given commit
 	Commit(CommitId),
@@ -25,12 +25,14 @@ pub enum DiffType {
 }
 
 ///
-#[derive(Hash, Clone, PartialEq)]
+#[derive(Debug, Hash, Clone, PartialEq)]
 pub struct DiffParams {
 	/// path to the file to diff
 	pub path: String,
 	/// what kind of diff
 	pub diff_type: DiffType,
+	/// diff options
+	pub options: DiffOptions,
 }
 
 struct Request<R, A>(R, Option<A>);
@@ -87,7 +89,7 @@ impl AsyncDiff {
 		&mut self,
 		params: DiffParams,
 	) -> Result<Option<FileDiff>> {
-		log::trace!("request");
+		log::trace!("request {:?}", params);
 
 		let hash = hash(&params);
 
@@ -148,12 +150,18 @@ impl AsyncDiff {
 		hash: u64,
 	) -> Result<bool> {
 		let res = match params.diff_type {
-			DiffType::Stage => {
-				sync::diff::get_diff(CWD, &params.path, true)?
-			}
-			DiffType::WorkDir => {
-				sync::diff::get_diff(CWD, &params.path, false)?
-			}
+			DiffType::Stage => sync::diff::get_diff(
+				CWD,
+				&params.path,
+				true,
+				Some(params.options),
+			)?,
+			DiffType::WorkDir => sync::diff::get_diff(
+				CWD,
+				&params.path,
+				false,
+				Some(params.options),
+			)?,
 			DiffType::Commit(id) => sync::diff::get_diff_commit(
 				CWD,
 				id,

asyncgit/src/diff.rs

@@ -1,7 +1,7 @@
 use crate::{
 	error::Result,
 	hash,
-	sync::{self, status::StatusType},
+	sync::{self, status::StatusType, ShowUntrackedFilesConfig},
 	AsyncGitNotification, StatusItem, CWD,
 };
 use crossbeam_channel::Sender;
@@ -31,14 +31,19 @@ pub struct Status {
 pub struct StatusParams {
 	tick: u128,
 	status_type: StatusType,
+	config: Option<ShowUntrackedFilesConfig>,
 }
 
 impl StatusParams {
 	///
-	pub fn new(status_type: StatusType) -> Self {
+	pub fn new(
+		status_type: StatusType,
+		config: Option<ShowUntrackedFilesConfig>,
+	) -> Self {
 		Self {
 			tick: current_tick(),
 			status_type,
+			config,
 		}
 	}
 }
@@ -109,12 +114,14 @@ impl AsyncStatus {
 		let sender = self.sender.clone();
 		let arc_pending = Arc::clone(&self.pending);
 		let status_type = params.status_type;
+		let config = params.config;
 
 		self.pending.fetch_add(1, Ordering::Relaxed);
 
 		rayon_core::spawn(move || {
 			let ok = Self::fetch_helper(
 				status_type,
+				config,
 				hash_request,
 				&arc_current,
 				&arc_last,
@@ -135,11 +142,12 @@ impl AsyncStatus {
 
 	fn fetch_helper(
 		status_type: StatusType,
+		config: Option<ShowUntrackedFilesConfig>,
 		hash_request: u64,
 		arc_current: &Arc<Mutex<Request<u64, Status>>>,
 		arc_last: &Arc<Mutex<Status>>,
 	) -> Result<()> {
-		let res = Self::get_status(status_type)?;
+		let res = Self::get_status(status_type, config)?;
 		log::trace!(
 			"status fetched: {} (type: {:?})",
 			hash_request,
@@ -161,9 +169,16 @@ impl AsyncStatus {
 		Ok(())
 	}
 
-	fn get_status(status_type: StatusType) -> Result<Status> {
+	fn get_status(
+		status_type: StatusType,
+		config: Option<ShowUntrackedFilesConfig>,
+	) -> Result<Status> {
 		Ok(Status {
-			items: sync::status::get_status(CWD, status_type)?,
+			items: sync::status::get_status(
+				CWD,
+				status_type,
+				config,
+			)?,
 		})
 	}
 }

asyncgit/src/status.rs

@@ -5,6 +5,7 @@ use scopetime::scope_time;
 
 // see https://git-scm.com/docs/git-config#Documentation/git-config.txt-statusshowUntrackedFiles
 /// represents the `status.showUntrackedFiles` git config state
+#[derive(Hash, Copy, Clone, PartialEq)]
 pub enum ShowUntrackedFilesConfig {
 	///
 	No,
@@ -14,19 +15,25 @@ pub enum ShowUntrackedFilesConfig {
 	All,
 }
 
+impl Default for ShowUntrackedFilesConfig {
+	fn default() -> Self {
+		Self::No
+	}
+}
+
 impl ShowUntrackedFilesConfig {
 	///
-	pub const fn include_none(&self) -> bool {
+	pub const fn include_none(self) -> bool {
 		matches!(self, Self::No)
 	}
 
 	///
-	pub const fn include_untracked(&self) -> bool {
+	pub const fn include_untracked(self) -> bool {
 		matches!(self, Self::Normal | Self::All)
 	}
 
 	///
-	pub const fn recurse_untracked_dirs(&self) -> bool {
+	pub const fn recurse_untracked_dirs(self) -> bool {
 		matches!(self, Self::All)
 	}
 }

asyncgit/src/sync/config.rs

@@ -8,8 +8,7 @@ use super::{
 use crate::{error::Error, error::Result, hash};
 use easy_cast::Conv;
 use git2::{
-	Delta, Diff, DiffDelta, DiffFormat, DiffHunk, DiffOptions, Patch,
-	Repository,
+	Delta, Diff, DiffDelta, DiffFormat, DiffHunk, Patch, Repository,
 };
 use scopetime::scope_time;
 use std::{cell::RefCell, fs, path::Path, rc::Rc};
@@ -125,18 +124,41 @@ pub struct FileDiff {
 	pub size_delta: i64,
 }
 
+/// see <https://libgit2.org/libgit2/#HEAD/type/git_diff_options>
+#[derive(Debug, Hash, Clone, Copy, PartialEq)]
+pub struct DiffOptions {
+	/// see <https://libgit2.org/libgit2/#HEAD/type/git_diff_options>
+	pub ignore_whitespace: bool,
+	/// see <https://libgit2.org/libgit2/#HEAD/type/git_diff_options>
+	pub context: u32,
+	/// see <https://libgit2.org/libgit2/#HEAD/type/git_diff_options>
+	pub interhunk_lines: u32,
+}
+
+impl Default for DiffOptions {
+	fn default() -> Self {
+		Self {
+			ignore_whitespace: false,
+			context: 3,
+			interhunk_lines: 0,
+		}
+	}
+}
+
 pub(crate) fn get_diff_raw<'a>(
 	repo: &'a Repository,
 	p: &str,
 	stage: bool,
 	reverse: bool,
-	context: Option<u32>,
+	options: Option<DiffOptions>,
 ) -> Result<Diff<'a>> {
 	// scope_time!("get_diff_raw");
 
-	let mut opt = DiffOptions::new();
-	if let Some(context) = context {
-		opt.context_lines(context);
+	let mut opt = git2::DiffOptions::new();
+	if let Some(options) = options {
+		opt.context_lines(options.context);
+		opt.ignore_whitespace(options.ignore_whitespace);
+		opt.interhunk_lines(options.interhunk_lines);
 	}
 	opt.pathspec(p);
 	opt.reverse(reverse);
@@ -173,12 +195,13 @@ pub fn get_diff(
 	repo_path: &str,
 	p: &str,
 	stage: bool,
+	options: Option<DiffOptions>,
 ) -> Result<FileDiff> {
 	scope_time!("get_diff");
 
 	let repo = utils::repo(repo_path)?;
 	let work_dir = work_dir(&repo)?;
-	let diff = get_diff_raw(&repo, p, stage, false, None)?;
+	let diff = get_diff_raw(&repo, p, stage, false, options)?;
 
 	raw_diff_to_file_diff(&diff, work_dir)
 }
@@ -386,7 +409,8 @@ mod tests {
 
 		assert_eq!(get_statuses(repo_path), (1, 0));
 
-		let diff = get_diff(repo_path, "foo/bar.txt", false).unwrap();
+		let diff =
+			get_diff(repo_path, "foo/bar.txt", false, None).unwrap();
 
 		assert_eq!(diff.hunks.len(), 1);
 		assert_eq!(diff.hunks[0].lines[1].content, "test\n");
@@ -412,9 +436,13 @@ mod tests {
 
 		assert_eq!(get_statuses(repo_path), (0, 1));
 
-		let diff =
-			get_diff(repo_path, file_path.to_str().unwrap(), true)
-				.unwrap();
+		let diff = get_diff(
+			repo_path,
+			file_path.to_str().unwrap(),
+			true,
+			None,
+		)
+		.unwrap();
 
 		assert_eq!(diff.hunks.len(), 1);
 	}
@@ -462,8 +490,8 @@ mod tests {
 				.unwrap();
 		}
 
-		let res =
-			get_status(repo_path, StatusType::WorkingDir).unwrap();
+		let res = get_status(repo_path, StatusType::WorkingDir, None)
+			.unwrap();
 		assert_eq!(res.len(), 1);
 		assert_eq!(res[0].path, "bar.txt");
 
@@ -480,7 +508,8 @@ mod tests {
 
 		assert_eq!(get_statuses(repo_path), (1, 1));
 
-		let res = get_diff(repo_path, "bar.txt", false).unwrap();
+		let res =
+			get_diff(repo_path, "bar.txt", false, None).unwrap();
 
 		assert_eq!(res.hunks.len(), 2)
 	}
@@ -503,6 +532,7 @@ mod tests {
 			sub_path.to_str().unwrap(),
 			file_path.to_str().unwrap(),
 			false,
+			None,
 		)
 		.unwrap();
 
@@ -525,9 +555,13 @@ mod tests {
 		File::create(&root.join(file_path))?
 			.write_all(b"\x00\x02")?;
 
-		let diff =
-			get_diff(repo_path, file_path.to_str().unwrap(), false)
-				.unwrap();
+		let diff = get_diff(
+			repo_path,
+			file_path.to_str().unwrap(),
+			false,
+			None,
+		)
+		.unwrap();
 
 		dbg!(&diff);
 		assert_eq!(diff.sizes, (1, 2));
@@ -546,9 +580,13 @@ mod tests {
 		File::create(&root.join(file_path))?
 			.write_all(b"\x00\xc7")?;
 
-		let diff =
-			get_diff(repo_path, file_path.to_str().unwrap(), false)
-				.unwrap();
+		let diff = get_diff(
+			repo_path,
+			file_path.to_str().unwrap(),
+			false,
+			None,
+		)
+		.unwrap();
 
 		dbg!(&diff);
 		assert_eq!(diff.sizes, (0, 2));

asyncgit/src/sync/diff.rs

@@ -173,6 +173,7 @@ mod tests {
 			sub_path.to_str().unwrap(),
 			file_path.to_str().unwrap(),
 			false,
+			None,
 		)?;
 
 		assert!(reset_hunk(

asyncgit/src/sync/hunks.rs

@@ -255,10 +255,12 @@ mod tests {
 	/// helper returning amount of files with changes in the (wd,stage)
 	pub fn get_statuses(repo_path: &str) -> (usize, usize) {
 		(
-			get_status(repo_path, StatusType::WorkingDir)
+			get_status(repo_path, StatusType::WorkingDir, None)
+				.unwrap()
+				.len(),
+			get_status(repo_path, StatusType::Stage, None)
 				.unwrap()
 				.len(),
-			get_status(repo_path, StatusType::Stage).unwrap().len(),
 		)
 	}