Add unescapeHtmlTags flag and bump dependencies (#53)

adriangl · web-flow · commit 1ce076543c71 · 2023-05-08T22:08:54.000+02:00
diff --git a/.idea/compiler.xml b/.idea/compiler.xml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,7 +22,34 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 ### Added
-- No new features!
+- Add new `unescapeHtmlTags` flag to enable or disable HTML unescaping from strings.
+
+<details open><summary>Groovy</summary>
+
+```groovy
+poEditor {
+    apiToken = "your_api_token"
+    projectId = 12345
+    defaultLang = "en"
+    unescapeHtmlTags = false
+}
+```
+
+</details>
+
+<details><summary>Kotlin</summary>
+
+```kotlin
+poEditor {
+    apiToken = "your_api_token"
+    projectId = 12345
+    defaultLang = "en"
+    unescapeHtmlTags = false
+}
+```
+
+</details>
+
 ### Changed
 - No changed features!
 ### Deprecated
diff --git a/README.md b/README.md
@@ -93,6 +93,7 @@ Attribute                              | Description
 ```resFileName```                      | (Since 3.1.0) (Optional) Sets the file name for the imported string resource XML files. Defaults to `strings`.
 ```order```                            | (Since 3.1.0) (Optional) Defines how to order the export. Accepted values are defined by the POEditor API.
 ```unquoted```                         | (Since 3.2.0) (Optional) Defines if the strings should be unquoted, overriding default PoEditor configuration. Defaults to `false`.
+```unescapeHtmlTags```                 | (Since 3.4.0) (Optional) Whether or not to unescape HTML entitites from strings. Defaults to true.
 
 After the configuration is done, just run the new ```importPoEditorStrings``` task via Android Studio or command line:
 
@@ -518,6 +519,37 @@ poEditor {
     
 </details>
 
+## Toggling HTML unescaping
+> Requires version 3.4.0 of the plug-in
+
+You can enable or disable HTML tags unescaping with the `unescapeHtmlTags` flag.
+
+<details open><summary>Groovy</summary>
+
+```groovy
+poEditor {
+    apiToken = "your_api_token"
+    projectId = 12345
+    defaultLang = "en"
+    unescapeHtmlTags = false
+}
+```
+
+</details>
+
+<details><summary>Kotlin</summary>
+
+```kotlin
+poEditor {
+    apiToken = "your_api_token"
+    projectId = 12345
+    defaultLang = "en"
+    unescapeHtmlTags = false
+}
+```
+
+</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)
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -135,6 +135,21 @@ publishing {
                     }
                 }
 
+                organization {
+                    name.set("HyperDevs")
+                    url.set("https://github.com/hyperdevs-team")
+                }
+
+                issueManagement {
+                    system.set("GitHub Issues")
+                    url.set("https://github.com/hyperdevs-team/poeditor-android-gradle-plugin/issues")
+                }
+
+                scm {
+                    connection.set("git@github.com:hyperdevs-team/poeditor-android-gradle-plugin.git")
+                    url.set("https://github.com/hyperdevs-team/poeditor-android-gradle-plugin.git")
+                }
+
                 developers {
                     developer {
                         name.set("Iván Martínez")
@@ -148,12 +163,6 @@ publishing {
                         id.set("adriangl")
                         url.set("https://github.com/adriangl")
                         roles.set(listOf("Maintainer"))
-
-                        organization {
-                            name.set("HyperDevs")
-                            id.set("hyperdevs-team")
-                            url.set("https://github.com/hyperdevs-team")
-                        }
                     }
                 }
             }
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -32,7 +32,6 @@ detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" }
 gitVersionGradle = { id = "com.gladed.androidgitversion", version = "0.4.14"}
 versionsUpdate = { id = "com.github.ben-manes.versions", version = "0.46.0" }
 
-
 [bundles]
 moshi = ["moshi", "moshi-kotlin", "moshi-adapters"]
 retrofit = ["retrofit", "retrofit-converterMoshi"]
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/Main.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/Main.kt
@@ -58,6 +58,7 @@ fun main() {
         ?: emptyMap()
     val minimumTranslationPercentage = dotenv.get("MINIMUM_TRANSLATION_PERCENTAGE", "85").toInt()
     val unquoted = dotenv.get("UNQUOTED", "false").toBoolean()
+    val unescapeHtmlTags = dotenv.get("UNESCAPE_HTML_TAGS", "true").toBoolean()
 
     PoEditorStringsImporter.importPoEditorStrings(
         apiToken,
@@ -70,6 +71,7 @@ fun main() {
         languageValuesOverridePathMap,
         minimumTranslationPercentage,
         resFileName,
-        unquoted
+        unquoted,
+        unescapeHtmlTags
     )
 }
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorPlugin.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorPlugin.kt
@@ -60,6 +60,7 @@ class PoEditorPlugin : Plugin<Project> {
                 minimumTranslationPercentage.convention(-1)
                 resFileName.convention("strings")
                 unquoted.convention(false)
+                unescapeHtmlTags.convention(true)
             }
 
         // Add flavor and build-type configurations if the project has the "com.android.application" plugin
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorPluginExtension.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorPluginExtension.kt
@@ -142,6 +142,15 @@ open class PoEditorPluginExtension @Inject constructor(objects: ObjectFactory, p
     @get:Input
     val unquoted: Property<Boolean> = objects.property(Boolean::class.java)
 
+    /**
+     * Whether or not HTML tags in strings should be unescaped or not.
+     *
+     * Defaults to true.
+     */
+    @get:Optional
+    @get:Input
+    val unescapeHtmlTags: Property<Boolean> = objects.property(Boolean::class.java)
+
     /**
      * Sets the configuration as enabled or not.
      *
@@ -261,4 +270,14 @@ open class PoEditorPluginExtension @Inject constructor(objects: ObjectFactory, p
      * Gradle Kotlin DSL users must use `unquoted.set(value)`.
      */
     fun setUnquoted(value: Boolean) = unquoted.set(value)
+
+    /**
+     * Sets if strings should have HTML tags unescaped.
+     *
+     * 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 `unescapeHtmlTags.set(value)`.
+     */
+    fun setUnescapeHtmlTags(value: Boolean) = unescapeHtmlTags.set(value)
 }
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorStringsImporter.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorStringsImporter.kt
@@ -93,14 +93,15 @@ object PoEditorStringsImporter {
                               languageValuesOverridePathMap: Map<String, String>,
                               minimumTranslationPercentage: Int,
                               resFileName: String,
-                              unquoted: Boolean) {
+                              unquoted: Boolean,
+                              unescapeHtmlTags: Boolean) {
         try {
             val poEditorApiController = PoEditorApiControllerImpl(apiToken, moshi, poEditorApi)
 
             // Retrieve available languages from PoEditor
             logger.lifecycle("Retrieving project languages...")
             val projectLanguages = poEditorApiController.getProjectLanguages(projectId)
-            val skippedLanguages = projectLanguages.filter { it.percentage < minimumTranslationPercentage }
+            val skippedLanguages = projectLanguages.filter { it.percentage < minimumTranslationPercentage }.toSet()
 
             // Iterate over every available language
             logger.lifecycle("Available languages: ${projectLanguages.joinAndFormat { it.code }}")
@@ -141,17 +142,20 @@ object PoEditorStringsImporter {
                 val translationFile = okHttpClient.downloadUrlToString(translationFileUrl)
 
                 // Extract final files from downloaded translation XML
-                val postProcessedXmlDocumentMap =
-                    xmlPostProcessor.postProcessTranslationXml(
-                        translationFile, listOf(TABLET_REGEX_STRING))
+                val postProcessedXmlDocumentMap = xmlPostProcessor.postProcessTranslationXml(
+                    translationFile,
+                    listOf(TABLET_REGEX_STRING),
+                    unescapeHtmlTags
+                )
 
                 xmlWriter.saveXml(
                     resDirPath,
                     resFileName,
                     postProcessedXmlDocumentMap,
                     defaultLang,
                     languageCode,
-                    languageValuesOverridePathMap
+                    languageValuesOverridePathMap,
+                    unescapeHtmlTags
                 )
             }
         } catch (e: Exception) {
@@ -161,6 +165,6 @@ object PoEditorStringsImporter {
         }
     }
 
-    private fun List<ProjectLanguage>.joinAndFormat(transform: ((ProjectLanguage) -> CharSequence)) =
+    private fun Collection<ProjectLanguage>.joinAndFormat(transform: ((ProjectLanguage) -> CharSequence)) =
         joinToString(separator = ", ", prefix = "[", postfix = "]", transform = transform)
 }
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/ktx/DocumentExtensions.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/ktx/DocumentExtensions.kt
@@ -44,7 +44,7 @@ fun String.toStringsXmlDocument(): Document {
 /**
  * Converts a [Document] into a formatted [String].
  */
-fun Document.toAndroidXmlString(): String {
+fun Document.toAndroidXmlString(unescapeHtmlTags: kotlin.Boolean): String {
     val registry = DOMImplementationRegistry.newInstance()
     val impl = registry.getDOMImplementation("LS") as DOMImplementationLS
     val output = impl.createLSOutput().apply { encoding = "utf-8" }
@@ -59,5 +59,5 @@ fun Document.toAndroidXmlString(): String {
 
     serializer.write(this, output)
 
-    return writer.toString().unescapeHtmlTags()
+    return writer.toString().let { if (unescapeHtmlTags) it.unescapeHtmlTags() else it }
 }
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/ktx/StringExtensions.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/ktx/StringExtensions.kt
@@ -21,4 +21,4 @@ package com.hyperdevs.poeditor.gradle.ktx
 /**
  * Unescapes HTML tags from string.
  */
-fun String.unescapeHtmlTags() = this.replace("&lt;", "<").replace("&gt;", ">")
+fun String.unescapeHtmlTags() = this.replace("&lt;", "<").replace("&gt;", ">").replace("&amp;", "&")
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/tasks/ImportPoEditorStringsTask.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/tasks/ImportPoEditorStringsTask.kt
@@ -54,6 +54,7 @@ abstract class ImportPoEditorStringsTask
         val minimumTranslationPercentage: Int
         val resFileName: String
         val unquoted: Boolean
+        val unescapeHtmlTags: Boolean
 
         try {
             apiToken = extension.apiToken.get()
@@ -67,6 +68,7 @@ abstract class ImportPoEditorStringsTask
             minimumTranslationPercentage = extension.minimumTranslationPercentage.get()
             resFileName = extension.resFileName.get()
             unquoted = extension.unquoted.get()
+            unescapeHtmlTags = extension.unescapeHtmlTags.get()
         } catch (e: Exception) {
             logger.error("Import configuration failed", e)
 
@@ -87,6 +89,8 @@ abstract class ImportPoEditorStringsTask
             languageOverridePathMap,
             minimumTranslationPercentage,
             resFileName,
-            unquoted)
+            unquoted,
+            unescapeHtmlTags
+        )
     }
 }
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/xml/AndroidXmlWriter.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/xml/AndroidXmlWriter.kt
@@ -41,7 +41,8 @@ class AndroidXmlWriter {
                 postProcessedXmlDocumentMap: Map<String, Document>,
                 defaultLang: String,
                 languageCode: String,
-                languageValuesOverridePathMap: Map<String, String>?) {
+                languageValuesOverridePathMap: Map<String, String>?,
+                unescapeHtmlTags: Boolean) {
         // First check if we have passed a default "values" folder for the given language
         var baseValuesDir: File? = languageValuesOverridePathMap?.get(languageCode)?.let { File(it) }
 
@@ -65,11 +66,14 @@ class AndroidXmlWriter {
         }
 
         folderToXmlMap.forEach { (valuesFolderFile, document) ->
-            saveXmlToFolder(valuesFolderFile, document, resFileName)
+            saveXmlToFolder(valuesFolderFile, document, resFileName, unescapeHtmlTags)
         }
     }
 
-    private fun saveXmlToFolder(stringsFolderFile: File, document: Document, resFileName: String) {
+    private fun saveXmlToFolder(stringsFolderFile: File,
+                                document: Document,
+                                resFileName: String,
+                                unescapeHtmlTags: Boolean) {
         if (!stringsFolderFile.exists()) {
             logger.debug("Creating strings folder for new language")
             val folderCreated = stringsFolderFile.mkdirs()
@@ -78,6 +82,6 @@ class AndroidXmlWriter {
         }
 
         logger.lifecycle("Saving strings to ${stringsFolderFile.absolutePath}")
-        File(stringsFolderFile, "$resFileName.xml").writeText(document.toAndroidXmlString())
+        File(stringsFolderFile, "$resFileName.xml").writeText(document.toAndroidXmlString(unescapeHtmlTags))
     }
 }
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/xml/XmlPostProcessor.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/xml/XmlPostProcessor.kt
@@ -49,19 +49,24 @@ class XmlPostProcessor {
      * - Split to multiple XML files depending on regex matching
      */
     fun postProcessTranslationXml(translationFileXmlString: String,
-                                  fileSplitRegexStringList: List<String>): Map<String, Document> =
-        splitTranslationXml(formatTranslationXml(translationFileXmlString), fileSplitRegexStringList)
+                                  fileSplitRegexStringList: List<String>,
+                                  unescapeHtmlTags: Boolean): Map<String, Document> =
+        splitTranslationXml(formatTranslationXml(translationFileXmlString, unescapeHtmlTags), fileSplitRegexStringList)
 
     /**
      * Formats a given translations XML string to conform to Android strings.xml format.
      */
-    fun formatTranslationXml(translationFileXmlString: String): String {
+    fun formatTranslationXml(translationFileXmlString: String, unescapeHtmlTags: Boolean): String {
         // Parse line by line by traversing the original file using DOM
         val translationFileXmlDocument = translationFileXmlString.toStringsXmlDocument()
 
-        formatTranslationXmlDocument(translationFileXmlDocument, translationFileXmlDocument.childNodes)
+        formatTranslationXmlDocument(
+            translationFileXmlDocument,
+            translationFileXmlDocument.childNodes,
+            null
+        )
 
-        return translationFileXmlDocument.toAndroidXmlString()
+        return translationFileXmlDocument.toAndroidXmlString(unescapeHtmlTags)
     }
 
     /**
@@ -88,7 +93,6 @@ class XmlPostProcessor {
         return translationString
             // Replace % with %% if variables are found
             .let { if (containsVariables) it.replace("%", "%%") else it }
-            .unescapeHtmlTags()
             // Replace placeholders from {{variable}} to %1$s format.
             .replace(VARIABLE_REGEX, placeholderTransform)
     }
@@ -129,7 +133,9 @@ class XmlPostProcessor {
             .plus(ALL_REGEX_STRING to translationFileRecords)
     }
 
-    private fun formatTranslationXmlDocument(document: Document, nodeList: NodeList, rootNode: Node? = null) {
+    private fun formatTranslationXmlDocument(document: Document,
+                                             nodeList: NodeList,
+                                             rootNode: Node? = null) {
         for (i in 0 until nodeList.length) {
             if (nodeList.item(i).nodeType == Node.ELEMENT_NODE) {
                 val nodeElement = nodeList.item(i) as Element
@@ -155,8 +161,10 @@ class XmlPostProcessor {
         }
     }
 
-    private fun processTextAndReplaceNodeContent(document: Document, nodeElement: Element, rootNode: Node?) {
-        // First check if we have a CDATA node as the a child of the element. If we have it, we have to
+    private fun processTextAndReplaceNodeContent(document: Document,
+                                                 nodeElement: Element,
+                                                 rootNode: Node?) {
+        // First check if we have a CDATA node as the child of the element. If we have it, we have to
         // preserve the CDATA node but process the text. Else, we handle the node as a usual text node
         val copiedNodeElement: Element
         val (cDataNode, cDataPosition) = getCDataChildForNode(nodeElement)
diff --git a/src/test/kotlin/com/hyperdevs/poeditor/gradle/xml/XmlPostProcessorTest.kt b/src/test/kotlin/com/hyperdevs/poeditor/gradle/xml/XmlPostProcessorTest.kt

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@ class PoEditorPlugin : Plugin<Project> {`
`60`	`60`	`minimumTranslationPercentage.convention(-1)`
`61`	`61`	`resFileName.convention("strings")`
`62`	`62`	`unquoted.convention(false)`
	`63`	`+ unescapeHtmlTags.convention(true)`
`63`	`64`	`}`
`64`	`65`
`65`	`66`	`// Add flavor and build-type configurations if the project has the "com.android.application" plugin`