extract factory for json annotations

Author: hauner

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

@@ -44,7 +44,7 @@ abstract class DataTypeWriterBase(
     protected val identifier: Identifier,
     protected val generatedWriter: GeneratedWriter,
     protected val validationAnnotations: BeanValidationFactory,
-    protected val jacksonAnnotations: JacksonAnnotations,
+    protected val jsonAnnotations: JsonAnnotationFactory,
     protected val javadocFactory: JavaDocFactory
 ): DataTypeWriter {
     protected val annotationWriter = AnnotationWriter()
@@ -126,7 +126,9 @@ abstract class DataTypeWriterBase(
         result += extBuilder.toString()
 
         if (requiresJsonPropertyAnnotation(propData)) {
-            result += "    ${getPropertyAnnotation(propData.srcPropName, propDataType)}"
+            jsonAnnotations.createPropertyAnnotations(propData.srcPropName, propDataType).forEach {
+                result += "    $it\n"
+            }
         }
 
         result += if (access == Access.PRIVATE) {
@@ -186,28 +188,6 @@ abstract class DataTypeWriterBase(
         }
     }
 
-    private fun getPropertyAnnotation(propertyName: String, propDataType: PropertyDataType): String {
-        val access = getAccess(propDataType)
-
-        var result = "@JsonProperty("
-        result += if (access != null) {
-            "value = \"$propertyName\", access = JsonProperty.Access.${access.value}"
-        } else {
-            "\"$propertyName\""
-        }
-
-        result += ")\n"
-        return result
-    }
-
-    private fun getAccess(propDataType: PropertyDataType): PropertyAccess? {
-        return when {
-            propDataType.readOnly -> PropertyAccess("READ_ONLY")
-            propDataType.writeOnly -> PropertyAccess("WRITE_ONLY")
-            else -> null
-        }
-    }
-
     protected fun ifDeprecated(propDataType: DataType): String {
         return if (propDataType.deprecated) {
             "    $deprecated\n"
@@ -324,7 +304,7 @@ abstract class DataTypeWriterBase(
         val target = getTarget(propData.propDataType)
 
         if (requiresJsonPropertyAnnotation(propData)) {
-            imports.addAll(jacksonAnnotations.jsonProperty.imports)
+            imports.addAll(jsonAnnotations.createPropertyImports(propData.propDataType))
         }
 
         if (apiOptions.beanValidation) {
@@ -391,4 +371,3 @@ abstract class DataTypeWriterBase(
     }
 }
 
-class PropertyAccess(val value: String)

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

@@ -7,6 +7,7 @@ package io.openapiprocessor.core.writer.java
 
 import io.openapiprocessor.core.converter.ApiOptions
 import io.openapiprocessor.core.model.Annotation
+import io.openapiprocessor.core.model.datatypes.PropertyDataType
 
 /**
  * TODO remove v3
@@ -15,16 +16,17 @@ import io.openapiprocessor.core.model.Annotation
  *
  * mapping jon schema definition to configure the jackson version.
  *
- *         "jackson": {
- *           "description": "jackson annotations version.",
- *           "default": "v2",
- *           "enum": ["v2", "v3"]
- *         },
+ *  "jackson": {
+ *    "description": "jackson annotations version.",
+ *    "default": "v2",
+ *    "enum": ["v2", "v3"]
+ *  }
  */
-class JacksonAnnotations(apiOptions: ApiOptions) {
-    val jsonProperty: Annotation
-    val jsonCreator: Annotation
-    val jsonValue: Annotation
+class JacksonAnnotations(apiOptions: ApiOptions): JsonAnnotationFactory {
+    @Deprecated("use methods")
+    override val jsonProperty: Annotation  // todo make private
+    override val jsonCreator: Annotation
+    override val jsonValue: Annotation
 
     init {
         when (getJacksonFormat(apiOptions)) {
@@ -41,11 +43,42 @@ class JacksonAnnotations(apiOptions: ApiOptions) {
         }
     }
 
+    override fun createPropertyImports(propDataType: PropertyDataType): Collection<String> {
+        return jsonProperty.imports
+    }
+
+    override fun createPropertyAnnotations(propertyName: String, propDataType: PropertyDataType): Collection<String> {
+        val params = createPropertyParameter(propertyName, getAccess(propDataType))
+        val result = "${jsonProperty.annotationName}(${params.joinToString(", ")})"
+        return listOf(result)
+    }
+
+    private fun createPropertyParameter(propertyName: String, access: PropertyAccess?): Collection<String> {
+        return if (access != null) {
+            listOf(
+                """value = "$propertyName"""",
+                "access = JsonProperty.Access.${access.value}"
+            )
+        } else {
+            listOf(""""$propertyName"""")
+        }
+    }
+
+    private fun getAccess(propDataType: PropertyDataType): PropertyAccess? {
+        return when {
+            propDataType.readOnly -> PropertyAccess("READ_ONLY")
+            propDataType.writeOnly -> PropertyAccess("WRITE_ONLY")
+            else -> null
+        }
+    }
+
     private fun getJacksonFormat(options: ApiOptions): JacksonFormat {
         return when (options.jackson) {
             "v2" -> JacksonFormat.V2
-            "v3" -> JacksonFormat.V3
+            "v3" -> JacksonFormat.V2 /* v3 is currently not needed */
             else -> JacksonFormat.V2
         }
     }
 }
+
+class PropertyAccess(val value: String)

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

@@ -12,5 +12,6 @@ import io.openapiprocessor.core.model.EndpointResponse
  * mapping annotation factory.
  */
 interface MappingAnnotationFactory {
+    //fun imports(endpoint: Endpoint, endpointResponse: EndpointResponse): List<String> { return emptyList() }
     fun create(endpoint: Endpoint, endpointResponse: EndpointResponse): List<String>
 }

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterPojoSpec.kt

@@ -881,7 +881,10 @@ class DataTypeWriterPojoSpec: StringSpec({
 
         writer.write(target, dataType)
 
-        verify { jackson.jsonProperty }
+        verify {
+            jackson.createPropertyImports(any())
+            jackson.createPropertyAnnotations(any(), any())
+        }
     }
 
 })

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/DataTypeWriterRecordSpec.kt

@@ -587,7 +587,10 @@ class DataTypeWriterRecordSpec: StringSpec({
 
         writer.write(target, dataType)
 
-        verify { jackson.jsonProperty }
+        verify {
+            jackson.createPropertyImports(any())
+            jackson.createPropertyAnnotations(any(), any())
+        }
     }
 })
 

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/writer/java/JacksonAnnotationsSpec.kt

@@ -7,7 +7,9 @@ package io.openapiprocessor.core.writer.java
 
 import io.kotest.core.spec.style.StringSpec
 import io.kotest.matchers.collections.shouldContainExactly
+import io.mockk.mockk
 import io.openapiprocessor.core.converter.ApiOptions
+import io.openapiprocessor.core.model.datatypes.PropertyDataType
 
 class JacksonAnnotationsSpec: StringSpec({
 
@@ -17,18 +19,22 @@ class JacksonAnnotationsSpec: StringSpec({
 
         val jackson = JacksonAnnotations(options)
 
-        jackson.jsonProperty.imports shouldContainExactly setOf("com.fasterxml.jackson.annotation.JsonProperty")
+        jackson.createPropertyImports(mockk<PropertyDataType>())
+            .shouldContainExactly(setOf("com.fasterxml.jackson.annotation.JsonProperty"))
+
         jackson.jsonCreator.imports shouldContainExactly setOf("com.fasterxml.jackson.annotation.JsonCreator")
         jackson.jsonValue.imports shouldContainExactly setOf("com.fasterxml.jackson.annotation.JsonValue")
     }
 
-    "provides jackson 3 annotations" {
+    "provides jackson 3 annotations".config(enabled = false) {
         val options = ApiOptions()
         options.jackson = "v3"
 
         val jackson = JacksonAnnotations(options)
 
-        jackson.jsonProperty.imports shouldContainExactly setOf("tools.jackson.annotation.JsonProperty")
+        jackson.createPropertyImports(mockk<PropertyDataType>())
+            .shouldContainExactly(setOf("tools.jackson.annotation.JsonProperty"))
+
         jackson.jsonCreator.imports shouldContainExactly setOf("tools.jackson.annotation.JsonCreator")
         jackson.jsonValue.imports shouldContainExactly setOf("tools.jackson.annotation.JsonValue")
     }