Migrated to new XCFramework setup, replaced manual creation of xcframework in favor of the XCFramework usage. Added additional xcFrameworkName property available allowing the swiftpackage and xcframework to have a different name.

wesleydonk · wesleydonk · commit c856b5bbdfc4 · 2022-01-14T16:55:12.000+01:00
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -4,11 +4,11 @@ buildscript {
         jcenter()
     }
     dependencies {
-        classpath("org.jetbrains.kotlinx:binary-compatibility-validator:0.2.4")
+        classpath("org.jetbrains.kotlinx:binary-compatibility-validator:0.8.0")
     }
 }
 
-apply(plugin = "binary-compatibility-validator")
+// apply(plugin = "binary-compatibility-validator")
 
 plugins {
     `kotlin-dsl`
@@ -17,19 +17,19 @@ plugins {
     signing
 }
 
-version = "2.0.3-m1"
+version = "2.0.3-m1-xcframework"
 
 repositories {
     jcenter()
 }
 
 dependencies {
-    compileOnly(kotlin("gradle-plugin", "1.5.30"))
+    compileOnly(kotlin("gradle-plugin", "1.6.10"))
     testImplementation("io.kotest:kotest-runner-junit5:4.3.0")
     testImplementation("io.kotest:kotest-assertions-core:4.3.0")
     testImplementation("io.kotest:kotest-property:4.3.0")
     testImplementation("io.mockk:mockk:1.10.0")
-    testImplementation(kotlin("gradle-plugin", "1.5.30"))
+    testImplementation(kotlin("gradle-plugin", "1.6.10"))
 }
 
 java {
@@ -103,9 +103,9 @@ publishing {
     }
 }
 
-signing {
-    sign(publishing.publications["pluginMaven"])
-}
+//signing {
+//    sign(publishing.publications["pluginMaven"])
+//}
 
 tasks.javadoc {
     if (JavaVersion.current().isJava9Compatible) {
diff --git a/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/MultiplatformSwiftPackagePlugin.kt b/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/MultiplatformSwiftPackagePlugin.kt
@@ -2,8 +2,8 @@ package com.chromaticnoise.multiplatformswiftpackage
 
 import com.chromaticnoise.multiplatformswiftpackage.domain.AppleTarget
 import com.chromaticnoise.multiplatformswiftpackage.domain.platforms
+import com.chromaticnoise.multiplatformswiftpackage.task.registerCopyXCFrameworkFileTask
 import com.chromaticnoise.multiplatformswiftpackage.task.registerCreateSwiftPackageTask
-import com.chromaticnoise.multiplatformswiftpackage.task.registerCreateXCFrameworkTask
 import com.chromaticnoise.multiplatformswiftpackage.task.registerCreateZipFileTask
 import org.gradle.api.Plugin
 import org.gradle.api.Project
@@ -25,7 +25,7 @@ public class MultiplatformSwiftPackagePlugin : Plugin<Project> {
                     nativeTargets = kmpExtension.targets.toList(),
                     platforms = extension.targetPlatforms.platforms
                 )
-                project.registerCreateXCFrameworkTask()
+                project.registerCopyXCFrameworkFileTask()
                 project.registerCreateZipFileTask()
                 project.registerCreateSwiftPackageTask()
             }
diff --git a/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/SwiftPackageExtension.kt b/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/SwiftPackageExtension.kt
@@ -14,12 +14,15 @@ public open class SwiftPackageExtension(internal val project: Project) {
 
     internal var buildConfiguration: BuildConfiguration = BuildConfiguration.Release
     internal var packageName: Either<PluginConfigurationError, PackageName>? = null
-    internal var outputDirectory: OutputDirectory = OutputDirectory(File(project.projectDir, "swiftpackage"))
+    internal var outputDirectory: OutputDirectory =
+        OutputDirectory(File(project.projectDir, "swiftpackage"))
     internal var swiftToolsVersion: SwiftToolVersion? = null
     internal var distributionMode: DistributionMode = DistributionMode.Local
-    internal var targetPlatforms: Collection<Either<List<PluginConfigurationError>, TargetPlatform>> = emptyList()
+    internal var targetPlatforms: Collection<Either<List<PluginConfigurationError>, TargetPlatform>> =
+        emptyList()
     internal var appleTargets: Collection<AppleTarget> = emptyList()
     internal var zipFileName: Either<PluginConfigurationError, ZipFileName>? = null
+    internal var xcframeworkName: Either<PluginConfigurationError, XCFrameworkName>? = null
 
     /**
      * Sets the name of the Swift package.
@@ -31,6 +34,10 @@ public open class SwiftPackageExtension(internal val project: Project) {
         packageName = PackageName.of(name)
     }
 
+    public fun xcframeworkName(name: String) {
+        xcframeworkName = XCFrameworkName.of(name)
+    }
+
     /**
      * Sets the directory where files like the Package.swift and XCFramework will be created.
      * Defaults to $projectDir/swiftpackage
diff --git a/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/PluginConfiguration.kt b/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/PluginConfiguration.kt
@@ -12,12 +12,14 @@ internal class PluginConfiguration private constructor(
     val distributionMode: DistributionMode,
     val targetPlatforms: Collection<TargetPlatform>,
     val appleTargets: Collection<AppleTarget>,
-    val zipFileName: ZipFileName
+    val zipFileName: ZipFileName,
+    val xcFrameworkName: XCFrameworkName
 ) {
     internal companion object {
         fun of(extension: SwiftPackageExtension): Either<List<PluginConfigurationError>, PluginConfiguration> {
             val targetPlatforms = extension.targetPlatforms.platforms
             val packageName = extension.getPackageName()
+            val xcFrameworkName = extension.getXCFrameworkName()
 
             val errors = mutableListOf<PluginConfigurationError>().apply {
                 if (extension.swiftToolsVersion == null) {
@@ -40,6 +42,8 @@ internal class PluginConfiguration private constructor(
                 packageName.leftValueOrNull?.let { error -> add(error) }
 
                 extension.zipFileName?.leftValueOrNull?.let { error -> add(error) }
+
+                extension.xcframeworkName?.leftValueOrNull?.let { error -> add(error) }
             }
 
             return if (errors.isEmpty()) {
@@ -52,21 +56,36 @@ internal class PluginConfiguration private constructor(
                         extension.distributionMode,
                         targetPlatforms,
                         extension.appleTargets,
-                        extension.zipFileName?.orNull ?: defaultZipFileName(packageName.orNull!!, extension.project)
+                        extension.zipFileName?.orNull ?: defaultZipFileName(
+                            packageName.orNull!!,
+                            extension.project
+                        ),
+                        extension.xcframeworkName?.orNull ?: defaultXCFrameworkName(
+                            xcFrameworkName.orNull!!
+                        )
                     )
                 )
             } else {
                 Either.Left(errors)
             }
         }
 
-        private fun SwiftPackageExtension.getPackageName(): Either<PluginConfigurationError, PackageName> = packageName
-            ?: appleTargets.map { it.getFramework(buildConfiguration) }.firstOrNull()?.let { framework ->
-                PackageName.of(framework.name.value)
-            } ?: Either.Left(BlankPackageName)
+        private fun SwiftPackageExtension.getPackageName(): Either<PluginConfigurationError, PackageName> =
+            packageName
+                ?: appleTargets.map { it.getFramework(buildConfiguration) }.firstOrNull()
+                    ?.let { framework ->
+                        PackageName.of(framework.name.value)
+                    } ?: Either.Left(BlankPackageName)
+
+        private fun SwiftPackageExtension.getXCFrameworkName(): Either<PluginConfigurationError, XCFrameworkName> {
+            return xcframeworkName ?: Either.Left(BlankXCFrameworkName)
+        }
 
         private fun defaultZipFileName(packageName: PackageName, project: Project) =
             ZipFileName.of("${packageName.value}-${project.version}").orNull!!
+
+        private fun defaultXCFrameworkName(xcFrameworkName: XCFrameworkName) =
+            XCFrameworkName.of(xcFrameworkName.value).orNull!!
     }
 
     internal sealed class PluginConfigurationError {
@@ -76,5 +95,6 @@ internal class PluginConfiguration private constructor(
         object MissingAppleTargets : PluginConfigurationError()
         object BlankPackageName : PluginConfigurationError()
         object BlankZipFileName : PluginConfigurationError()
+        object BlankXCFrameworkName : PluginConfigurationError()
     }
 }
diff --git a/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/Project+PluginConfiguration.kt b/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/Project+PluginConfiguration.kt
@@ -40,5 +40,8 @@ private fun List<PluginConfigurationError>.toErrorMessage() = joinToString("\n\n
         PluginConfigurationError.BlankZipFileName -> """
         * ZIP file name must not be blank
         """.trimIndent()
+        PluginConfigurationError.BlankXCFrameworkName -> """
+        * XCFramework name must not be blank
+        """.trimIndent()
     }
 }
diff --git a/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/XCFrameworkName.kt b/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/XCFrameworkName.kt
@@ -0,0 +1,16 @@
+package com.chromaticnoise.multiplatformswiftpackage.domain
+
+internal class XCFrameworkName private constructor(val value: String) {
+
+    internal companion object {
+        fun of(name: String?): Either<PluginConfiguration.PluginConfigurationError, XCFrameworkName> =
+            name?.ifNotBlank { Either.Right(XCFrameworkName(it)) }
+                ?: Either.Left(PluginConfiguration.PluginConfigurationError.BlankXCFrameworkName)
+    }
+
+    override fun equals(other: Any?): Boolean = value == (other as? XCFrameworkName)?.value
+
+    override fun hashCode(): Int = value.hashCode()
+
+    override fun toString(): String = "XCFrameworkName(value='$value')"
+}
diff --git a/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/task/CopyXCFrameworkFileTask.kt b/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/task/CopyXCFrameworkFileTask.kt
@@ -0,0 +1,22 @@
+package com.chromaticnoise.multiplatformswiftpackage.task
+
+import com.chromaticnoise.multiplatformswiftpackage.domain.getConfigurationOrThrow
+import org.gradle.api.Project
+import org.gradle.api.tasks.Copy
+import java.io.File
+
+internal fun Project.registerCopyXCFrameworkFileTask() {
+    tasks.register("copyXCFrameworkFile", Copy::class.java) {
+        setGroup(null) // hide the task from the task list
+        description = "Copies XCFrameworks into swiftpackage output folder"
+
+        val configuration = getConfigurationOrThrow()
+        dependsOn("assemble${configuration.xcFrameworkName.value}XCFramework")
+
+        val buildConfiguration = configuration.buildConfiguration.name
+        from(
+            "${project.buildDir.path}/XCFrameworks/${buildConfiguration}/"
+        )
+        into(configuration.outputDirectory.value.path)
+    }
+}
diff --git a/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/task/CreateSwiftPackageTask.kt b/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/task/CreateSwiftPackageTask.kt
@@ -10,7 +10,6 @@ internal fun Project.registerCreateSwiftPackageTask() {
         group = "multiplatform-swift-package"
         description = "Creates a Swift package to distribute an XCFramework"
 
-        dependsOn("createXCFramework")
         dependsOn("createZipFile")
 
         doLast {
diff --git a/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/task/CreateXCFrameworkTask.kt b/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/task/CreateXCFrameworkTask.kt
diff --git a/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/task/CreateZipFileTask.kt b/src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/task/CreateZipFileTask.kt
@@ -9,14 +9,15 @@ internal fun Project.registerCreateZipFileTask() {
         setGroup(null) // hide the task from the task list
         description = "Creates a ZIP file containing the XCFramework"
 
-        dependsOn("createXCFramework")
+        dependsOn("copyXCFrameworkFile")
 
         val configuration = getConfigurationOrThrow()
         val outputDirectory = configuration.outputDirectory.value
         archiveFileName.set(configuration.zipFileName.nameWithExtension)
         destinationDirectory.set(outputDirectory)
+
         from(outputDirectory) {
-            include("**/*.xcframework/")
+            include("*.xcframework/")
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -4,11 +4,11 @@ buildscript {`
`4`	`4`	`jcenter()`
`5`	`5`	`}`
`6`	`6`	`dependencies {`
`7`		`- classpath("org.jetbrains.kotlinx:binary-compatibility-validator:0.2.4")`
	`7`	`+ classpath("org.jetbrains.kotlinx:binary-compatibility-validator:0.8.0")`
`8`	`8`	`}`
`9`	`9`	`}`
`10`	`10`
`11`		`-apply(plugin = "binary-compatibility-validator")`
	`11`	`+// apply(plugin = "binary-compatibility-validator")`
`12`	`12`
`13`	`13`	`plugins {`
`14`	`14`	`kotlin-dsl`
`@@ -17,19 +17,19 @@ plugins {`
`17`	`17`	`signing`
`18`	`18`	`}`
`19`	`19`
`20`		`-version = "2.0.3-m1"`
	`20`	`+version = "2.0.3-m1-xcframework"`
`21`	`21`
`22`	`22`	`repositories {`
`23`	`23`	`jcenter()`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`dependencies {`
`27`		`- compileOnly(kotlin("gradle-plugin", "1.5.30"))`
	`27`	`+ compileOnly(kotlin("gradle-plugin", "1.6.10"))`
`28`	`28`	`testImplementation("io.kotest:kotest-runner-junit5:4.3.0")`
`29`	`29`	`testImplementation("io.kotest:kotest-assertions-core:4.3.0")`
`30`	`30`	`testImplementation("io.kotest:kotest-property:4.3.0")`
`31`	`31`	`testImplementation("io.mockk:mockk:1.10.0")`
`32`		`- testImplementation(kotlin("gradle-plugin", "1.5.30"))`
	`32`	`+ testImplementation(kotlin("gradle-plugin", "1.6.10"))`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`java {`
`@@ -103,9 +103,9 @@ publishing {`
`103`	`103`	`}`
`104`	`104`	`}`
`105`	`105`
`106`		`-signing {`
`107`		`- sign(publishing.publications["pluginMaven"])`
`108`		`-}`
	`106`	`+//signing {`
	`107`	`+// sign(publishing.publications["pluginMaven"])`
	`108`	`+//}`
`109`	`109`
`110`	`110`	`tasks.javadoc {`
`111`	`111`	`if (JavaVersion.current().isJava9Compatible) {`
Original file line number	Diff line number	Diff line change
`@@ -40,5 +40,8 @@ private fun List<PluginConfigurationError>.toErrorMessage() = joinToString("\n\n`
`40`	`40`	`PluginConfigurationError.BlankZipFileName -> """`
`41`	`41`	`* ZIP file name must not be blank`
`42`	`42`	`""".trimIndent()`
	`43`	`+ PluginConfigurationError.BlankXCFrameworkName -> """`
	`44`	`+ * XCFramework name must not be blank`
	`45`	`+ """.trimIndent()`
`43`	`46`	`}`
`44`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,14 +9,15 @@ internal fun Project.registerCreateZipFileTask() {`
`9`	`9`	`setGroup(null) // hide the task from the task list`
`10`	`10`	`description = "Creates a ZIP file containing the XCFramework"`
`11`	`11`
`12`		`- dependsOn("createXCFramework")`
	`12`	`+ dependsOn("copyXCFrameworkFile")`
`13`	`13`
`14`	`14`	`val configuration = getConfigurationOrThrow()`
`15`	`15`	`val outputDirectory = configuration.outputDirectory.value`
`16`	`16`	`archiveFileName.set(configuration.zipFileName.nameWithExtension)`
`17`	`17`	`destinationDirectory.set(outputDirectory)`
	`18`	`+`
`18`	`19`	`from(outputDirectory) {`
`19`		`- include("*/.xcframework/")`
	`20`	`+ include("*.xcframework/")`
`20`	`21`	`}`
`21`	`22`	`}`
`22`	`23`	`}`