Add lazy property configuration (#71)

Author: adriangl

.idea/compiler.xml

@@ -34,6 +34,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 - No security issues fixed!
 
+## [4.1.0] - 2023-11-26
+### Changed
+- Allow PoEditor importing task lazy configuration.
+
 ## [4.0.0] - 2023-11-07
 ### Changed
 - BREAKING CHANGE: Bump Gradle version to 8 and AGP version to 8.1.2.
@@ -483,7 +487,8 @@ res_dir_path -> resDirPath
 ### Added
 - Initial release.
 
-[Unreleased]: https://github.com/hyperdevs-team/poeditor-android-gradle-plugin/compare/4.0.0...HEAD
+[Unreleased]: https://github.com/hyperdevs-team/poeditor-android-gradle-plugin/compare/4.1.0...HEAD
+[4.1.0]: https://github.com/hyperdevs-team/poeditor-android-gradle-plugin/compare/4.0.0...4.1.0
 [4.0.0]: https://github.com/hyperdevs-team/poeditor-android-gradle-plugin/compare/3.4.2...4.0.0
 [3.4.2]: https://github.com/hyperdevs-team/poeditor-android-gradle-plugin/compare/3.4.1...3.4.2
 [3.4.1]: https://github.com/hyperdevs-team/poeditor-android-gradle-plugin/compare/3.4.0...3.4.1

CHANGELOG.md

@@ -579,6 +579,25 @@ poEditor {
 
 </details>
 
+## Creating extra PoEditor tasks
+> Requires version 4.1.0 of the plug-in
+
+You can create extra PoEditor tasks to import strings for other projects, for example. You can do so by adding this to
+your `build.gradle(.kts)` file:
+<details><summary>Kotlin</summary>
+
+```kotlin
+tasks.register("importCustomPoEditorStrings", ImportPoEditorStringsTask::class.java) {
+    description = "Imports custom strings from POEditor."
+    group = "strings"
+
+    apiToken = "another_token_from_a_different_project"
+    projectId = 12345
+    resFileName = "strings_custom"
+}
+```
+
+</details>
 
 ## iOS alternative
 If you want a similar solution for your iOS projects, check this out: [poeditor-parser-swift](https://github.com/hyperdevs-team/poeditor-parser-swift)

README.md

@@ -25,7 +25,6 @@ import com.android.build.gradle.LibraryExtension
 import com.android.build.gradle.LibraryPlugin
 import com.android.build.gradle.internal.dsl.BaseAppModuleExtension
 import com.hyperdevs.poeditor.gradle.ktx.registerNewTask
-import com.hyperdevs.poeditor.gradle.network.api.OrderType
 import com.hyperdevs.poeditor.gradle.tasks.ImportPoEditorStringsTask
 import com.hyperdevs.poeditor.gradle.utils.*
 import org.gradle.api.NamedDomainObjectContainer
@@ -44,24 +43,11 @@ typealias ConfigName = String
 class PoEditorPlugin : Plugin<Project> {
     override fun apply(project: Project) {
         val mainConfigName = "main"
-        val mainResourceDirectory = getResourceDirectory(project, mainConfigName)
 
         // Add the 'poEditorPlugin' extension object in the project,
         // used to pass parameters to the main PoEditor task
         val mainPoEditorExtension: PoEditorPluginExtension = project.extensions
-            .create<PoEditorPluginExtension>(DEFAULT_PLUGIN_NAME, project.objects, mainConfigName).apply {
-                enabled.convention(true)
-                defaultLang.convention("en")
-                defaultResPath.convention(mainResourceDirectory.asFile.absolutePath)
-                filters.convention(emptyList())
-                order.convention(OrderType.NONE.name.toLowerCase())
-                tags.convention(emptyList())
-                languageValuesOverridePathMap.convention(emptyMap())
-                minimumTranslationPercentage.convention(-1)
-                resFileName.convention("strings")
-                unquoted.convention(false)
-                unescapeHtmlTags.convention(true)
-            }
+            .create<PoEditorPluginExtension>(DEFAULT_PLUGIN_NAME, project.objects, mainConfigName)
 
         // Add flavor and build-type configurations if the project has the "com.android.application" plugin
         project.plugins.withType<AppPlugin> {
@@ -182,8 +168,10 @@ class PoEditorPlugin : Plugin<Project> {
                 project.registerNewTask<ImportPoEditorStringsTask>(
                     mainPoEditorTaskName,
                     mainPoEditorTaskDescription,
-                    PLUGIN_GROUP,
-                    arrayOf(mainPoEditorExtension))
+                    PLUGIN_GROUP
+                ) {
+                    configureTask("main", mainPoEditorExtension)
+                }
             }
         }
     }
@@ -205,8 +193,7 @@ class PoEditorPlugin : Plugin<Project> {
             project.tasks.findByName(configTaskName) ?: run {
                 val rawConfigExtension = configsExtensionContainer.findByName(configName)?.also {
                     // Don't forget to add the default resources path for the configuration
-                    val configResDir = getResourceDirectory(project, configName)
-                    it.defaultResPath.convention(configResDir.asFile.absolutePath)
+                    it.configName = configName
                 }
 
                 if (rawConfigExtension != null) {
@@ -222,8 +209,10 @@ class PoEditorPlugin : Plugin<Project> {
                         val newConfigPoEditorTask = project.registerNewTask<ImportPoEditorStringsTask>(
                             configTaskName,
                             getPoEditorDescriptionForConfig(configName),
-                            PLUGIN_GROUP,
-                            arrayOf(mergedConfigExtension))
+                            PLUGIN_GROUP
+                        ) {
+                            configureTask(configName, mergedConfigExtension)
+                        }
 
                         configPoEditorTaskProvidersMap.put(configName, newConfigPoEditorTask)
                     }
@@ -256,9 +245,6 @@ class PoEditorPlugin : Plugin<Project> {
 
     private fun getPoEditorTaskName(configName: ConfigName = "") = "import${configName.capitalize()}PoEditorStrings"
 
-    private fun getResourceDirectory(project: Project, configName: ConfigName) =
-        project.layout.projectDirectory.dir("src/$configName/res")
-
     private fun getMainPoEditorDescription(): String = """
         Imports all PoEditor strings for all flavors and build types configurations.
     """.trimIndent()

src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorPlugin.kt

@@ -37,6 +37,15 @@ open class PoEditorPluginExtension @Inject constructor(objects: ObjectFactory, p
     @Internal
     override fun getName(): String = name
 
+    /**
+     * Name of the configuration to use to save strings.
+     *
+     * Must be present in order to run the plugin. Configured internally
+     */
+    @get:Optional
+    @get:Input
+    internal val configName: Property<String> = objects.property(String::class.java)
+
     /**
      * Whether the configuration is enabled or not.
      */
@@ -143,7 +152,7 @@ open class PoEditorPluginExtension @Inject constructor(objects: ObjectFactory, p
     val unquoted: Property<Boolean> = objects.property(Boolean::class.java)
 
     /**
-     * Whether or not HTML tags in strings should be unescaped or not.
+     * Whether HTML tags in strings should be unescaped or not.
      *
      * Defaults to true.
      */