support JsonScalaEnumeration

Author: PJ Fanning

src/main/scala/com/github/swagger/scala/converter/SwaggerScalaModelConverter.scala

@@ -1,16 +1,17 @@
 package com.github.swagger.scala.converter
 
+import java.lang.reflect.ParameterizedType
 import java.util.Iterator
 
 import com.fasterxml.jackson.databind.JavaType
 import com.fasterxml.jackson.databind.`type`.ReferenceType
-import com.fasterxml.jackson.module.scala.DefaultScalaModule
+import com.fasterxml.jackson.module.scala.{DefaultScalaModule, JsonScalaEnumeration}
 import io.swagger.v3.core.converter._
 import io.swagger.v3.core.jackson.ModelResolver
 import io.swagger.v3.core.util.{Json, PrimitiveType}
 import io.swagger.v3.oas.annotations.Parameter
 import io.swagger.v3.oas.annotations.media.{Schema => SchemaAnnotation}
-import io.swagger.v3.oas.models.media.{Schema, StringSchema}
+import io.swagger.v3.oas.models.media.Schema
 
 class AnnotatedTypeForOption extends AnnotatedType
 
@@ -59,21 +60,23 @@ class SwaggerScalaModelConverter extends ModelResolver(Json.mapper()) {
   }
 
   private def matchScalaPrimitives(`type`: AnnotatedType, nullableClass: Class[_]): Option[Schema[_]] = {
-    Option(nullableClass).flatMap { cls =>
-      // handle scala enums
-      getEnumerationInstance(cls) match {
-        case Some(enumInstance) => {
-          if (enumInstance.values != null) {
-            val sp = new StringSchema()
-            for (v <- enumInstance.values)
-              sp.addEnumItem(v.toString)
-            setRequired(`type`)
-            Some(sp)
-          } else {
-            None
+    val annotations = Option(`type`.getCtxAnnotations).map(_.toSeq).getOrElse(Seq.empty)
+    annotations.collectFirst { case ann: JsonScalaEnumeration => ann } match {
+      case Some(enumAnnotation) => {
+        val pt = enumAnnotation.value().getGenericSuperclass.asInstanceOf[ParameterizedType]
+        val args = pt.getActualTypeArguments
+        val cls = args(0).asInstanceOf[Class[Enumeration]]
+        getEnumerationInstance(cls).map { enum =>
+          val sp: Schema[String] = PrimitiveType.STRING.createProperty().asInstanceOf[Schema[String]]
+          setRequired(`type`)
+          enum.values.iterator.foreach { v =>
+            sp.addEnumItemObject(v.toString)
           }
+          sp
         }
-        case _ => {
+      }
+      case _ => {
+        Option(nullableClass).flatMap { cls =>
           if (cls == classOf[BigDecimal]) {
             val dp = PrimitiveType.DECIMAL.createProperty()
             setRequired(`type`)

src/test/scala/com/github/swagger/scala/converter/ScalaModelTest.scala

@@ -23,6 +23,18 @@ class ScalaModelTest extends FlatSpec with Matchers {
     //    (sp.getEnum().asScala.toSet & Set("TALL", "GRANDE", "VENTI")) should have size 3
   }
 
+  it should "extract a scala enum (jackson annotated)" in {
+    val schemas = ModelConverters.getInstance().readAll(classOf[SModelWithEnumJacksonAnnotated]).asScala
+    val userSchema = schemas("SModelWithEnumJacksonAnnotated")
+
+    val orderSize = userSchema.getProperties().get("orderSize")
+    orderSize should not be null
+    orderSize shouldBe a [StringSchema]
+    val sp = orderSize.asInstanceOf[StringSchema]
+    Option(sp.getEnum) shouldBe defined
+    sp.getEnum().asScala.toSet shouldEqual Set("TALL", "GRANDE", "VENTI")
+  }
+
   it should "read a scala case class with properties" in {
     val schemas = ModelConverters.getInstance().readAll(classOf[SimpleUser]).asScala
     val userSchema = schemas("SimpleUser")

src/test/scala/models/EnumModels.scala

@@ -1,5 +1,7 @@
 package models
 
+import com.fasterxml.jackson.core.`type`.TypeReference
+import com.fasterxml.jackson.module.scala.JsonScalaEnumeration
 import io.swagger.v3.oas.annotations.media.Schema
 import models.OrderSize.OrderSize
 
@@ -9,7 +11,11 @@ import scala.annotation.meta.field
 case class SModelWithEnum(
   @(Schema @field)(name = "Order Size", implementation = classOf[OrderSize]) orderSize: OrderSize = OrderSize.TALL)
 
-case object OrderSize extends Enumeration(0) {
+class OrderSizeTypeClass extends TypeReference[OrderSize.type]
+case class SModelWithEnumJacksonAnnotated(
+  @JsonScalaEnumeration(classOf[OrderSizeTypeClass]) orderSize: OrderSize = OrderSize.TALL)
+
+case object OrderSize extends Enumeration {
   type OrderSize = Value
   val TALL = Value("TALL")
   val GRANDE = Value("GRANDE")