Add multi-flavor environment (#12)

Author: Adrián García

.idea/codeStyles/Project.xml

@@ -6,13 +6,84 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
-- No new features!
+- Add support for flavor and build type configuration. The sample configuration is as follows:
+<details open><summary>Groovy</summary>
+
+```groovy
+poEditor {
+    // Default config that applies to all flavor/build type configurations. 
+    // Also executed when calling 'importPoEditorStrings'
+}
+
+android {
+    // If you have the following flavors...
+    flavorDimensions 'type'
+    productFlavors {
+        free { dimension 'type' }
+        paid { dimension 'type' }
+    }
+
+    poEditorConfig {
+        free {
+            // Configuration for the free flavor, same syntax as usual
+        }
+        paid {
+            // Configuration for the paid flavor, same syntax as usual
+        }
+        debug {
+            // Configuration for the debug build type, same syntax as usual
+        }
+        release {
+            // Configuration for the release build type, same syntax as usual
+        }
+    }
+}
+```
+
+</details>
+
+<details><summary>Kotlin</summary>
+
+```kt
+poEditor {
+    // Default config that applies to all flavor/build type configurations. 
+    // Also executed when calling 'importPoEditorStrings'
+}
+
+android {
+    // If you have the following flavors...
+    flavorDimensions("type")
+
+    productFlavors {
+        register("free") { setDimension("type") }
+        register("paid") { setDimension("type") }
+    }
+
+    poEditorConfig {
+        register("free") {
+            // Configuration for the free flavor, same syntax as usual
+        }
+        register("paid") {
+            // Configuration for the paid flavor, same syntax as usual
+        }
+        register("debug") {
+            // Configuration for the debug build type, same syntax as usual
+        }
+        register("release") {
+            // Configuration for the release build type, same syntax as usual
+        }
+    }
+}
+```
+
+</details>
+
 ### Changed
 - No changed features!
 ### Deprecated
 - No deprecated features!
 ### Removed
-- No removed features!
+- The `resDirPath` parameter is no longer needed, since it gets inferred from the flavor or build type configured in the app
 ### Fixed
 - No fixed issues!
 ### Security

.idea/jarRepositories.xml

@@ -10,38 +10,77 @@ It also provides a built-in syntax to handle placeholders to enhance the already
 ## Setting Up
 In your main `build.gradle`, add [jitpack.io](https://jitpack.io/) repository in the `buildscript` block and include the plug-in as a dependency:
 
+<details open><summary>Groovy</summary>
+
 ```groovy
 buildscript {
     repositories { 
         maven { url 'https://jitpack.io' }
     }
     dependencies {
-        classpath 'com.github.bq:poeditor-android-gradle-plugin:1.0.0'
+        classpath 'com.github.bq:poeditor-android-gradle-plugin:1.1.0'
+    }
+}
+```
+
+</details>
+
+<details><summary>Kotlin</summary>
+
+```kt
+buildscript {
+    repositories { 
+        maven("https://jitpack.io")
+    }
+    dependencies {
+        classpath("com.github.bq:poeditor-android-gradle-plugin:1.1.0")
     }
 }
 ```
 
+</details>
+
 ## How to use
 Apply and configure the plug-in in your app's `build.gradle` file:
+<details open><summary>Groovy</summary>
+
 ```groovy
-apply plugin: 'com.bq.poeditor'
+apply plugin: "com.android.application"
+apply plugin: "com.bq.poeditor"
+
+poEditor {
+    apiToken = "your_api_token"
+    projectId = 12345
+    defaultLang = "en"
+}
+```
+
+</details>
+
+<details><summary>Kotlin</summary>
+
+```kt
+plugins {
+    id "com.android.application"
+    id "com.bq.poeditor"
+}
 
 poEditor {
     apiToken = "your_api_token"
     projectId = 12345
     defaultLang = "en"
-    resDirPath = "${project.rootDir}/app/src/main/res"
 }
 ```
 
+</details>
+
 The complete attribute list is the following:
 
 Attribute                     | Description
 ------------------------------|-----------------------------------------
 ```apiToken```                | PoEditor API Token.
 ```projectId```               | PoEditor project ID.
 ```defaultLang```             | The lang to be used to build default ```strings.xml``` (```/values``` folder)
-```resDirPath```              | The path to the project's ```/res``` folder.
 
 After the configuration is done, just run the new ```importPoEditorStrings``` task via Android Studio or command line:
 
@@ -55,6 +94,93 @@ This task will:
 * Create and save strings.xml files to ```/values-<lang>``` (or ```/values``` in case of the default lang). It supports
 region specific languages by creating the proper folders (i.e. ```/values-es-rMX```).
 
+## Handling multiple flavors and build types
+
+Sometimes we might want to import different strings for a given flavor (for example, in white label apps, we could have
+different string definitions depending on the brand where they're used). The plugin supports this kind of apps by providing
+specific configurations via the `poEditorConfig` block.
+
+Let's see an example configuration:
+
+<details open><summary>Groovy</summary>
+
+```groovy
+poEditor {
+    // Default config that applies to all flavor/build type configurations. 
+    // Also executed when calling 'importPoEditorStrings'
+}
+
+android {
+    // If you have the following flavors...
+    flavorDimensions 'type'
+    productFlavors {
+        free { dimension 'type' }
+        paid { dimension 'type' }
+    }
+
+    poEditorConfig {
+        free {
+            // Configuration for the free flavor, same syntax as the standard 'poEditor' block
+        }
+        paid {
+            // Configuration for the paid flavor, same syntax as the standard 'poEditor' block
+        }
+        debug {
+            // Configuration for the debug build type, same syntax as the standard 'poEditor' block
+        }
+        release {
+            // Configuration for the release build type, same syntax as the standard 'poEditor' block
+        }
+    }
+}
+```
+
+</details>
+
+<details><summary>Kotlin</summary>
+
+```kt
+poEditor {
+    // Default config that applies to all flavor/build type configurations. 
+    // Also executed when calling 'importPoEditorStrings'
+}
+
+android {
+    // If you have the following flavors...
+    flavorDimensions("type")
+
+    productFlavors {
+        register("free") { setDimension("type") }
+        register("paid") { setDimension("type") }
+    }
+
+    poEditorConfig {
+        register("free") {
+            // Configuration for the free flavor, same syntax as the standard 'poEditor' block
+        }
+        register("paid") {
+            // Configuration for the paid flavor, same syntax as the standard 'poEditor' block
+        }
+        register("debug") {
+            // Configuration for the debug build type, same syntax as the standard 'poEditor' block
+        }
+        register("release") {
+            // Configuration for the release build type, same syntax as the standard 'poEditor' block
+        }
+    }
+}
+```
+
+</details>
+
+Each flavor (`free` and `paid`) and build type (`debug` and `release`) will have its own task to import strings for said
+configuration: `importFreePoEditorStrings`, `importPaidPoEditorStrings`, `importDebugPoEditorStrings` and 
+`importReleasePoEditorStrings`.
+
+Now the `importPoEditorStrings` task will import the main strings configured in the `poEditor` block and also the
+strings for each defined flavor or build type.
+
+
 ## Handling tablet specific strings
 
 You can mark some strings as tablet specific strings by adding ```_tablet```suffix to the string key in PoEditor. 
@@ -75,7 +201,7 @@ The plug-in will create two `strings.xml` files:
 <string name="welcome_message">Hey friend how are you doing today, you look great!</string>
 ```
 
-## Handle placeholders
+## Handling placeholders
 You can add placeholders to your strings. We've defined a placeholder markup to use in PoEditor string definition: it uses a double braces syntax, like this one
 
 ```

CHANGELOG.md

@@ -20,6 +20,12 @@ buildscript {
     repositories {
         mavenCentral()
         jcenter()
+        google().content {
+            includeGroup("com.android")
+            includeGroupByRegex("com\\.android\\..*")
+            includeGroupByRegex("com\\.google\\..*")
+            includeGroupByRegex("androidx\\..*")
+        }
     }
 
     dependencies {
@@ -38,11 +44,19 @@ plugins {
 repositories {
     mavenCentral()
     jcenter()
+    google().content {
+        includeGroup("com.android")
+        includeGroupByRegex("com\\.android\\..*")
+        includeGroupByRegex("com\\.google\\..*")
+        includeGroupByRegex("androidx\\..*")
+    }
 }
 
 dependencies {
     implementation(localGroovy())
 
+    compileOnly("com.android.tools.build:gradle:4.2.0-alpha01")
+
     implementation("org.jetbrains.kotlin:kotlin-stdlib:1.3.72")
 
     implementation("com.squareup.moshi:moshi:1.9.2")

README.md

@@ -1,22 +1,5 @@
-#
-# Copyright 2020 BQ
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-#Thu Apr 04 09:06:52 CEST 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.5.1-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-all.zip