Add unescapeHtmlTags flag

Author: adriangl

.idea/compiler.xml

@@ -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

CHANGELOG.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)

README.md

@@ -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")
- }
  }
  }
  }

build.gradle.kts

@@ -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"]

gradle/libs.versions.toml

@@ -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
  )
 }

src/main/kotlin/com/hyperdevs/poeditor/gradle/Main.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

src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorPlugin.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)
 }

src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorPluginExtension.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)
 }

src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorStringsImporter.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 }
 }