add cli option --force-url-http for URL display (#1314)

* add cli option --force-url-http for URL display

* * rename force_url_http to http_url
* rename create_http_url to create_http_url_from_ssh
* add test for create_http_url_from_ssh

* rust fmt

---------

Co-authored-by: o2sh <ossama-hjaji@live.fr>

Author: 0spotter0

src/cli.rs

@@ -84,6 +84,9 @@ pub struct InfoCliOptions {
     /// Show the email address of each author
     #[arg(long, short = 'E')]
     pub email: bool,
+    /// Display repository URL as HTTP
+    #[arg(long)]
+    pub http_url: bool,
     /// Count hidden files and directories
     #[arg(long)]
     pub include_hidden: bool,
@@ -243,6 +246,7 @@ impl Default for InfoCliOptions {
             no_bots: Option::default(),
             no_merges: Default::default(),
             email: Default::default(),
+            http_url: Default::default(),
             include_hidden: Default::default(),
             r#type: vec![LanguageType::Programming, LanguageType::Markup],
             disabled_fields: Vec::default(),

src/info/mod.rs

@@ -143,7 +143,7 @@ pub fn build_info(cli_options: &CliOptions) -> Result<Info> {
         .ok()
         .context("BUG: panic in language statistics thread")??;
     let manifest = get_manifest(&repo_path)?;
-    let repo_url = get_repo_url(&repo);
+    let repo_url = get_repo_url(&repo, cli_options.info.http_url);
 
     let git_metrics = traverse_commit_graph(
         &repo,

src/info/url.rs

@@ -16,7 +16,7 @@ impl UrlInfo {
     }
 }
 
-pub fn get_repo_url(repo: &Repository) -> String {
+pub fn get_repo_url(repo: &Repository, http_url: bool) -> String {
     let config = repo.config_snapshot();
     let remotes = match config.plumbing().sections_by_name("remote") {
         Some(sections) => sections,
@@ -36,17 +36,32 @@ pub fn get_repo_url(repo: &Repository) -> String {
     }
 
     match remote_url {
-        Some(url) => remove_token_from_url(&url),
+        Some(url) => format_url(&url, http_url),
         None => String::default(),
     }
 }
 
+fn format_url(url: &str, http_url: bool) -> String {
+    let removed_token = remove_token_from_url(&url);
+    if !http_url || removed_token.starts_with("http") {
+        removed_token
+    } else {
+        create_http_url_from_ssh(url)
+    }
+}
+
 fn remove_token_from_url(url: &str) -> String {
     let pattern = Regex::new(r"(https?://)([^@]+@)").unwrap();
     let replaced_url = pattern.replace(url, "$1").to_string();
     replaced_url
 }
 
+fn create_http_url_from_ssh(url: &str) -> String {
+    let pattern = Regex::new(r"([^@]+)@([^:]+):(.*)").unwrap();
+    let replaced_url = pattern.replace(url, "https://${2}/${3}").to_string();
+    replaced_url
+}
+
 #[typetag::serialize]
 impl InfoField for UrlInfo {
     fn value(&self) -> String {
@@ -74,6 +89,46 @@ mod test {
         );
     }
 
+    #[test]
+    fn test_format_url_http() {
+        let remote_url_github =
+            "https://1234567890abcdefghijklmnopqrstuvwxyz@github.com/0spotter0/onefetch.git";
+        let res_url_github = format_url(remote_url_github, true);
+        assert_eq!("https://github.com/0spotter0/onefetch.git", res_url_github);
+
+        let remote_url_gitlab =
+            "https://john:abc123personaltoken@gitlab.com/0spotter0/onefetch.git";
+        let res_url_gitlab = format_url(remote_url_gitlab, true);
+        assert_eq!("https://gitlab.com/0spotter0/onefetch.git", res_url_gitlab);
+    }
+
+    #[test]
+    fn test_format_url_ssh() {
+        let remote_url_github = "git@github.com:0spotter0/onefetch.git";
+        let res_url_github_force_http_true = format_url(remote_url_github, true);
+        let res_url_github_force_http_false = format_url(remote_url_github, false);
+        assert_eq!(
+            "https://github.com/0spotter0/onefetch.git",
+            res_url_github_force_http_true
+        );
+        assert_eq!(
+            "git@github.com:0spotter0/onefetch.git",
+            res_url_github_force_http_false
+        );
+
+        let remote_url_gitlab = "git@gitlab.com:0spotter0/onefetch.git";
+        let res_url_gitlab_force_http_true = format_url(remote_url_gitlab, true);
+        let res_url_gitlab_force_http_false = format_url(remote_url_gitlab, false);
+        assert_eq!(
+            "https://gitlab.com/0spotter0/onefetch.git",
+            res_url_gitlab_force_http_true
+        );
+        assert_eq!(
+            "git@gitlab.com:0spotter0/onefetch.git",
+            res_url_gitlab_force_http_false
+        );
+    }
+
     #[test]
     fn test_token_removal_github() {
         let remote_url =
@@ -88,4 +143,15 @@ mod test {
         let res_url = remove_token_from_url(remote_url);
         assert_eq!("https://gitlab.com/jim4067/myproject.git", res_url);
     }
+
+    #[test]
+    fn test_create_http_url_from_ssh() {
+        let remote_url_github = "git@github.com:0spotter0/onefetch.git";
+        let res_url_github = create_http_url_from_ssh(remote_url_github);
+        assert_eq!("https://github.com/0spotter0/onefetch.git", res_url_github);
+
+        let remote_url_gitlab = "git@gitlab.com:0spotter0/onefetch.git";
+        let res_url_gitlab = create_http_url_from_ssh(remote_url_gitlab);
+        assert_eq!("https://gitlab.com/0spotter0/onefetch.git", res_url_gitlab);
+    }
 }