#30, support "object @ io.oap.Annotation" mapping

Author: hauner

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

@@ -16,8 +16,8 @@ import io.openapiprocessor.core.model.HttpMethod
  */
 class MappingFinder(private val typeMappings: List<Mapping> = emptyList()) {
 
-    fun findTypeAnnotations(typeName: String): List<AnnotationTypeMapping> {
-        return findTypeAnnotations(typeMappings, typeName)
+    fun findTypeAnnotations(typeName: String, allowObject: Boolean = false): List<AnnotationTypeMapping> {
+        return findTypeAnnotations(typeMappings, typeName, allowObject)
     }
 
     fun findParameterAnnotations(path: String, method: HttpMethod?, typeName: String)
@@ -53,7 +53,7 @@ class MappingFinder(private val typeMappings: List<Mapping> = emptyList()) {
             .flatten()
     }
 
-    private fun findTypeAnnotations(typeMappings: List<Mapping>, typeName: String)
+    private fun findTypeAnnotations(typeMappings: List<Mapping>, typeName: String, allowObject: Boolean = false)
         : List<AnnotationTypeMapping> {
 
         val (type, format) = splitTypeName(typeName)
@@ -64,7 +64,7 @@ class MappingFinder(private val typeMappings: List<Mapping> = emptyList()) {
                 val matchType = it.sourceTypeName == type
                 val matchFormat = it.sourceTypeFormat == format
 
-                (matchType && matchFormat) || (matchObject && matchFormat)
+                (matchType && matchFormat) || (allowObject && matchObject)
             }
     }
 

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

@@ -82,7 +82,7 @@ class DataTypeWriterPojo(
 
     private fun writeAnnotationsMappings(target: Writer, dataType: ModelDataType) {
         val annotationTypeMappings = MappingFinder(apiOptions.typeMappings)
-            .findTypeAnnotations(dataType.getTypeName())
+            .findTypeAnnotations(dataType.getTypeName(), true)
 
         annotationTypeMappings.forEach {
             annotationWriter.write(target, Annotation(it.annotation.type, it.annotation.parameters))
@@ -273,7 +273,7 @@ class DataTypeWriterPojo(
         imports.addAll(dataType.referencedImports)
 
         val annotationTypeMappings = MappingFinder(apiOptions.typeMappings)
-            .findTypeAnnotations(dataType.getTypeName())
+            .findTypeAnnotations(dataType.getTypeName(), true)
 
         annotationTypeMappings.forEach {
             imports.add(it.annotation.type)

openapi-processor-core/src/test/kotlin/io/openapiprocessor/core/converter/MappingFinderAnnotationSpec.kt

@@ -6,10 +6,15 @@
 package io.openapiprocessor.core.converter
 
 import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.collections.shouldBeEmpty
 import io.kotest.matchers.shouldBe
 import io.openapiprocessor.core.converter.mapping.Annotation
 import io.openapiprocessor.core.converter.mapping.AnnotationTypeMapping
 import io.openapiprocessor.core.converter.mapping.ParameterAnnotationTypeMapping
+import io.openapiprocessor.core.model.datatypes.ArrayDataType
+import io.openapiprocessor.core.model.datatypes.StringDataType
+import io.openapiprocessor.core.support.datatypes.ObjectDataType
+import io.openapiprocessor.core.support.datatypes.propertyDataTypeString
 
 class MappingFinderAnnotationSpec: StringSpec({
 
@@ -26,19 +31,37 @@ class MappingFinderAnnotationSpec: StringSpec({
         mapping.first().sourceTypeName shouldBe "Foo"
     }
 
-    "find 'object' type annotation mapping" {
+    "find 'object' type annotation mapping for model data type" {
         val finder = MappingFinder(listOf(
             AnnotationTypeMapping(
                 "object", null,
                 Annotation("annotation.Bar"))
         ))
 
-        val mapping = finder.findTypeAnnotations("Foo")
+        val dataType = ObjectDataType("Foo", "pkg", linkedMapOf(
+            Pair("foo", propertyDataTypeString())
+        ))
+
+        val mapping = finder.findTypeAnnotations(dataType.getTypeName(), true)
 
         mapping.size shouldBe 1
         mapping.first().sourceTypeName shouldBe "object"
     }
 
+    "ignore 'object' type annotation mapping for non model data types" {
+        val finder = MappingFinder(listOf(
+            AnnotationTypeMapping(
+                "object", null,
+                Annotation("annotation.Bar"))
+        ))
+
+        val mappingSimple = finder.findTypeAnnotations(StringDataType().getTypeName())
+        mappingSimple.shouldBeEmpty()
+
+        val mappingCollection = finder.findTypeAnnotations(ArrayDataType(StringDataType()).getTypeName())
+        mappingCollection.shouldBeEmpty()
+    }
+
     "find type:format annotation mapping" {
         val finder = MappingFinder(listOf(
             AnnotationTypeMapping(

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

@@ -347,4 +347,45 @@ class DataTypeWriterPojoSpec: StringSpec({
             |}
             """.trimMargin()
     }
+
+    "writes additional annotation from 'object' annotation mapping" {
+        options.typeMappings = listOf(
+            AnnotationTypeMapping(
+                "object", annotation = MappingAnnotation("foo.Bar", linkedMapOf())
+            )
+        )
+
+        writer = DataTypeWriterPojo(options, generatedWriter, BeanValidationFactory())
+
+        val dataType = ObjectDataType("Object",
+            "pkg", linkedMapOf(
+                "foo" to propertyDataType(ObjectDataType("Foo", "model")))
+            )
+
+        // when:
+        writer.write(target, dataType)
+
+        // then:
+        target.toString() shouldContain
+            """    
+            |@Bar
+            |@Generated
+            |public class Object {
+            |
+            |    @JsonProperty("foo")
+            |    private Foo foo;
+            |
+            |    public Foo getFoo() {
+            |        return foo;
+            |    }
+            |
+            |    public void setFoo(Foo foo) {
+            |        this.foo = foo;
+            |    }
+            |
+            |}
+            """.trimMargin()
+    }
+
+
 })