Merge pull request #1588 from JD557/support-ssh-scm-urls

Add support for explicit SSH connections in SCM URLs

Author: adpi2

modules/data/src/main/scala/scaladex/data/cleanup/ScmInfoParser.scala

@@ -20,7 +20,7 @@ object ScmInfoParser extends Parsers:
     else v
 
   private def ScmUrl[A: P] = P(
-    "scm:".? ~ "git:".? ~ ("git@" | "https://" | "git://" | "//") ~
+    "scm:".? ~ "git:".? ~ ("git@" | "https://" | "git://" | ("ssh://" ~ "git@".?) | "//") ~
       "github.com" ~ (":" | "/") ~ Segment
         .rep(1)
         .! ~ "/" ~ Segment.rep(1).!.map(removeDotGit)

modules/data/src/test/scala/scaladex/data/cleanup/ScmInfoParserTests.scala

@@ -0,0 +1,44 @@
+package scaladex.data
+package cleanup
+
+import org.scalatest.funspec.AnyFunSpec
+import org.scalatest.matchers.should.Matchers
+
+class ScmInfoParserTests extends AnyFunSpec with Matchers:
+  describe("ScmInfoParse") {
+    it("correctly parse valid SCM strings") {
+      // Implicit protocol
+      ScmInfoParser
+        .parse("scm:git:[email protected]:foobarbuz/example.git")
+        .map(_.toString) shouldBe Some("foobarbuz/example")
+      // HTTPS
+      ScmInfoParser
+        .parse("scm:https://github.com/foobarbuz/example.git")
+        .map(_.toString) shouldBe Some("foobarbuz/example")
+      ScmInfoParser
+        .parse("scm:https://github.com/foobarbuz/example")
+        .map(_.toString) shouldBe Some("foobarbuz/example")
+      // Git
+      ScmInfoParser
+        .parse("scm:git:git://github.com:foobarbuz/example.git")
+        .map(_.toString) shouldBe Some("foobarbuz/example")
+      ScmInfoParser
+        .parse("scm:git://github.com:foobarbuz/example.git")
+        .map(_.toString) shouldBe Some("foobarbuz/example")
+      // SSH
+      ScmInfoParser
+        .parse("scm:git:ssh://[email protected]:foobarbuz/example.git")
+        .map(_.toString) shouldBe Some("foobarbuz/example")
+      ScmInfoParser
+        .parse("scm:git:ssh://github.com:foobarbuz/example.git")
+        .map(_.toString) shouldBe Some("foobarbuz/example")
+      // Unknown protocol
+      ScmInfoParser
+        .parse("scm:git:unknown://[email protected]:foobarbuz/example.git")
+        .map(_.toString) shouldBe None
+      ScmInfoParser
+        .parse("scm:git:unknown://github.com:foobarbuz/example.git")
+        .map(_.toString) shouldBe None
+    }
+  }
+end ScmInfoParserTests