fix: use url.Values for Qualifiers #56
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BREAKING CHANGE: This commit removes all the custom qualifier-logic that existed in order to keep the ordering of the qualifiers. The spec says: > sort this list of qualifier strings lexicographically However, it doesn't say anything about the ordering within the typed representation. Using `url.Values` through a type alias gives users an easier way to access specific values and removes code that we now don't need to maintain anymore. See package-url#53 for more information.
This commit switches to using `QueryEscape` for escaping all components. However, because `QueryEscape` escapes ` ` (space) to `+`, we actually change that to a `%20`, that is the percent-encoded equivalent. `QueryEscape` was built for HTTP Query parameters, and although there is [some discussion](https://stackoverflow.com/questions/2678551/when-should-space-be-encoded-to-plus-or-20) around it, escaping ` ` to a `+` is completely valid. Sadly, other languages like Javascript don't handle that properly, so if we simply used `QueryEscape`, the purl couldn't be parsed by other implementations. By using the universally supported `%20` instead, we restore compatibility.
|
Closing in favor of #57, sorry for the noise. |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BREAKING CHANGE: This commit removes all the custom qualifier-logic that existed in order to keep the ordering of the qualifiers. The spec says:
However, it doesn't say anything about the ordering within the typed representation.
Using
url.Valuesthrough a type alias gives users an easier way to access specific values and removes code that we now don't need to maintain anymore.See #53 for more information.
#53 briefly touches on the release process as well. Because this library is still in alpha-release (
v0.x.y), I don't think we need to bump the major version. Releasing av0.2.0would be fine according to the SemVer rules.I'm aware that this is quite a big change to the API, but I think better now than later :)