Skip to content

Update FormatUrl with support for fragment #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 28, 2018
Merged

Update FormatUrl with support for fragment #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions url/url.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ import (
"strings"
)

// Create a URL with the given base and path parts. This method will properly URI encode everything and handle leading
// and trailing slashes.
func FormatUrl(baseUrl string, pathParts []string, query url.Values) (string, error) {
// Create a URL with the given base, path parts, query string, and fragment. This method will properly URI encode
// everything and handle leading and trailing slashes.
func FormatUrl(baseUrl string, pathParts []string, query url.Values, fragment string) (string, error) {
parsedUrl, err := url.Parse(stripSlashes(baseUrl))
if err != nil {
return "", errors.WithStackTrace(err)
Expand All @@ -27,6 +27,7 @@ func FormatUrl(baseUrl string, pathParts []string, query url.Values) (string, er
}

parsedUrl.RawQuery = mergeQuery(parsedUrl.Query(), query).Encode()
parsedUrl.Fragment = fragment

return parsedUrl.String(), nil
}
Expand Down
25 changes: 14 additions & 11 deletions url/url_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,29 @@ func TestFormatUrl(t *testing.T) {
baseUrl string
parts []string
query url.Values
fragment string
expected string
}{
{"base-url-only", "http://www.example.com", parts(), query0(), "http://www.example.com"},
{"base-url-with-one-part", "http://www.example.com", parts("foo"), query0(), "http://www.example.com/foo"},
{"base-url-with-multiple-parts", "http://www.example.com", parts("foo", "bar", "baz"), query0(), "http://www.example.com/foo/bar/baz"},
{"base-url-with-trailing-slash-with-multiple-parts", "http://www.example.com/", parts("foo", "bar", "baz"), query0(), "http://www.example.com/foo/bar/baz"},
{"base-url-with-trailing-slash-with-multiple-parts-with-slashes", "http://www.example.com/", parts("/foo", "bar/", "//baz///"), query0(), "http://www.example.com/foo/bar/baz"},
{"base-url-with-path-with-multiple-parts", "http://www.example.com/a/b/c", parts("foo", "bar", "baz"), query0(), "http://www.example.com/a/b/c/foo/bar/baz"},
{"base-url-with-query-string-with-multiple-parts", "http://www.example.com/?a=b&c=d", parts("foo", "bar", "baz"), query0(), "http://www.example.com/foo/bar/baz?a=b&c=d"},
{"base-url-with-multiple-parts-encoding", "http://www.example.com", parts("foo a b c", "?#$@!"), query0(), "http://www.example.com/foo%20a%20b%20c/%3F%23$@%21"},
{"base-url-with-one-query-param", "http://www.example.com", parts(), query1("foo", "bar"), "http://www.example.com?foo=bar"},
{"base-url-with-one-query-param-encoding", "http://www.example.com", parts(), query1("foo a b c", "?#$@!"), "http://www.example.com?foo+a+b+c=%3F%23%24%40%21"},
{"base-url-only", "http://www.example.com", parts(), query0(), "", "http://www.example.com"},
{"base-url-with-one-part", "http://www.example.com", parts("foo"), query0(), "", "http://www.example.com/foo"},
{"base-url-with-multiple-parts", "http://www.example.com", parts("foo", "bar", "baz"), query0(), "", "http://www.example.com/foo/bar/baz"},
{"base-url-with-trailing-slash-with-multiple-parts", "http://www.example.com/", parts("foo", "bar", "baz"), query0(), "", "http://www.example.com/foo/bar/baz"},
{"base-url-with-trailing-slash-with-multiple-parts-with-slashes", "http://www.example.com/", parts("/foo", "bar/", "//baz///"), query0(), "", "http://www.example.com/foo/bar/baz"},
{"base-url-with-path-with-multiple-parts", "http://www.example.com/a/b/c", parts("foo", "bar", "baz"), query0(), "", "http://www.example.com/a/b/c/foo/bar/baz"},
{"base-url-with-query-string-with-multiple-parts", "http://www.example.com/?a=b&c=d", parts("foo", "bar", "baz"), query0(), "", "http://www.example.com/foo/bar/baz?a=b&c=d"},
{"base-url-with-multiple-parts-encoding", "http://www.example.com", parts("foo a b c", "?#$@!"), query0(), "", "http://www.example.com/foo%20a%20b%20c/%3F%23$@%21"},
{"base-url-with-one-query-param", "http://www.example.com", parts(), query1("foo", "bar"), "", "http://www.example.com?foo=bar"},
{"base-url-with-one-query-param-encoding", "http://www.example.com", parts(), query1("foo a b c", "?#$@!"), "", "http://www.example.com?foo+a+b+c=%3F%23%24%40%21"},
{"base-url-with-fragment", "http://www.example.com", parts(), query0(), "foo", "http://www.example.com#foo"},
{"base-url-with-path-query-fragment", "http://www.example.com", parts("foo", "bar"), query1("baz", "blah"), "fragment", "http://www.example.com/foo/bar?baz=blah#fragment"},
}

for _, testCase := range testCases {
// Store a copy in scope so all the test cases don't end up running the last item in the loop
testCase := testCase

t.Run(testCase.name, func(t *testing.T) {
actual, err := FormatUrl(testCase.baseUrl, testCase.parts, testCase.query)
actual, err := FormatUrl(testCase.baseUrl, testCase.parts, testCase.query, testCase.fragment)
assert.NoError(t, err)
assert.Equal(t, testCase.expected, actual)
})
Expand Down