Merge pull request #51 from icerockdev/develop

Release 0.9.0

Author: Alex009

.github/workflows/compilation-check.yml

@@ -15,5 +15,7 @@ jobs:
       uses: actions/setup-java@v1
       with:
         java-version: 1.8
-    - name: Build and publish local
-      run: ./gradlew -PlibraryPublish :gradle-plugin:publishPluginPublicationToMavenLocal :resources:publishToMavenLocal
+    - name: Check plugin build
+      run: ./gradlew -PlibraryPublish :gradle-plugin:publishPluginPublicationToMavenLocal
+    - name: Check library build
+      run: ./gradlew -PlibraryPublish :resources:publishToMavenLocal

.github/workflows/publish.yml

@@ -14,5 +14,7 @@ jobs:
         uses: actions/setup-java@v1
         with:
           java-version: 1.8
-      - name: Build and publish to Bintray
-        run: ./gradlew -PlibraryPublish :gradle-plugin:publishPluginPublicationToBintrayRepository :resources:publishAllPublicationsToBintrayRepository -DBINTRAY_USER=${{ secrets.BINTRAY_USER }} -DBINTRAY_KEY=${{ secrets.BINTRAY_KEY }}
+      - name: Publish plugin
+        run: ./gradlew -PlibraryPublish :gradle-plugin:publishPluginPublicationToBintrayRepository -DBINTRAY_USER=${{ secrets.BINTRAY_USER }} -DBINTRAY_KEY=${{ secrets.BINTRAY_KEY }}
+      - name: Publish library
+        run: ./gradlew -PlibraryPublish :resources:publishAllPublicationsToBintrayRepository -DBINTRAY_USER=${{ secrets.BINTRAY_USER }} -DBINTRAY_KEY=${{ secrets.BINTRAY_KEY }}

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

@@ -12,9 +12,11 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-      - name: Build and publish local
-        run: ./gradlew -PlibraryPublish :gradle-plugin:publishPluginPublicationToMavenLocal :resources:publishToMavenLocal
-      - name: Sample unit-tests
+      - name: Build plugin
+        run: ./gradlew -PlibraryPublish :gradle-plugin:publishPluginPublicationToMavenLocal
+      - name: Build library
+        run: ./gradlew -PlibraryPublish :resources:publishToMavenLocal
+      - name: Run android tests
         uses: reactivecircus/android-emulator-runner@v2
         with:
           api-level: 29

README.md

@@ -1,5 +1,5 @@
 ![moko-resources](img/logo.png)  
-[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0) [![Download](https://api.bintray.com/packages/icerockdev/moko/moko-resources/images/download.svg) ](https://bintray.com/icerockdev/moko/moko-resources/_latestVersion) ![kotlin-version](https://img.shields.io/badge/kotlin-1.3.61-orange)
+[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0) [![Download](https://api.bintray.com/packages/icerockdev/moko/moko-resources/images/download.svg) ](https://bintray.com/icerockdev/moko/moko-resources/_latestVersion) ![kotlin-version](https://img.shields.io/badge/kotlin-1.3.70-orange)
 
 # Mobile Kotlin resources
 This is a Kotlin MultiPlatform library that provides access to the resources on iOS & Android with the support of the default system localization.
@@ -38,6 +38,8 @@ This is a Kotlin MultiPlatform library that provides access to the resources on
   - 0.6.2
   - 0.7.0
   - 0.8.0
+- kotlin 1.3.70
+  - 0.9.0
 
 ## Installation
 root build.gradle  
@@ -48,7 +50,7 @@ buildscript {
     }
 
     dependencies {
-        classpath "dev.icerock.moko:resources-generator:0.8.0"
+        classpath "dev.icerock.moko:resources-generator:0.9.0"
     }
 }
 
@@ -65,11 +67,13 @@ project build.gradle
 apply plugin: "dev.icerock.mobile.multiplatform-resources"
 
 dependencies {
-    commonMainApi("dev.icerock.moko:resources:0.8.0")
+    commonMainApi("dev.icerock.moko:resources:0.9.0")
 }
 
 multiplatformResources {
     multiplatformResourcesPackage = "org.example.library"
+    iosBaseLocalizationRegion = "en" //optional, default "en"
+    multiplatformResourcesSourceSet = "commonClientMain"  // optional, default "commonMain"
 }
 ```
 
@@ -234,7 +238,17 @@ let string1 = getUserName(user: user).localized() // we got name from User model
 let string2 = getUserName(user: null).localized() // we got name_placeholder from resources
 ```
 
-### Example 6 - pass image
+### Example 6 - Select localization in runtime
+You can force `StringDesc` to use preferred localization in common code: 
+```kotlin
+StringDesc.localeType = StringDesc.LocaleType.Custom("es")
+```
+and return to system behaviour (when localization depends on device settings):
+```kotlin
+StringDesc.localeType = StringDesc.LocaleType.System()
+```
+
+### Example 7 - pass image
 Image resources directory is `commonMain/resources/MR/images` with support of nested directories.  
 Image name should be end with one of: 
 - `@0.75x` - android ldpi;
@@ -253,7 +267,7 @@ We got autogenerated `MR.images.home_black_18` `ImageResource` in code, that we
 - Android: `imageView.setImageResource(image.drawableResId)`
 - iOS: `imageView.image = image.toUIImage()`
 
-### Example 7 - pass font
+### Example 8 - pass font
 Fonts resources directory is `commonMain/resources/MR/fonts`.  
 Font name should be this pattern: `<fontFamily>-<fontStyle>` like:
 - `Raleway-Bold.ttf`

build.gradle.kts

@@ -19,5 +19,6 @@ allprojects {
 }
 
 tasks.register("clean", Delete::class).configure {
+    group = "build"
     delete(rootProject.buildDir)
 }

buildSrc/build.gradle.kts

@@ -12,9 +12,9 @@ repositories {
 }
 
 dependencies {
-    implementation("dev.icerock:mobile-multiplatform:0.4.0")
-    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.60")
-    implementation("com.android.tools.build:gradle:3.5.2")
+    implementation("dev.icerock:mobile-multiplatform:0.6.0")
+    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.70")
+    implementation("com.android.tools.build:gradle:3.6.1")
 }
 
 kotlinDslPluginOptions {

buildSrc/src/main/kotlin/Versions.kt

@@ -9,12 +9,12 @@ object Versions {
         const val minSdk = 16
     }
 
-    const val kotlin = "1.3.61"
+    const val kotlin = "1.3.70"
 
-    private const val mokoResources = "0.8.0"
+    private const val mokoResources = "0.9.0"
 
     object Plugins {
-        const val android = "3.5.2"
+        const val android = "3.6.1"
 
         const val kotlin = Versions.kotlin
         const val mokoResources = Versions.mokoResources

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

@@ -28,7 +28,7 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
         val mrExtension =
             target.extensions.create<MultiplatformResourcesPluginExtension>("multiplatformResources")
 
-        mrExtension.onChange = {
+        target.afterEvaluate {
             configureGenerators(
                 target = target,
                 mrExtension = mrExtension
@@ -45,8 +45,7 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
                 target.extensions.getByType(KotlinMultiplatformExtension::class)
 
             val sourceSets = multiplatformExtension.sourceSets
-            val commonSourceSet =
-                sourceSets.getByName(KotlinSourceSet.COMMON_MAIN_SOURCE_SET_NAME)
+            val commonSourceSet = sourceSets.getByName(mrExtension.sourceSetName)
             val commonResources = commonSourceSet.resources
 
             val androidExtension = target.extensions.getByType(LibraryExtension::class)
@@ -96,13 +95,14 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
                 androidPackage
             )
             val features = listOf(
-                StringsGeneratorFeature(sourceInfo),
-                PluralsGeneratorFeature(sourceInfo),
+                StringsGeneratorFeature(sourceInfo, extension.iosBaseLocalizationRegion),
+                PluralsGeneratorFeature(sourceInfo, extension.iosBaseLocalizationRegion),
                 ImagesGeneratorFeature(sourceInfo),
                 FontsGeneratorFeature(sourceInfo)
             )
             val generator = createGenerator(
                 multiplatformExtension = multiplatformExtension,
+                extension = extension,
                 info = sourceInfo,
                 features = features
             ) ?: return@forEach
@@ -113,16 +113,19 @@ class MultiplatformResourcesPlugin : Plugin<Project> {
 
     private fun createGenerator(
         multiplatformExtension: KotlinMultiplatformExtension,
+        extension: MultiplatformResourcesPluginExtension,
         info: SourceInfo,
         features: List<ResourceGeneratorFeature>
     ): MRGenerator? {
-        if (info.sourceSet.name == KotlinSourceSet.COMMON_MAIN_SOURCE_SET_NAME) {
+        if (info.sourceSet.name == extension.sourceSetName) {
             return CommonMRGenerator(
                 info.generatedDir,
                 info.sourceSet,
                 info.mrClassPackage,
                 generators = features.map { it.createCommonGenerator() }
             )
+        } else if (info.sourceSet.name == KotlinSourceSet.COMMON_MAIN_SOURCE_SET_NAME) {
+            return null
         }
 
         val target = multiplatformExtension.targets.firstOrNull { target ->

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

@@ -4,12 +4,11 @@
 
 package dev.icerock.gradle
 
+import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet
+
 open class MultiplatformResourcesPluginExtension {
     var multiplatformResourcesPackage: String? = null
-        set(value) {
-            field = value
-            onChange?.invoke()
-        }
-
-    internal var onChange: (() -> Unit)? = null
+    var multiplatformResourcesSourceSet: String? = null
+    var iosBaseLocalizationRegion: String = "en"
+    val sourceSetName: String get() = multiplatformResourcesSourceSet ?: KotlinSourceSet.COMMON_MAIN_SOURCE_SET_NAME
 }

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

@@ -14,7 +14,8 @@ import java.io.File
 
 class IosPluralsGenerator(
     sourceSet: KotlinSourceSet,
-    pluralsFileTree: FileTree
+    pluralsFileTree: FileTree,
+    private val baseLocalizationRegion: String
 ) : PluralsGenerator(
     sourceSet = sourceSet,
     pluralsFileTree = pluralsFileTree
@@ -30,20 +31,7 @@ class IosPluralsGenerator(
         )
     }
 
-    override fun generateResources(
-        resourcesGenerationDir: File,
-        language: String?,
-        strings: Map<KeyType, PluralMap>
-    ) {
-        val resDirName = when (language) {
-            null -> "Base.lproj"
-            else -> "$language.lproj"
-        }
-
-        val resDir = File(resourcesGenerationDir, resDirName)
-        val localizableFile = File(resDir, "Localizable.stringsdict")
-        resDir.mkdirs()
-
+    private fun writeStringsFile(file: File, strings: Map<KeyType, PluralMap>) {
         val head = """<?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
 <plist version="1.0">
@@ -79,8 +67,31 @@ class IosPluralsGenerator(
 	</dict>
 </plist>"""
 
-        localizableFile.writeText(head)
-        localizableFile.appendText(content)
-        localizableFile.appendText(footer)
+        file.writeText(head)
+        file.appendText(content)
+        file.appendText(footer)
+    }
+
+    override fun generateResources(
+        resourcesGenerationDir: File,
+        language: String?,
+        strings: Map<KeyType, PluralMap>
+    ) {
+        val resDirName = when (language) {
+            null -> "Base.lproj"
+            else -> "$language.lproj"
+        }
+
+        val resDir = File(resourcesGenerationDir, resDirName)
+        val localizableFile = File(resDir, "Localizable.stringsdict")
+        resDir.mkdirs()
+        writeStringsFile(localizableFile, strings)
+
+        if (language == null) {
+            val regionDir = File(resourcesGenerationDir, "$baseLocalizationRegion.lproj")
+            regionDir.mkdirs()
+            val regionFile = File(regionDir, "Localizable.stringsdict")
+            writeStringsFile(regionFile, strings)
+        }
     }
 }