Nullable arrays (#301)

* test: Added nullableArrayItems model generation test * Fix nullable array parameterized type. Also combining the two latest test cases around nullable true into existing test cases to reduce example set --------- Co-authored-by: DavidMazarro <[email protected]>
cjbooms · Jul 14, 2024 · 8caa7c4 · 8caa7c4
1 parent 9600df3
commit 8caa7c4
Show file tree

Hide file tree

Showing 9 changed files with 32 additions and 59 deletions.
diff --git a/src/main/kotlin/com/cjbooms/fabrikt/generators/model/JacksonModelGenerator.kt b/src/main/kotlin/com/cjbooms/fabrikt/generators/model/JacksonModelGenerator.kt
@@ -86,6 +86,7 @@ class JacksonModelGenerator(
                     toModelType(
                         basePackage,
                         typeInfo.parameterizedType,
+                        typeInfo.isParameterizedTypeNullable
                     ),
                 )
 

diff --git a/src/main/kotlin/com/cjbooms/fabrikt/model/KotlinTypeInfo.kt b/src/main/kotlin/com/cjbooms/fabrikt/model/KotlinTypeInfo.kt
@@ -35,7 +35,11 @@ sealed class KotlinTypeInfo(val modelKClass: KClass<*>, val generatedModelClassN
     object UntypedObject : KotlinTypeInfo(Any::class)
     object AnyType : KotlinTypeInfo(Any::class)
     data class Object(val simpleClassName: String) : KotlinTypeInfo(GeneratedType::class, simpleClassName)
-    data class Array(val parameterizedType: KotlinTypeInfo) : KotlinTypeInfo(List::class)
+    data class Array(
+        val parameterizedType: KotlinTypeInfo,
+        val isParameterizedTypeNullable: kotlin.Boolean = false
+    ) : KotlinTypeInfo(List::class)
+
     data class Map(val parameterizedType: KotlinTypeInfo) : KotlinTypeInfo(Map::class)
     object UnknownAdditionalProperties : KotlinTypeInfo(Any::class)
     object UntypedObjectAdditionalProperties : KotlinTypeInfo(Any::class)
@@ -77,7 +81,7 @@ sealed class KotlinTypeInfo(val modelKClass: KClass<*>, val generatedModelClassN
                 OasType.Array ->
                     if (schema.itemsSchema.isNotDefined())
                         throw IllegalArgumentException("Property ${schema.name} cannot be parsed to a Schema. Check your input")
-                    else Array(from(schema.itemsSchema, oasKey, enclosingSchema))
+                    else Array(from(schema.itemsSchema, oasKey, enclosingSchema), schema.itemsSchema.isNullable)
 
                 OasType.Object -> Object(ModelNameRegistry.getOrRegister(schema, enclosingSchema))
                 OasType.Map ->

diff --git a/src/test/kotlin/com/cjbooms/fabrikt/generators/ModelGeneratorTest.kt b/src/test/kotlin/com/cjbooms/fabrikt/generators/ModelGeneratorTest.kt
@@ -63,7 +63,6 @@ class ModelGeneratorTest {
         "openapi310",
         "binary",
         "oneOfMarkerInterface",
-        "requiredButNullableObjectProperty",
     )
 
     @BeforeEach

diff --git a/src/test/resources/examples/arrays/api.yaml b/src/test/resources/examples/arrays/api.yaml
@@ -16,6 +16,12 @@ components:
             properties:
               some-array-prop:
                 type: string
+        a-nullable-array:
+          type: array
+          nullable: true
+          items:
+            type: string
+            nullable: true
 
     ArrayOfSomething:
       type: array

diff --git a/src/test/resources/examples/arrays/models/ContainsArrayOfArrays.kt b/src/test/resources/examples/arrays/models/ContainsArrayOfArrays.kt
@@ -2,6 +2,7 @@ package examples.arrays.models
 
 import com.fasterxml.jackson.`annotation`.JsonProperty
 import javax.validation.Valid
+import kotlin.String
 import kotlin.collections.List
 
 public data class ContainsArrayOfArrays(
@@ -13,4 +14,7 @@ public data class ContainsArrayOfArrays(
   @get:JsonProperty("absent-object-type-in-array")
   @get:Valid
   public val absentObjectTypeInArray: List<ContainsArrayOfArraysAbsentObjectTypeInArray>? = null,
+  @param:JsonProperty("a-nullable-array")
+  @get:JsonProperty("a-nullable-array")
+  public val aNullableArray: List<String?>? = null,
 )
diff --git a/src/test/resources/examples/optionalVsRequired/api.yaml b/src/test/resources/examples/optionalVsRequired/api.yaml
@@ -5,13 +5,17 @@ components:
       type: object
       required:
       - name
-      - requiredNullable
+      - requiredNullableString
+      - requiredNullableUntypedObject
       properties:
         name:
           type: string
         gender:
           type: string
           format: uuid
-        requiredNullable:
+        requiredNullableString:
           type: string
-          nullable: true
+          nullable: true
+        requiredNullableUntypedObject:
+          type: object
+          nullable: true
diff --git a/src/test/resources/examples/optionalVsRequired/models/OptionalVsRequired.kt b/src/test/resources/examples/optionalVsRequired/models/OptionalVsRequired.kt
@@ -3,7 +3,9 @@ package examples.optionalVsRequired.models
 import com.fasterxml.jackson.`annotation`.JsonProperty
 import java.util.UUID
 import javax.validation.constraints.NotNull
+import kotlin.Any
 import kotlin.String
+import kotlin.collections.Map
 
 public data class OptionalVsRequired(
   @param:JsonProperty("name")
@@ -13,7 +15,10 @@ public data class OptionalVsRequired(
   @param:JsonProperty("gender")
   @get:JsonProperty("gender")
   public val gender: UUID? = null,
-  @param:JsonProperty("requiredNullable")
-  @get:JsonProperty("requiredNullable")
-  public val requiredNullable: String?,
+  @param:JsonProperty("requiredNullableString")
+  @get:JsonProperty("requiredNullableString")
+  public val requiredNullableString: String?,
+  @param:JsonProperty("requiredNullableUntypedObject")
+  @get:JsonProperty("requiredNullableUntypedObject")
+  public val requiredNullableUntypedObject: Map<String, Any?>?,
 )
diff --git a/src/test/resources/examples/requiredButNullableObjectProperty/api.yaml b/src/test/resources/examples/requiredButNullableObjectProperty/api.yaml
diff --git a/...es/examples/requiredButNullableObjectProperty/models/RequiredButNullableObjectProperty.kt b/...es/examples/requiredButNullableObjectProperty/models/RequiredButNullableObjectProperty.kt