Merge pull request #4 from SamTheisens/fix/duplicate-entry-for-annotated-enums

Fix: duplicate entry for annotated enums

Author: pjfanning

.gitignore

@@ -1,2 +1,3 @@
-
+target/
 .bsp/sbt.json
+.idea/

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

@@ -14,34 +14,34 @@ import io.swagger.v3.oas.models.media.Schema
 class SwaggerEnumeratumModelConverter extends ModelResolver(Json.mapper()) {
   private val enumEntryClass = classOf[EnumEntry]
 
+  def noneIfEmpty(s: String): Option[String] = Option(s).filter(_.trim.nonEmpty)
+
   override def resolve(annotatedType: AnnotatedType, context: ModelConverterContext, chain: Iterator[ModelConverter]): Schema[_] = {
     val javaType = _mapper.constructType(annotatedType.getType)
     val cls = javaType.getRawClass
     if (isEnum(cls)) {
       val sp: Schema[String] = PrimitiveType.STRING.createProperty().asInstanceOf[Schema[String]]
       setRequired(annotatedType)
-      getValues(cls).foreach { v =>
+      getValues(cls).foreach { v: String =>
         sp.addEnumItemObject(v)
       }
       nullSafeList(annotatedType.getCtxAnnotations).foreach {
         case p: Parameter => {
-          Option(p.description).foreach(desc => sp.setDescription(desc))
+          noneIfEmpty(p.description).foreach(desc => sp.setDescription(desc))
           sp.setDeprecated(p.deprecated)
-          Option(p.example).foreach(ex => sp.setExample(ex))
-          Option(p.name).foreach(name => sp.setName(name))
+          noneIfEmpty(p.example).foreach(ex => sp.setExample(ex))
+          noneIfEmpty(p.name).foreach(name => sp.setName(name))
         }
         case s: SchemaAnnotation => {
-          Option(s.description).foreach(desc => sp.setDescription(desc))
-          Option(s.defaultValue).foreach(df => sp.setDefault(df))
+          noneIfEmpty(s.description).foreach(desc => sp.setDescription(desc))
+          noneIfEmpty(s.defaultValue).foreach(df => sp.setDefault(df))
           sp.setDeprecated(s.deprecated)
-          Option(s.example).foreach(ex => sp.setExample(ex))
-          Option(s.name).foreach(name => sp.setName(name))
-          Option(s.accessMode).foreach { accessMode =>
-            accessMode match {
-              case AccessMode.READ_ONLY => sp.setReadOnly(true)
-              case AccessMode.WRITE_ONLY => sp.setWriteOnly(true)
-              case _ =>
-            }
+          noneIfEmpty(s.example).foreach(ex => sp.setExample(ex))
+          noneIfEmpty(s.name).foreach(name => sp.setName(name))
+          Option(s.accessMode).foreach {
+            case AccessMode.READ_ONLY => sp.setReadOnly(true)
+            case AccessMode.WRITE_ONLY => sp.setWriteOnly(true)
+            case _ =>
           }
         }
         case _ =>

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

@@ -2,7 +2,7 @@ package com.github.swagger.enumeratum.converter
 
 import io.swagger.v3.core.converter._
 import io.swagger.v3.oas.models.media._
-import models.{Ctx, ModelWCtxEnum, ModelWEnum, ModelWEnumAnnotated, ModelWEnumSet, ModelWOptionalEnum, OrderSize}
+import models.{Ctx, ModelWCtxEnum, ModelWCtxEnumAndAnnotation, ModelWEnum, ModelWEnumAnnotated, ModelWEnumSet, ModelWOptionalEnum, OrderSize}
 import org.scalatest.OptionValues
 import org.scalatest.flatspec.AnyFlatSpec
 import org.scalatest.matchers.should.Matchers
@@ -60,13 +60,33 @@ class ModelPropertyParserTest extends AnyFlatSpec with Matchers with OptionValue
   it should "process Model for Enumeratum Enum defined in scope of another object" in {
     val converter = ModelConverters.getInstance()
     val schemas = converter.readAll(classOf[ModelWCtxEnum]).asScala.toMap
+    schemas.keys should have size 1
     val model = findModel(schemas, "ModelWCtxEnum")
     model should be (defined)
     model.get.getProperties should not be (null)
     val field = model.value.getProperties.get("field")
     field shouldBe a [StringSchema]
     val schema = field.asInstanceOf[StringSchema]
     schema.getDescription shouldEqual (null)
+    schema.getDefault should be (null)
+    schema.getEnum.asScala shouldEqual Ctx.Color.values.map(_.entryName)
+    nullSafeList(model.value.getRequired) shouldBe Seq("field")
+  }
+
+  it should "not add additional model when enum field is annotated" in {
+    val converter = ModelConverters.getInstance()
+    val schemas = converter.readAll(classOf[ModelWCtxEnumAndAnnotation]).asScala.toMap
+    schemas.keys should have size 1
+
+    val model = findModel(schemas, "ModelWCtxEnum")
+    model should be(defined)
+    model.get.getProperties should not be (null)
+    val field = model.value.getProperties.get("field")
+    field shouldBe a[StringSchema]
+    val schema = field.asInstanceOf[StringSchema]
+    schema.getDescription shouldEqual "An annotated field"
+    schema.getName shouldEqual "field"
+    schema.getDefault should be (null)
     schema.getEnum.asScala shouldEqual Ctx.Color.values.map(_.entryName)
     nullSafeList(model.value.getRequired) shouldBe Seq("field")
   }

src/test/scala/models/Ctx.scala

@@ -1,6 +1,7 @@
 package models
 
 import enumeratum.{Enum, EnumEntry}
+import io.swagger.v3.oas.annotations.media.Schema
 
 object Ctx {
   sealed abstract class Color(override val entryName: String) extends EnumEntry
@@ -16,3 +17,5 @@ object Ctx {
 }
 
 case class ModelWCtxEnum(field: Ctx.Color)
+
+case class ModelWCtxEnumAndAnnotation(@Schema(description = "An annotated field", required = true) field: Ctx.Color)