Merge pull request #143 from icerockdev/develop

Release 0.14.0

Author: Alex009

README.md

@@ -17,7 +17,9 @@ This is a Kotlin MultiPlatform library that provides access to the resources on
 
 ## Features
 - **Strings, Plurals, Images, Fonts, Files** to access the corresponding resources from common code;
+- **Colors** with light/dark mode support;
 - **StringDesc** for lifecycle-aware access to resources and unified localization on both platforms;
+- **Static** iOS frameworks support;
 - **FatFrameworkWithResourcesTask** Gradle task.
 
 ## Requirements
@@ -54,6 +56,7 @@ This is a Kotlin MultiPlatform library that provides access to the resources on
   - 0.13.1
 - kotlin 1.4.21
   - 0.13.2
+  - 0.14.0
 
 ## Installation
 root build.gradle  
@@ -64,7 +67,7 @@ buildscript {
     }
 
     dependencies {
-        classpath "dev.icerock.moko:resources-generator:0.13.2"
+        classpath "dev.icerock.moko:resources-generator:0.14.0"
     }
 }
 
@@ -81,7 +84,7 @@ project build.gradle
 apply plugin: "dev.icerock.mobile.multiplatform-resources"
 
 dependencies {
-    commonMainApi("dev.icerock.moko:resources:0.13.2")
+    commonMainApi("dev.icerock.moko:resources:0.14.0")
 }
 
 multiplatformResources {
@@ -121,6 +124,28 @@ multiplatformResources {
 }
 ```
 
+#### With Pods dependencies in Kotlin
+When you use `org.jetbrains.kotlin.native.cocoapods` plugin and also kotlin module depends to Pods -
+ you also need to pass extra properties:
+```shell script
+"$SRCROOT/../gradlew" -p "$SRCROOT/../" :shared: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\
+    -Pkotlin.native.cocoapods.target=$KOTLIN_TARGET \
+    -Pkotlin.native.cocoapods.configuration=$CONFIGURATION \
+    -Pkotlin.native.cocoapods.cflags="$OTHER_CFLAGS" \
+    -Pkotlin.native.cocoapods.paths.headers="$HEADER_SEARCH_PATHS" \
+    -Pkotlin.native.cocoapods.paths.frameworks="$FRAMEWORK_SEARCH_PATHS"
+```
+and setup extra build settings in your xcode target:
+```
+'KOTLIN_TARGET[sdk=iphonesimulator*]' => 'ios_x64'
+'KOTLIN_TARGET[sdk=iphoneos*]' => 'ios_arm64'
+```
+[here example of changes](https://github.com/ln-12/moko-resources-issue-99/pull/2/files)
+
 ## 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:
@@ -154,6 +179,33 @@ let string = getMyString().localized()
 ```
 Note: `StringDesc` is a multiple-source container for Strings: in StringDesc we can use a resource, plurals, formatted variants, or raw string. To convert `StringDesc` to `String` on Android call `toString(context)` (a context is required for the resources usage), on iOS - call `localized()`. 
 
+#### MR directly from native side
+Android:
+```kotlin
+val string = MR.strings.my_string.desc().toString(context = this)
+``` 
+iOS:
+```swift
+let string = MR.strings.my_string.desc().localized()
+```
+
+#### Get resourceId for Jetpack Compose / SwiftUI
+Android:
+```kotlin
+val resId = MR.strings.my_string.resourceId
+```
+for example in Compose:
+```kotlin
+text = stringResource(id = MR.strings.email.resourceId)
+```
+
+iOS:
+```swift
+LocalizedStringKey(MR.strings.email.resourceId)
+```
+
+Note: more info in issue [#126](https://github.com/icerockdev/moko-resources/issues/126).
+
 ### Example 2 - formatted localization string
 In `commonMain/resources/MR/base/strings.xml` add:
 ```xml
@@ -326,6 +378,65 @@ We got autogenerated `MR.fonts.Raleway.italic`, `MR.fonts.Raleway.regular`, `MR.
 - Android: `textView.typeface = font.getTypeface(context = this)`
 - iOS: `textView.font = font.uiFont(withSize: 14.0)`
 
+### Example 9 - pass colors
+Colors resources directory is `commonMain/resources/MR/colors`.  
+Colors files is `xml` with format:
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <color name="valueColor">#B02743FF</color>
+    <color name="referenceColor">@color/valueColor</color>
+    <color name="themedColor">
+        <light>0xB92743FF</light>
+        <dark>7CCFEEFF</dark>
+    </color>
+    <color name="themedReferenceColor">
+        <light>@color/valueColor</light>
+        <dark>@color/referenceColor</dark>
+    </color>
+</resources>
+```
+If you want use one color without light/dark theme selection:
+```xml
+<color name="valueColor">#B02743FF</color>
+```
+If you want use value of other color - use references:
+```xml
+<color name="referenceColor">@color/valueColor</color>
+```
+If you want different colors in light/dark themes:
+```xml
+<color name="themedColor">
+    <light>0xB92743FF</light>
+    <dark>7CCFEEFF</dark>
+</color>
+```
+Also themed colors can be referenced too:
+```xml
+<color name="themedReferenceColor">
+    <light>@color/valueColor</light>
+    <dark>@color/referenceColor</dark>
+</color>
+```
+
+Colors available in common code insode `MR.colors.**` as `ColorResource`.  
+`ColorResource` can be `ColorResource.Single` - simple color without theme selection.  
+And can be `ColorResource.Themed` with colors for each mode.
+
+You can read colors value from common code:
+```kotlin
+val color: Color = MR.colors.valueColor.color
+```
+but if you use `ColorResource.Themed` you can get current theme color only from platfrom side.
+Android:
+```kotlin
+val color: Color = MR.colors.valueColor.getColor(context = this)
+```
+iOS:
+```swift
+val color: UIColor = MR.colors.valueColor.getColor(UIScreen.main.traitCollection.userInterfaceStyle)
+```
+
 ### Gradle task for creating Fat Framework with resources 
 
 If you want to create Fat Framework for iOS with all resources from KMP Gradle module you should use

buildSrc/src/main/kotlin/Deps.kt

@@ -19,7 +19,7 @@ object Deps {
 
     private const val mokoGraphicsVersion = "0.5.0"
     private const val mokoParcelizeVersion = "0.5.0"
-    const val mokoResourcesVersion = "0.13.2"
+    const val mokoResourcesVersion = "0.14.0"
 
     object Android {
         const val compileSdk = 28
@@ -35,12 +35,12 @@ object Deps {
         val kotlinMultiplatform = GradlePlugin(id = "org.jetbrains.kotlin.multiplatform")
         val kotlinKapt = GradlePlugin(id = "kotlin-kapt")
         val kotlinAndroid = GradlePlugin(id = "kotlin-android")
-        val kotlinAndroidExtensions = GradlePlugin(id = "kotlin-android-extensions")
+        val kotlinParcelize = GradlePlugin(id = "kotlin-parcelize")
         val kotlinSerialization = GradlePlugin(id = "kotlin-serialization")
         val mavenPublish = GradlePlugin(id = "org.gradle.maven-publish")
 
         val mobileMultiplatform = GradlePlugin(id = "dev.icerock.mobile.multiplatform")
-        val iosFramework = GradlePlugin(id = "dev.icerock.mobile.multiplatform.ios-framework")
+        val appleFramework = GradlePlugin(id = "dev.icerock.mobile.multiplatform.apple-framework")
 
         val mokoResources = GradlePlugin(
             id = "dev.icerock.mobile.multiplatform-resources",
@@ -80,7 +80,7 @@ object Deps {
             const val mokoResources = "dev.icerock.moko:resources:$mokoResourcesVersion"
             const val mokoParcelize = "dev.icerock.moko:parcelize:$mokoParcelizeVersion"
             val mokoGraphics = "dev.icerock.moko:graphics:$mokoGraphicsVersion"
-                .defaultMPL(ios = true)
+                .defaultMPL(android = true, ios = true, macos = true)
 
             object Tests {
                 const val kotlinTest =

plugins/resources-generator/src/main/kotlin/dev/icerock/gradle/MultiplatformResourcesPlugin.kt

@@ -4,8 +4,8 @@
 
 package dev.icerock.gradle
 
-import com.android.build.gradle.LibraryExtension
-import com.android.build.gradle.LibraryPlugin
+import com.android.build.gradle.BaseExtension
+import com.android.build.gradle.BasePlugin
 import com.android.build.gradle.api.AndroidSourceSet
 import dev.icerock.gradle.generator.ColorsGenerator
 import dev.icerock.gradle.generator.FilesGenerator
@@ -18,7 +18,7 @@ import dev.icerock.gradle.generator.SourceInfo
 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.generator.apple.AppleMRGenerator
 import dev.icerock.gradle.tasks.GenerateMultiplatformResourcesTask
 import org.gradle.api.Plugin
 import org.gradle.api.Project
@@ -30,39 +30,43 @@ import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet
 import org.jetbrains.kotlin.gradle.plugin.KotlinTarget
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinAndroidTarget
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
-import org.jetbrains.kotlin.konan.target.Family
 import org.jetbrains.kotlin.konan.target.HostManager
 import java.io.File
 import javax.xml.parsers.DocumentBuilderFactory
 
 class MultiplatformResourcesPlugin : Plugin<Project> {
     override fun apply(target: Project) {
         val mrExtension =
-            target.extensions.create("multiplatformResources", MultiplatformResourcesPluginExtension::class.java)
+            target.extensions.create(
+                "multiplatformResources",
+                MultiplatformResourcesPluginExtension::class.java
+            )
 
         target.plugins.withType(KotlinMultiplatformPluginWrapper::class.java) {
-            val multiplatformExtension = target.extensions.getByType(KotlinMultiplatformExtension::class.java)
+            val multiplatformExtension =
+                target.extensions.getByType(KotlinMultiplatformExtension::class.java)
 
-            target.plugins.withType(LibraryPlugin::class.java) {
-                val androidExtension = target.extensions.getByName("android") as LibraryExtension
+            target.plugins.withType(BasePlugin::class.java) {
+                val extension = it.getExtension()
 
                 target.afterEvaluate {
                     configureGenerators(
                         target = target,
                         mrExtension = mrExtension,
                         multiplatformExtension = multiplatformExtension,
-                        androidExtension = androidExtension
+                        androidExtension = extension
                     )
                 }
             }
         }
     }
 
+    @Suppress("LongMethod")
     private fun configureGenerators(
         target: Project,
         mrExtension: MultiplatformResourcesPluginExtension,
         multiplatformExtension: KotlinMultiplatformExtension,
-        androidExtension: LibraryExtension
+        androidExtension: BaseExtension
     ) {
         val androidMainSourceSet =
             androidExtension.sourceSets.getByName(SourceSet.MAIN_SOURCE_SET_NAME)
@@ -95,7 +99,13 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
         )
         val targets: List<KotlinTarget> = multiplatformExtension.targets.toList()
 
-        setupCommonGenerator(commonSourceSet, generatedDir, mrClassPackage, features, target)
+        val commonGenerationTask = setupCommonGenerator(
+            commonSourceSet = commonSourceSet,
+            generatedDir = generatedDir,
+            mrClassPackage = mrClassPackage,
+            features = features,
+            target = target
+        )
         setupAndroidGenerator(
             targets,
             androidMainSourceSet,
@@ -105,7 +115,7 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
             target
         )
         if (HostManager.hostIsMac) {
-            setupIosGenerator(
+            setupAppleGenerator(
                 targets,
                 generatedDir,
                 mrClassPackage,
@@ -118,7 +128,6 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
         }
 
         val generationTasks = target.tasks.filterIsInstance<GenerateMultiplatformResourcesTask>()
-        val commonGenerationTask = generationTasks.first { it.name == "generateMRcommonMain" }
         generationTasks.filter { it != commonGenerationTask }
             .forEach { it.dependsOn(commonGenerationTask) }
     }
@@ -129,9 +138,9 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
         mrClassPackage: String,
         features: List<ResourceGeneratorFeature<out MRGenerator.Generator>>,
         target: Project
-    ) {
+    ): GenerateMultiplatformResourcesTask {
         val commonGeneratorSourceSet: MRGenerator.SourceSet = createSourceSet(commonSourceSet)
-        CommonMRGenerator(
+        return CommonMRGenerator(
             generatedDir,
             commonGeneratorSourceSet,
             mrClassPackage,
@@ -165,7 +174,7 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
     }
 
     @Suppress("LongParameterList")
-    private fun setupIosGenerator(
+    private fun setupAppleGenerator(
         targets: List<KotlinTarget>,
         generatedDir: File,
         mrClassPackage: String,
@@ -175,7 +184,7 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
     ) {
         val compilations = targets
             .filterIsInstance<KotlinNativeTarget>()
-            .filter { it.konanTarget.family == Family.IOS }
+            .filter { it.konanTarget.family.isAppleFamily }
             .map { kotlinNativeTarget ->
                 kotlinNativeTarget.compilations
                     .getByName(KotlinCompilation.MAIN_COMPILATION_NAME)
@@ -187,7 +196,7 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
             val depend = kss.getDependedFrom(defSourceSets)
 
             val sourceSet = createSourceSet(depend ?: kss)
-            IosMRGenerator(
+            AppleMRGenerator(
                 generatedDir,
                 sourceSet,
                 mrClassPackage,

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

@@ -12,7 +12,7 @@ import com.squareup.kotlinpoet.PropertySpec
 import com.squareup.kotlinpoet.TypeSpec
 import dev.icerock.gradle.generator.android.AndroidColorsGenerator
 import dev.icerock.gradle.generator.common.CommonColorsGenerator
-import dev.icerock.gradle.generator.ios.IosColorsGenerator
+import dev.icerock.gradle.generator.apple.AppleColorsGenerator
 import org.gradle.api.file.FileTree
 import java.io.File
 import javax.xml.parsers.DocumentBuilderFactory
@@ -141,7 +141,7 @@ abstract class ColorsGenerator(
         }
 
         override fun createIosGenerator(): ColorsGenerator {
-            return IosColorsGenerator(
+            return AppleColorsGenerator(
                 colorsFileTree
             )
         }

plugins/resources-generator/src/main/kotlin/dev/icerock/gradle/generator/FilesGenerator.kt

@@ -11,7 +11,7 @@ import com.squareup.kotlinpoet.PropertySpec
 import com.squareup.kotlinpoet.TypeSpec
 import dev.icerock.gradle.generator.android.AndroidFilesGenerator
 import dev.icerock.gradle.generator.common.CommonFilesGenerator
-import dev.icerock.gradle.generator.ios.IosFilesGenerator
+import dev.icerock.gradle.generator.apple.AppleFilesGenerator
 import org.gradle.api.file.FileTree
 import java.io.File
 
@@ -90,7 +90,7 @@ abstract class FilesGenerator(
         }
 
         override fun createIosGenerator(): FilesGenerator {
-            return IosFilesGenerator(fileTree)
+            return AppleFilesGenerator(fileTree)
         }
 
         override fun createAndroidGenerator(): FilesGenerator {

plugins/resources-generator/src/main/kotlin/dev/icerock/gradle/generator/FontsGenerator.kt

@@ -11,7 +11,7 @@ import com.squareup.kotlinpoet.PropertySpec
 import com.squareup.kotlinpoet.TypeSpec
 import dev.icerock.gradle.generator.android.AndroidFontsGenerator
 import dev.icerock.gradle.generator.common.CommonFontsGenerator
-import dev.icerock.gradle.generator.ios.IosFontsGenerator
+import dev.icerock.gradle.generator.apple.AppleFontsGenerator
 import org.gradle.api.file.FileTree
 import java.io.File
 
@@ -117,7 +117,7 @@ abstract class FontsGenerator(
         }
 
         override fun createIosGenerator(): FontsGenerator {
-            return IosFontsGenerator(stringsFileTree)
+            return AppleFontsGenerator(stringsFileTree)
         }
 
         override fun createAndroidGenerator(): FontsGenerator {