feat(repo): 🎉 Add commit gpg support.

Author: sdttttt

src/log.rs

@@ -3,41 +3,53 @@ use std::fmt::Display;
 use console::Style;
 
 /// GCR logger.
-pub fn grc_println(content: impl Display) {
+pub fn grc_log(content: impl Display) {
 	println!("{}", content)
 }
 
 /// GCR error logger.
-pub fn grc_err_println(content: impl Display) {
+pub fn grc_err(content: impl Display) {
 	let color = Style::new().red();
 
 	println!("{}", color.apply_to(content))
 }
 
 /// GCR error logger.
-pub fn grc_warn_println(content: impl Display) {
+pub fn grc_warn(content: impl Display) {
 	let color = Style::new().yellow();
 
 	println!("{}", color.apply_to(content))
 }
 
+/// GCR success logger.
+pub fn grc_succ(content: impl Display) {
+	let color = Style::new().green();
+
+	println!("{}", color.apply_to(content))
+}
+
 #[cfg(test)]
 mod tests {
 
 	use super::*;
 
 	#[test]
 	fn it_grc_println() {
-		grc_println("TEST CONTENT.");
+		grc_log("TEST CONTENT.");
 	}
 
 	#[test]
 	fn it_grc_err_println() {
-		grc_err_println("TEST ERROR CONTENT.");
+		grc_err("TEST ERROR CONTENT.");
 	}
 
 	#[test]
 	fn it_grc_warn_println() {
-		grc_warn_println("TEST WARN CONTENT.");
+		grc_warn("TEST WARN CONTENT.");
+	}
+
+	#[test]
+	fn it_grc_succ_println() {
+		grc_succ("TEST SUCCESS CONTENT.");
 	}
 }

src/main.rs

@@ -23,7 +23,7 @@ fn main() {
 	let arg = match Arguments::collect() {
 		| Ok(a) => a,
 		| Err(e) => {
-			grc_err_println(e.message());
+			grc_err(e.message());
 			return;
 		}
 	};
@@ -38,7 +38,7 @@ fn main() {
 	let extensions = match ext {
 		| Ok(e) => e,
 		| Err(e) => {
-			grc_err_println(e.to_string());
+			grc_err(e.to_string());
 			return;
 		}
 	};
@@ -50,7 +50,7 @@ fn main() {
 	let repo = match Repository::new(path, Rc::clone(&config)) {
 		| Ok(r) => r,
 		| Err(e) => {
-			grc_err_println(e.message());
+			grc_err(e.message());
 			return;
 		}
 	};
@@ -62,10 +62,10 @@ fn main() {
 		.ask()
 		.build();
 
-	grc_println(&message);
+	grc_log(&message);
 
 	// Git commit
 	if let Err(e) = repo.commit(message.as_str()) {
-		grc_err_println(e.message());
+		grc_err(e.message());
 	}
 }

src/message.rs

@@ -1,6 +1,6 @@
 use dialoguer::{theme::ColorfulTheme, Input, Select};
 
-use crate::log::grc_err_println;
+use crate::log::grc_err;
 use crate::metadata::*;
 use crate::util::remove_pound_prefix;
 
@@ -69,7 +69,7 @@ impl Messager {
 			.map(|typ: &String| -> CommitTD {
 				let arr_td = typ.split(SEPARATOR_SYMBOL).collect::<Vec<&str>>();
 				if arr_td.len() < 2 {
-					grc_err_println(TYPE_PARSE_FAILED);
+					grc_err(TYPE_PARSE_FAILED);
 					std::process::exit(1);
 				};
 				CommitTD::from(arr_td[0].trim(), arr_td[1].trim())
@@ -87,7 +87,7 @@ impl Messager {
 			emo.iter().for_each(|type_emo: &String| {
 				let arr_emo = type_emo.split(SEPARATOR_SYMBOL).collect::<Vec<&str>>();
 				if arr_emo.len() < 2 {
-					grc_err_println(OVERWRITE_PARSE_FAILED);
+					grc_err(OVERWRITE_PARSE_FAILED);
 					std::process::exit(1);
 				};
 				if td.0 == arr_emo[0].trim() {

src/plugins/push.rs

@@ -1,4 +1,4 @@
-use crate::{log::grc_warn_println, repo::Repository};
+use crate::{log::grc_warn, repo::Repository};
 use console::Style;
 use git2::{Cred, Error, PushOptions, RemoteCallbacks};
 use std::env;
@@ -39,8 +39,8 @@ impl CommitPlugin for PushPlugin {
 		let mut push_option: PushOptions = PushOptions::new();
 		push_option.remote_callbacks(callbacks);
 
-		grc_warn_println(format!("Remote: {}", remote_name));
-		grc_warn_println(format!("Branch: {}", branch_name));
+		grc_warn(format!("Remote: {}", remote_name));
+		grc_warn(format!("Branch: {}", branch_name));
 
 		remote.push(
 			&[format!("refs/heads/{}:refs/heads/{}", branch_name, branch_name).as_str()],

src/repo.rs

@@ -7,9 +7,9 @@ use git2::{
 
 use crate::{
 	config::Configuration,
-	log::{grc_println, grc_warn_println},
+	log::{grc_log, grc_warn},
 	metadata::Mode,
-	util::{author_sign_from_env, committer_sign_from_env, is_all_workspace},
+	util::{author_sign_from_env, committer_sign_from_env, is_all_workspace, repo_gpg_available},
 };
 
 /// Repository in GRC.
@@ -37,13 +37,23 @@ impl Repository {
 	pub fn commit(&self, message: &str) -> Result<(), Error> {
 		self.pre_commit()?;
 
+		let is_gpg_commit = self.gpg_sign_commit(message)?;
+		if !is_gpg_commit {
+			self.general_commit(message)?;
+		}
+
+		self.after_commit()?;
+
+		Ok(())
+	}
+
+	fn general_commit(&self, message: &str) -> Result<(), Error> {
 		let tree_id = {
 			let mut index = self.repo.index()?;
 			index.write_tree()?
 		};
 
 		let tree = self.repo.find_tree(tree_id)?;
-
 		let (author_sign, committer_sign) = self.generate_sign()?;
 
 		match self.find_last_commit() {
@@ -58,7 +68,7 @@ impl Repository {
 				)?;
 			}
 			| Err(_) => {
-				grc_warn_println("grc think this is the repo's first commit.");
+				grc_warn("grc think this is the repo's first commit.");
 				self.repo.commit(
 					Some("HEAD"),
 					&author_sign,
@@ -68,11 +78,54 @@ impl Repository {
 					&[],
 				)?;
 			}
-		};
+		}
+		Ok(())
+	}
 
-		self.after_commit()?;
+	/// check gpg is available, if true then using gpg sign commit.
+	/// github.com/sdttttt/gcr/issues/52 Thinks @Enter-tainer @CoelacanthusHex
+	fn gpg_sign_commit(&self, message: &str) -> Result<bool, Error> {
+		match repo_gpg_available(&self.repo) {
+			| Some(ref key) => {
+				let tree_id = {
+					let mut index = self.repo.index()?;
+					index.write_tree()?
+				};
 
-		Ok(())
+				let tree = self.repo.find_tree(tree_id)?;
+				let (author_sign, committer_sign) = self.generate_sign()?;
+
+				let buf = match self.find_last_commit() {
+					| Ok(commit) => self.repo.commit_create_buffer(
+						&author_sign,
+						&committer_sign,
+						message,
+						&tree,
+						&[&commit],
+					)?,
+					| Err(_) => {
+						grc_warn("grc think this is the repo's first commit.");
+						self.repo.commit_create_buffer(
+							&author_sign,
+							&committer_sign,
+							message,
+							&tree,
+							&[],
+						)?
+					}
+				};
+
+				// https://github.com/rust-lang/git2-rs/issues/507 Thinks @cole-h
+				let commit_content = std::str::from_utf8(&buf).unwrap();
+				let ret = self.repo.commit_signed(commit_content, key, Some(key))?;
+				let commit = self.repo.find_commit(ret)?;
+				self.repo.branch(&self.current_branch_name(), &commit, false)?;
+
+				Ok(true)
+			}
+
+			| None => Ok(false),
+		}
 	}
 
 	fn pre_commit(&self) -> Result<(), Error> {
@@ -158,7 +211,7 @@ impl Repository {
 		};
 
 		if use_env {
-			grc_println("you are using environment variables to generate commit sign.");
+			grc_log("you are using environment variables to generate commit sign.");
 		}
 
 		Ok((author_sign, committer_sign))
@@ -170,6 +223,12 @@ impl Repository {
 		obj.into_commit().map_err(|_| Error::from_str("not fonund Commit."))
 	}
 
+	fn current_branch_name(&self) -> String {
+		let head = &self.repo.head().unwrap();
+		let branch_name = head.shorthand().unwrap_or_else(|| "");
+		String::from(branch_name)
+	}
+
 	/// Check to see if the repository commit index is empty.
 	fn check_index(&self) -> Result<(), Error> {
 		match self.status() {
@@ -185,3 +244,16 @@ impl Repository {
 		}
 	}
 }
+
+//#[cfg(test)]
+//mod tests {
+
+//	use git2::Repository;
+
+//	#[test]
+//	fn check_gpg() {
+//		let repo = Repository::open(".").unwrap();
+//		let config = repo.config().unwrap();
+//		let gpg_enabled = config.get_bool("commit.gpgsign").unwrap_or_else(|_|
+// false); 		assert_eq!(gpg_enabled, true); 	}
+//}

src/util.rs

@@ -1,13 +1,35 @@
-use git2::{Signature, Status, Statuses};
+use git2::{Repository, Signature, Status, Statuses};
 use std::{env, fs};
 
-use crate::metadata::{GIT_AUTHOR_EMAIL, GIT_AUTHOR_NAME, GIT_COMMITTER_EMAIL, GIT_COMMITTER_NAME};
+use crate::{
+	log::grc_warn,
+	metadata::{GIT_AUTHOR_EMAIL, GIT_AUTHOR_NAME, GIT_COMMITTER_EMAIL, GIT_COMMITTER_NAME},
+};
 
 pub fn current_path() -> String {
 	let path = fs::canonicalize(".").unwrap();
 	String::from(path.to_str().unwrap())
 }
 
+/// if gpg available at repo. then return user.signingKey.
+pub fn repo_gpg_available(repo: &Repository) -> Option<String> {
+	let config = repo.config().unwrap();
+	let gpg_enabled = config.get_bool("commit.gpgsign").unwrap_or_else(|_| false);
+	if gpg_enabled {
+		let gpg_sign_key = config.get_str("user.signingkey").unwrap_or_else(|_| "");
+		if gpg_sign_key.is_empty() {
+			grc_warn(
+				"It looks like you configured `gpgSign`, but grc did not find your `signingKey`.",
+			);
+			return None;
+		} else {
+			return Some(String::from(gpg_sign_key));
+		}
+	}
+	None
+}
+
+/// Check the workspace for file changes.
 pub fn is_all_workspace(statuses: &Statuses) -> bool {
 	let mut tip = false;
 	for state in statuses.iter() {