Add interchange support with url::Url

Author: tjtelan

src/lib.rs

@@ -15,9 +15,9 @@
 //! - 🏗️ Host provider info extraction
 //!   - Easy to implement trait [`GitProvider`](crate::types::provider::GitProvider) for custom provider parsing
 //!   - Built-in support for multiple Git hosting providers
-//!       * [Generic](crate::types::provider::GenericProvider) (`git@host:owner/repo.git` style urls)
-//!       * [GitLab](crate::types::provider::GitLabProvider)
-//!       * [Azure DevOps](crate::types::provider::AzureDevOpsProvider)
+//!       * [Generic](crate::types::provider::generic::GenericProvider) (`git@host:owner/repo.git` style urls)
+//!       * [GitLab](crate::types::provider::gitlab::GitLabProvider)
+//!       * [Azure DevOps](crate::types::provider::azure_devops::AzureDevOpsProvider)
 //!
 //! ## Quick Example
 //!
@@ -90,7 +90,12 @@
 //! #### `url`
 //! (**enabled by default**)
 //!
-//! Uses [url](https://docs.rs/url/latest/) during parsing for full url validation
+//! `GitUrl` parsing finishes with [url](https://docs.rs/url/latest/) during parsing for full url validation
+//!
+//! [`GitUrl::parse_to_url`] will normalize an ssh-based url and return [`url::Url`](https://docs.rs/url/latest/url/struct.Url.html)
+//!
+//! You can use `url::Url` with the built-in [`GitProvider`](crate::types::provider::GitProvider) host parsers. See the `url_interop` tests for examples
+//!
 //!
 
 pub mod types;

src/types/mod.rs

@@ -67,15 +67,6 @@ pub struct GitUrl {
     hint: GitUrlParseHint,
 }
 
-/// Build the printable GitUrl from its components
-impl fmt::Display for GitUrl {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        let git_url_str = self.display();
-
-        write!(f, "{git_url_str}",)
-    }
-}
-
 impl GitUrl {
     /// scheme name (i.e. `scheme://`)
     pub fn scheme(&self) -> Option<&str> {
@@ -130,7 +121,7 @@ impl GitUrl {
     }
 
     /// This method rebuilds the printable GitUrl from its components.
-    /// `url_compat` results in output that can be parsed by the `url` crate
+    /// `url_compat` results in output that can be parsed by the [`url`](https://docs.rs/url/latest/url/) crate
     fn build_string(&self, url_compat: bool) -> String {
         let scheme = if self.print_scheme() || url_compat {
             if let Some(scheme) = self.scheme() {
@@ -176,45 +167,7 @@ impl GitUrl {
         let git_url_str = format!("{scheme}{auth_info}{host}{port}{path}");
         git_url_str
     }
-}
-
-#[cfg(feature = "url")]
-impl TryFrom<&GitUrl> for Url {
-    type Error = url::ParseError;
-    fn try_from(value: &GitUrl) -> Result<Self, Self::Error> {
-        // Since we don't fully implement any spec, we'll rely on the url crate
-        Url::parse(&value.url_compat_display())
-    }
-}
-
-#[cfg(feature = "url")]
-impl TryFrom<GitUrl> for Url {
-    type Error = url::ParseError;
-    fn try_from(value: GitUrl) -> Result<Self, Self::Error> {
-        // Since we don't fully implement any spec, we'll rely on the url crate
-        Url::parse(&value.url_compat_display())
-    }
-}
-
-#[cfg(feature = "url")]
-impl TryFrom<&Url> for GitUrl {
-    type Error = GitUrlParseError;
-    fn try_from(value: &Url) -> Result<Self, Self::Error> {
-        // Since we don't fully implement any spec, we'll rely on the url crate
-        GitUrl::parse(value.as_str())
-    }
-}
-
-#[cfg(feature = "url")]
-impl TryFrom<Url> for GitUrl {
-    type Error = GitUrlParseError;
-    fn try_from(value: Url) -> Result<Self, Self::Error> {
-        // Since we don't fully implement any spec, we'll rely on the url crate
-        GitUrl::parse(value.as_str())
-    }
-}
 
-impl GitUrl {
     /// Returns `GitUrl` after removing all user info values
     pub fn trim_auth(&self) -> GitUrl {
         let mut new_giturl = self.clone();
@@ -244,7 +197,7 @@ impl GitUrl {
         Ok(git_url)
     }
 
-    /// Internal parse to `GitUrl` without further validation
+    /// Internal parse to `GitUrl` without validation steps
     fn parse_to_git_url(input: &str) -> Result<Self, GitUrlParseError> {
         let mut git_url_result = GitUrl::default();
         // Error if there are null bytes within the url
@@ -414,3 +367,46 @@ impl GitUrl {
         Ok(())
     }
 }
+
+/// Build the printable GitUrl from its components
+impl fmt::Display for GitUrl {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        let git_url_str = self.display();
+
+        write!(f, "{git_url_str}",)
+    }
+}
+
+#[cfg(feature = "url")]
+impl TryFrom<&GitUrl> for Url {
+    type Error = url::ParseError;
+    fn try_from(value: &GitUrl) -> Result<Self, Self::Error> {
+        // Since we don't fully implement any spec, we'll rely on the url crate
+        Url::parse(&value.url_compat_display())
+    }
+}
+
+#[cfg(feature = "url")]
+impl TryFrom<GitUrl> for Url {
+    type Error = url::ParseError;
+    fn try_from(value: GitUrl) -> Result<Self, Self::Error> {
+        // Since we don't fully implement any spec, we'll rely on the url crate
+        Url::parse(&value.url_compat_display())
+    }
+}
+
+#[cfg(feature = "url")]
+impl TryFrom<&Url> for GitUrl {
+    type Error = GitUrlParseError;
+    fn try_from(value: &Url) -> Result<Self, Self::Error> {
+        GitUrl::parse(value.as_str())
+    }
+}
+
+#[cfg(feature = "url")]
+impl TryFrom<Url> for GitUrl {
+    type Error = GitUrlParseError;
+    fn try_from(value: Url) -> Result<Self, Self::Error> {
+        GitUrl::parse(value.as_str())
+    }
+}

src/types/provider/azure_devops.rs

@@ -4,6 +4,7 @@ use crate::{GitUrl, GitUrlParseError};
 
 use getset::Getters;
 use nom::Parser;
+use nom::branch::alt;
 use nom::bytes::complete::{is_not, tag, take_until};
 use nom::combinator::opt;
 use nom::sequence::{preceded, separated_pair, terminated};
@@ -82,8 +83,10 @@ impl AzureDevOpsProvider {
 
     /// Parse the path of an ssh url for Azure Devops patterns
     fn parse_ssh_path(input: &str) -> Result<(&str, AzureDevOpsProvider), GitUrlParseError> {
-        // Handle optional leading v3/ or other prefix
-        let (input, _) = opt(take_until("/")).parse(input)?;
+        // Handle optional leading /v3/ or v3/ prefix
+        let (input, _) =
+            opt(alt((preceded(tag("/"), tag("v3/")), take_until("/")))).parse(input)?;
+
         let (input, _) = opt(tag("/")).parse(input)?;
 
         // Parse org/project/repo

src/types/provider/mod.rs

@@ -9,15 +9,18 @@
 //! - [GitLab](crate::types::provider::GitLabProvider)
 //! - Custom (via [`GitProvider`] trait)
 
-mod azure_devops;
-mod generic;
-mod gitlab;
+/// Azure DevOps git host
+pub mod azure_devops;
+/// Generic git host
+pub mod generic;
+/// GitLab git host
+pub mod gitlab;
 
 pub use azure_devops::AzureDevOpsProvider;
 pub use generic::GenericProvider;
 pub use gitlab::GitLabProvider;
 
-/// Secondary parser called by [`GitUrl::provider_info()`] to extract Git host provider info from url
+/// Secondary parser called by [`crate::GitUrl::provider_info()`] to extract Git host provider info from url
 ///
 /// ```
 /// // Custom trait example
@@ -43,6 +46,8 @@ pub use gitlab::GitLabProvider;
 ///  let expected = MyCustomProvider;
 ///  assert_eq!(provider_info, expected)
 /// ```
+///
+/// With `feature = url`, there is support for parsing Git host provider info from [`url::Url`](https://docs.rs/url/latest/url/struct.Url.html)
 pub trait GitProvider<T, E>: Clone + std::fmt::Debug {
     /// Trait method called by `GitUrl::provider_info()`
     ///