Merge pull request #108 from icerockdev/develop

Release 0.12.0

Author: Alex009

.github/workflows/compilation-check.yml

@@ -22,3 +22,5 @@ jobs:
         run: ./gradlew -PlibraryPublish detekt :resources:publishToMavenLocal
       - name: Check demo library
         run: ./gradlew detekt :sample:mpp-conditional:build :sample:mpp-hierarhical:build :sample:mpp-library:build :sample:mpp-mixed:build
+      - name: Check tests
+        run: ./gradlew :sample:mpp-hierarhical:check

.github/workflows/ui-tests-android-sample.yml

@@ -20,4 +20,4 @@ jobs:
         uses: reactivecircus/android-emulator-runner@v2
         with:
           api-level: 29
-          script: ./gradlew connectedAndroidTest
+          script: ./gradlew :sample:android-app:connectedAndroidTest

README.md

@@ -48,6 +48,7 @@ This is a Kotlin MultiPlatform library that provides access to the resources on
   - 0.10.1
   - 0.11.0
   - 0.11.1
+  - 0.12.0
 
 ## Installation
 root build.gradle  
@@ -58,7 +59,7 @@ buildscript {
     }
 
     dependencies {
-        classpath "dev.icerock.moko:resources-generator:0.11.1"
+        classpath "dev.icerock.moko:resources-generator:0.12.0"
     }
 }
 
@@ -75,7 +76,7 @@ project build.gradle
 apply plugin: "dev.icerock.mobile.multiplatform-resources"
 
 dependencies {
-    commonMainApi("dev.icerock.moko:resources:0.11.1")
+    commonMainApi("dev.icerock.moko:resources:0.12.0")
 }
 
 multiplatformResources {
@@ -95,6 +96,26 @@ ios-app Info.plist:
 ```
 in array should be added all used languages.
 
+### Static kotlin frameworks support
+If project configured with static framework output (for example by `org.jetbrains.kotlin.native.cocoapods` plugin)
+ in Xcode project should be added `Build Phase` (at end of list) with script:
+```shell script
+"$SRCROOT/../gradlew" -p "$SRCROOT/../" :yourframeworkproject:copyFrameworkResourcesToApp \
+    -Pmoko.resources.PLATFORM_NAME=$PLATFORM_NAME \
+    -Pmoko.resources.CONFIGURATION=$CONFIGURATION \
+    -Pmoko.resources.BUILT_PRODUCTS_DIR=$BUILT_PRODUCTS_DIR \
+    -Pmoko.resources.CONTENTS_FOLDER_PATH=$CONTENTS_FOLDER_PATH
+```
+Please replace `:yourframeworkproject` to kotlin project gradle path, and set correct relative path (`$SRCROOT/../` in example).  
+This phase will copy resources into application, because static frameworks can't have resources.
+
+To disable warnings about static framework in gradle set flag:
+```kotlin
+multiplatformResources {
+    disableStaticFrameworkWarning = true
+}
+```
+
 ## Usage
 ### Example 1 - simple localization string
 The first step is a create a file `strings.xml` in `commonMain/resources/MR/base` with the following content:
@@ -335,6 +356,9 @@ Then just launch task:
 ## Samples
 Please see more examples in the [sample directory](sample).
 
+Sample `mpp-hierarhical` contains usage of `org.jetbrains.kotlin.native.cocoapods` plugin and unit
+ tests with resources usage. 
+
 ## Set Up Locally 
 - The [resources directory](resources) contains the `resources` library;
 - The [gradle-plugin directory](gradle-plugin) contains a gradle plugin with a `MR` class generator;

buildSrc/src/main/kotlin/Versions.kt

@@ -12,7 +12,7 @@ object Versions {
     const val kotlin = "1.3.72"
     const val detekt = "1.7.4"
 
-    private const val mokoResources = "0.11.1"
+    private const val mokoResources = "0.12.0"
 
     object Plugins {
         const val android = "3.6.2"

gradle-plugin/src/main/kotlin/dev/icerock/gradle/MultiplatformResourcesPlugin.kt

@@ -10,7 +10,6 @@ import com.android.build.gradle.api.AndroidSourceSet
 import dev.icerock.gradle.generator.ColorsGenerator
 import dev.icerock.gradle.generator.FilesGenerator
 import dev.icerock.gradle.generator.FontsGenerator
-import dev.icerock.gradle.generator.GenerateMultiplatformResourcesTask
 import dev.icerock.gradle.generator.ImagesGenerator
 import dev.icerock.gradle.generator.MRGenerator
 import dev.icerock.gradle.generator.PluralsGenerator
@@ -20,6 +19,7 @@ import dev.icerock.gradle.generator.StringsGenerator
 import dev.icerock.gradle.generator.android.AndroidMRGenerator
 import dev.icerock.gradle.generator.common.CommonMRGenerator
 import dev.icerock.gradle.generator.ios.IosMRGenerator
+import dev.icerock.gradle.tasks.GenerateMultiplatformResourcesTask
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.tasks.SourceSet
@@ -67,7 +67,8 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
         multiplatformExtension: KotlinMultiplatformExtension,
         androidExtension: LibraryExtension
     ) {
-        val androidMainSourceSet = androidExtension.sourceSets.getByName(SourceSet.MAIN_SOURCE_SET_NAME)
+        val androidMainSourceSet =
+            androidExtension.sourceSets.getByName(SourceSet.MAIN_SOURCE_SET_NAME)
 
         val commonSourceSet = multiplatformExtension.sourceSets.getByName(mrExtension.sourceSetName)
         val commonResources = commonSourceSet.resources
@@ -95,8 +96,15 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
         val targets: List<KotlinTarget> = multiplatformExtension.targets.toList()
 
         setupCommonGenerator(commonSourceSet, generatedDir, mrClassPackage, features, target)
-        setupAndroidGenerator(targets, androidMainSourceSet, generatedDir, mrClassPackage, features, target)
-        if(HostManager.hostIsMac) {
+        setupAndroidGenerator(
+            targets,
+            androidMainSourceSet,
+            generatedDir,
+            mrClassPackage,
+            features,
+            target
+        )
+        if (HostManager.hostIsMac) {
             setupIosGenerator(
                 targets,
                 generatedDir,
@@ -146,7 +154,8 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
             .filterNot { it.name.endsWith("Test") } // remove tests compilations
             .map { it.defaultSourceSet }
 
-        val androidSourceSet: MRGenerator.SourceSet = createSourceSet(androidMainSourceSet, kotlinSourceSets)
+        val androidSourceSet: MRGenerator.SourceSet =
+            createSourceSet(androidMainSourceSet, kotlinSourceSets)
         AndroidMRGenerator(
             generatedDir,
             androidSourceSet,

gradle-plugin/src/main/kotlin/dev/icerock/gradle/MultiplatformResourcesPluginExtension.kt

@@ -11,4 +11,5 @@ open class MultiplatformResourcesPluginExtension {
     var multiplatformResourcesSourceSet: String? = null
     var iosBaseLocalizationRegion: String = "en"
     val sourceSetName: String get() = multiplatformResourcesSourceSet ?: KotlinSourceSet.COMMON_MAIN_SOURCE_SET_NAME
+    var disableStaticFrameworkWarning = false
 }

gradle-plugin/src/main/kotlin/dev/icerock/gradle/generator/ColorsGenerator.kt

@@ -72,6 +72,17 @@ abstract class ColorsGenerator(
 
     private fun parseColors(): List<ColorNode> {
         val colorNodes = mutableListOf<ColorNode>()
+        val colorValues = mutableMapOf<String, String>()
+
+        fun getColor(color: String?): String?  {
+            return if (color?.startsWith(XmlColorReferencePrefix) == true) {
+                val colorName = color.replace(XmlColorReferencePrefix, "")
+                colorValues[colorName]
+            } else {
+                color
+            }
+        }
+
         colorsFileTree.map { file ->
             val dbFactory = DocumentBuilderFactory.newInstance()
             val dBuilder = dbFactory.newDocumentBuilder()
@@ -96,10 +107,15 @@ abstract class ColorsGenerator(
                         }
                         else -> {
                             singleColor = xmlNode.textContent
+                            singleColor?.let {
+                                if (!it.startsWith(XmlColorReferencePrefix)) {
+                                    colorValues[colorName] = it
+                                }
+                            }
                         }
                     }
                 }
-                colorNodes.add(ColorNode(colorName, lightColor, darkColor, singleColor))
+                colorNodes.add(ColorNode(colorName, getColor(lightColor), getColor(darkColor), getColor(singleColor)))
             }
         }
 
@@ -139,6 +155,7 @@ abstract class ColorsGenerator(
     companion object {
         internal const val XmlColorTag = "color"
         internal const val XmlNodeAttrColorName = "name"
+        internal const val XmlColorReferencePrefix = "@color/"
     }
 }
 

gradle-plugin/src/main/kotlin/dev/icerock/gradle/generator/MRGenerator.kt

@@ -9,6 +9,7 @@ import com.squareup.kotlinpoet.FileSpec
 import com.squareup.kotlinpoet.KModifier
 import com.squareup.kotlinpoet.ParameterizedTypeName.Companion.parameterizedBy
 import com.squareup.kotlinpoet.TypeSpec
+import dev.icerock.gradle.tasks.GenerateMultiplatformResourcesTask
 import org.gradle.api.Project
 import org.gradle.api.Task
 import java.io.File
@@ -43,7 +44,8 @@ abstract class MRGenerator(
         generators.forEach { generator ->
             val builder = TypeSpec.objectBuilder(generator.mrObjectName)
 
-            val fileResourceInterfaceClassName = ClassName("dev.icerock.moko.resources", "ResourceContainer")
+            val fileResourceInterfaceClassName =
+                ClassName("dev.icerock.moko.resources", "ResourceContainer")
             builder.addSuperinterface(fileResourceInterfaceClassName.parameterizedBy(generator.resourceClassName))
 
             mrClassSpec.addType(generator.generate(resourcesGenerationDir, builder))
@@ -72,7 +74,10 @@ abstract class MRGenerator(
         val genTaskName = "generateMR$name"
         val genTask = runCatching {
             project.tasks.getByName(genTaskName)
-        }.getOrNull() ?: project.tasks.create(genTaskName, GenerateMultiplatformResourcesTask::class.java) {
+        }.getOrNull() ?: project.tasks.create(
+            genTaskName,
+            GenerateMultiplatformResourcesTask::class.java
+        ) {
             doLast {
                 this@MRGenerator.generate()
             }

gradle-plugin/src/main/kotlin/dev/icerock/gradle/generator/android/AndroidColorsGenerator.kt

@@ -54,9 +54,6 @@ class AndroidColorsGenerator(
             buildColorString(colorNode.name, replaceColorAlpha(colorNode.darkColor))
         }
 
-        println("defaultContent = $defaultContent")
-        println("darkContent = $darkContent")
-
         defaultStringsFile.writeText(header + "\n")
         defaultStringsFile.appendText(defaultContent)
         defaultStringsFile.appendText("\n" + footer)

gradle-plugin/src/main/kotlin/dev/icerock/gradle/generator/ios/IosMRGenerator.kt

@@ -9,14 +9,19 @@ import com.squareup.kotlinpoet.CodeBlock
 import com.squareup.kotlinpoet.KModifier
 import com.squareup.kotlinpoet.PropertySpec
 import com.squareup.kotlinpoet.TypeSpec
+import dev.icerock.gradle.MultiplatformResourcesPluginExtension
 import dev.icerock.gradle.generator.MRGenerator
+import dev.icerock.gradle.tasks.CopyFrameworkResourcesToAppEntryPointTask
+import dev.icerock.gradle.tasks.CopyFrameworkResourcesToAppTask
 import org.gradle.api.Project
 import org.gradle.api.Task
 import org.gradle.kotlin.dsl.support.unzipTo
 import org.jetbrains.kotlin.gradle.plugin.mpp.AbstractKotlinNativeCompilation
 import org.jetbrains.kotlin.gradle.plugin.mpp.Framework
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
+import org.jetbrains.kotlin.gradle.plugin.mpp.TestExecutable
 import org.jetbrains.kotlin.gradle.tasks.KotlinNativeCompile
+import org.jetbrains.kotlin.gradle.tasks.KotlinNativeLink
 import org.jetbrains.kotlin.konan.file.zipDirAs
 import org.jetbrains.kotlin.library.impl.KotlinLibraryLayoutImpl
 import java.io.File
@@ -65,6 +70,7 @@ class IosMRGenerator(
     override fun apply(generationTask: Task, project: Project) {
         setupKLibResources(generationTask)
         setupFrameworkResources()
+        setupTestsResources()
     }
 
     override fun beforeMRGeneration() {
@@ -131,6 +137,7 @@ class IosMRGenerator(
 
     private fun setupFrameworkResources() {
         val kotlinNativeTarget = compilation.target as KotlinNativeTarget
+        val project = kotlinNativeTarget.project
 
         kotlinNativeTarget.binaries
             .matching { it is Framework && it.compilation == compilation }
@@ -140,17 +147,90 @@ class IosMRGenerator(
                 val linkTask = framework.linkTask
 
                 linkTask.doLast {
-                    linkTask.libraries
-                        .plus(linkTask.intermediateLibrary.get())
-                        .filter { it.extension == "klib" }
-                        .forEach {
-                            project.logger.info("copy resources from $it")
-                            val klibKonan = org.jetbrains.kotlin.konan.file.File(it.path)
-                            val klib = KotlinLibraryLayoutImpl(klibKonan)
-                            val layout = klib.extractingToTemp
-
-                            File(layout.resourcesDir.path).copyRecursively(framework.outputFile, overwrite = true)
-                        }
+                    copyKlibsResourcesIntoFramework(linkTask)
+                }
+
+                if (framework.isStatic) {
+                    val resourcesExtension =
+                        project.extensions.getByType(MultiplatformResourcesPluginExtension::class.java)
+                    if (resourcesExtension.disableStaticFrameworkWarning.not()) {
+                        project.logger.warn("$linkTask produces static framework, Xcode should have Build Phase with copyFrameworkResourcesToApp gradle task call. Please read readme on https://github.com/icerockdev/moko-resources")
+                    }
+                    createCopyFrameworkResourcesTask(linkTask)
+                }
+            }
+    }
+
+    private fun copyKlibsResourcesIntoFramework(linkTask: KotlinNativeLink) {
+        val project = linkTask.project
+        val framework = linkTask.binary as Framework
+
+        copyResourcesFromLibraries(
+            linkTask = linkTask,
+            project = project,
+            outputDir = framework.outputFile
+        )
+    }
+
+    private fun copyResourcesFromLibraries(
+        linkTask: KotlinNativeLink,
+        project: Project,
+        outputDir: File
+    ) {
+        linkTask.libraries
+            .plus(linkTask.intermediateLibrary.get())
+            .filter { it.extension == "klib" }
+            .forEach {
+                project.logger.info("copy resources from $it into $outputDir")
+                val klibKonan = org.jetbrains.kotlin.konan.file.File(it.path)
+                val klib = KotlinLibraryLayoutImpl(klibKonan)
+                val layout = klib.extractingToTemp
+
+                File(layout.resourcesDir.path).copyRecursively(
+                    target = outputDir,
+                    overwrite = true
+                )
+            }
+    }
+
+    private fun createCopyFrameworkResourcesTask(linkTask: KotlinNativeLink) {
+        val framework = linkTask.binary as Framework
+        val project = linkTask.project
+        val taskName = linkTask.name.replace("link", "copyResources")
+
+        val copyTask = project.tasks.create(taskName, CopyFrameworkResourcesToAppTask::class.java) {
+            this.framework = framework
+        }
+        copyTask.dependsOn(linkTask)
+
+        val xcodeTask = project.tasks.maybeCreate(
+            "copyFrameworkResourcesToApp",
+            CopyFrameworkResourcesToAppEntryPointTask::class.java
+        )
+
+        if (framework.target.konanTarget == xcodeTask.konanTarget &&
+            framework.buildType.getName() == xcodeTask.configuration
+        ) {
+            xcodeTask.dependsOn(copyTask)
+        }
+    }
+
+    private fun setupTestsResources() {
+        val kotlinNativeTarget = compilation.target as KotlinNativeTarget
+        val project = kotlinNativeTarget.project
+
+        kotlinNativeTarget.binaries
+            .matching { it is TestExecutable && it.compilation.associateWith.contains(compilation) }
+            .configureEach {
+                val executable = this as TestExecutable
+
+                val linkTask = executable.linkTask
+                linkTask.doLast {
+                    copyResourcesFromLibraries(
+                        linkTask = linkTask,
+                        project = project,
+                        outputDir = executable.outputDirectory
+                    )
                 }
             }
     }