chore: Align on "purl" spelling for Package URLs

That seems to be the official spelling, see [1]. [1]: https://github.com/package-url/purl-spec?tab=readme-ov-file#solution Signed-off-by: Sebastian Schuberth <sebastian@doubleopen.org>
oss-review-toolkit · Oct 24, 2024 · 4814301 · 4814301
1 parent d2dd061
commit 4814301
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 9 deletions.
diff --git a/clients/dos/src/main/kotlin/DosClient.kt b/clients/dos/src/main/kotlin/DosClient.kt
@@ -48,7 +48,7 @@ class DosClient(private val service: DosService) {
         return if (response.isSuccessful && responseBody != null) {
             responseBody
         } else {
-            logger.error { "Error getting the package configuration for PURL $purl: ${response.errorBody()?.string()}" }
+            logger.error { "Error getting the package configuration for purl $purl: ${response.errorBody()?.string()}" }
 
             null
         }

diff --git a/clients/vulnerable-code/src/main/kotlin/VulnerableCodeService.kt b/clients/vulnerable-code/src/main/kotlin/VulnerableCodeService.kt
@@ -138,7 +138,7 @@ interface VulnerableCodeService {
      */
     @Serializable
     data class PackageVulnerabilities(
-        /** The PURL identifying this package. */
+        /** The purl identifying this package. */
         val purl: String,
 
         /** An optional list with vulnerabilities that have not yet been resolved. */

diff --git a/model/src/main/kotlin/utils/PurlExtensions.kt b/model/src/main/kotlin/utils/PurlExtensions.kt
@@ -102,7 +102,7 @@ fun Provenance.toPurlExtras(): PurlExtras =
     }
 
 /**
- * Decode [Provenance] from extra qualifying data / a subpath of the PURL represented by this [String]. Return
+ * Decode [Provenance] from extra qualifying data / a subpath of the purl represented by this [String]. Return
  * [UnknownProvenance] if extra data is not present.
  */
 fun String.toProvenance(): Provenance {

diff --git a/model/src/main/kotlin/utils/PurlUtils.kt b/model/src/main/kotlin/utils/PurlUtils.kt
@@ -57,7 +57,7 @@ enum class PurlType(private val value: String) {
 }
 
 /**
- * Extra data than can be appended to a "clean" PURL via qualifiers or a subpath.
+ * Extra data than can be appended to a "clean" purl via qualifiers or a subpath.
  */
 data class PurlExtras(
     /**

diff --git a/model/src/test/kotlin/IdentifierTest.kt b/model/src/test/kotlin/IdentifierTest.kt
@@ -124,7 +124,7 @@ class IdentifierTest : WordSpec({
         }
     }
 
-    "Purl representations" should {
+    "purl representations" should {
         "not suffix the scheme with '//'" {
             val purl = Identifier("type", "namespace", "name", "version").toPurl()
 

diff --git a/model/src/test/kotlin/utils/PurlExtensionsTest.kt b/model/src/test/kotlin/utils/PurlExtensionsTest.kt
@@ -79,7 +79,7 @@ class PurlExtensionsTest : WordSpec({
             purl.toProvenance() shouldBe provenance
         }
 
-        "work for a PURL without qualifiers" {
+        "work for a purl without qualifiers" {
             "pkg:npm/mime-db@1.33.0".toProvenance() shouldBe UnknownProvenance
         }
     }

diff --git a/plugins/commands/upload-result-to-sw360/src/main/kotlin/UploadResultToSw360Command.kt b/plugins/commands/upload-result-to-sw360/src/main/kotlin/UploadResultToSw360Command.kt
@@ -142,7 +142,7 @@ class UploadResultToSw360Command : OrtCommand(
         val sw360Project = SW360Project()
             .setName(project.id.name)
             .setVersion(project.id.version)
-            .setDescription("A ${project.id.type} project with the PURL ${project.id.toPurl()}.")
+            .setDescription("A ${project.id.type} project with the purl ${project.id.toPurl()}.")
             .setVisibility(SW360Visibility.BUISNESSUNIT_AND_MODERATORS)
 
         return try {

diff --git a/plugins/scanners/fossid/src/main/kotlin/FossId.kt b/plugins/scanners/fossid/src/main/kotlin/FossId.kt
@@ -124,7 +124,7 @@ class FossId internal constructor(
         private val GIT_FETCH_DONE_REGEX = Regex("-> FETCH_HEAD(?: Already up to date.)*$")
 
         /**
-         * A regular expression to extract the artifact and version from a Purl returned by FossID.
+         * A regular expression to extract the artifact and version from a purl returned by FossID.
          */
         @JvmStatic
         private val SNIPPET_PURL_REGEX = Regex("^.*/(?<artifact>[^@]+)@(?<version>.+)")

diff --git a/plugins/scanners/fossid/src/main/kotlin/FossIdScanResults.kt b/plugins/scanners/fossid/src/main/kotlin/FossIdScanResults.kt
@@ -447,7 +447,7 @@ private fun urlToPackageType(url: String): PurlType =
         else -> {
             PurlType.GENERIC.also {
                 logger.warn {
-                    "Cannot determine PURL type for URL $url and provider '$provider'. Falling back to '$it'."
+                    "Cannot determine purl type for URL $url and provider '$provider'. Falling back to '$it'."
                 }
             }
         }
-Original file line number
+Diff line change
@@ Expand Up / @@ -57,7 +57,7 @@ enum class PurlType(private val value: String) { @@
     }
     /**
-     * Extra data than can be appended to a "clean" PURL via qualifiers or a subpath.
+     * Extra data than can be appended to a "clean" purl via qualifiers or a subpath.
      */
     data class PurlExtras(
         /**
@@ Expand Down @@