Fix frameworks cannot be detected for some project configurations (#9)

Fixes #8

Author: ge-org

CHANGELOG.md

@@ -6,7 +6,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-tbd
+### Fixed
+- Fix a bug where the plugin was not able to detect the frameworks for some project configurations
+[#8](https://github.com/ge-org/multiplatform-swiftpackage/issues/8)
 
 ## [2.0.1]
 ### Changed

src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/AppleFramework.kt

@@ -0,0 +1,33 @@
+package com.chromaticnoise.multiplatformswiftpackage.domain
+
+import org.jetbrains.kotlin.gradle.plugin.mpp.NativeBinary
+import java.io.File
+
+internal class AppleFramework(
+    val outputFile: AppleFrameworkOutputFile,
+    val name: AppleFrameworkName,
+    val linkTask: AppleFrameworkLinkTask
+) {
+
+    val dsymFile: File get() = File(outputFile.parent, "${name.value}.framework.dSYM")
+
+    internal companion object
+}
+
+internal fun AppleFramework.Companion.of(binary: NativeBinary?): AppleFramework? = binary?.let {
+    AppleFramework(
+        AppleFrameworkOutputFile(it.outputFile),
+        AppleFrameworkName(it.baseName),
+        AppleFrameworkLinkTask(it.linkTaskName)
+    )
+}
+
+internal data class AppleFrameworkOutputFile(private val file: File) {
+    val path: String get() = file.path
+
+    val parent: File get() = file.parentFile
+}
+
+internal data class AppleFrameworkName(val value: String)
+
+internal data class AppleFrameworkLinkTask(val name: String)

src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/AppleTarget.kt

@@ -1,14 +1,20 @@
 package com.chromaticnoise.multiplatformswiftpackage.domain
 
 import org.jetbrains.kotlin.gradle.plugin.KotlinTarget
-import org.jetbrains.kotlin.gradle.plugin.mpp.Framework
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
+import org.jetbrains.kotlin.gradle.plugin.mpp.NativeBinary
+import org.jetbrains.kotlin.gradle.plugin.mpp.NativeOutputKind
+import java.io.File
 
 internal class AppleTarget private constructor(val nativeTarget: KotlinNativeTarget) {
 
-    internal fun framework(buildConfiguration: BuildConfiguration): Framework? =
+    internal fun getFramework(buildConfiguration: BuildConfiguration): AppleFramework? =
         try {
-            nativeTarget.binaries.getFramework(buildConfiguration.name)
+            val nativeBinary = nativeTarget.binaries.find { binary ->
+                binary.buildType.getName().equals(buildConfiguration.name, ignoreCase = true) &&
+                    binary.outputKind == NativeOutputKind.FRAMEWORK
+            }
+            AppleFramework.of(nativeBinary)
         } catch (_: Exception) { null }
 
     internal companion object {

src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/BuildConfiguration.kt

@@ -1,13 +1,15 @@
 package com.chromaticnoise.multiplatformswiftpackage.domain
 
+import org.jetbrains.kotlin.gradle.plugin.mpp.NativeBuildType
+
 internal sealed class BuildConfiguration {
     internal object Release : BuildConfiguration()
     internal object Debug : BuildConfiguration()
     internal data class Custom(val configurationName: String) : BuildConfiguration()
 
     val name get() = when(this) {
-        Release -> "RELEASE"
-        Debug -> "DEBUG"
+        Release -> NativeBuildType.RELEASE.getName()
+        Debug -> NativeBuildType.DEBUG.getName()
         is Custom -> configurationName
     }
 }

src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/PluginConfiguration.kt

@@ -56,8 +56,8 @@ internal class PluginConfiguration private constructor(
         }
 
         private fun SwiftPackageExtension.getPackageName(): Either<PluginConfigurationError, PackageName> = packageName
-            ?: appleTargets.getFrameworks(buildConfiguration).firstOrNull()?.let { framework ->
-                PackageName.of(framework.baseName)
+            ?: appleTargets.map { it.getFramework(buildConfiguration) }.firstOrNull()?.let { framework ->
+                PackageName.of(framework.name.value)
             } ?: Either.Left(InvalidPackageName(null))
     }
 

src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/extensions.kt

@@ -1,7 +1,6 @@
 package com.chromaticnoise.multiplatformswiftpackage.domain
 
 import org.gradle.api.Action
-import org.jetbrains.kotlin.gradle.plugin.mpp.Framework
 import org.jetbrains.kotlin.konan.target.Family
 import org.jetbrains.kotlin.konan.target.KonanTarget
 
@@ -35,8 +34,3 @@ internal val TargetName.konanTarget: KonanTarget get() = when (this) {
     TargetName.TvOSx64 -> KonanTarget.TVOS_X64
     TargetName.MacOSx64 -> KonanTarget.MACOS_X64
 }
-
-internal fun Collection<AppleTarget>.getFrameworks(buildConfiguration: BuildConfiguration): Collection<Framework> =
-    mapNotNull { target ->
-        target.framework(buildConfiguration)
-    }

src/main/kotlin/com/chromaticnoise/multiplatformswiftpackage/task/CreateXCFrameworkTask.kt

@@ -1,7 +1,6 @@
 package com.chromaticnoise.multiplatformswiftpackage.task
 
 import com.chromaticnoise.multiplatformswiftpackage.domain.getConfigurationOrThrow
-import com.chromaticnoise.multiplatformswiftpackage.domain.getFrameworks
 import org.gradle.api.Project
 import org.gradle.api.tasks.Exec
 import java.io.File
@@ -12,9 +11,9 @@ internal fun Project.registerCreateXCFrameworkTask() = tasks.register("createXCF
 
     val configuration = getConfigurationOrThrow()
     val xcFrameworkDestination = File(configuration.outputDirectory.value, "${configuration.packageName.value}.xcframework")
-    val frameworks = configuration.appleTargets.getFrameworks(configuration.buildConfiguration)
+    val frameworks = configuration.appleTargets.mapNotNull { it.getFramework(configuration.buildConfiguration) }
 
-    dependsOn(frameworks.map { it.linkTaskName })
+    dependsOn(frameworks.map { it.linkTask.name })
 
     executable = "xcodebuild"
     args(mutableListOf<String>().apply {
@@ -25,8 +24,7 @@ internal fun Project.registerCreateXCFrameworkTask() = tasks.register("createXCF
             add("-framework")
             add(framework.outputFile.path)
 
-            val dsymFile = File(framework.outputFile.parent, "${framework.baseName}.framework.dSYM")
-            if (dsymFile.exists()) {
+            framework.dsymFile.takeIf { it.exists() }?.let { dsymFile ->
                 add("-debug-symbols")
                 add(dsymFile.path)
             }

src/test/kotlin/com/chromaticnoise/multiplatformswiftpackage/domain/PluginConfigurationTest.kt

@@ -8,7 +8,6 @@ import io.kotest.matchers.shouldBe
 import io.mockk.every
 import io.mockk.mockk
 import org.gradle.api.Project
-import org.jetbrains.kotlin.gradle.plugin.mpp.Framework
 import java.io.File
 
 class PluginConfigurationTest : BehaviorSpec() {
@@ -71,11 +70,11 @@ class PluginConfigurationTest : BehaviorSpec() {
 
             When("the package name is null and apple frameworks exist") {
                 val expectedName = "expected name"
-                val framework = mockk<Framework> { every { baseName } returns expectedName }
+                val framework = AppleFramework(AppleFrameworkOutputFile(mockk()), AppleFrameworkName(expectedName), AppleFrameworkLinkTask(""))
                 extension.swiftToolsVersion = SwiftToolVersion.of("42")
                 extension.packageName = null
                 extension.appleTargets = listOf(
-                    mockk { every { framework(any()) } returns framework }
+                    mockk { every { getFramework(any()) } returns framework }
                 )
 
                 Then("the base name of the first framework should be used") {