#45, wrap with null type

Author: hauner

src/main/kotlin/io/openapiprocessor/core/converter/wrapper/NullDataTypeWrapper.kt

@@ -0,0 +1,64 @@
+/*
+ * Copyright 2020 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.converter.wrapper
+
+import io.openapiprocessor.core.converter.ApiOptions
+import io.openapiprocessor.core.converter.SchemaInfo
+import io.openapiprocessor.core.converter.mapping.MappingFinder
+import io.openapiprocessor.core.converter.mapping.TargetType
+import io.openapiprocessor.core.model.datatypes.DataType
+import io.openapiprocessor.core.model.datatypes.NoneDataType
+import io.openapiprocessor.core.model.datatypes.NullDataType
+
+/**
+ * wraps a data type in [io.openapiprocessor.core.model.datatypes.NullDataType].
+ */
+class NullDataTypeWrapper(
+    private val options: ApiOptions,
+    private val finder: MappingFinder = MappingFinder(options.typeMappings)
+) {
+
+    /**
+     * wraps any data type with the configured null data type like
+     * `org.openapitools.jackson.nullable.JsonNullable`.
+     *
+     * @param dataType the data type to wrap
+     * @param schemaInfo the open api type with context information
+     * @return the resulting java data type
+     */
+    fun wrap(dataType: DataType, schemaInfo: SchemaInfo): DataType {
+        val targetType = getNullDataType(schemaInfo)
+        if (targetType == null) {
+            return dataType
+        }
+
+        val wrappedType = NullDataType (
+            targetType.getName(),
+            targetType.getPkg(),
+            checkNone (dataType)
+        )
+
+        return wrappedType
+    }
+
+    private fun getNullDataType(info: SchemaInfo): TargetType? {
+        // check endpoint result mapping
+        return finder.findEndpointNullTypeMapping(info)?.getTargetType()
+
+        // not yet supported
+        // check global result mapping
+        // return finder.findNullTypeMapping()?.getTargetType()
+    }
+
+    private fun checkNone(dataType: DataType): DataType {
+        if (dataType is NoneDataType) {
+            return dataType.wrappedInResult ()
+        }
+
+        return dataType
+    }
+
+}

src/main/kotlin/io/openapiprocessor/core/model/datatypes/NullDataType.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2021 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.model.datatypes
+
+/**
+ * Null(able) data type wrapper. Assumes a single generic parameter.
+ */
+class NullDataType(
+    private val type: String,
+    private val pkg: String,
+    private val dataType: DataType
+): DataType {
+
+    override fun getName(): String {
+        return "$type<${dataType.getName()}>"
+    }
+
+    override fun getPackageName(): String {
+        return pkg
+    }
+
+    override fun getImports(): Set<String> {
+        return setOf("${getPackageName()}.$type") + dataType.getImports()
+    }
+
+    override fun getReferencedImports(): Set<String> {
+        return emptySet()
+    }
+
+}

src/test/kotlin/io/openapiprocessor/core/converter/wrapper/NullDataTypeWrapperSpec.kt

@@ -0,0 +1,50 @@
+/*
+ * Copyright 2020 https://github.com/openapi-processor/openapi-processor-core
+ * PDX-License-Identifier: Apache-2.0
+ */
+
+package io.openapiprocessor.core.converter.wrapper
+
+import io.kotest.core.spec.style.StringSpec
+import io.kotest.matchers.shouldBe
+import io.kotest.matchers.types.shouldBeSameInstanceAs
+import io.mockk.every
+import io.mockk.mockk
+import io.openapiprocessor.core.converter.ApiOptions
+import io.openapiprocessor.core.converter.SchemaInfo
+import io.openapiprocessor.core.converter.mapping.MappingFinder
+import io.openapiprocessor.core.converter.mapping.TypeMapping
+import io.openapiprocessor.core.model.datatypes.StringDataType
+import io.openapiprocessor.core.parser.RefResolver
+
+class NullDataTypeWrapperSpec : StringSpec({
+    val resolver = mockk<RefResolver>()
+
+    "does not wrap datatype if there is no null mapping" {
+        val finder = mockk<MappingFinder>()
+        every { finder.findEndpointNullTypeMapping(any()) } returns null
+
+        val wrapper = NullDataTypeWrapper(ApiOptions(), finder)
+
+        val info = SchemaInfo("/any", "", "", null, resolver)
+        val dataType = StringDataType()
+
+        wrapper.wrap(dataType, info).shouldBeSameInstanceAs(dataType)
+    }
+
+    "does wrap datatype if there is a null mapping" {
+        val finder = mockk<MappingFinder>()
+        every { finder.findEndpointNullTypeMapping(any()) } returns TypeMapping(
+            "null", "org.openapitools.jackson.nullable.JsonNullable")
+
+        val wrapper = NullDataTypeWrapper(ApiOptions(), finder)
+
+        val info = SchemaInfo("/any", "", "", null, resolver)
+        val dataType = StringDataType()
+
+        val result = wrapper.wrap(dataType, info)
+        result.getName().shouldBe("JsonNullable<String>")
+        result.getPackageName().shouldBe("org.openapitools.jackson.nullable")
+    }
+
+})