feat: Url::path_is_root() to determine if the path is /. (#450)

Byron · Byron · commit fbe75c945770 · 2022-09-02T11:33:54.000+08:00
This could also be considered an empty path depending on the context
which is what makes it useful.
diff --git a/git-url/src/impls.rs b/git-url/src/impls.rs
@@ -0,0 +1,68 @@
+use crate::{parse, Scheme, Url};
+use bstr::BStr;
+use std::convert::TryFrom;
+use std::path::PathBuf;
+
+impl Default for Url {
+    fn default() -> Self {
+        Url {
+            scheme: Scheme::Ssh,
+            user: None,
+            host: None,
+            port: None,
+            path: bstr::BString::default(),
+        }
+    }
+}
+
+impl TryFrom<&str> for Url {
+    type Error = parse::Error;
+
+    fn try_from(value: &str) -> Result<Self, Self::Error> {
+        Self::from_bytes(value.into())
+    }
+}
+
+impl TryFrom<String> for Url {
+    type Error = parse::Error;
+
+    fn try_from(value: String) -> Result<Self, Self::Error> {
+        Self::from_bytes(value.as_str().into())
+    }
+}
+
+impl TryFrom<PathBuf> for Url {
+    type Error = parse::Error;
+
+    fn try_from(value: PathBuf) -> Result<Self, Self::Error> {
+        use std::convert::TryInto;
+        git_path::into_bstr(value).try_into()
+    }
+}
+
+impl TryFrom<&std::ffi::OsStr> for Url {
+    type Error = parse::Error;
+
+    fn try_from(value: &std::ffi::OsStr) -> Result<Self, Self::Error> {
+        use std::convert::TryInto;
+        git_path::os_str_into_bstr(value)
+            .expect("no illformed UTF-8 on Windows")
+            .try_into()
+    }
+}
+
+impl TryFrom<&BStr> for Url {
+    type Error = parse::Error;
+
+    fn try_from(value: &BStr) -> Result<Self, Self::Error> {
+        Self::from_bytes(value)
+    }
+}
+
+impl<'a> TryFrom<std::borrow::Cow<'a, BStr>> for Url {
+    type Error = parse::Error;
+
+    fn try_from(value: std::borrow::Cow<'a, BStr>) -> Result<Self, Self::Error> {
+        Self::try_from(&*value)
+    }
+}
diff --git a/git-url/src/lib.rs b/git-url/src/lib.rs
@@ -8,9 +8,6 @@
 #![deny(rust_2018_idioms, missing_docs)]
 #![forbid(unsafe_code)]
 
-use std::convert::TryFrom;
-use std::path::PathBuf;
-
 use bstr::{BStr, BString};
 
 ///
@@ -43,22 +40,10 @@ pub struct Url {
     host: Option<String>,
     /// The port to use when connecting to a host. If `None`, standard ports depending on `scheme` will be used.
     pub port: Option<u16>,
-    /// The path portion of the URL, usually the location of the git repository, and at least `/`
+    /// The path portion of the URL, usually the location of the git repository.
     pub path: bstr::BString,
 }
 
-impl Default for Url {
-    fn default() -> Self {
-        Url {
-            scheme: Scheme::Ssh,
-            user: None,
-            host: None,
-            port: None,
-            path: bstr::BString::default(),
-        }
-    }
-}
-
 /// Instantiation
 impl Url {
     /// Create a new instance from the given parts, which will be validated by parsing them back.
@@ -103,6 +88,10 @@ impl Url {
     pub fn host(&self) -> Option<&str> {
         self.host.as_deref()
     }
+    /// Returns true if the path portion of the url is `/`.
+    pub fn path_is_root(&self) -> bool {
+        self.path == "/"
+    }
 }
 
 /// Serialization
@@ -152,54 +141,4 @@ impl Url {
     }
 }
 
-impl TryFrom<&str> for Url {
-    type Error = parse::Error;
-
-    fn try_from(value: &str) -> Result<Self, Self::Error> {
-        Self::from_bytes(value.into())
-    }
-}
-
-impl TryFrom<String> for Url {
-    type Error = parse::Error;
-
-    fn try_from(value: String) -> Result<Self, Self::Error> {
-        Self::from_bytes(value.as_str().into())
-    }
-}
-
-impl TryFrom<PathBuf> for Url {
-    type Error = parse::Error;
-
-    fn try_from(value: PathBuf) -> Result<Self, Self::Error> {
-        use std::convert::TryInto;
-        git_path::into_bstr(value).try_into()
-    }
-}
-
-impl TryFrom<&std::ffi::OsStr> for Url {
-    type Error = parse::Error;
-
-    fn try_from(value: &std::ffi::OsStr) -> Result<Self, Self::Error> {
-        use std::convert::TryInto;
-        git_path::os_str_into_bstr(value)
-            .expect("no illformed UTF-8 on Windows")
-            .try_into()
-    }
-}
-
-impl TryFrom<&BStr> for Url {
-    type Error = parse::Error;
-
-    fn try_from(value: &BStr) -> Result<Self, Self::Error> {
-        Self::from_bytes(value)
-    }
-}
-
-impl<'a> TryFrom<std::borrow::Cow<'a, BStr>> for Url {
-    type Error = parse::Error;
-
-    fn try_from(value: std::borrow::Cow<'a, BStr>) -> Result<Self, Self::Error> {
-        Self::try_from(&*value)
-    }
-}
+mod impls;
diff --git a/git-url/tests/parse/mod.rs b/git-url/tests/parse/mod.rs
@@ -1,7 +1,19 @@
+use bstr::ByteSlice;
 use git_url::Scheme;
 
 fn assert_url_and(url: &str, expected: git_url::Url) -> Result<git_url::Url, crate::Error> {
-    assert_eq!(git_url::parse(url.into())?, expected);
+    let actual = git_url::parse(url.into())?;
+    assert_eq!(actual, expected);
+    if actual.scheme.as_str().starts_with("http") {
+        assert!(
+            actual.path.starts_with_str("/"),
+            "paths are never empty and at least '/': {:?}",
+            actual.path
+        );
+        if actual.path.len() < 2 {
+            assert!(actual.path_is_root())
+        }
+    }
     Ok(expected)
 }
 
