Updating GitUrl to fix results for Scheme::File

Adding CHANGELOG.md
Lots of new tests
Bumping to 0.3.0
Resolves #5

Author: tjtelan

CHANGELOG.md

@@ -0,0 +1,25 @@
+# [0.3.0](https://github.com/tjtelan/git-url-parse-rs/compare/v0.2.0...v0.3.0)
+- Add `CHANGELOG.md`
+- Add new schemes `Ftp` and `Ftps`
+- Update `GitUrl` format for `Scheme::File` for `GitUrl.host` and `GitUrl.path`
+- Add more tests
+
+# [0.2.0](https://github.com/tjtelan/git-url-parse-rs/compare/v0.1.1...v0.2.0)
+- Updating `GitUrl` format 
+- Add `trim_auth()`
+- Add `impl Display` for `GitUrl`
+- Rename enum `Protocol` to `Scheme`
+
+# [0.1.1](https://github.com/tjtelan/git-url-parse-rs/compare/v0.1.0...v0.1.1)
+- Add CI via Github Actions
+- Add badges for docs, crates, build to `README`
+- Update `README.md`
+- Making enums and Structs `Clone`
+
+# [0.1.0](https://github.com/tjtelan/git-url-parse-rs/compare/v0.0.1...v0.1.0)
+- Add support for Azure DevOps
+- Add `README.md`
+
+# [0.0.1](https://github.com/tjtelan/git-url-parse-rs/commit/9255fc3f0516e6cfa60c651dd0436fa702b701b1)
+- Pre-process urls before feeding to `url` crate
+- Specialized normalization rules between ssh or file path urls

Cargo.toml

@@ -9,18 +9,18 @@ license = "MIT"
 name = "git-url-parse"
 readme = "README.md"
 repository = "https://github.com/tjtelan/git-url-parse-rs"
-version = "0.2.0"
+version = "0.3.0"
 
 [badges.maintenance]
 status = "actively-developed"
 
 [dependencies]
-log = "0.4"
-url = "2.1"
-strum = "0.18"
-strum_macros = "0.18"
-anyhow = "1.0"
-regex = "1.3"
+log = "~0.4"
+url = "~2.1"
+strum = "~0.18"
+strum_macros = "~0.18"
+anyhow = "~1.0"
+regex = "~1.3"
 
 [dev-dependencies]
-env_logger = "0.7"
+env_logger = "~0.7"

src/lib.rs

@@ -248,16 +248,34 @@ impl GitUrl {
             }
         };
 
-        Ok(GitUrl {
-            host: match normalized.host_str() {
+        let final_scheme = Scheme::from_str(normalized.scheme()).expect("Scheme unsupported");
+
+        let final_host = match final_scheme {
+            Scheme::File => None,
+            _ => match normalized.host_str() {
                 Some(h) => Some(h.to_string()),
                 None => None,
             },
+        };
+
+        let final_path = match final_scheme {
+            Scheme::File => {
+                if let Some(host) = normalized.host_str() {
+                    format!("{}{}", host, urlpath)
+                } else {
+                    urlpath
+                }
+            },
+            _ => urlpath,
+        };
+
+        Ok(GitUrl {
+            host: final_host,
             name: name,
             owner: owner,
             organization: organization,
             fullname: fullname,
-            scheme: Scheme::from_str(normalized.scheme()).expect("Scheme unsupported"),
+            scheme: final_scheme,
             user: match normalized.username().to_string().len() {
                 0 => None,
                 _ => Some(normalized.username().to_string()),
@@ -267,7 +285,7 @@ impl GitUrl {
                 None => None,
             },
             port: normalized.port(),
-            path: urlpath,
+            path: final_path,
             git_suffix: *git_suffix_check,
             scheme_prefix: url.contains("://"),
             ..Default::default()

tests/normalize.rs

@@ -59,21 +59,74 @@ fn ssh_no_scheme_no_user() {
 }
 
 #[test]
-fn file_scheme() {
+fn unix_file_scheme_abs_path() {
     let test_url = "file:///user/project-name.git";
     let normalized = normalize_url(test_url).expect("Normalizing url failed");
 
     assert_eq!(normalized.as_str(), "file:///user/project-name.git");
 }
 
 #[test]
-fn file_no_scheme() {
+fn unix_file_no_scheme_abs_path() {
     let test_url = "/user/project-name.git";
     let normalized = normalize_url(test_url).expect("Normalizing url failed");
 
     assert_eq!(normalized.as_str(), "file:///user/project-name.git");
 }
 
+#[test]
+fn unix_file_scheme_rel_path() {
+    let test_url = "file://../user/project-name.git";
+    let normalized = normalize_url(test_url).expect("Normalizing url failed");
+
+    assert_eq!(normalized.as_str(), "file://../user/project-name.git");
+}
+
+#[test]
+fn unix_file_no_scheme_rel_path() {
+    let test_url = "../user/project-name.git";
+    let normalized = normalize_url(test_url).expect("Normalizing url failed");
+
+    assert_eq!(normalized.as_str(), "file://../user/project-name.git");
+}
+
+#[should_panic(expected = "assertion failed: `(left == right)")]
+#[test]
+fn win_file_scheme_abs_path() {
+    let test_url = "file://c:\\user\\project-name.git";
+    let normalized = normalize_url(test_url).expect("Normalizing url failed");
+
+    // I actually don't know how this should be normalized.
+    assert_eq!(normalized.as_str(), "file://c:\\user\\project-name.git");
+}
+
+#[should_panic(expected = "assertion failed: `(left == right)")]
+#[test]
+fn win_file_no_scheme_abs_path() {
+    let test_url = "c:\\user\\project-name.git";
+    let normalized = normalize_url(test_url).expect("Normalizing url failed");
+
+    // I actually don't know how this should be normalized.
+    assert_eq!(normalized.as_str(), "file://c:\\user\\project-name.git");
+}
+
+#[test]
+fn win_file_scheme_rel_path() {
+    let test_url = "file://..\\user\\project-name.git";
+    let normalized = normalize_url(test_url).expect("Normalizing url failed");
+
+    // I actually don't know how this should be normalized.
+    assert_eq!(normalized.as_str(), "file://../user/project-name.git");
+}
+
+#[test]
+fn win_file_no_scheme_rel_path() {
+    let test_url = "..\\user\\project-name.git";
+    let normalized = normalize_url(test_url).expect("Normalizing url failed");
+
+    // I actually don't know how this should be normalized.
+    assert_eq!(normalized.as_str(), "file://../user/project-name.git");
+}
 #[test]
 fn multi_git_ssh() {
     let test_url = "git+ssh://host.tld/user/project-name.git";

tests/parse.rs

@@ -247,41 +247,88 @@ fn relative_unix_path() {
     let test_url = "../project-name.git";
     let parsed = GitUrl::parse(test_url).expect("URL parse failed");
     let expected = GitUrl {
-        host: Some("host.tld".to_string()),
+        host: None,
         name: "project-name".to_string(),
-        owner: Some("user".to_string()),
+        owner: None,
         organization: None,
-        fullname: "../project-name.git".to_string(),
-        scheme: Scheme::Ftps,
-        user: Some("git".to_string()),
+        fullname: "project-name".to_string(),
+        scheme: Scheme::File,
+        user: None,
         token: None,
         port: None,
         path: "../project-name.git".to_string(),
         git_suffix: true,
-        scheme_prefix: true,
+        scheme_prefix: false,
+    };
+
+    assert_eq!(parsed, expected);
+}
+
+#[test]
+fn absolute_unix_path() {
+    let test_url = "/path/to/project-name.git";
+    let parsed = GitUrl::parse(test_url).expect("URL parse failed");
+    let expected = GitUrl {
+        host: None,
+        name: "project-name".to_string(),
+        owner: None,
+        organization: None,
+        fullname: "project-name".to_string(),
+        scheme: Scheme::File,
+        user: None,
+        token: None,
+        port: None,
+        path: "/path/to/project-name.git".to_string(),
+        git_suffix: true,
+        scheme_prefix: false,
     };
 
     assert_eq!(parsed, expected);
 }
 
+// Issue #6 - Relative Windows paths will parse into Unix paths
 #[test]
 fn relative_windows_path() {
     let test_url = "..\\project-name.git";
     let parsed = GitUrl::parse(test_url).expect("URL parse failed");
     let expected = GitUrl {
-        host: Some("host.tld".to_string()),
+        host: None,
         name: "project-name".to_string(),
-        owner: Some("user".to_string()),
+        owner: None,
         organization: None,
-        fullname: "..\\project-name.git".to_string(),
-        scheme: Scheme::Ftps,
-        user: Some("git".to_string()),
+        fullname: "project-name".to_string(),
+        scheme: Scheme::File,
+        user: None,
+        token: None,
+        port: None,
+        path: "../project-name.git".to_string(),
+        git_suffix: true,
+        scheme_prefix: false,
+    };
+
+    assert_eq!(parsed, expected);
+}
+
+// Issue #7 - Absolute Windows paths will not parse at all
+#[should_panic(expected = "index out of bounds: the len is 1 but the index is 1")]
+#[test]
+fn absolute_windows_path() {
+    let test_url = "c:\\project-name.git";
+    let parsed = GitUrl::parse(test_url).expect("URL parse failed");
+    let expected = GitUrl {
+        host: None,
+        name: "project-name".to_string(),
+        owner: None,
+        organization: None,
+        fullname: "project-name".to_string(),
+        scheme: Scheme::File,
+        user: None,
         token: None,
         port: None,
-        path: "..\\project-name.git".to_string(),
+        path: "c:\\project-name.git".to_string(),
         git_suffix: true,
         scheme_prefix: true,
     };
 
     assert_eq!(parsed, expected);
-}
+}