Add support for named values for integers

Author: krzema12

README.md

@@ -110,6 +110,18 @@ inputs:
     ...
 ```
 
+In case of "magic values" meaning something else that the user would expect, you can specify them like so:
+
+```yaml
+...
+inputs:
+  fetch-depth:
+    type: integer
+    namedValues:
+      infinite: 0
+    ...
+```
+
 ### Float
 
 A number with a fractional component.

src/main/kotlin/it/krzeminski/githubactionstyping/parsing/ManifestParsing.kt

@@ -16,6 +16,7 @@ data class ApiItem(
     val type: String? = null,
     val allowedValues: List<String>? = null,
     val separator: String? = null,
+    val namedValues: Map<String, Int>? = null,
     val listItem: ApiItem? = null,
 )
 

src/main/kotlin/it/krzeminski/githubactionstyping/validation/types/Boolean.kt

@@ -13,6 +13,9 @@ fun ApiItem.validateBoolean(): ItemValidationResult {
     if (this.listItem != null) {
         return ItemValidationResult.Invalid("'listItem' is not allowed for this type.")
     }
+    if (this.namedValues != null) {
+        return ItemValidationResult.Invalid("'namedValues' are currently supported only for integers.")
+    }
 
     return ItemValidationResult.Valid
 }

src/main/kotlin/it/krzeminski/githubactionstyping/validation/types/Enum.kt

@@ -13,6 +13,9 @@ fun ApiItem.validateEnum(): ItemValidationResult {
     if (this.listItem != null) {
         return ItemValidationResult.Invalid("'listItem' is not allowed for this type.")
     }
+    if (this.namedValues != null) {
+        return ItemValidationResult.Invalid("'namedValues' are currently supported only for integers.")
+    }
     if (this.allowedValues.size < 2) {
         return ItemValidationResult.Invalid("There must be at least two allowed values.")
     }

src/main/kotlin/it/krzeminski/githubactionstyping/validation/types/Float.kt

@@ -13,6 +13,9 @@ fun ApiItem.validateFloat(): ItemValidationResult {
     if (this.listItem != null) {
         return ItemValidationResult.Invalid("'listItem' is not allowed for this type.")
     }
+    if (this.namedValues != null) {
+        return ItemValidationResult.Invalid("'namedValues' are currently supported only for integers.")
+    }
 
     return ItemValidationResult.Valid
 }

src/main/kotlin/it/krzeminski/githubactionstyping/validation/types/List.kt

@@ -14,6 +14,9 @@ fun ApiItem.validateList(): ItemValidationResult {
     if (this.allowedValues != null) {
         return ItemValidationResult.Invalid("'allowedValues' is not allowed for this type.")
     }
+    if (this.namedValues != null) {
+        return ItemValidationResult.Invalid("'namedValues' are currently supported only for integers.")
+    }
     return when (this.listItem.type) {
         "string" -> this.listItem.validateString()
         "boolean" -> this.listItem.validateBoolean()

src/main/kotlin/it/krzeminski/githubactionstyping/validation/types/String.kt

@@ -13,6 +13,9 @@ fun ApiItem.validateString(): ItemValidationResult {
     if (this.listItem != null) {
         return ItemValidationResult.Invalid("'listItem' is not allowed for this type.")
     }
+    if (this.namedValues != null) {
+        return ItemValidationResult.Invalid("'namedValues' are currently supported only for integers.")
+    }
 
     return ItemValidationResult.Valid
 }

src/test/kotlin/it/krzeminski/githubactionstyping/validation/ManifestValidationTest.kt

@@ -15,6 +15,7 @@ class ManifestValidationTest : FunSpec({
                     "string-input" to ApiItem(type = "string"),
                     "boolean-input" to ApiItem(type = "boolean"),
                     "integer-input" to ApiItem(type = "integer"),
+                    "integer-with-named-values-input" to ApiItem(type = "integer", namedValues = mapOf("foo" to 1, "bar" to 2)),
                     "float-input" to ApiItem(type = "float"),
                 ),
             )
@@ -29,6 +30,7 @@ class ManifestValidationTest : FunSpec({
                     "string-input" to ItemValidationResult.Valid,
                     "boolean-input" to ItemValidationResult.Valid,
                     "integer-input" to ItemValidationResult.Valid,
+                    "integer-with-named-values-input" to ItemValidationResult.Valid,
                     "float-input" to ItemValidationResult.Valid,
                 ),
             )
@@ -497,5 +499,34 @@ class ManifestValidationTest : FunSpec({
                 ),
             )
         }
+
+        test("non-integer types with named values") {
+            // given
+            val manifest = Manifest(
+                typingSpec = expectedTypingSpec,
+                inputs = mapOf(
+                    "string-input" to ApiItem(type = "string", namedValues = mapOf("foo" to 1)),
+                    "boolean-input" to ApiItem(type = "boolean", namedValues = mapOf("foo" to 1)),
+                    "float-input" to ApiItem(type = "float", namedValues = mapOf("foo" to 1)),
+                    "list-input" to ApiItem(type = "list", separator = ",", listItem = ApiItem(type = "string"), namedValues = mapOf("foo" to 1)),
+                    "enum-input" to ApiItem(type = "enum", allowedValues = listOf("foo", "bar"), namedValues = mapOf("foo" to 1)),
+                ),
+            )
+
+            // when
+            val result = manifest.validate()
+
+            // then
+            result shouldBe ActionValidationResult(
+                overallResult = ItemValidationResult.Invalid("Some typing is invalid."),
+                inputs = mapOf(
+                    "string-input" to ItemValidationResult.Invalid("'namedValues' are currently supported only for integers."),
+                    "boolean-input" to ItemValidationResult.Invalid("'namedValues' are currently supported only for integers."),
+                    "float-input" to ItemValidationResult.Invalid("'namedValues' are currently supported only for integers."),
+                    "list-input" to ItemValidationResult.Invalid("'namedValues' are currently supported only for integers."),
+                    "enum-input" to ItemValidationResult.Invalid("'namedValues' are currently supported only for integers."),
+                ),
+            )
+        }
     }
 })