Add feature to update only tracked files (gitui-org#933)

Author: Revantus

CHANGELOG.md

@@ -6,7 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
- 
+ - Add the 'u' shortcut to stage tracked files only [[@Revantus](https://github.com/Revantus)] ([#933](https://github.com/extrawurst/gitui/issues/933))
+
 ## Added
 - add `trace-libgit` feature to make git tracing optional [[@dm9pZCAq](https://github.com/dm9pZCAq)] ([#902](https://github.com/extrawurst/gitui/issues/902))
 - support merging and rebasing remote branches ([#920](https://github.com/extrawurst/gitui/issues/920))
@@ -121,7 +122,7 @@ see `vim_style_key_config.ron` for their default vim binding
 - indicator for longer commit message than displayed ([#773](https://github.com/extrawurst/gitui/issues/773))
 
 ![msg-len](assets/long-msg-indicator.gif)
-  
+
 ## Fixed
 - wrong file with same name shown in file tree ([#748](https://github.com/extrawurst/gitui/issues/748))
 - filetree collapsing broken on windows ([#761](https://github.com/extrawurst/gitui/issues/761))
@@ -157,7 +158,7 @@ see `vim_style_key_config.ron` for their default vim binding
 - `--bugreport` cmd line arg to help diagnostics [[@zcorniere](https://github.com/zcorniere)] ([#695](https://github.com/extrawurst/gitui/issues/695))
 
 ## Changed
-- smarter log timestamps ([#682](https://github.com/extrawurst/gitui/issues/682)) 
+- smarter log timestamps ([#682](https://github.com/extrawurst/gitui/issues/682))
 - create-branch popup aligned with rename-branch [[@bruceCoelho](https://github.com/bruceCoelho)] ([#679](https://github.com/extrawurst/gitui/issues/679))
 - smart focus change after staging all files ([#706](https://github.com/extrawurst/gitui/issues/706))
 - do not allow to commit when `gpgsign` enabled ([#740](https://github.com/extrawurst/gitui/issues/740))
@@ -244,13 +245,13 @@ Thanks for your interest and support over this year! Read more about the 1 year
 ![chars-branch-name](assets/chars_and_branchname.gif)
 
 ### Breaking Change
-- MacOS config directory now uses `~/.config/gitui` [[@remique](https://github.com/remique)] ([#317](https://github.com/extrawurst/gitui/issues/317)) 
+- MacOS config directory now uses `~/.config/gitui` [[@remique](https://github.com/remique)] ([#317](https://github.com/extrawurst/gitui/issues/317))
 
 ### Added
 - support for pull (fetch + simple merging) ([#319](https://github.com/extrawurst/gitui/issues/319))
 - show used char count in input texts ([#466](https://github.com/extrawurst/gitui/issues/466))
 - support smoother left/right toggle/keys for commit details ([#418](https://github.com/extrawurst/gitui/issues/418))
-- support *force push* command [[@WizardOhio24](https://github.com/WizardOhio24)] ([#274](https://github.com/extrawurst/gitui/issues/274)) 
+- support *force push* command [[@WizardOhio24](https://github.com/WizardOhio24)] ([#274](https://github.com/extrawurst/gitui/issues/274))
 
 ### Fixed
 - don't close branchlist every time ([#550](https://github.com/extrawurst/gitui/issues/550))

asyncgit/src/sync/mod.rs

@@ -81,7 +81,8 @@ pub use tags::{
 pub use tree::{tree_file_content, tree_files, TreeFile};
 pub use utils::{
 	get_head, get_head_tuple, is_bare_repo, is_repo, repo_dir,
-	stage_add_all, stage_add_file, stage_addremoved, Head,
+	stage_add_all, stage_add_file, stage_add_updated,
+	stage_addremoved, Head,
 };
 
 #[cfg(test)]

asyncgit/src/sync/utils.rs

@@ -149,6 +149,40 @@ pub fn stage_add_all(repo_path: &str, pattern: &str) -> Result<()> {
 	Ok(())
 }
 
+/// add all changed files that are currently tracked
+pub fn stage_add_updated(
+	repo_path: &str,
+	pattern: &str,
+) -> Result<()> {
+	scope_time!("stage_add_updated");
+
+	let repo = repo(repo_path)?;
+
+	let mut index = repo.index()?;
+
+	// Gets the status of a file in the index.
+	// If it's in the working tree update it.
+	// If for whatever reason we can't get the status of a file,
+	// treat it as an empty status.
+	let cb = &mut |path: &Path, _matched_spec: &[u8]| -> i32 {
+		let status = repo
+			.status_file(path)
+			.unwrap_or_else(|_| git2::Status::empty());
+
+		if status.contains(git2::Status::WT_MODIFIED) {
+			0
+		} else {
+			1
+		}
+	};
+	let cb = Some(cb as &mut git2::IndexMatchedPath);
+
+	index.update_all(vec![pattern], cb)?;
+	index.write()?;
+
+	Ok(())
+}
+
 /// Undo last commit in repo
 pub fn undo_last_commit(repo_path: &str) -> Result<()> {
 	let repo = repo(repo_path)?;
@@ -229,7 +263,7 @@ mod tests {
 		},
 	};
 	use std::{
-		fs::{self, remove_file, File},
+		fs::{self, remove_file, File, OpenOptions},
 		io::Write,
 		path::Path,
 	};
@@ -271,6 +305,53 @@ mod tests {
 		assert_eq!(get_statuses(repo_path), (1, 1));
 	}
 
+	#[test]
+	fn test_updated_only_tracked() -> Result<()> {
+		let tracked_file = "file1.txt";
+		let (_td, repo) = repo_init().unwrap();
+		let root = repo.path().parent().unwrap();
+		let repo_path = root.as_os_str().to_str().unwrap();
+
+		// Create and commit file 1
+		write_commit_file(
+			&repo,
+			tracked_file,
+			"test file1 content",
+			"c1",
+		);
+
+		// No changes in (wd, stage)
+		assert_eq!(get_statuses(repo_path), (0, 0));
+
+		// Create new untracked file 2
+		File::create(&root.join(Path::new("file2.txt")))
+			.unwrap()
+			.write_all(b"test file2 content")
+			.unwrap();
+
+		// Single change in wd
+		assert_eq!(get_statuses(repo_path), (1, 0));
+
+		// Add new content to file 1
+		OpenOptions::new()
+			.write(true)
+			.append(true)
+			.open(&root.join(Path::new(tracked_file)))
+			.unwrap()
+			.write_all(b"add new content")?;
+
+		// Two changes in wd, nothing staged
+		assert_eq!(get_statuses(repo_path), (2, 0));
+
+		// Only add file 1 to the stage as file 2 is untracked
+		stage_add_updated(repo_path, "*").unwrap();
+
+		// Single change in wd and stage
+		assert_eq!(get_statuses(repo_path), (1, 1));
+
+		Ok(())
+	}
+
 	#[test]
 	fn test_staging_folder() -> Result<()> {
 		let (_td, repo) = repo_init().unwrap();

src/components/changes.rs

@@ -120,6 +120,14 @@ impl ChangesComponent {
 		Ok(())
 	}
 
+	fn index_add_updated(&mut self) -> Result<()> {
+		sync::stage_add_updated(CWD, "*")?;
+
+		self.queue.push(InternalEvent::Update(NeedsUpdate::ALL));
+
+		Ok(())
+	}
+
 	fn stage_remove_all(&mut self) -> Result<()> {
 		sync::reset_stage(CWD, "*")?;
 
@@ -195,6 +203,11 @@ impl Component for ChangesComponent {
 				true,
 				some_selection && self.focused(),
 			));
+			out.push(CommandInfo::new(
+				strings::commands::stage_update(&self.key_config),
+				true,
+				some_selection && self.focused(),
+			));
 			out.push(CommandInfo::new(
 				strings::commands::stage_item(&self.key_config),
 				true,
@@ -259,6 +272,21 @@ impl Component for ChangesComponent {
 					self.queue
 						.push(InternalEvent::StatusLastFileMoved);
 					Ok(EventState::Consumed)
+				} else if e == self.key_config.status_stage_update
+					&& !self.is_empty()
+				{
+					if self.is_working_dir {
+						try_or_popup!(
+							self,
+							"staging all tracked error:",
+							self.index_add_updated()
+						);
+					} else {
+						self.stage_remove_all()?;
+					}
+					self.queue
+						.push(InternalEvent::StatusLastFileMoved);
+					Ok(EventState::Consumed)
 				} else if e == self.key_config.status_reset_item
 					&& self.is_working_dir
 				{

src/keys.rs

@@ -56,6 +56,7 @@ pub struct KeyConfig {
 	pub blame: KeyEvent,
 	pub edit_file: KeyEvent,
 	pub status_stage_all: KeyEvent,
+	pub status_stage_update: KeyEvent,
 	pub status_reset_item: KeyEvent,
 	pub status_ignore_file: KeyEvent,
 	pub diff_stage_lines: KeyEvent,
@@ -130,6 +131,7 @@ impl Default for KeyConfig {
 			blame: KeyEvent { code: KeyCode::Char('B'), modifiers: KeyModifiers::SHIFT},
 			edit_file: KeyEvent { code: KeyCode::Char('e'), modifiers: KeyModifiers::empty()},
 			status_stage_all: KeyEvent { code: KeyCode::Char('a'), modifiers: KeyModifiers::empty()},
+			status_stage_update: KeyEvent { code: KeyCode::Char('u'), modifiers: KeyModifiers::empty()},
 			status_reset_item: KeyEvent { code: KeyCode::Char('D'), modifiers: KeyModifiers::SHIFT},
 			diff_reset_lines: KeyEvent { code: KeyCode::Char('d'), modifiers: KeyModifiers::empty()},
 			status_ignore_file: KeyEvent { code: KeyCode::Char('i'), modifiers: KeyModifiers::empty()},

src/strings.rs

@@ -767,6 +767,16 @@ pub mod commands {
 			CMD_GROUP_CHANGES,
 		)
 	}
+	pub fn stage_update(key_config: &SharedKeyConfig) -> CommandText {
+		CommandText::new(
+			format!(
+				"Stage Only Tracked Files [{}]",
+				key_config.get_hint(key_config.status_stage_update),
+			),
+			"stage all changes (in already tracked, unstaged files)",
+			CMD_GROUP_CHANGES,
+		)
+	}
 	pub fn unstage_item(key_config: &SharedKeyConfig) -> CommandText {
 		CommandText::new(
 			format!(

vim_style_key_config.ron

@@ -1,5 +1,5 @@
 // bit for modifiers
-// bits: 0  None 
+// bits: 0  None
 // bits: 1  SHIFT
 // bits: 2  CONTROL
 //
@@ -33,7 +33,7 @@
 
     open_commit: ( code: Char('c'), modifiers: ( bits: 0,),),
     // Note: the shift modifier does not work for open_commit_editor
-    // Also just plain text characters will not work because the commit 
+    // Also just plain text characters will not work because the commit
     // msg editor will interpret them as text input
     open_commit_editor: ( code: Char('e'), modifiers: ( bits: 2,),),
     undo_commit: ( code: Char('U'), modifiers: ( bits: 1,),),
@@ -58,6 +58,7 @@
     edit_file: ( code: Char('I'), modifiers: ( bits: 1,),),
 
     status_stage_all: ( code: Char('a'), modifiers: ( bits: 0,),),
+    status_stage_update: ( code: Char('u'), modifiers: ( bits: 0,),),
     status_reset_item: ( code: Char('U'), modifiers: ( bits: 1,),),
     status_ignore_file: ( code: Char('i'), modifiers: ( bits: 0,),),