Merge pull request #60 from touchlab/kpg/spm_local_dev

Kpg/spm local dev

Author: kpgalligan

docs/IOS_DEV_SETUP.md

@@ -2,7 +2,7 @@
 
 To use the published Xcode Framework, you'll need to integrate it into your Xcode project. You'll also need to understand how to add authentication information, if required by your artifact storage.
 
-For developers editing Kotlin, you will want to test locally-built Kotlin code directly in your Xcode project from time to time. How that works differs depending on which dependency manager you use. For Cocoapods see  [IOS_LOCAL_DEV_COCOAPODS](IOS_LOCAL_DEV_COCOAPODS.md). For SPM see  [IOS_LOCAL_DEV_SPM](IOS_LOCAL_DEV_SPM.md).
+For developers editing Kotlin, you will want to test locally-built Kotlin code directly in your Xcode project from time to time. How that works differs depending on which dependency manager you use. For Cocoapods see  [IOS_LOCAL_DEV_COCOAPODS](IOS_LOCAL_DEV_COCOAPODS.md). For SPM see   [IOS_SPM_DEV](IOS_SPM_DEV.md).
 
 ## Private Github Releases
 
@@ -18,6 +18,4 @@ If you are using private Github artifacts, you'll need to add auth info for that
 
 ## Using SPM
 
-* Add Packages, use GIthub
-* Select "Up to next major version"
-
+See [IOS_SPM_DEV](IOS_SPM_DEV.md).

docs/IOS_SPM_DEV.md

@@ -0,0 +1,96 @@
+# Using Swift Pacakge Manager
+
+Swift Package Manager is a newer dependency manager directly from Apple. In some ways it's more integrated into Xcode, but is also less flexible than Cocoapods. Much of that seems by design, as it's very difficult to introduce side effects into the `Package.swift` build scripts. While that is likely to result in more reliable builds for the average Xcode project, for Kotlin builds, that means some more manual processes at present.
+
+Out of the box, the Kotlin tools are far less integrated into SPM. We have some basic support for SPM development, but this is a work in progress. Feedback welcome.
+
+## Kotlin Project Configuration
+
+After setting up KMM Bridge in your Kotlin project, you should configure SPM for library publishing. Generally speaking, SPM wants to have the `Package.swift` file in the root of the repo. Xcode and SPM use git repos as an organizational and discovery unit. The `Package.swift` file goes in the root, and Xcode clones from Github (or others) to read info about the library and source code.
+
+If you don't have a `Package.swift` file, or don't know how to set one up, that's OK. KMM Bridge currently generates these files for you.
+
+> Note: If you'd prefer, or need to, manage your own `Package.swift` file, please reach out. An earlier version of the plugin modified the file rather than replacing it. We may add that feature back after KMM Bridge is more stable.
+
+In the `kmmbridge` block, add `spm()`, and point the parameter to the root folder of your repo.
+
+```kotlin
+kmmbridge {
+    spm("..")
+    // Other config...
+}
+```
+
+In the example above, the Kotlin module is one folder down, so we add the parent path string `..`
+
+![spmfolder](https://tl-navigator-images.s3.us-east-1.amazonaws.com/docimages/2022-10-06_06-43-spmfolder.png)
+
+SPM uses git for versioning, so you'll want to use either git tag or Github release version managers, and likely want to use Github artifacts.
+
+Here is the suggested config for SPM:
+
+```kotlin
+kmmbridge {
+    githubReleaseArtifacts()
+    githubReleaseVersions()
+    versionPrefix.set("0.1")
+    spm("..")
+}
+```
+
+Once this is all set up, run a build so you have at least one version available.
+
+## Xcode Configuration
+
+Open or create an Xcode project. To add an SPM package, go to `File > Add Packages` in the Xcode menu. Add your source control account (presumably Github). You can usually browse for the package at that point, but depending on how many repos you have, it may be easier to copy/paste the repo URL in the top/right search bar. After finding the package, you should generally add the pacakge by version ("Up to Next Major Version" suggested).
+
+![addpackages](https://tl-navigator-images.s3.us-east-1.amazonaws.com/docimages/2022-10-06_06-57-addpackages.png)
+
+Once added, you should be able to import the Kotlin module into Swift/Objc files and build!
+
+![import](https://tl-navigator-images.s3.us-east-1.amazonaws.com/docimages/2022-10-06_07-00-import.png)
+
+## Updating Builds
+
+Run the KMM Bridge build again. It should automatically create another build version and publish that to the Github repo. In Xcode, you can update your imported version by right-clicking on the module and selecting "Update Package":
+
+![updatepackage](https://tl-navigator-images.s3.us-east-1.amazonaws.com/docimages/2022-10-06_07-04-updatepackage.png)
+
+![updatepackagedone](https://tl-navigator-images.s3.us-east-1.amazonaws.com/docimages/2022-10-06_07-17-updatepackagedone.png)
+
+## SPM Local Dev Flow
+
+***Experimental:*** *While all of KMM Bridge is relatively new, the SPM dev flow is very experimental. The most likely issues with be path resolutions.*
+
+If you are editing the Kotlin code, you will periodically want to test your local edits directly in Xcode.
+
+> As mentioned, SPM is not really integrated out of the box with Kotlin, and SPM itself does not make integrations easy (generally speaking). We have some support for local dev flow, but we are looking for feedback and improvements.
+
+Since KMM Bridge is generating your `Package.swift` files, the first step is to run a dev build step to build the local dev `Package.swift` and locally build a debug version of the Kotlin code.
+
+```shell
+./gradlew spmDevBuild
+```
+
+This should:
+
+* Build a debug version of the XCFramework
+* Write a local dev path to `Package.swift`
+
+Next, you need to manually copy the whole Kotlin project into Xcode. That means, quite liteally, drag the Kotlin project's folder into Xcode.
+
+<video src="dragspm.mp4"></video>
+
+In the sample above, the pacakge `allshared` is inside `KevsKmmTest`. When you drag it in, if Xcode properly recognizes it, you'll see `allshared` disappear, but when you build, things should work as expected.
+
+When you are done build, select the folder you dragged in, and remove it by right-clicking it and selecting "Delete". Make sure to select "Remove References" on the popup. Xcode should then reload the version you had previously.
+
+<video src="removelocal.mp4"></video>
+
+When you run `spmDevBuild`, it will build all architectures, which you probably don't need for testing on a simulator. To restrict architectures when building, you can pass in a Gradle param.
+
+```shell
+./gradlew spmDevBuild -PspmBuildTargets=ios_x64
+```
+
+For Intel Macs, use `ios_x64`. For arm Macs, use `ios_simulator_arm64`. You can pass in multiple architectures by separating them with commas.

docs/dragspm.mp4

@@ -12,7 +12,7 @@ android.useAndroidX=true
 org.gradle.jvmargs=-Xmx2g
 
 GROUP=co.touchlab.faktory
-VERSION_NAME=0.1.16-SNAPSHOT
+VERSION_NAME=0.1.17-SNAPSHOT
 KOTLIN_VERSION=1.6.21
 
 POM_URL=https://github.com/touchlab/KMMBridge

docs/removelocal.mp4

@@ -163,6 +163,8 @@ class KMMBridgePlugin : Plugin<Project> {
         val extension = extensions.getByType<KmmBridgeExtension>()
         var xcFrameworkConfig: XCFrameworkConfig? = null
 
+        val spmBuildTargets: Set<String> = project.spmBuildTargets?.split(",")?.map { it.trim() }?.filter { it.isNotEmpty() }?.toSet() ?: emptySet()
+
         kotlin.targets
             .withType<KotlinNativeTarget>()
             .filter { it.konanTarget.family.isAppleFamily }
@@ -177,26 +179,16 @@ class KMMBridgePlugin : Plugin<Project> {
                         throw IllegalStateException("Only one framework name currently allowed. Found $currentName and $theName")
                     }
                 }
-                if (xcFrameworkConfig == null) {
-                    xcFrameworkConfig = XCFramework(theName)
+                val shouldAddTarget = spmBuildTargets.isEmpty() || spmBuildTargets.contains(framework.target.konanTarget.name)
+                if(shouldAddTarget) {
+                    if (xcFrameworkConfig == null) {
+                        xcFrameworkConfig = XCFramework(theName)
+                    }
+                    xcFrameworkConfig!!.add(framework)
                 }
-                xcFrameworkConfig!!.add(framework)
             }
     }
 
-    private fun Project.findXCFrameworkAssembleTask(): Task {
-        val extension = extensions.getByType<KmmBridgeExtension>()
-        val name = extension.frameworkName.get()
-        val buildTypeString = extension.buildType.get().getName().capitalize()
-        val taskWithoutName = "assemble${buildTypeString}XCFramework"
-        val taskWithName = "assemble${name.capitalize()}${buildTypeString}XCFramework"
-        return try {
-            tasks.findByName(taskWithName) ?: tasks.findByPath(taskWithoutName)!!
-        } catch (e: Exception) {
-            throw UnknownTaskException("Cannot find XCFramework assemble task. Tried ${taskWithName} and ${taskWithoutName}.")
-        }
-    }
-
     private fun Project.configureDeploy() {
         val extension = extensions.getByType<KmmBridgeExtension>()
 
@@ -248,3 +240,16 @@ class KMMBridgePlugin : Plugin<Project> {
     }
 }
 
+internal fun Project.findXCFrameworkAssembleTask(buildType: NativeBuildType? = null): Task {
+    val extension = extensions.getByType<KmmBridgeExtension>()
+    val name = extension.frameworkName.get()
+    val buildTypeString = (buildType ?: extension.buildType.get()).getName().capitalize()
+    val taskWithoutName = "assemble${buildTypeString}XCFramework"
+    val taskWithName = "assemble${name.capitalize()}${buildTypeString}XCFramework"
+    return try {
+        tasks.findByName(taskWithName) ?: tasks.findByPath(taskWithoutName)!!
+    } catch (e: Exception) {
+        throw UnknownTaskException("Cannot find XCFramework assemble task. Tried ${taskWithName} and ${taskWithoutName}.")
+    }
+}
+

gradle.properties

@@ -27,6 +27,9 @@ internal val Project.githubRepo
     get() = (project.findStringProperty("GITHUB_REPO")
         ?: throw IllegalArgumentException("KMM Bridge Github operations need a repo param or property GITHUB_REPO"))
 
+internal val Project.spmBuildTargets: String?
+    get() = project.findStringProperty("spmBuildTargets")
+
 internal fun Project.zipFilePath(): File {
     val tempDir = file("$buildDir/faktory/zip")
     val artifactName = "frameworkarchive.zip"

kmmbridge/src/main/kotlin/KMMBridge.kt

@@ -3,6 +3,7 @@ package co.touchlab.faktory
 import co.touchlab.faktory.internal.procRunFailLog
 import org.gradle.api.Project
 import org.gradle.api.Task
+import org.jetbrains.kotlin.gradle.plugin.mpp.NativeBuildType
 import java.io.ByteArrayOutputStream
 import java.io.File
 import java.nio.charset.Charset
@@ -39,6 +40,12 @@ class SpmDependencyManager(
 
         updatePackageSwiftTask.dependsOn(uploadTask)
         publishRemoteTask.dependsOn(updatePackageSwiftTask)
+
+        project.task("spmDevBuild") {
+            group = TASK_GROUP_NAME
+            dependsOn(project.findXCFrameworkAssembleTask(NativeBuildType.DEBUG))
+            project.writePackageFile(makeLocalDevPackageFileText(packageName, project))
+        }
     }
 
     private fun Project.writePackageFile(packageName: String, url: String, checksum: String){
@@ -90,6 +97,40 @@ internal fun stripEndSlash(path: String): String {
     }
 }
 
+private fun makeLocalDevPackageFileText(packageName: String, project: Project): String {
+    val extension = project.kmmBridgeExtension
+
+    val xcFrameworkPath = extension.xcFrameworkPath.getOrElse("${project.projectDir.name}/build/XCFrameworks/${NativeBuildType.DEBUG.getName()}")
+    val packageFileString = """
+// swift-tools-version:5.3
+import PackageDescription
+
+let packageName = "$packageName"
+
+let package = Package(
+    name: packageName,
+    platforms: [
+        .iOS(.v13)
+    ],
+    products: [
+        .library(
+            name: packageName,
+            targets: [packageName]
+        ),
+    ],
+    targets: [
+        .binaryTarget(
+            name: packageName,
+            path: "./${xcFrameworkPath}/\(packageName).xcframework"
+        )
+        ,
+    ]
+)
+""".trimIndent()
+
+    return packageFileString
+}
+
 private fun makePackageFileText(packageName: String, url:String, checksum: String): String = """
 // swift-tools-version:5.3
 import PackageDescription