Make FilterType use enums

adriangl · adriangl · commit 3b2e3fa7987e · 2022-11-13T19:55:11.000+01:00
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,12 +1,12 @@
 [versions]
-kotlin = "1.6.10"
+kotlin = "1.7.20"
 detekt = "1.19.0"
 moshi = "1.12.0"
 retrofit = "2.9.0"
 okhttp = "4.9.3"
 
 [libraries]
-android-buildTools = "com.android.tools.build:gradle:7.1.0"
+android-buildTools = "com.android.tools.build:gradle:7.3.0"
 
 kotlin-gradle = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib", version.ref = "kotlin" }
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/Main.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/Main.kt
@@ -18,6 +18,7 @@
 
 package com.hyperdevs.poeditor.gradle
 
+import com.hyperdevs.poeditor.gradle.network.api.FilterType
 import io.github.cdimascio.dotenv.Dotenv
 
 /**
@@ -37,6 +38,7 @@ fun main() {
         .takeIf { it.isNotBlank() }
         ?.split(",")
         ?.map { it.trim() }
+        ?.map { FilterType.from(it) }
         ?: emptyList()
     val tags = dotenv.get("TAGS", "")
         .takeIf { it.isNotBlank() }
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorStringsImporter.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/PoEditorStringsImporter.kt
@@ -21,6 +21,7 @@ package com.hyperdevs.poeditor.gradle
 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.FilterType
 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
@@ -62,7 +63,7 @@ object PoEditorStringsImporter {
                 logger.debug(message)
             }
         })
-            .setLevel(HttpLoggingInterceptor.Level.HEADERS))
+            .setLevel(HttpLoggingInterceptor.Level.BODY))
         .build()
 
     private val retrofit = Retrofit.Builder()
@@ -85,7 +86,7 @@ object PoEditorStringsImporter {
                               projectId: Int,
                               defaultLang: String,
                               resDirPath: String,
-                              filters: List<String>,
+                              filters: List<FilterType>,
                               tags: List<String>,
                               languageValuesOverridePathMap: Map<String, String>,
                               minimumTranslationPercentage: Int) {
@@ -100,7 +101,7 @@ object PoEditorStringsImporter {
             // Iterate over every available language
             logger.lifecycle("Available languages: ${projectLanguages.joinAndFormat { it.code }}")
 
-            if (minimumTranslationPercentage > -1) {
+            if (minimumTranslationPercentage >= 0) {
                 val skippedLanguagesMessage = if (skippedLanguages.isEmpty()) {
                     "All languages are translated above the minimum of $minimumTranslationPercentage%"
                 } else {
@@ -147,7 +148,7 @@ object PoEditorStringsImporter {
             }
         } catch (e: Exception) {
             logger.error("An error happened when retrieving strings from project. " +
-                "Please review the plug-in's input parameters and try again")
+                         "Please review the plug-in's input parameters and try again")
             throw e
         }
     }
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/network/PoEditorApiController.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/network/PoEditorApiController.kt
@@ -18,10 +18,7 @@
 
 package com.hyperdevs.poeditor.gradle.network
 
-import com.hyperdevs.poeditor.gradle.network.api.ExportType
-import com.hyperdevs.poeditor.gradle.network.api.PoEditorApi
-import com.hyperdevs.poeditor.gradle.network.api.PoEditorResponse
-import com.hyperdevs.poeditor.gradle.network.api.ProjectLanguage
+import com.hyperdevs.poeditor.gradle.network.api.*
 import retrofit2.Response
 
 /**
@@ -40,7 +37,7 @@ interface PoEditorApiController {
     fun getTranslationFileUrl(projectId: Int,
                               code: String,
                               type: ExportType,
-                              filters: List<String>?,
+                              filters: List<FilterType>?,
                               tags: List<String>?): String
 }
 
@@ -59,13 +56,13 @@ class PoEditorApiControllerImpl(private val apiToken: String,
     override fun getTranslationFileUrl(projectId: Int,
                                        code: String,
                                        type: ExportType,
-                                       filters: List<String>?,
+                                       filters: List<FilterType>?,
                                        tags: List<String>?): String {
         val response = poEditorApi.getExportFileInfo(
             apiToken = apiToken,
             id = projectId,
             type = type.toString().toLowerCase(),
-            filters = filters,
+            filters = filters?.map { it.name.toLowerCase() },
             language = code,
             tags = tags)
             .execute()
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/network/api/PoEditorApi.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/network/api/PoEditorApi.kt
@@ -41,6 +41,7 @@ interface PoEditorApi {
      */
     @Suppress("LongParameterList")
     @FormUrlEncoded
+    @JvmSuppressWildcards
     @POST("projects/export")
     fun getExportFileInfo(@Field("api_token") apiToken: String,
                           @Field("id") id: Int,
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/network/api/PoEditorApiModels.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/network/api/PoEditorApiModels.kt
@@ -18,6 +18,8 @@
 
 package com.hyperdevs.poeditor.gradle.network.api
 
+import com.squareup.moshi.Json
+import java.lang.IllegalArgumentException
 import java.util.Date
 
 /**
@@ -91,25 +93,47 @@ enum class ExportType {
 
     companion object {
         /** Returns the enum value associated to a string value. */
-        fun from(filterString: String) = valueOf(filterString.toUpperCase())
+        fun from(value: String) =
+            try {
+                valueOf(value.toUpperCase())
+            } catch (e: Exception) {
+                val message = "Value \"$value\" is not a valid ${this::class.java.declaringClass.simpleName}; " +
+                              "allowed values are: ${values().joinToString(", ") { "\"${it.name.toLowerCase()}\"" }}"
+                throw IllegalArgumentException(message)
+            }
     }
 }
 
 /**
  * Filter types to use in file exports.
  */
 enum class FilterType {
+    @Json(name = "translated")
     TRANSLATED,
+    @Json(name = "untranslated")
     UNTRANSLATED,
+    @Json(name = "fuzzy")
     FUZZY,
+    @Json(name = "not_fuzzy")
     NOT_FUZZY,
+    @Json(name = "automatic")
     AUTOMATIC,
+    @Json(name = "not_automatic")
     NOT_AUTOMATIC,
+    @Json(name = "proofread")
     PROOFREAD,
+    @Json(name = "not_proofread")
     NOT_PROOFREAD;
 
     companion object {
         /** Returns the enum value associated to a string value. */
-        fun from(filterString: String) = valueOf(filterString.toUpperCase())
+        fun from(value: String) =
+            try {
+                valueOf(value.toUpperCase())
+            } catch (e: Exception) {
+                val message = "Value \"$value\" is not a valid ${this::class.java.declaringClass.simpleName}; " +
+                              "allowed values are: ${values().joinToString(", ") { "\"${it.name.toLowerCase()}\"" }}"
+                throw IllegalArgumentException(message)
+            }
     }
 }
diff --git a/src/main/kotlin/com/hyperdevs/poeditor/gradle/tasks/ImportPoEditorStringsTask.kt b/src/main/kotlin/com/hyperdevs/poeditor/gradle/tasks/ImportPoEditorStringsTask.kt
@@ -20,6 +20,7 @@ package com.hyperdevs.poeditor.gradle.tasks
 
 import com.hyperdevs.poeditor.gradle.PoEditorPluginExtension
 import com.hyperdevs.poeditor.gradle.PoEditorStringsImporter
+import com.hyperdevs.poeditor.gradle.network.api.FilterType
 import com.hyperdevs.poeditor.gradle.utils.DEFAULT_PLUGIN_NAME
 import com.hyperdevs.poeditor.gradle.utils.POEDITOR_CONFIG_NAME
 import org.gradle.api.DefaultTask
@@ -45,7 +46,7 @@ abstract class ImportPoEditorStringsTask
         val projectId: Int
         val defaultLang: String
         val defaultResPath: String
-        val filters: List<String>
+        val filters: List<FilterType>
         val tags: List<String>
         val languageOverridePathMap: Map<String, String>
         val minimumTranslationPercentage: Int
@@ -55,7 +56,7 @@ abstract class ImportPoEditorStringsTask
             projectId = extension.projectId.get()
             defaultLang = extension.defaultLang.get()
             defaultResPath = extension.defaultResPath.get()
-            filters = extension.filters.get()
+            filters = extension.filters.get().map { FilterType.from(it) }
             tags = extension.tags.get()
             languageOverridePathMap = extension.languageValuesOverridePathMap.get()
             minimumTranslationPercentage = extension.minimumTranslationPercentage.get()
