prefix invalid enum identifier instead of removing the invalid characters to avoid duplicate identifiers (openapi-processor/openapi-processor-spring#350)

hauner · hauner · commit 23e5fa07f383 · 2025-06-27T18:57:59.000+02:00
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/ApiOptions.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/ApiOptions.kt
@@ -170,4 +170,9 @@ class ApiOptions: MappingSettings {
      * break identifier names from digits to letters.
      */
     var identifierWordBreakFromDigitToLetter = true
+
+    /**
+     * prefix enum identifier if it starts with an invalid character.
+     */
+    var identifierPrefixInvalidEnumStart = true
 }
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/OptionsConverter.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/OptionsConverter.kt
@@ -113,6 +113,7 @@ class OptionsConverter(private val checkObsoleteProcessorOptions: Boolean = fals
                     with(mapping.compatibility) {
                         options.beanValidationValidOnReactive = beanValidationValidOnReactive
                         options.identifierWordBreakFromDigitToLetter = identifierWordBreakFromDigitToLetter
+                        options.identifierPrefixInvalidEnumStart = identifierPrefixInvalidEnumStart
                     }
 
                     val mappings = MappingConverter().convert(mapping)
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/Compatibility.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/processor/mapping/v2/Compatibility.kt
@@ -17,5 +17,10 @@ data class Compatibility(
     /**
      * split identifier when switching from digits to letters.
      */
-    val identifierWordBreakFromDigitToLetter: Boolean = true
+    val identifierWordBreakFromDigitToLetter: Boolean = true,
+
+    /**
+     * prefix enum identifier if it starts with an invalid character.
+     */
+    val identifierPrefixInvalidEnumStart: Boolean = true
 )
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/IdentifierOptions.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/IdentifierOptions.kt
@@ -9,5 +9,10 @@ data class IdentifierOptions(
     /**
      * recognize switch from digits to letters as word break.
      */
-    val wordBreakFromDigitToLetter: Boolean = true
+    val wordBreakFromDigitToLetter: Boolean = true,
+
+    /**
+     * prefix OpenAPI enum value if it starts with an invalid start character.
+     */
+    val prefixInvalidEnumStart: Boolean = true
 )
diff --git a/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/JavaIdentifier.kt b/openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/JavaIdentifier.kt
@@ -14,7 +14,7 @@ import javax.lang.model.SourceVersion
 import kotlin.collections.ArrayList
 
 
-private val INVALID_WORD_PREFIX = "v"
+private const val INVALID_WORD_PREFIX = "v"  // v for "value"
 private val INVALID_WORD_BREAKS = listOf(' ', '-')
 private val VALID_WORD_BREAKS = listOf('_')
 
@@ -51,7 +51,13 @@ class JavaIdentifier(val options: IdentifierOptions = IdentifierOptions()): Iden
     }
 
     override fun toEnum(src: String): String {
-        return joinEnum(splitAtWordBreaks(src))
+        val item = if (options.prefixInvalidEnumStart) {
+            src.prefixInvalidStart()
+        } else {
+            src
+        }
+
+        return joinEnum(splitAtWordBreaks(item))
     }
 
     override fun toMethodTail(src: String): String {
@@ -196,6 +202,13 @@ class JavaIdentifier(val options: IdentifierOptions = IdentifierOptions()): Iden
         return false
     }
 
+    private fun String.prefixInvalidStart(): String {
+        if(!isValidStart(this[0])) {
+            return INVALID_WORD_PREFIX.plus(this)
+        }
+        return this
+    }
+
     private fun String.trimInvalidStart(): String {
         return trimStart {
             !isValidStart(it)
diff --git a/openapi-processor-core/src/main/resources/mapping/v13/mapping.yaml.json b/openapi-processor-core/src/main/resources/mapping/v13/mapping.yaml.json
@@ -194,6 +194,11 @@
           "description": "identifier word break when switching from digits to letters.",
           "type": "boolean",
           "default": true
+        },
+        "identifier-prefix-invalid-enum-start": {
+          "description": "identifier, prefix enum if it starts with an invalid character.",
+          "type": "boolean",
+          "default": true
         }
       }
     },
diff --git a/openapi-processor-core/src/test/groovy/io/openapiprocessor/core/writer/java/IdentifierSpec.groovy b/openapi-processor-core/src/test/groovy/io/openapiprocessor/core/writer/java/IdentifierSpec.groovy
@@ -10,8 +10,25 @@ import spock.lang.Unroll
 
 class IdentifierSpec extends Specification {
 
+    void "prefixes invalid start character of enum values"() {
+        def convert = new JavaIdentifier(new IdentifierOptions(wbfdtl, pies))
+
+        convert.toEnum(src) == enumn
+
+        where:
+        src   | enumn   | wbfdtl | pies
+        "1A"  | "V1_A"  | true   | true
+        "1A"  | "A"     | true   | false
+        "1A"  | "V1A"   | false  | true
+        "1A"  | "A"     | false  | false
+        "_1A" | "V_1_A" | true   | true
+        "_1A" | "A"     | true   | false
+        "_1A" | "V_1A"  | false  | true
+        "_1A" | "A"     | false  | false
+    }
+
     void "add prefix to single invalid identifier"() {
-        def convert = new JavaIdentifier(new IdentifierOptions(wbfdtl))
+        def convert = new JavaIdentifier(new IdentifierOptions(wbfdtl, true))
 
         expect:
         convert.toCamelCase(src) == camelCase
@@ -28,7 +45,7 @@ class IdentifierSpec extends Specification {
     }
 
     void "recognize word break if a digit is followed by a letter" () {
-        def convert = new JavaIdentifier(new IdentifierOptions(true))
+        def convert = new JavaIdentifier(new IdentifierOptions(true, true))
 
         expect:
         convert.toCamelCase(src) == camelCase
@@ -42,7 +59,7 @@ class IdentifierSpec extends Specification {
     }
 
     void "ignore word break if a digit is followed by a letter" () {
-        def convert = new JavaIdentifier(new IdentifierOptions(false))
+        def convert = new JavaIdentifier(new IdentifierOptions(false, true))
 
         expect:
         convert.toCamelCase(src) == camelCase
@@ -57,7 +74,7 @@ class IdentifierSpec extends Specification {
 
     @Unroll
     void "convert source string '#src' to valid identifiers: #identifier/#clazz/#enumn" () {
-        def convert = new JavaIdentifier(new IdentifierOptions(true))
+        def convert = new JavaIdentifier(new IdentifierOptions(true, true))
 
         expect:
         convert.toCamelCase (src) == camelCase
@@ -74,8 +91,8 @@ class IdentifierSpec extends Specification {
         "AA"             | "aa"           | "aa"           | "Aa"           | "AA"
 
         // invalid chars are stripped
-        "1a"             | "a"            | "a"            | "A"            | "A"
-        "2345a"          | "a"            | "a"            | "A"            | "A"
+        "1a"             | "a"            | "a"            | "A"            | "V1_A"
+        "2345a"          | "a"            | "a"            | "A"            | "V2345_A"
 
         // word break at invalid character
         "a foo"          | "aFoo"         | "aFoo"         | "AFoo"         | "A_FOO"
@@ -85,10 +102,10 @@ class IdentifierSpec extends Specification {
         "a-foo-bar"      | "aFooBar"      | "aFooBar"      | "AFooBar"      | "A_FOO_BAR"
         "a foo-bar"      | "aFooBar"      | "aFooBar"      | "AFooBar"      | "A_FOO_BAR"
         'api/some/thing' | 'apiSomeThing' | 'apiSomeThing' | "ApiSomeThing" | "API_SOME_THING"
-        "_fo-o"          | 'foO'          | 'foO'          | 'FoO'          | "FO_O"
+        "_fo-o"          | 'foO'          | 'foO'          | 'FoO'          | "V_FO_O"
 
         // word break at underscore, it is valid but unwanted except for enums
-        "_ab"            | "ab"           | "ab"           | "Ab"           | "AB"
+        "_ab"            | "ab"           | "ab"           | "Ab"           | "V_AB"
         "a_b"            | "aB"           | "aB"           | "AB"           | "A_B"
         "a_foo"          | "aFoo"         | "aFoo"         | "AFoo"         | "A_FOO"
         "A_A"            | "aA"           | "aA"           | "AA"           | "A_A"
@@ -116,14 +133,14 @@ class IdentifierSpec extends Specification {
     }
 
     void "adds suffix to class name" () {
-        def convert = new JavaIdentifier(new IdentifierOptions(true))
+        def convert = new JavaIdentifier(new IdentifierOptions(true, true))
 
         expect:
         convert.toClass("foo", "X") == "FooX"
     }
 
     void "ignores suffix if class name already ends with the suffix"() {
-        def convert = new JavaIdentifier(new IdentifierOptions(true))
+        def convert = new JavaIdentifier(new IdentifierOptions(true, true))
 
         expect:
         convert.toClass("FooX", "X") == "FooX"
diff --git a/openapi-processor-core/src/test/groovy/io/openapiprocessor/core/writer/java/StringEnumWriterSpec.groovy b/openapi-processor-core/src/test/groovy/io/openapiprocessor/core/writer/java/StringEnumWriterSpec.groovy
@@ -139,7 +139,7 @@ public enum $type implements Supplier<String> {
         target.toString ().contains ("""\
 public enum Foo {
     FOO("foo"),
-    FOO_2("_foo-2"),
+    V_FOO_2("_foo-2"),
     FOO_FOO("foo-foo");
 
 """)
diff --git a/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/converter/OptionsConverterSpec.kt b/openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/converter/OptionsConverterSpec.kt
@@ -49,6 +49,7 @@ class OptionsConverterSpec: StringSpec({
 
         options.beanValidationValidOnReactive.shouldBeTrue()
         options.identifierWordBreakFromDigitToLetter.shouldBeTrue()
+        options.identifierPrefixInvalidEnumStart.shouldBeTrue()
     }
 
     "should set target dir" {
@@ -130,6 +131,7 @@ class OptionsConverterSpec: StringSpec({
                 compatibility:
                   bean-validation-valid-on-reactive: false
                   identifier-word-break-from-digit-to-letter: false
+                  identifier-prefix-invalid-enum-start: false
             """.trimIndent()
         ))
 
@@ -153,6 +155,7 @@ class OptionsConverterSpec: StringSpec({
 
         options.beanValidationValidOnReactive.shouldBeFalse()
         options.identifierWordBreakFromDigitToLetter.shouldBeFalse()
+        options.identifierPrefixInvalidEnumStart.shouldBeFalse()
     }
 
     "overrides old target-dir mapping options" {

Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,7 @@ class OptionsConverter(private val checkObsoleteProcessorOptions: Boolean = fals`
`113`	`113`	`with(mapping.compatibility) {`
`114`	`114`	`options.beanValidationValidOnReactive = beanValidationValidOnReactive`
`115`	`115`	`options.identifierWordBreakFromDigitToLetter = identifierWordBreakFromDigitToLetter`
	`116`	`+ options.identifierPrefixInvalidEnumStart = identifierPrefixInvalidEnumStart`
`116`	`117`	`}`
`117`	`118`
`118`	`119`	`val mappings = MappingConverter().convert(mapping)`
Original file line number	Diff line number	Diff line change
`@@ -194,6 +194,11 @@`
`194`	`194`	`"description": "identifier word break when switching from digits to letters.",`
`195`	`195`	`"type": "boolean",`
`196`	`196`	`"default": true`
	`197`	`+ },`
	`198`	`+ "identifier-prefix-invalid-enum-start": {`
	`199`	`+ "description": "identifier, prefix enum if it starts with an invalid character.",`
	`200`	`+ "type": "boolean",`
	`201`	`+ "default": true`
`197`	`202`	`}`
`198`	`203`	`}`
`199`	`204`	`},`