Merge branch 'gix-url-parse-rewrite'

Byron · Sep 26, 2023 · a12e4a8 · a12e4a8
2 parents 94fe675 + 4184a5e
commit a12e4a8
Show file tree

Hide file tree

Showing 24 changed files with 1,132 additions and 566 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+This release includes an overhaul of the url parsing implementation, allowing more urls to be parsed correctly and refining the error messages for
+invalid ones. Improvements include the added support for ssh aliases (`github:byron/gitoxide` has previously been parsed as local path), adjustments
+around the interpretation of colons in file names (previously we disallowed colons that were not followed up with a slash character) and some smaller
+changes that bring the interpretation of file urls more in line with Git's implementation.
+
+There are still many (edge) cases in Git's url parsing implementation which are not handled correctly by Gitoxide. If you notice any such deviation please
+open a new issue to help us making Gitoxide even more correct.
+
 ## 0.30.0 (2023-09-24)
 
 <csr-id-d3ac691446c9d029eb4f04d111887fa06720939d/>

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/gix-url/CHANGELOG.md b/gix-url/CHANGELOG.md
@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased
+
+This release contains a complete rewrite of the internal url parsing logic, the public interface stays mostly the same however. Gitoxide will now be
+more correct, interpreting more urls the same way Git does. Improvements include the added support for ssh aliases (`github:byron/gitoxide` has previously
+been parsed as local path), adjustments around the interpretation of colons in file names (previously we disallowed colons that were not followed up
+with a slash character) and some smaller changes that bring the interpretation of file urls more in line with Git's implementation. Additionally, the
+error types have been adjusted to print a more comprehensive message by default, making sure they stay helpful even when bubbled up through multiple abstraction
+layers.
+
+There are still many (edge) cases in Git's url parsing implementation which are not handled correctly by Gitoxide. If you notice any such deviation please
+open a new issue to help us making Gitoxide even more correct.
+
 ## 0.24.0 (2023-09-24)
 
 ### New Features

diff --git a/gix-url/Cargo.toml b/gix-url/Cargo.toml
@@ -12,10 +12,6 @@ rust-version = "1.65"
 [lib]
 doctest = false
 
-[[test]]
-name = "baseline"
-harness = false
-
 [features]
 ## Data structures implement `serde::Serialize` and `serde::Deserialize`.
 serde = ["dep:serde", "bstr/serde"]
@@ -33,8 +29,8 @@ home = "0.5.3"
 document-features = { version = "0.2.0", optional = true }
 
 [dev-dependencies]
+assert_matches = "1.5.0"
 gix-testtools = { path = "../tests/tools" }
-libtest-mimic = "0.6.1"
 
 [package.metadata.docs.rs]
 all-features = true

diff --git a/gix-url/fuzz/.gitignore b/gix-url/fuzz/.gitignore
@@ -0,0 +1,3 @@
+target
+corpus
+artifacts