Fix issue encoding hash character when used in a file name (#175)

Using `URI(protocol, null, host, port, path, query, ref)` encodes the path correctly except for the `#` character which is confusing. The fragment is sent in the `ref` argument, so it should know to escape it. 

Switch to the encoder provided in `com.google.common.net` and encode the substitutions manually.

Author: ben-gibson

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - Add images to README
 - Add Open Collective link to README
+- Fix issue where the '#' character in a file name is not correctly encoded.
 
 ## [4.0.1]
 - Fixed settings button opening the wrong menu.

src/main/kotlin/uk/co/ben_gibson/git/link/url/Encode.kt

@@ -0,0 +1,5 @@
+package uk.co.ben_gibson.git.link.url
+
+import com.google.common.net.UrlEscapers
+
+fun encode(value: String): String = UrlEscapers.urlPathSegmentEscaper().escape(value)

src/main/kotlin/uk/co/ben_gibson/git/link/url/UrlExtensions.kt

@@ -15,4 +15,22 @@ fun URL.toHttps(): URL {
     }
 
     return URL("https", host, port, normalised)
+}
+
+fun URL.trimPath(): URL {
+    if (!path.endsWith("/")) {
+        return this;
+    }
+
+    var normalisedFile = path.trimEnd('/')
+
+    query?.let {
+        normalisedFile = normalisedFile.plus("?${query}")
+    }
+
+    ref?.let {
+        normalisedFile = normalisedFile.plus("#${ref}")
+    }
+
+    return URL(protocol, host, port, normalisedFile)
 }

src/main/kotlin/uk/co/ben_gibson/git/link/url/factory/TemplatedUrlFactory.kt

@@ -5,11 +5,9 @@ import uk.co.ben_gibson.git.link.git.File
 import uk.co.ben_gibson.git.link.ui.LineSelection
 import uk.co.ben_gibson.git.link.url.*
 import uk.co.ben_gibson.git.link.url.template.UrlTemplates
-import java.net.URI
 import java.net.URL
 import java.util.regex.Pattern
 
-
 class TemplatedUrlFactory(private val templates: UrlTemplates) : UrlFactory {
     private val remotePathPattern = Pattern.compile("\\{remote:url:path:(\\d)}")
 
@@ -22,20 +20,9 @@ class TemplatedUrlFactory(private val templates: UrlTemplates) : UrlFactory {
 
         processTemplate = processBaseUrl(processTemplate, options.baseUrl)
         processTemplate = removeUnmatchedSubstitutions(processTemplate)
+        processTemplate = processTemplate.replace("(?<!:)/{2,}".toRegex(), "/")
 
-        val url = URL(processTemplate)
-
-        val uri = URI(
-            url.protocol,
-            null,
-            url.host,
-            url.port,
-            url.path.replace("/{2,}".toRegex(), "/").trimEnd('/'),
-            url.query,
-            url.ref
-        );
-
-        return URL(uri.toASCIIString())
+        return URL(processTemplate).trimPath()
     }
 
     private fun removeUnmatchedSubstitutions(template: String) = template.replace("\\{.+?}".toRegex(), "")
@@ -87,12 +74,12 @@ class TemplatedUrlFactory(private val templates: UrlTemplates) : UrlFactory {
     }
 
     private fun processBranch(template: String, branch: String) = template
-        .replace("{branch}", branch)
+        .replace("{branch}", encode(branch))
 
     private fun processFile(template: String, file: File) = template
         .replace("{object}", if (file.isDirectory) "tree" else "blob")
-        .replace("{file:name}", if (file.isRoot) "" else file.name)
-        .replace("{file:path}", file.path)
+        .replace("{file:name}", if (file.isRoot) "" else encode(file.name))
+        .replace("{file:path}", file.path.split("/").map { encode(it) }.joinToString("/"))
 
     private fun processCommit(template: String, commit: Commit) = template
         .replace("{commit}", commit.toString())

src/test/kotlin/uk/co/ben_gibson/git/link/GitLabTest.kt

@@ -40,6 +40,15 @@ class GitLabTest {
                 UrlOptionsFileAtCommit(REMOTE_BASE_URL, FILE, COMMIT, LineSelection(10, 20)),
                 "https://gitlab.com/my/repo/blob/b032a0707beac9a2f24b1b7d97ee4f7156de182c/src/Foo.java#L10-20"
             ),
+            Arguments.of(
+                UrlOptionsFileAtBranch(
+                    REMOTE_BASE_URL,
+                    File("Code.cs", false, "Assets/#/Sources", false),
+                    BRANCH,
+                    LINE_SELECTION
+                ),
+                "https://gitlab.com/my/repo/blob/master/Assets/%23/Sources/Code.cs#L10-20"
+            ),
             Arguments.of(
                 UrlOptionsFileAtCommit(
                     REMOTE_BASE_URL,