feat: Extend Identifier with fromPurl() method

This commit adds method to Identifier object
that allows creation of new Identifier object
from PURL.

Signed-off-by: Kamil Bielecki <kamil.bielecki@pl.bosch.com>

Author: Kamil Bielecki

gradle/libs.versions.toml

@@ -55,6 +55,7 @@ mordant = "3.0.2"
 okhttp = "5.3.2"
 postgres = "42.7.8"
 postgresEmbedded = "1.1.1"
+purlkt = "0.0.7"
 reflections = "0.10.2"
 retrofit = "3.0.0"
 s3 = "2.40.1"
@@ -167,6 +168,7 @@ okhttp = { module = "com.squareup.okhttp3:okhttp", version.ref = "okhttp" }
 okhttp-loggingInterceptor = { module = "com.squareup.okhttp3:logging-interceptor", version.ref = "okhttp" }
 postgres = { module = "org.postgresql:postgresql", version.ref = "postgres" }
 postgresEmbedded = { module = "com.opentable.components:otj-pg-embedded", version.ref = "postgresEmbedded" }
+purlkt = { module = "space.iseki.purlkt:purlkt", version.ref = "purlkt"}
 reflections = { module = "org.reflections:reflections", version.ref = "reflections" }
 retrofit = { module = "com.squareup.retrofit2:retrofit", version.ref = "retrofit" }
 retrofit-converter-jackson = { module = "com.squareup.retrofit2:converter-jackson", version.ref = "retrofit" }

model/build.gradle.kts

@@ -41,6 +41,7 @@ dependencies {
     implementation(libs.bundles.hoplite)
     implementation(libs.hikari)
     implementation(libs.postgres)
+    implementation(libs.purlkt)
     implementation(libs.semver4j)
     implementation(libs.tika)
 

model/src/main/kotlin/Identifier.kt

@@ -25,6 +25,9 @@ import com.fasterxml.jackson.annotation.JsonValue
 import org.ossreviewtoolkit.utils.common.AlphaNumericComparator
 import org.ossreviewtoolkit.utils.common.encodeOr
 
+import space.iseki.purl.PUrl
+import space.iseki.purl.PUrlParsingException
+
 /**
  * A unique identifier for a software component.
  */
@@ -66,6 +69,16 @@ data class Identifier(
         // This comparator is consistent with `equals()` as all properties are taken into account.
         private val COMPARATOR = compareBy<Identifier>({ it.type }, { it.namespace }, { it.name })
             .thenComparing({ it.version }, AlphaNumericComparator)
+
+        @Suppress("SwallowedException")
+        fun fromPurl(purlString: String): Identifier {
+            try {
+                val purl = PUrl.parse(purlString)
+                return Identifier(purl.type, purl.namespace.joinToString("."), purl.name, purl.version)
+            } catch (ex: PUrlParsingException) {
+                throw IllegalArgumentException(ex.message)
+            }
+        }
     }
 
     private constructor(properties: List<String>) : this(

model/src/test/kotlin/IdentifierTest.kt

@@ -20,6 +20,7 @@
 package org.ossreviewtoolkit.model
 
 import io.kotest.assertions.assertSoftly
+import io.kotest.assertions.throwables.shouldThrow
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.inspectors.forAll
 import io.kotest.matchers.maps.containExactly
@@ -135,4 +136,34 @@ class IdentifierTest : WordSpec({
             }
         }
     }
+
+    "Purl representation" should {
+        "should accept only pkg type purls" {
+            shouldThrow<IllegalArgumentException> {
+                Identifier.fromPurl("nonpkg:someurl/example.com/invalid@1.1")
+            }
+        }
+
+        "be parsed correctly for purl with namespace" {
+            val id = Identifier.fromPurl("pkg:github/example.com/valid-with-namespace@1.0")
+
+            with(id) {
+                type shouldBe "github"
+                namespace shouldBe "example.com"
+                name shouldBe "valid-with-namespace"
+                version shouldBe "1.0"
+            }
+        }
+
+        "be parsed correctly for purl without namespace" {
+            val id = Identifier.fromPurl("pkg:pypi/valid-without-namespace@2.0")
+
+            with(id) {
+                type shouldBe "pypi"
+                namespace shouldBe ""
+                name shouldBe "valid-without-namespace"
+                version shouldBe "2.0"
+            }
+        }
+    }
 })