refactor(spm)!: Use the term SwiftPm in classes, files and package

The Swift Package Manager folks do not use the term `Spm` for that package manager. Align the name with upstream terminology, see also [1]. [1]: https://www.swift.org/package-manager/ Signed-off-by: Frank Viernau <frank_viernau@epam.com>
oss-review-toolkit · Jan 22, 2024 · 0289776 · 0289776
1 parent 4116d16
commit 0289776
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 14 deletions.
diff --git a/...gers/spm/src/funTest/kotlin/SpmFunTest.kt → .../spm/src/funTest/kotlin/SwiftPmFunTest.kt b/...gers/spm/src/funTest/kotlin/SpmFunTest.kt → .../spm/src/funTest/kotlin/SwiftPmFunTest.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.plugins.packagemanagers.spm
+package org.ossreviewtoolkit.plugins.packagemanagers.swiftpm
 
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.matchers.should
@@ -30,7 +30,7 @@ import org.ossreviewtoolkit.model.toYaml
 import org.ossreviewtoolkit.utils.test.getAssetFile
 import org.ossreviewtoolkit.utils.test.matchExpectedResult
 
-class SpmFunTest : WordSpec({
+class SwiftPmFunTest : WordSpec({
     "Parsing 'Package.resolved' dependencies" should {
         "return the correct result" {
             val definitionFile = getAssetFile("projects/synthetic/spm-app/Package.resolved")

diff --git a/...ckage-managers/spm/src/main/kotlin/Spm.kt → ...e-managers/spm/src/main/kotlin/SwiftPm.kt b/...ckage-managers/spm/src/main/kotlin/Spm.kt → ...e-managers/spm/src/main/kotlin/SwiftPm.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.plugins.packagemanagers.spm
+package org.ossreviewtoolkit.plugins.packagemanagers.swiftpm
 
 import java.io.File
 
@@ -50,22 +50,22 @@ private const val DEPENDENCIES_SCOPE_NAME = "dependencies"
 /**
  * The [Swift Package Manager](https://github.com/apple/swift-package-manager).
  */
-class Spm(
+class SwiftPm(
     name: String,
     analysisRoot: File,
     analyzerConfig: AnalyzerConfiguration,
     repoConfig: RepositoryConfiguration
 ) : PackageManager(name, analysisRoot, analyzerConfig, repoConfig), CommandLineTool {
-    private val graphBuilder = DependencyGraphBuilder(SpmDependencyHandler())
+    private val graphBuilder = DependencyGraphBuilder(SwiftPmDependencyHandler())
 
-    class Factory : AbstractPackageManagerFactory<Spm>(PACKAGE_TYPE) {
+    class Factory : AbstractPackageManagerFactory<SwiftPm>(PACKAGE_TYPE) {
         override val globsForDefinitionFiles = listOf(PACKAGE_SWIFT_NAME, PACKAGE_RESOLVED_NAME)
 
         override fun create(
             analysisRoot: File,
             analyzerConfig: AnalyzerConfiguration,
             repoConfig: RepositoryConfiguration
-        ) = Spm(type, analysisRoot, analyzerConfig, repoConfig)
+        ) = SwiftPm(type, analysisRoot, analyzerConfig, repoConfig)
     }
 
     override fun command(workingDir: File?) = if (Os.isWindows) "swift.exe" else "swift"

diff --git a/...m/src/main/kotlin/SpmDependencyHandler.kt → ...c/main/kotlin/SwiftPmDependencyHandler.kt b/...m/src/main/kotlin/SpmDependencyHandler.kt → ...c/main/kotlin/SwiftPmDependencyHandler.kt
@@ -17,20 +17,20 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.plugins.packagemanagers.spm
+package org.ossreviewtoolkit.plugins.packagemanagers.swiftpm
 
 import org.ossreviewtoolkit.model.Identifier
 import org.ossreviewtoolkit.model.Issue
 import org.ossreviewtoolkit.model.Package
 import org.ossreviewtoolkit.model.PackageLinkage
 import org.ossreviewtoolkit.model.PackageLinkage.DYNAMIC
 import org.ossreviewtoolkit.model.utils.DependencyHandler
-import org.ossreviewtoolkit.plugins.packagemanagers.spm.SwiftPackage.Dependency
+import org.ossreviewtoolkit.plugins.packagemanagers.swiftpm.SwiftPackage.Dependency
 
 /**
  * A specialized [DependencyHandler] implementation for SPM.
  */
-class SpmDependencyHandler : DependencyHandler<Dependency> {
+class SwiftPmDependencyHandler : DependencyHandler<Dependency> {
     override fun identifierFor(dependency: Dependency): Identifier = dependency.id
 
     override fun dependenciesFor(dependency: Dependency): Collection<Dependency> = dependency.dependencies

diff --git a/...-managers/spm/src/main/kotlin/SpmModel.kt → ...agers/spm/src/main/kotlin/SwiftPmModel.kt b/...-managers/spm/src/main/kotlin/SpmModel.kt → ...agers/spm/src/main/kotlin/SwiftPmModel.kt
@@ -17,7 +17,7 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.plugins.packagemanagers.spm
+package org.ossreviewtoolkit.plugins.packagemanagers.swiftpm
 
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable

diff --git a/.../src/main/resources/META-INF/services/org.ossreviewtoolkit.analyzer.PackageManagerFactory b/.../src/main/resources/META-INF/services/org.ossreviewtoolkit.analyzer.PackageManagerFactory
@@ -1 +1 @@
-org.ossreviewtoolkit.plugins.packagemanagers.spm.Spm$Factory
+org.ossreviewtoolkit.plugins.packagemanagers.swiftpm.SwiftPm$Factory
diff --git a/...e-managers/spm/src/test/kotlin/SpmTest.kt → ...nagers/spm/src/test/kotlin/SwiftPmTest.kt b/...e-managers/spm/src/test/kotlin/SpmTest.kt → ...nagers/spm/src/test/kotlin/SwiftPmTest.kt
@@ -17,13 +17,13 @@
  * License-Filename: LICENSE
  */
 
-package org.ossreviewtoolkit.plugins.packagemanagers.spm
+package org.ossreviewtoolkit.plugins.packagemanagers.swiftpm
 
 import io.kotest.core.spec.style.WordSpec
 import io.kotest.inspectors.forAll
 import io.kotest.matchers.shouldBe
 
-class SpmTest : WordSpec({
+class SwiftPmTest : WordSpec({
     "getCanonicalName()" should {
         "return the expected canonical name" {
             listOf(