Fix branch substitution in commit templates (#337)

ben-gibson · Sep 2, 2024 · e1d25dc · e1d25dc
1 parent 3f94bf7
commit e1d25dc
Show file tree

Hide file tree

Showing 14 changed files with 77 additions and 49 deletions.
diff --git a/src/main/kotlin/uk/co/ben_gibson/git/link/pipeline/Pipeline.kt b/src/main/kotlin/uk/co/ben_gibson/git/link/pipeline/Pipeline.kt
@@ -10,15 +10,15 @@ import uk.co.ben_gibson.url.URL
 import java.util.*
 import kotlin.collections.Set
 
-@Service
+@Service(Service.Level.PROJECT)
 class Pipeline(private val project: Project) {
     private val middlewares: Set<Middleware> = setOf(
-        project.service<GenerateUrl>(),
-        project.service<Timer>(),
-        project.service<RecordHit>(),
-        project.service<ForceHttps>(),
-        project.service<SendSupportNotification>(),
-        project.service<ResolveContext>(),
+        service<GenerateUrl>(),
+        service<Timer>(),
+        service<RecordHit>(),
+        service<ForceHttps>(),
+        service<SendSupportNotification>(),
+        service<ResolveContext>(),
     )
 
     fun accept(context: Context) : URL? {

diff --git a/src/main/kotlin/uk/co/ben_gibson/git/link/pipeline/middleware/GenerateUrl.kt b/src/main/kotlin/uk/co/ben_gibson/git/link/pipeline/middleware/GenerateUrl.kt
@@ -37,13 +37,26 @@ class GenerateUrl : Middleware {
         val repositoryFile = File.forRepository(context.file, repository)
 
         return when (context) {
-            is ContextFileAtCommit -> UrlOptions.UrlOptionsFileAtCommit(repositoryFile, context.commit, context.lineSelection)
-            is ContextCommit -> UrlOptions.UrlOptionsCommit(context.commit)
+            is ContextFileAtCommit -> UrlOptions.UrlOptionsFileAtCommit(
+                repositoryFile,
+                repository.currentBranch?.name ?: settings.fallbackBranch,
+                context.commit,
+                context.lineSelection
+            )
+            is ContextCommit -> UrlOptions.UrlOptionsCommit(
+                context.commit,
+                repository.currentBranch?.name ?: settings.fallbackBranch
+            )
             is ContextCurrentFile -> {
                 val commit = resolveCommit(repository, remote, settings, pullRequestWorkflowSupported)
 
                 if (commit != null) {
-                    UrlOptions.UrlOptionsFileAtCommit(repositoryFile, commit, context.lineSelection)
+                    UrlOptions.UrlOptionsFileAtCommit(
+                        repositoryFile,
+                        repository.currentBranch?.name ?: settings.fallbackBranch,
+                        commit,
+                        context.lineSelection
+                    )
                 } else {
                     UrlOptions.UrlOptionsFileAtBranch(
                         repositoryFile,

diff --git a/src/main/kotlin/uk/co/ben_gibson/git/link/ui/validation/ValidationExtensions.kt b/src/main/kotlin/uk/co/ben_gibson/git/link/ui/validation/ValidationExtensions.kt
@@ -63,6 +63,7 @@ fun ValidationInfoBuilder.fileAtCommitTemplate(value: String): ValidationInfo? {
 
     val options = UrlOptions.UrlOptionsFileAtCommit(
         File("foo.kt", false, "src/main", false),
+        "main",
         Commit("734232a3c18f0625843bd161c3f5da272b9d53c1"),
         LineSelection(10, 20)
     )
@@ -89,7 +90,7 @@ fun ValidationInfoBuilder.commitTemplate(value: String): ValidationInfo? {
         return null
     }
 
-    val options = UrlOptions.UrlOptionsCommit(Commit("734232a3c18f0625843bd161c3f5da272b9d53c1"))
+    val options = UrlOptions.UrlOptionsCommit(Commit("734232a3c18f0625843bd161c3f5da272b9d53c1"), "main")
 
     return urlTemplate(options, commit = value)
 }

diff --git a/src/main/kotlin/uk/co/ben_gibson/git/link/url/UrlOptions.kt b/src/main/kotlin/uk/co/ben_gibson/git/link/url/UrlOptions.kt
@@ -5,7 +5,7 @@ import uk.co.ben_gibson.git.link.git.File
 import uk.co.ben_gibson.git.link.ui.LineSelection
 
 sealed interface UrlOptions {
-    class UrlOptionsCommit(val commit: Commit) : UrlOptions
-    class UrlOptionsFileAtCommit(val file: File, val commit: Commit, val lineSelection: LineSelection? = null) : UrlOptions
+    class UrlOptionsCommit(val commit: Commit, val currentBranch: String,) : UrlOptions
+    class UrlOptionsFileAtCommit(val file: File, val currentBranch: String, val commit: Commit, val lineSelection: LineSelection? = null) : UrlOptions
     class UrlOptionsFileAtBranch(val file: File, val branch: String, val lineSelection: LineSelection? = null) : UrlOptions
 }
diff --git a/src/main/kotlin/uk/co/ben_gibson/git/link/url/factory/TemplatedUrlFactory.kt b/src/main/kotlin/uk/co/ben_gibson/git/link/url/factory/TemplatedUrlFactory.kt
@@ -45,6 +45,7 @@ open class TemplatedUrlFactory(private val templates: UrlTemplates) : UrlFactory
 
         template = processFile(template, options.file)
         template = processCommit(template, options.commit)
+        template = processBranch(template, options.currentBranch)
         template = processLineSelection(template, options.lineSelection, options.file)
 
         return template
@@ -54,6 +55,7 @@ open class TemplatedUrlFactory(private val templates: UrlTemplates) : UrlFactory
         var template = templates.commit
 
         template = processCommit(template, options.commit)
+        template = processBranch(template, options.currentBranch)
 
         return template
     }

diff --git a/src/test/kotlin/uk/co/ben_gibson/git/link/url/AzureTest.kt b/src/test/kotlin/uk/co/ben_gibson/git/link/url/AzureTest.kt
@@ -37,13 +37,14 @@ class AzureTest {
             ),
             Arguments.of(
                 REMOTE_BASE_URL_WITH_GIT,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT, LINE_SELECTION),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT, LINE_SELECTION),
                 "https://dev.azure.com/ben-gibson/_git/test.git?version=GCb032a0707beac9a2f24b1b7d97ee4f7156de182c&path=src%2FFoo.java&line=10&lineEnd=21&lineStartColumn=1&lineEndColumn=1"
             ),
             Arguments.of(
                 REMOTE_BASE_URL_WITH_GIT,
                 UrlOptions.UrlOptionsFileAtCommit(
                     File("resources", true, "src/foo", false),
+                    "main",
                     COMMIT
                 ),
                 "https://dev.azure.com/ben-gibson/_git/test.git?version=GCb032a0707beac9a2f24b1b7d97ee4f7156de182c&path=src%2Ffoo%2Fresources"
@@ -52,37 +53,38 @@ class AzureTest {
                 REMOTE_BASE_URL_WITH_GIT,
                 UrlOptions.UrlOptionsFileAtCommit(
                     File("my-project", true, "", true),
+                    "main",
                     COMMIT
                 ),
                 "https://dev.azure.com/ben-gibson/_git/test.git?version=GCb032a0707beac9a2f24b1b7d97ee4f7156de182c&path=%2F"),
             Arguments.of(
                 REMOTE_BASE_URL_WITH_GIT,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT),
                 "https://dev.azure.com/ben-gibson/_git/test.git?version=GCb032a0707beac9a2f24b1b7d97ee4f7156de182c&path=src%2FFoo.java"
             ),
             Arguments.of(
                 REMOTE_BASE_URL_WITH_GIT,
-                UrlOptions.UrlOptionsCommit(COMMIT),
+                UrlOptions.UrlOptionsCommit(COMMIT, "main"),
                 "https://dev.azure.com/ben-gibson/_git/test.git/commit/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             ),
             Arguments.of(
                 REMOTE_BASE_URL_WITHOUT_GIT,
-                UrlOptions.UrlOptionsCommit(COMMIT),
+                UrlOptions.UrlOptionsCommit(COMMIT, "main"),
                 "https://dev.azure.com/ben-gibson/_git/test.git/commit/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             ),
             Arguments.of(
                 REMOTE_BASE_URL_WITH_COMPANY_AND_GIT,
-                UrlOptions.UrlOptionsCommit(COMMIT),
+                UrlOptions.UrlOptionsCommit(COMMIT, "main"),
                 "https://dev.azure.com/company/project/_git/test.git/commit/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             ),
             Arguments.of(
                 REMOTE_BASE_URL_WITH_COMPANY_WITHOUT_GIT,
-                UrlOptions.UrlOptionsCommit(COMMIT),
+                UrlOptions.UrlOptionsCommit(COMMIT, "main"),
                 "https://dev.azure.com/company/project/_git/test.git/commit/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             ),
             Arguments.of(
                 URL.fromString("https://ssh.dev.azure.com/v3/ben-gibson/test/test"),
-                UrlOptions.UrlOptionsCommit(COMMIT),
+                UrlOptions.UrlOptionsCommit(COMMIT, "main"),
                 "https://dev.azure.com/ben-gibson/test/_git/test.git/commit/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             )
         )

diff --git a/src/test/kotlin/uk/co/ben_gibson/git/link/url/BitBucketCloudTest.kt b/src/test/kotlin/uk/co/ben_gibson/git/link/url/BitBucketCloudTest.kt
@@ -9,8 +9,6 @@ import uk.co.ben_gibson.git.link.ui.LineSelection
 import java.util.stream.Stream
 import uk.co.ben_gibson.git.link.git.Commit
 import uk.co.ben_gibson.git.link.url.factory.BitbucketCloudUrlFactory
-import uk.co.ben_gibson.git.link.url.factory.TemplatedUrlFactory
-import uk.co.ben_gibson.git.link.url.template.UrlTemplates
 import uk.co.ben_gibson.url.URL
 
 class BitBucketCloudTest {
@@ -46,13 +44,14 @@ class BitBucketCloudTest {
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT, LineSelection(10, 20)),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT, LineSelection(10, 20)),
                 "https://bitbucket.org/foo/bar/src/b032a0707beac9a2f24b1b7d97ee4f7156de182c/src/Foo.java#lines-10:20"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
                 UrlOptions.UrlOptionsFileAtCommit(
                     File("resources", true, "src/foo", false),
+                    "main",
                     COMMIT
                 ),
                 "https://bitbucket.org/foo/bar/src/b032a0707beac9a2f24b1b7d97ee4f7156de182c/src/foo/resources"
@@ -61,18 +60,19 @@ class BitBucketCloudTest {
                 REMOTE_BASE_URL,
                 UrlOptions.UrlOptionsFileAtCommit(
                     File("my-project", true, "", true),
+                    "main",
                     COMMIT
                 ),
                 "https://bitbucket.org/foo/bar/src/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT),
                 "https://bitbucket.org/foo/bar/src/b032a0707beac9a2f24b1b7d97ee4f7156de182c/src/Foo.java"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsCommit(COMMIT),
+                UrlOptions.UrlOptionsCommit(COMMIT, "main"),
                 "https://bitbucket.org/foo/bar/commits/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             )
         )

diff --git a/src/test/kotlin/uk/co/ben_gibson/git/link/url/BitBucketServerTest.kt b/src/test/kotlin/uk/co/ben_gibson/git/link/url/BitBucketServerTest.kt
@@ -35,13 +35,14 @@ class BitBucketServerTest {
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT, LineSelection(10, 20)),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT, LineSelection(10, 20)),
                 "https://stash.example.com/projects/foo/repos/bar/browse/src/Foo.java?at=b032a0707beac9a2f24b1b7d97ee4f7156de182c#10-20"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
                 UrlOptions.UrlOptionsFileAtCommit(
                     File("resources", true, "src/foo", false),
+                    "main",
                     COMMIT
                 ),
                 "https://stash.example.com/projects/foo/repos/bar/browse/src/foo/resources?at=b032a0707beac9a2f24b1b7d97ee4f7156de182c"
@@ -50,18 +51,19 @@ class BitBucketServerTest {
                 REMOTE_BASE_URL,
                 UrlOptions.UrlOptionsFileAtCommit(
                     File("my-project", true, "", true),
+                    "main",
                     COMMIT
                 ),
                 "https://stash.example.com/projects/foo/repos/bar/browse?at=b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT),
                 "https://stash.example.com/projects/foo/repos/bar/browse/src/Foo.java?at=b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsCommit(COMMIT),
+                UrlOptions.UrlOptionsCommit(COMMIT, "main"),
                 "https://stash.example.com/projects/foo/repos/bar/commits/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             )
         )

diff --git a/src/test/kotlin/uk/co/ben_gibson/git/link/url/ChromiumTest.kt b/src/test/kotlin/uk/co/ben_gibson/git/link/url/ChromiumTest.kt
@@ -51,38 +51,38 @@ class ChromiumTest {
             // Chromiumos file at commit
             Arguments.of(
                 REMOTE_BASE_URL_CHROMIUMOS,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT, LINE_SELECTION),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT, LINE_SELECTION),
                 "https://source.chromium.org/chromiumos/chromiumos/codesearch/+/b032a0707beac9a2f24b1b7d97ee4f7156de182c:src/platform/ec/board/foo.c;l=10-20"
             ),
             Arguments.of(
                 REMOTE_BASE_URL_CHROMIUMOS,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT),
                 "https://source.chromium.org/chromiumos/chromiumos/codesearch/+/b032a0707beac9a2f24b1b7d97ee4f7156de182c:src/platform/ec/board/foo.c"
             ),
 
             // Chromium file at commit
             Arguments.of(
                 REMOTE_BASE_URL_CHROMIUM,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT, LINE_SELECTION),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT, LINE_SELECTION),
                 "https://source.chromium.org/chromium/chromium/tools/build/+/b032a0707beac9a2f24b1b7d97ee4f7156de182c:board/foo.c;l=10-20"
             ),
             Arguments.of(
                 REMOTE_BASE_URL_CHROMIUM,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT),
                 "https://source.chromium.org/chromium/chromium/tools/build/+/b032a0707beac9a2f24b1b7d97ee4f7156de182c:board/foo.c"
             ),
 
             // Chromiumos commit
             Arguments.of(
                 REMOTE_BASE_URL_CHROMIUMOS,
-                UrlOptions.UrlOptionsCommit(COMMIT),
+                UrlOptions.UrlOptionsCommit(COMMIT, "main"),
                 "https://source.chromium.org/chromiumos/_/chromium/chromiumos/platform/ec/+/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             ),
 
             // Chromium commit
             Arguments.of(
                 REMOTE_BASE_URL_CHROMIUM,
-                UrlOptions.UrlOptionsCommit(COMMIT),
+                UrlOptions.UrlOptionsCommit(COMMIT, "main"),
                 "https://source.chromium.org/chromium/chromium/tools/build/+/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             ),
         )

diff --git a/src/test/kotlin/uk/co/ben_gibson/git/link/url/GerritTest.kt b/src/test/kotlin/uk/co/ben_gibson/git/link/url/GerritTest.kt
@@ -35,13 +35,14 @@ class GerritTest {
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT, LineSelection(10, 20)),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT, LineSelection(10, 20)),
                 "https://gerrit.example.com/plugins/gitiles/foo/bar/+/b032a0707beac9a2f24b1b7d97ee4f7156de182c/src/Foo.java#10"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
                 UrlOptions.UrlOptionsFileAtCommit(
                     File("resources", true, "src/foo", false),
+                    "main",
                     COMMIT
                 ),
                 "https://gerrit.example.com/plugins/gitiles/foo/bar/+/b032a0707beac9a2f24b1b7d97ee4f7156de182c/src/foo/resources"
@@ -50,18 +51,19 @@ class GerritTest {
                 REMOTE_BASE_URL,
                 UrlOptions.UrlOptionsFileAtCommit(
                     File("my-project", true, "", true),
+                    "main",
                     COMMIT
                 ),
                 "https://gerrit.example.com/plugins/gitiles/foo/bar/+/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT),
                 "https://gerrit.example.com/plugins/gitiles/foo/bar/+/b032a0707beac9a2f24b1b7d97ee4f7156de182c/src/Foo.java"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsCommit(COMMIT),
+                UrlOptions.UrlOptionsCommit(COMMIT, "main"),
                 "https://gerrit.example.com/plugins/gitiles/foo/bar/+/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             )
         )

diff --git a/src/test/kotlin/uk/co/ben_gibson/git/link/url/GitHubTest.kt b/src/test/kotlin/uk/co/ben_gibson/git/link/url/GitHubTest.kt
@@ -43,13 +43,14 @@ class GitHubTest {
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT, LineSelection(10, 20)),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT, LineSelection(10, 20)),
                 "https://github.com/my/repo/blob/b032a0707beac9a2f24b1b7d97ee4f7156de182c/src/Foo.java#L10-L20"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
                 UrlOptions.UrlOptionsFileAtCommit(
                     File("resources", true, "src/foo", false),
+                    "main",
                     COMMIT
                 ),
                 "https://github.com/my/repo/tree/b032a0707beac9a2f24b1b7d97ee4f7156de182c/src/foo/resources"
@@ -58,18 +59,19 @@ class GitHubTest {
                 REMOTE_BASE_URL,
                 UrlOptions.UrlOptionsFileAtCommit(
                     File("my-project", true, "", true),
+                    "main",
                     COMMIT
                 ),
                 "https://github.com/my/repo/tree/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsFileAtCommit(FILE, COMMIT),
+                UrlOptions.UrlOptionsFileAtCommit(FILE, "main", COMMIT),
                 "https://github.com/my/repo/blob/b032a0707beac9a2f24b1b7d97ee4f7156de182c/src/Foo.java"
             ),
             Arguments.of(
                 REMOTE_BASE_URL,
-                UrlOptions.UrlOptionsCommit(COMMIT),
+                UrlOptions.UrlOptionsCommit(COMMIT, "main"),
                 "https://github.com/my/repo/commit/b032a0707beac9a2f24b1b7d97ee4f7156de182c"
             )
         )