openapi-processor/openapi-processor-spring#198, generate supplier enum

Author: hauner

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/converter/ApiOptions.kt

@@ -52,7 +52,7 @@ class ApiOptions {
     var modelType = "default"
 
     /**
-     * enum type. default|string|framework.
+     * enum type. default|string|supplier.
      */
     var enumType = "default"
 

openapi-processor-core/src/main/kotlin/io/openapiprocessor/core/writer/java/StringEnumWriter.kt

@@ -5,14 +5,15 @@
 
 package io.openapiprocessor.core.writer.java
 
+import io.openapiprocessor.core.converter.ApiOptions
 import io.openapiprocessor.core.model.datatypes.DataType
 import io.openapiprocessor.core.model.datatypes.StringEnumDataType
 import java.io.Writer
 
 /**
  * Writer for String enum.
  */
-open class StringEnumWriter(private val generatedWriter: GeneratedWriter) {
+open class StringEnumWriter(private val apiOptions: ApiOptions, private val generatedWriter: GeneratedWriter) {
 
     fun write(target: Writer, dataType: StringEnumDataType) {
         target.write("package ${dataType.getPackageName()};\n\n")
@@ -27,7 +28,11 @@ open class StringEnumWriter(private val generatedWriter: GeneratedWriter) {
 
         generatedWriter.writeUse(target)
         target.write("\n")
-        target.write("public enum ${dataType.getTypeName()} {\n")
+        target.write("public enum ${dataType.getTypeName()}")
+        if (isSupplier()) {
+            target.write(" implements Supplier<String>")
+        }
+        target.write(" {\n")
 
         val values = mutableListOf<String>()
         dataType.values.forEach {
@@ -45,15 +50,29 @@ open class StringEnumWriter(private val generatedWriter: GeneratedWriter) {
             |
             """.trimMargin())
 
-        target.write(
-            """
-            |    @JsonValue
-            |    public String getValue() {
-            |        return this.value;
-            |    }
-            |
-            |
-            """.trimMargin())
+        if(isSupplier()) {
+            target.write(
+                """
+                |    @JsonValue
+                |    public String get() {
+                |        return this.value;
+                |    }
+                |
+                |
+                """.trimMargin())
+
+        } else {
+            // default
+            target.write(
+                """
+                |    @JsonValue
+                |    public String getValue() {
+                |        return this.value;
+                |    }
+                |
+                |
+                """.trimMargin())
+        }
 
         target.write(
             """
@@ -78,10 +97,16 @@ open class StringEnumWriter(private val generatedWriter: GeneratedWriter) {
         imports.add ("com.fasterxml.jackson.annotation.JsonValue")
         imports.add(generatedWriter.getImport())
         imports.addAll (dataType.referencedImports)
+        if (isSupplier()) {
+            imports.add ("java.util.function.Supplier")
+        }
 
         return DefaultImportFilter ()
             .filter(packageName, imports)
             .sorted()
     }
 
+    private fun isSupplier(): Boolean {
+        return apiOptions.enumType == "supplier"
+    }
 }

openapi-processor-core/src/main/resources/mapping/v5/mapping.example.yaml

@@ -25,7 +25,7 @@ options: # general processor options [required]
   # default (i.e pojo) or record
   model-type: default
 
-  # default, string, framework
+  # default, string, supplier
   enum-type: default
 
   # generate common interface for an `oneOf` object list (optional): true or false (default)

openapi-processor-core/src/main/resources/mapping/v5/mapping.yaml.json

@@ -54,9 +54,9 @@
           "enum": ["default", "record"]
         },
         "enum-type": {
-          "description": "generate default, string or framework specific enum. Default is default.",
+          "description": "generate default enum, string or supplier enum. Default is default.",
           "default": "default",
-          "enum": ["default", "string", "framework"]
+          "enum": ["default", "string", "supplier"]
         },
         "one-of-interface": {
           "description": "generate common interface for a `oneOf` object list.",

openapi-processor-core/src/test/groovy/com/github/hauner/openapi/core/writer/java/StringEnumWriterSpec.groovy

@@ -15,7 +15,7 @@ import spock.lang.Specification
 class StringEnumWriterSpec extends Specification {
     def options = new ApiOptions()
     def generatedWriter = new SimpleGeneratedWriter(options)
-    def writer = new StringEnumWriter(generatedWriter)
+    def writer = new StringEnumWriter(options, generatedWriter)
     def target = new StringWriter ()
 
     void "writes 'package'" () {
@@ -69,6 +69,46 @@ public enum $type {
         'Foo' | 'FooX'
     }
 
+    void "writes Supplier import" () {
+        options.enumType = "supplier"
+
+        def dataType = new StringEnumDataType(
+            new DataTypeName('Foo'), 'pkg', [], null, false)
+
+        when:
+        writer.write (target, dataType)
+
+        then:
+        target.toString ().contains ("""\
+import java.util.function.Supplier;
+""")
+    }
+
+    void "writes enum class implementing Supplier<String>"() {
+        options.enumType = "supplier"
+
+        def pkg = 'com.github.hauner.openapi'
+        def dataType = new StringEnumDataType(
+            new DataTypeName(id, type), pkg, [], null, false)
+
+        when:
+        writer.write (target, dataType)
+
+        then:
+        target.toString ().contains ("""\
+@Generated
+public enum $type implements Supplier<String> {
+""")
+        target.toString ().contains ("""\
+}
+""")
+
+        where:
+        id    | type
+        'Foo' | 'Foo'
+        'Foo' | 'FooX'
+    }
+
     void "writes enum values"() {
         def pkg = 'com.github.hauner.openapi'
         def dataType = new StringEnumDataType(
@@ -141,6 +181,27 @@ public enum Foo {
         return this.value;
     }
 
+""")
+    }
+
+    void "writes @JsonValue & Supplier<> method for serialization"() {
+        options.enumType = "supplier"
+
+        def pkg = 'com.github.hauner.openapi'
+        def dataType = new StringEnumDataType (
+            new DataTypeName('Foo'), pkg, ['foo', '_foo-2', 'foo-foo'], null, false)
+
+        when:
+        writer.write (target, dataType)
+
+        then:
+        target.toString ().contains ("""\
+
+    @JsonValue
+    public String get() {
+        return this.value;
+    }
+
 """)
     }
 

openapi-processor-core/src/testInt/kotlin/io/openapiprocessor/core/TestProcessor.kt

@@ -81,7 +81,7 @@ class TestProcessor:
                         javaDocWriter
                     )
                 },
-                StringEnumWriter(generatedWriter),
+                StringEnumWriter(options, generatedWriter),
                 InterfaceDataTypeWriter(
                     options,
                     generatedWriter,