From 0289776773191c7bb37d94a8942d41fe5fbb2737 Mon Sep 17 00:00:00 2001 From: Frank Viernau Date: Mon, 22 Jan 2024 09:37:37 +0100 Subject: [PATCH] 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 --- .../kotlin/{SpmFunTest.kt => SwiftPmFunTest.kt} | 4 ++-- .../spm/src/main/kotlin/{Spm.kt => SwiftPm.kt} | 10 +++++----- ...ependencyHandler.kt => SwiftPmDependencyHandler.kt} | 6 +++--- .../src/main/kotlin/{SpmModel.kt => SwiftPmModel.kt} | 2 +- ...org.ossreviewtoolkit.analyzer.PackageManagerFactory | 2 +- .../spm/src/test/kotlin/{SpmTest.kt => SwiftPmTest.kt} | 4 ++-- 6 files changed, 14 insertions(+), 14 deletions(-) rename plugins/package-managers/spm/src/funTest/kotlin/{SpmFunTest.kt => SwiftPmFunTest.kt} (96%) rename plugins/package-managers/spm/src/main/kotlin/{Spm.kt => SwiftPm.kt} (95%) rename plugins/package-managers/spm/src/main/kotlin/{SpmDependencyHandler.kt => SwiftPmDependencyHandler.kt} (87%) rename plugins/package-managers/spm/src/main/kotlin/{SpmModel.kt => SwiftPmModel.kt} (98%) rename plugins/package-managers/spm/src/test/kotlin/{SpmTest.kt => SwiftPmTest.kt} (94%) diff --git a/plugins/package-managers/spm/src/funTest/kotlin/SpmFunTest.kt b/plugins/package-managers/spm/src/funTest/kotlin/SwiftPmFunTest.kt similarity index 96% rename from plugins/package-managers/spm/src/funTest/kotlin/SpmFunTest.kt rename to plugins/package-managers/spm/src/funTest/kotlin/SwiftPmFunTest.kt index eeadefd892ac..6a2a93b4fbab 100644 --- a/plugins/package-managers/spm/src/funTest/kotlin/SpmFunTest.kt +++ b/plugins/package-managers/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/plugins/package-managers/spm/src/main/kotlin/Spm.kt b/plugins/package-managers/spm/src/main/kotlin/SwiftPm.kt similarity index 95% rename from plugins/package-managers/spm/src/main/kotlin/Spm.kt rename to plugins/package-managers/spm/src/main/kotlin/SwiftPm.kt index e45b51c0f1f3..e3f78d007153 100644 --- a/plugins/package-managers/spm/src/main/kotlin/Spm.kt +++ b/plugins/package-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(PACKAGE_TYPE) { + class Factory : AbstractPackageManagerFactory(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/plugins/package-managers/spm/src/main/kotlin/SpmDependencyHandler.kt b/plugins/package-managers/spm/src/main/kotlin/SwiftPmDependencyHandler.kt similarity index 87% rename from plugins/package-managers/spm/src/main/kotlin/SpmDependencyHandler.kt rename to plugins/package-managers/spm/src/main/kotlin/SwiftPmDependencyHandler.kt index 64ba8616e821..4468e1b18b15 100644 --- a/plugins/package-managers/spm/src/main/kotlin/SpmDependencyHandler.kt +++ b/plugins/package-managers/spm/src/main/kotlin/SwiftPmDependencyHandler.kt @@ -17,7 +17,7 @@ * 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 @@ -25,12 +25,12 @@ 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 { +class SwiftPmDependencyHandler : DependencyHandler { override fun identifierFor(dependency: Dependency): Identifier = dependency.id override fun dependenciesFor(dependency: Dependency): Collection = dependency.dependencies diff --git a/plugins/package-managers/spm/src/main/kotlin/SpmModel.kt b/plugins/package-managers/spm/src/main/kotlin/SwiftPmModel.kt similarity index 98% rename from plugins/package-managers/spm/src/main/kotlin/SpmModel.kt rename to plugins/package-managers/spm/src/main/kotlin/SwiftPmModel.kt index b053bc372dec..6f2f17497410 100644 --- a/plugins/package-managers/spm/src/main/kotlin/SpmModel.kt +++ b/plugins/package-managers/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/plugins/package-managers/spm/src/main/resources/META-INF/services/org.ossreviewtoolkit.analyzer.PackageManagerFactory b/plugins/package-managers/spm/src/main/resources/META-INF/services/org.ossreviewtoolkit.analyzer.PackageManagerFactory index a500e898b4b3..647ba18ccda6 100644 --- a/plugins/package-managers/spm/src/main/resources/META-INF/services/org.ossreviewtoolkit.analyzer.PackageManagerFactory +++ b/plugins/package-managers/spm/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/plugins/package-managers/spm/src/test/kotlin/SpmTest.kt b/plugins/package-managers/spm/src/test/kotlin/SwiftPmTest.kt similarity index 94% rename from plugins/package-managers/spm/src/test/kotlin/SpmTest.kt rename to plugins/package-managers/spm/src/test/kotlin/SwiftPmTest.kt index 890e082e6b86..05f65e8ea285 100644 --- a/plugins/package-managers/spm/src/test/kotlin/SpmTest.kt +++ b/plugins/package-managers/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(