Add support for custom resource file name (#59)

Author: gustavaa

CHANGELOG.md

@@ -22,7 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
-- No new features!
+- Add configuration support to define custom resource file names.
 ### Changed
 - No changed features!
 ### Deprecated

README.md

@@ -90,7 +90,7 @@ Attribute                          | Description
 ```languageValuesOverridePathMap```    | (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``` | (Since 2.3.0) (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.
 ```filters```                      | (Since 2.4.0) (Optional) List of PoEditor filters to use during download. Defaults to empty list. Accepted values are defined by the POEditor API.
-
+```resFileName``` | (Since 3.1.0) (Optional) Sets the file name for the imported string resource XML files. Defaults to `strings`
 After the configuration is done, just run the new ```importPoEditorStrings``` task via Android Studio or command line:
 
 ```
@@ -100,7 +100,7 @@ After the configuration is done, just run the new ```importPoEditorStrings``` ta
 This task will:
 * Download all strings files (every available lang) from PoEditor given the api token and project id.
 * Process the incoming strings to fix some PoEditor incompatibilities with Android strings system. 
-* Create and save strings.xml files to ```/values-<lang>``` (or ```/values``` in case of the default lang). It supports
+* Create and save strings.xml (or whatever file name you desire by using the `resFileName` attribute) 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```).
 
 ## Enhanced syntax

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

@@ -32,6 +32,7 @@ fun main() {
 
     val apiToken = dotenv.get("API_TOKEN", "")
     val projectId = dotenv.get("PROJECT_ID", "-1").toInt()
+    val resFileName = dotenv.get("RES_FILE_NAME", "strings")
     val resDirPath = dotenv.get("RES_DIR_PATH", "")
     val defaultLanguage = dotenv.get("DEFAULT_LANGUAGE", "")
     val filters = dotenv.get("FILTERS", "")
@@ -63,6 +64,7 @@ fun main() {
         filters,
         tags,
         languageValuesOverridePathMap,
-        minimumTranslationPercentage
+        minimumTranslationPercentage,
+        resFileName
     )
 }

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

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

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

@@ -78,6 +78,15 @@ open class PoEditorPluginExtension @Inject constructor(objects: ObjectFactory, p
     @get:Input
     val defaultResPath: Property<String> = objects.property(String::class.java)
 
+    /**
+     * File name of the string resource files.
+     *
+     * Defaults to "strings" if not defined.
+     */
+    @get:Optional
+    @get:Input
+    val resFileName: Property<String> = objects.property(String::class.java)
+
     /**
      * Filters to limit downloaded strings with, from the officially supported list in PoEditor.
      *
@@ -165,6 +174,16 @@ open class PoEditorPluginExtension @Inject constructor(objects: ObjectFactory, p
      */
     fun setDefaultResPath(value: String) = defaultResPath.set(value)
 
+    /**
+     * Sets the file name for the resource files.
+     *
+     * 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 `resFileName.set(value)`.
+     */
+    fun setResFileName(value: String) = resFileName.set(value)
+
     /**
      * Sets the filters to limit downloaded strings with, from the officially supported list in PoEditor.
      *

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

@@ -89,7 +89,8 @@ object PoEditorStringsImporter {
                               filters: List<FilterType>,
                               tags: List<String>,
                               languageValuesOverridePathMap: Map<String, String>,
-                              minimumTranslationPercentage: Int) {
+                              minimumTranslationPercentage: Int,
+                              resFileName: String) {
         try {
             val poEditorApiController = PoEditorApiControllerImpl(apiToken, poEditorApi)
 
@@ -140,10 +141,11 @@ object PoEditorStringsImporter {
 
                 xmlWriter.saveXml(
                     resDirPath,
+                    resFileName,
                     postProcessedXmlDocumentMap,
                     defaultLang,
                     languageCode,
-                    languageValuesOverridePathMap
+                    languageValuesOverridePathMap,
                 )
             }
         } catch (e: Exception) {

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

@@ -50,6 +50,7 @@ abstract class ImportPoEditorStringsTask
         val tags: List<String>
         val languageOverridePathMap: Map<String, String>
         val minimumTranslationPercentage: Int
+        val resFileName: String
 
         try {
             apiToken = extension.apiToken.get()
@@ -60,6 +61,7 @@ abstract class ImportPoEditorStringsTask
             tags = extension.tags.get()
             languageOverridePathMap = extension.languageValuesOverridePathMap.get()
             minimumTranslationPercentage = extension.minimumTranslationPercentage.get()
+            resFileName = extension.resFileName.get()
         } catch (e: Exception) {
             logger.error("Import configuration failed", e)
 
@@ -77,6 +79,7 @@ abstract class ImportPoEditorStringsTask
             filters,
             tags,
             languageOverridePathMap,
-            minimumTranslationPercentage)
+            minimumTranslationPercentage,
+            resFileName)
     }
 }

src/main/kotlin/com/hyperdevs/poeditor/gradle/xml/AndroidXmlWriter.kt

@@ -35,7 +35,9 @@ class AndroidXmlWriter {
      * Saves a given map of XML files related to a language that the project contains to the
      * project's strings folder.
      */
+    @Suppress("LongParameterList")
     fun saveXml(resDirPath: String,
+                resFileName: String,
                 postProcessedXmlDocumentMap: Map<String, Document>,
                 defaultLang: String,
                 languageCode: String,
@@ -63,11 +65,11 @@ class AndroidXmlWriter {
         }
 
         folderToXmlMap.forEach { (valuesFolderFile, document) ->
-            saveXmlToFolder(valuesFolderFile, document)
+            saveXmlToFolder(valuesFolderFile, document, resFileName)
         }
     }
 
-    private fun saveXmlToFolder(stringsFolderFile: File, document: Document) {
+    private fun saveXmlToFolder(stringsFolderFile: File, document: Document, resFileName: String) {
         if (!stringsFolderFile.exists()) {
             logger.debug("Creating strings folder for new language")
             val folderCreated = stringsFolderFile.mkdirs()
@@ -76,6 +78,6 @@ class AndroidXmlWriter {
         }
 
         logger.lifecycle("Saving strings to ${stringsFolderFile.absolutePath}")
-        File(stringsFolderFile, "strings.xml").writeText(document.toAndroidXmlString())
+        File(stringsFolderFile, "$resFileName.xml").writeText(document.toAndroidXmlString())
     }
 }