Merge pull request #6 from SamTheisens/fix/spurious-required-fields

Fix/spurious required fields

Author: pjfanning

.scalafmt.conf

@@ -0,0 +1,10 @@
+# https://scalameta.org/scalafmt/docs/configuration.html
+version = "3.5.9"
+runner.dialect = scala213source3
+maxColumn = 140
+project.git = true
+
+spaces.afterKeywordBeforeParen = true
+align.preset = none
+align.openParenCallSite = false
+align.openParenDefnSite = false

src/main/scala/com/github/swagger/enumeratum/converter/SwaggerEnumeratumModelConverter.scala

@@ -97,4 +97,3 @@ class SwaggerEnumeratumModelConverter extends ModelResolver(Json.mapper()) {
     case Some(arr) => arr.toList
   }
 }
-

src/test/scala/com/github/swagger/enumeratum/converter/ModelPropertyParserTest.scala

@@ -2,7 +2,17 @@ package com.github.swagger.enumeratum.converter
 
 import io.swagger.v3.core.converter._
 import io.swagger.v3.oas.models.media._
-import models.{Ctx, ModelWCtxEnum, ModelWCtxEnumAndAnnotation, ModelWEnum, ModelWEnumAnnotated, ModelWEnumSet, ModelWOptionalEnum, OrderSize}
+import models.{
+  Animal,
+  Ctx,
+  ModelWCtxEnum,
+  ModelWCtxEnumAndAnnotation,
+  ModelWEnum,
+  ModelWEnumAnnotated,
+  ModelWEnumSet,
+  ModelWOptionalEnum,
+  OrderSize
+}
 import org.scalatest.OptionValues
 import org.scalatest.flatspec.AnyFlatSpec
 import org.scalatest.matchers.should.Matchers
@@ -14,32 +24,32 @@ class ModelPropertyParserTest extends AnyFlatSpec with Matchers with OptionValue
     val converter = ModelConverters.getInstance()
     val schemas = converter.readAll(classOf[ModelWEnum]).asScala.toMap
     val model = findModel(schemas, "ModelWEnum")
-    model should be (defined)
+    model should be(defined)
     model.get.getProperties should not be (null)
     val field = model.value.getProperties.get("field")
-    field shouldBe a [StringSchema]
+    field shouldBe a[StringSchema]
     field.asInstanceOf[StringSchema].getEnum.asScala shouldEqual OrderSize.values.map(_.entryName)
     nullSafeList(model.value.getRequired) shouldBe Seq("field")
   }
   it should "process Model with Optional Enumeratum Enum" in {
     val converter = ModelConverters.getInstance()
     val schemas = converter.readAll(classOf[ModelWOptionalEnum]).asScala.toMap
     val model = findModel(schemas, "ModelWOptionalEnum")
-    model should be (defined)
+    model should be(defined)
     model.get.getProperties should not be (null)
     val field = model.value.getProperties.get("field")
-    field shouldBe a [StringSchema]
+    field shouldBe a[StringSchema]
     field.asInstanceOf[StringSchema].getEnum.asScala shouldEqual OrderSize.values.map(_.entryName)
     nullSafeList(model.value.getRequired) shouldBe empty
   }
   it should "process Model with Enumeratum Set" in {
     val converter = ModelConverters.getInstance()
     val schemas = converter.readAll(classOf[ModelWEnumSet]).asScala.toMap
     val model = findModel(schemas, "ModelWEnumSet")
-    model should be (defined)
+    model should be(defined)
     model.get.getProperties should not be (null)
     val field = model.value.getProperties.get("sizes")
-    field shouldBe a [ArraySchema]
+    field shouldBe a[ArraySchema]
     val arraySchema = field.asInstanceOf[ArraySchema]
     arraySchema.getItems.getEnum.asScala shouldEqual OrderSize.values.map(_.entryName)
     nullSafeList(model.value.getRequired) shouldEqual List("sizes")
@@ -48,10 +58,10 @@ class ModelPropertyParserTest extends AnyFlatSpec with Matchers with OptionValue
     val converter = ModelConverters.getInstance()
     val schemas = converter.readAll(classOf[ModelWEnumAnnotated]).asScala.toMap
     val model = findModel(schemas, "ModelWEnumAnnotated")
-    model should be (defined)
+    model should be(defined)
     model.get.getProperties should not be (null)
     val field = model.value.getProperties.get("field")
-    field shouldBe a [StringSchema]
+    field shouldBe a[StringSchema]
     val schema = field.asInstanceOf[StringSchema]
     schema.getDescription shouldEqual "enum value"
     schema.getEnum.asScala shouldEqual OrderSize.values.map(_.entryName)
@@ -62,17 +72,40 @@ class ModelPropertyParserTest extends AnyFlatSpec with Matchers with OptionValue
     val schemas = converter.readAll(classOf[ModelWCtxEnum]).asScala.toMap
     schemas.keys should have size 1
     val model = findModel(schemas, "ModelWCtxEnum")
-    model should be (defined)
+    model should be(defined)
     model.get.getProperties should not be (null)
+
     val field = model.value.getProperties.get("field")
-    field shouldBe a [StringSchema]
+    field shouldBe a[StringSchema]
+    field.asInstanceOf[StringSchema].getRequired shouldBe null
+
     val schema = field.asInstanceOf[StringSchema]
     schema.getDescription shouldEqual (null)
-    schema.getDefault should be (null)
+    schema.getDefault should be(null)
     schema.getEnum.asScala shouldEqual Ctx.Color.values.map(_.entryName)
     nullSafeList(model.value.getRequired) shouldBe Seq("field")
   }
 
+  it should "process sealed abstract class" in {
+    val converter = ModelConverters.getInstance()
+    val schemas = converter.readAll(classOf[Animal]).asScala.toMap
+    val catModel = findModel(schemas, "Cat")
+    catModel should be(defined)
+    val catProps = catModel.value.getProperties
+    catProps should have size 3
+    catProps.get("name") shouldBe a[StringSchema]
+    catProps.get("age") shouldBe a[IntegerSchema]
+    catProps.get("animalType") shouldBe a[StringSchema]
+    catModel.value.getRequired.asScala shouldEqual Seq("age", "animalType", "name")
+    val dogModel = findModel(schemas, "Dog")
+    dogModel should be(defined)
+    val dogProps = dogModel.value.getProperties
+    dogProps should have size 2
+    dogProps.get("name") shouldBe a[StringSchema]
+    dogProps.get("animalType") shouldBe a[StringSchema]
+    dogModel.value.getRequired.asScala shouldEqual Seq("animalType", "name")
+  }
+
   it should "not add additional model when enum field is annotated" in {
     val converter = ModelConverters.getInstance()
     val schemas = converter.readAll(classOf[ModelWCtxEnumAndAnnotation]).asScala.toMap
@@ -86,8 +119,8 @@ class ModelPropertyParserTest extends AnyFlatSpec with Matchers with OptionValue
     val schema = field.asInstanceOf[StringSchema]
     schema.getDescription shouldEqual "An annotated field"
     schema.getName shouldEqual "field"
-    schema.getDefault should be (null)
-    schema.getDeprecated should be (null)
+    schema.getDefault should be(null)
+    schema.getDeprecated should be(null)
     schema.getEnum.asScala shouldEqual Ctx.Color.values.map(_.entryName)
     nullSafeList(model.value.getRequired) shouldBe Seq("field")
   }

src/test/scala/models/SealedTraitModels.scala

@@ -0,0 +1,11 @@
+package models
+
+sealed abstract class Animal(val animalType: String) {
+  val name: String
+}
+
+class Dog(val name: String) extends Animal("Dog")
+
+class Cat(val name: String, val age: Int) extends Animal("Cat")
+
+case class PetOwner(owner: String, pet: Animal)