Add property to fetch only languages that are translated over a certain percentage (#37)

* Fetch only languages that are over 85% translated

* Add minimumTranslationPercentage property

* Improve logging related to translated percentage

* Change default of minimumTranslationPercentage to -1

* Move away joinAndFormat() and isPercentageTooLow()

* Change how languages are skipped

Author: nokite

CHANGELOG.md

@@ -23,6 +23,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 ### Added
 - Add some code style rules to be shared via editorconfig (insert_final_newline=false)
+- Add `minimumTranslationPercentage` parameter to `poEditorConfig` block to specify the minimum accepted percentage of translated strings per language
 ### Changed
 - The xml attribute "encoding" in the generated string resource files is now lowercase "utf-8"
 - Migrate to PoEditor API v2

README.md

@@ -76,15 +76,16 @@ poEditor {
 
 The complete attribute list is the following:
 
-Attribute                       | Description
---------------------------------|-----------------------------------------
-```apiToken```                  | PoEditor API Token.
-```projectId```                 | PoEditor project ID.
-```defaultLang```               | (Optional) The lang to be used to build default ```strings.xml``` (```/values``` folder). Defaults to English (`en`).
-```defaultResPath```            | (Since 1.3.0) (Optional) Path where the plug-in should dump strings. Defaults to the module's default (or build variant) `res` path.
-```enabled```                   | (Since 1.4.0) (Optional) Enables the generation of the block's related task. Defaults to `true`.
-```tags```                      | (Since 2.1.0) (Optional) List of PoEditor tags to download. Defaults to empty list.
-```languageValuesOverrideMap``` | (Since 2.2.0) (Optional) Map of `language_code:path` entries that you want to override the default language values folder with. Defaults to empty map.
+Attribute                          | Description
+-----------------------------------|-----------------------------------------
+```apiToken```                     | PoEditor API Token.
+```projectId```                    | PoEditor project ID.
+```defaultLang```                  | (Optional) The lang to be used to build default ```strings.xml``` (```/values``` folder). Defaults to English (`en`).
+```defaultResPath```               | (Since 1.3.0) (Optional) Path where the plug-in should dump strings. Defaults to the module's default (or build variant) `res` path.
+```enabled```                      | (Since 1.4.0) (Optional) Enables the generation of the block's related task. Defaults to `true`.
+```tags```                         | (Since 2.1.0) (Optional) List of PoEditor tags to download. Defaults to empty list.
+```languageValuesOverrideMap```    | (Since 2.2.0) (Optional) Map of `language_code:path` entries that you want to override the default language values folder with. Defaults to empty map.
+```minimumTranslationPercentage``` | (TBD) (Optional) The minimum accepted percentage of translated strings per language. Languages with fewer translated strings will not be fetched. Defaults to no minimum, allowing all languages to be fetched.
 
 After the configuration is done, just run the new ```importPoEditorStrings``` task via Android Studio or command line:
 

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

@@ -46,13 +46,15 @@ fun main() {
             key to value
         }
         ?: emptyMap()
+    val minimumTranslationPercentage = dotenv.get("MINIMUM_TRANSLATION_PERCENTAGE", "85").toInt()
 
     PoEditorStringsImporter.importPoEditorStrings(
         apiToken,
         projectId,
         defaultLanguage,
         resDirPath,
         tags,
-        languageValuesOverridePathMap
+        languageValuesOverridePathMap,
+        minimumTranslationPercentage
     )
 }

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

@@ -54,6 +54,7 @@ class PoEditorPlugin : Plugin<Project> {
                 defaultResPath.convention(mainResourceDirectory.asFile.absolutePath)
                 tags.convention(emptyList())
                 languageValuesOverridePathMap.convention(emptyMap())
+                minimumTranslationPercentage.convention(-1)
             }
 
         // Add flavor and build-type configurations if the project has the "com.android.application" plugin

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

@@ -42,7 +42,7 @@ open class PoEditorPluginExtension @Inject constructor(objects: ObjectFactory, p
      */
     @get:Optional
     @get:Input
-    val enabled : Property<Boolean> = objects.property(Boolean::class.java)
+    val enabled: Property<Boolean> = objects.property(Boolean::class.java)
 
     /**
      * PoEditor API token.
@@ -97,13 +97,22 @@ open class PoEditorPluginExtension @Inject constructor(objects: ObjectFactory, p
     val languageValuesOverridePathMap: MapProperty<String, String> =
         objects.mapProperty(String::class.java, String::class.java)
 
+    /**
+     * The minimum accepted percentage of translated strings per language. Languages with fewer translated strings will not be fetched.
+     *
+     * Defaults to no minimum if not present, meaning that all languages will be fetched.
+     */
+    @get:Optional
+    @get:Input
+    val minimumTranslationPercentage: Property<Int> = objects.property(Int::class.java)
+
     /**
      * Sets the configuration as enabled or not.
      *
      * NOTE: added for Gradle Groovy DSL compatibility. Check the note on
      * https://docs.gradle.org/current/userguide/lazy_configuration.html#lazy_properties for more details.
      *
-     * Gradle Kotlin DSL users must use `apiToken.set(value)`.
+     * Gradle Kotlin DSL users must use `enabled.set(value)`.
      */
     fun setEnabled(value: Boolean) = enabled.set(value)
 
@@ -163,7 +172,17 @@ open class PoEditorPluginExtension @Inject constructor(objects: ObjectFactory, p
      * NOTE: added for Gradle Groovy DSL compatibility. Check the note on
      * https://docs.gradle.org/current/userguide/lazy_configuration.html#lazy_properties for more details.
      *
-     * Gradle Kotlin DSL users must use `languageOverridePathMap.set(value)`.
+     * Gradle Kotlin DSL users must use `languageValuesOverridePathMap.set(value)`.
      */
     fun setLanguageValuesOverridePathMap(value: Map<String, String>) = languageValuesOverridePathMap.set(value)
+
+    /**
+     * Sets the minimum accepted percentage of translated strings per language.
+     *
+     * NOTE: added for Gradle Groovy DSL compatibility. Check the note on
+     * https://docs.gradle.org/current/userguide/lazy_configuration.html#lazy_properties for more details.
+     *
+     * Gradle Kotlin DSL users must use `minimumTranslationPercentage.set(value)`.
+     */
+    fun setMinimumTranslationPercentage(value: Int) = minimumTranslationPercentage.set(value)
 }

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

@@ -18,11 +18,12 @@
 
 package com.hyperdevs.poeditor.gradle
 
-import com.hyperdevs.poeditor.gradle.network.api.PoEditorApi
-import com.hyperdevs.poeditor.gradle.network.PoEditorApiControllerImpl
-import com.hyperdevs.poeditor.gradle.utils.TABLET_REGEX_STRING
 import com.hyperdevs.poeditor.gradle.ktx.downloadUrlToString
+import com.hyperdevs.poeditor.gradle.network.PoEditorApiControllerImpl
 import com.hyperdevs.poeditor.gradle.network.api.ExportType
+import com.hyperdevs.poeditor.gradle.network.api.PoEditorApi
+import com.hyperdevs.poeditor.gradle.network.api.ProjectLanguage
+import com.hyperdevs.poeditor.gradle.utils.TABLET_REGEX_STRING
 import com.hyperdevs.poeditor.gradle.utils.logger
 import com.hyperdevs.poeditor.gradle.xml.AndroidXmlWriter
 import com.hyperdevs.poeditor.gradle.xml.XmlPostProcessor
@@ -51,6 +52,7 @@ object PoEditorStringsImporter {
     private const val CONNECT_TIMEOUT_SECONDS = 30L
     private const val READ_TIMEOUT_SECONDS = 30L
     private const val WRITE_TIMEOUT_SECONDS = 30L
+
     private val okHttpClient = OkHttpClient.Builder()
         .connectTimeout(CONNECT_TIMEOUT_SECONDS, TimeUnit.SECONDS)
         .readTimeout(READ_TIMEOUT_SECONDS, TimeUnit.SECONDS)
@@ -80,17 +82,31 @@ object PoEditorStringsImporter {
                               defaultLang: String,
                               resDirPath: String,
                               tags: List<String>,
-                              languageValuesOverridePathMap: Map<String, String>) {
+                              languageValuesOverridePathMap: Map<String, String>,
+                              minimumTranslationPercentage: Int) {
         try {
             val poEditorApiController = PoEditorApiControllerImpl(apiToken, poEditorApi)
 
             // Retrieve available languages from PoEditor
             logger.lifecycle("Retrieving project languages...")
             val projectLanguages = poEditorApiController.getProjectLanguages(projectId)
+            val skippedLanguages = projectLanguages.filter { it.percentage < minimumTranslationPercentage }
 
             // Iterate over every available language
-            logger.lifecycle("Available languages: [${projectLanguages.joinToString(", ") { it.code }}]")
-            projectLanguages.forEach { languageData ->
+            logger.lifecycle("Available languages: ${projectLanguages.joinAndFormat { it.code }}")
+
+            if (minimumTranslationPercentage > -1) {
+                val skippedLanguagesMessage = if (skippedLanguages.isEmpty()) {
+                    "All languages are translated above the minimum of $minimumTranslationPercentage%"
+                } else {
+                    val formattedLanguages = skippedLanguages.joinAndFormat { "${it.code} (${it.percentage}%)" }
+                    "Skipping languages translated under $minimumTranslationPercentage%: $formattedLanguages"
+                }
+
+                logger.lifecycle(skippedLanguagesMessage)
+            }
+
+            projectLanguages.minus(skippedLanguages).forEach { languageData ->
                 val languageCode = languageData.code
 
                 // Retrieve translation file URL for the given language and for the "android_strings" type,
@@ -125,4 +141,7 @@ object PoEditorStringsImporter {
             throw e
         }
     }
+
+    private fun List<ProjectLanguage>.joinAndFormat(transform: ((ProjectLanguage) -> CharSequence)) =
+        joinToString(separator = ", ", prefix = "[", postfix = "]", transform = transform)
 }

src/main/kotlin/com/hyperdevs/poeditor/gradle/tasks/ImportPoEditorStringsTask.kt

@@ -45,8 +45,9 @@ abstract class ImportPoEditorStringsTask
         val projectId: Int
         val defaultLang: String
         val defaultResPath: String
-        val tags : List<String>
+        val tags: List<String>
         val languageOverridePathMap: Map<String, String>
+        val minimumTranslationPercentage: Int
 
         try {
             apiToken = extension.apiToken.get()
@@ -55,6 +56,7 @@ abstract class ImportPoEditorStringsTask
             defaultResPath = extension.defaultResPath.get()
             tags = extension.tags.get()
             languageOverridePathMap = extension.languageValuesOverridePathMap.get()
+            minimumTranslationPercentage = extension.minimumTranslationPercentage.get()
         } catch (e: Exception) {
             logger.error("Import configuration failed", e)
 
@@ -70,6 +72,7 @@ abstract class ImportPoEditorStringsTask
             defaultLang,
             defaultResPath,
             tags,
-            languageOverridePathMap)
+            languageOverridePathMap,
+            minimumTranslationPercentage)
     }
 }