moved annotations, added @WithExample

Wicpar · Wicpar · commit 5469c449557d · 2020-03-17T00:56:55.000+01:00
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/SingleTypeValidator.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/SingleTypeValidator.kt
@@ -1,4 +1,4 @@
-package com.papsign.ktor.openapigen.validation.util
+package com.papsign.ktor.openapigen.annotations.type
 
 import com.papsign.ktor.openapigen.validation.Validator
 import com.papsign.ktor.openapigen.validation.ValidatorBuilder
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/NumberConstraintProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/NumberConstraintProcessor.kt
@@ -1,4 +1,4 @@
-package com.papsign.ktor.openapigen.validation.number
+package com.papsign.ktor.openapigen.annotations.type.number
 
 import com.papsign.ktor.openapigen.classLogger
 import com.papsign.ktor.openapigen.model.schema.SchemaModel
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/FloatingNumberConstraintProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/FloatingNumberConstraintProcessor.kt
@@ -1,7 +1,7 @@
-package com.papsign.ktor.openapigen.validation.number.floating
+package com.papsign.ktor.openapigen.annotations.type.number.floating
 
 import com.papsign.ktor.openapigen.getKType
-import com.papsign.ktor.openapigen.validation.number.NumberConstraintProcessor
+import com.papsign.ktor.openapigen.annotations.type.number.NumberConstraintProcessor
 
 abstract class FloatingNumberConstraintProcessor<A: Annotation>: NumberConstraintProcessor<A>(listOf(
     getKType<Float>(),
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/clamp/FClamp.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/clamp/FClamp.kt
@@ -1,9 +1,9 @@
-package com.papsign.ktor.openapigen.validation.number.floating.clamp
+package com.papsign.ktor.openapigen.annotations.type.number.floating.clamp
 
 import com.papsign.ktor.openapigen.schema.processor.SchemaProcessorAnnotation
 import com.papsign.ktor.openapigen.validation.ValidatorAnnotation
 
-@Target(AnnotationTarget.TYPE)
+@Target(AnnotationTarget.TYPE, AnnotationTarget.PROPERTY)
 @SchemaProcessorAnnotation(FClampProcessor::class)
 @ValidatorAnnotation(FClampProcessor::class)
 annotation class FClamp(val min: Double, val max: Double)
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/clamp/FClampProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/clamp/FClampProcessor.kt
@@ -1,8 +1,8 @@
-package com.papsign.ktor.openapigen.validation.number.floating.clamp
+package com.papsign.ktor.openapigen.annotations.type.number.floating.clamp
 
 import com.papsign.ktor.openapigen.model.schema.SchemaModel
-import com.papsign.ktor.openapigen.validation.number.NumberConstraint
-import com.papsign.ktor.openapigen.validation.number.floating.FloatingNumberConstraintProcessor
+import com.papsign.ktor.openapigen.annotations.type.number.NumberConstraint
+import com.papsign.ktor.openapigen.annotations.type.number.floating.FloatingNumberConstraintProcessor
 import java.math.BigDecimal
 
 object FClampProcessor : FloatingNumberConstraintProcessor<FClamp>() {
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/max/FMax.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/max/FMax.kt
@@ -1,9 +1,9 @@
-package com.papsign.ktor.openapigen.validation.number.floating.max
+package com.papsign.ktor.openapigen.annotations.type.number.floating.max
 
 import com.papsign.ktor.openapigen.schema.processor.SchemaProcessorAnnotation
 import com.papsign.ktor.openapigen.validation.ValidatorAnnotation
 
-@Target(AnnotationTarget.TYPE)
+@Target(AnnotationTarget.TYPE, AnnotationTarget.PROPERTY)
 @SchemaProcessorAnnotation(FMaxProcessor::class)
 @ValidatorAnnotation(FMaxProcessor::class)
 annotation class FMax(val value: Double)
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/max/FMaxProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/max/FMaxProcessor.kt
@@ -1,9 +1,8 @@
-package com.papsign.ktor.openapigen.validation.number.floating.max
+package com.papsign.ktor.openapigen.annotations.type.number.floating.max
 
 import com.papsign.ktor.openapigen.model.schema.SchemaModel
-import com.papsign.ktor.openapigen.validation.number.NumberConstraint
-import com.papsign.ktor.openapigen.validation.number.floating.FloatingNumberConstraintProcessor
-import com.papsign.ktor.openapigen.validation.number.floating.clamp.FClamp
+import com.papsign.ktor.openapigen.annotations.type.number.NumberConstraint
+import com.papsign.ktor.openapigen.annotations.type.number.floating.FloatingNumberConstraintProcessor
 import java.math.BigDecimal
 
 object FMaxProcessor: FloatingNumberConstraintProcessor<FMax>() {
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/min/FMin.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/min/FMin.kt
@@ -1,9 +1,9 @@
-package com.papsign.ktor.openapigen.validation.number.floating.min
+package com.papsign.ktor.openapigen.annotations.type.number.floating.min
 
 import com.papsign.ktor.openapigen.schema.processor.SchemaProcessorAnnotation
 import com.papsign.ktor.openapigen.validation.ValidatorAnnotation
 
-@Target(AnnotationTarget.TYPE)
+@Target(AnnotationTarget.TYPE, AnnotationTarget.PROPERTY)
 @SchemaProcessorAnnotation(FMinProcessor::class)
 @ValidatorAnnotation(FMinProcessor::class)
 annotation class FMin(val value: Double)
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/min/FMinProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/floating/min/FMinProcessor.kt
@@ -1,9 +1,8 @@
-package com.papsign.ktor.openapigen.validation.number.floating.min
+package com.papsign.ktor.openapigen.annotations.type.number.floating.min
 
 import com.papsign.ktor.openapigen.model.schema.SchemaModel
-import com.papsign.ktor.openapigen.validation.number.NumberConstraint
-import com.papsign.ktor.openapigen.validation.number.floating.FloatingNumberConstraintProcessor
-import com.papsign.ktor.openapigen.validation.number.floating.clamp.FClamp
+import com.papsign.ktor.openapigen.annotations.type.number.NumberConstraint
+import com.papsign.ktor.openapigen.annotations.type.number.floating.FloatingNumberConstraintProcessor
 import java.math.BigDecimal
 
 object FMinProcessor: FloatingNumberConstraintProcessor<FMin>() {
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/IntegerNumberConstraintProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/IntegerNumberConstraintProcessor.kt
@@ -1,7 +1,7 @@
-package com.papsign.ktor.openapigen.validation.number.integer
+package com.papsign.ktor.openapigen.annotations.type.number.integer
 
 import com.papsign.ktor.openapigen.getKType
-import com.papsign.ktor.openapigen.validation.number.NumberConstraintProcessor
+import com.papsign.ktor.openapigen.annotations.type.number.NumberConstraintProcessor
 
 abstract class IntegerNumberConstraintProcessor<A: Annotation>: NumberConstraintProcessor<A>(listOf(
     getKType<Int>(),
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/clamp/Clamp.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/clamp/Clamp.kt
@@ -1,9 +1,9 @@
-package com.papsign.ktor.openapigen.validation.number.integer.clamp
+package com.papsign.ktor.openapigen.annotations.type.number.integer.clamp
 
 import com.papsign.ktor.openapigen.schema.processor.SchemaProcessorAnnotation
 import com.papsign.ktor.openapigen.validation.ValidatorAnnotation
 
-@Target(AnnotationTarget.TYPE)
+@Target(AnnotationTarget.TYPE, AnnotationTarget.PROPERTY)
 @SchemaProcessorAnnotation(ClampProcessor::class)
 @ValidatorAnnotation(ClampProcessor::class)
 annotation class Clamp(val min: Long, val max: Long)
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/clamp/ClampProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/clamp/ClampProcessor.kt
@@ -1,9 +1,8 @@
-package com.papsign.ktor.openapigen.validation.number.integer.clamp
+package com.papsign.ktor.openapigen.annotations.type.number.integer.clamp
 
 import com.papsign.ktor.openapigen.model.schema.SchemaModel
-import com.papsign.ktor.openapigen.validation.number.NumberConstraint
-import com.papsign.ktor.openapigen.validation.number.floating.clamp.FClamp
-import com.papsign.ktor.openapigen.validation.number.integer.IntegerNumberConstraintProcessor
+import com.papsign.ktor.openapigen.annotations.type.number.NumberConstraint
+import com.papsign.ktor.openapigen.annotations.type.number.integer.IntegerNumberConstraintProcessor
 import java.math.BigDecimal
 
 object ClampProcessor: IntegerNumberConstraintProcessor<Clamp>() {
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/max/Max.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/max/Max.kt
@@ -1,9 +1,9 @@
-package com.papsign.ktor.openapigen.validation.number.integer.max
+package com.papsign.ktor.openapigen.annotations.type.number.integer.max
 
 import com.papsign.ktor.openapigen.schema.processor.SchemaProcessorAnnotation
 import com.papsign.ktor.openapigen.validation.ValidatorAnnotation
 
-@Target(AnnotationTarget.TYPE)
+@Target(AnnotationTarget.TYPE, AnnotationTarget.PROPERTY)
 @SchemaProcessorAnnotation(MaxProcessor::class)
 @ValidatorAnnotation(MaxProcessor::class)
 annotation class Max(val value: Long)
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/max/MaxProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/max/MaxProcessor.kt
@@ -1,9 +1,8 @@
-package com.papsign.ktor.openapigen.validation.number.integer.max
+package com.papsign.ktor.openapigen.annotations.type.number.integer.max
 
 import com.papsign.ktor.openapigen.model.schema.SchemaModel
-import com.papsign.ktor.openapigen.validation.number.NumberConstraint
-import com.papsign.ktor.openapigen.validation.number.floating.max.FMax
-import com.papsign.ktor.openapigen.validation.number.integer.IntegerNumberConstraintProcessor
+import com.papsign.ktor.openapigen.annotations.type.number.NumberConstraint
+import com.papsign.ktor.openapigen.annotations.type.number.integer.IntegerNumberConstraintProcessor
 import java.math.BigDecimal
 
 object MaxProcessor: IntegerNumberConstraintProcessor<Max>() {
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/min/Min.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/min/Min.kt
@@ -1,10 +1,9 @@
-package com.papsign.ktor.openapigen.validation.number.integer.min
+package com.papsign.ktor.openapigen.annotations.type.number.integer.min
 
 import com.papsign.ktor.openapigen.schema.processor.SchemaProcessorAnnotation
 import com.papsign.ktor.openapigen.validation.ValidatorAnnotation
-import com.papsign.ktor.openapigen.validation.string.lowercase.LowerCaseValidator
 
-@Target(AnnotationTarget.TYPE)
+@Target(AnnotationTarget.TYPE, AnnotationTarget.PROPERTY)
 @SchemaProcessorAnnotation(MinProcessor::class)
 @ValidatorAnnotation(MinProcessor::class)
 annotation class Min(val value: Long)
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/min/MinProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/number/integer/min/MinProcessor.kt
@@ -1,9 +1,8 @@
-package com.papsign.ktor.openapigen.validation.number.integer.min
+package com.papsign.ktor.openapigen.annotations.type.number.integer.min
 
 import com.papsign.ktor.openapigen.model.schema.SchemaModel
-import com.papsign.ktor.openapigen.validation.number.NumberConstraint
-import com.papsign.ktor.openapigen.validation.number.floating.min.FMin
-import com.papsign.ktor.openapigen.validation.number.integer.IntegerNumberConstraintProcessor
+import com.papsign.ktor.openapigen.annotations.type.number.NumberConstraint
+import com.papsign.ktor.openapigen.annotations.type.number.integer.IntegerNumberConstraintProcessor
 import java.math.BigDecimal
 
 object MinProcessor: IntegerNumberConstraintProcessor<Min>() {
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/object/example/ExampleProcessor.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/object/example/ExampleProcessor.kt
@@ -0,0 +1,30 @@
+package com.papsign.ktor.openapigen.annotations.type.`object`.example
+
+import com.papsign.ktor.openapigen.model.schema.SchemaModel
+import com.papsign.ktor.openapigen.schema.processor.SchemaProcessor
+import kotlin.reflect.KType
+import kotlin.reflect.full.companionObjectInstance
+import kotlin.reflect.jvm.jvmErasure
+
+object ExampleProcessor : SchemaProcessor<WithExample> {
+    override fun process(model: SchemaModel<*>, type: KType, annotation: WithExample): SchemaModel<*> {
+        val exampleClass = if (annotation.provider == NoExampleProvider::class) {
+            type.jvmErasure.companionObjectInstance as? ExampleProvider<*>
+                ?: error("Classes annotated with ${WithExample::class.simpleName} without a specified example provider must have a companion object implementing ${ExampleProvider::class}")
+        } else {
+            annotation.provider.objectInstance ?: error("Classes extending ${ExampleProvider::class} must be objects")
+        }
+        @Suppress("UNCHECKED_CAST")
+        (model as SchemaModel<Any?>).apply {
+            examples = examples?.plus(exampleClass.examples ?: listOf()) ?: exampleClass.examples
+            if (example != null) {
+                if (exampleClass.example != null)
+                    examples = examples?.plus(exampleClass.example)
+            } else {
+                example = exampleClass.example
+            }
+        }
+        return model
+    }
+
+}
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/object/example/ExampleProvider.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/object/example/ExampleProvider.kt
@@ -0,0 +1,8 @@
+package com.papsign.ktor.openapigen.annotations.type.`object`.example
+
+interface ExampleProvider<T> {
+    val example: T?
+        get() = null
+    val examples: List<T>?
+        get() = null
+}
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/object/example/NoExampleProvider.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/object/example/NoExampleProvider.kt
@@ -0,0 +1,3 @@
+package com.papsign.ktor.openapigen.annotations.type.`object`.example
+
+internal class NoExampleProvider private constructor(): ExampleProvider<Any?>
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/object/example/WithExample.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/object/example/WithExample.kt
@@ -0,0 +1,12 @@
+package com.papsign.ktor.openapigen.annotations.type.`object`.example
+
+import com.papsign.ktor.openapigen.schema.processor.SchemaProcessorAnnotation
+import kotlin.reflect.KClass
+
+/**
+ * Careful, no type checking done if you give the wrong provider
+ */
+@Target(AnnotationTarget.CLASS, AnnotationTarget.TYPE, AnnotationTarget.PROPERTY)
+@SchemaProcessorAnnotation(ExampleProcessor::class)
+annotation class WithExample(val provider: KClass<out ExampleProvider<*>> = NoExampleProvider::class)
+
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/lowercase/LowerCase.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/lowercase/LowerCase.kt
@@ -1,4 +1,4 @@
-package com.papsign.ktor.openapigen.validation.string.lowercase
+package com.papsign.ktor.openapigen.annotations.type.string.lowercase
 
 import com.papsign.ktor.openapigen.validation.ValidatorAnnotation
 
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/lowercase/LowerCaseValidator.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/lowercase/LowerCaseValidator.kt
@@ -1,8 +1,8 @@
-package com.papsign.ktor.openapigen.validation.string.lowercase
+package com.papsign.ktor.openapigen.annotations.type.string.lowercase
 
 import com.papsign.ktor.openapigen.getKType
 import com.papsign.ktor.openapigen.validation.Validator
-import com.papsign.ktor.openapigen.validation.util.SingleTypeValidator
+import com.papsign.ktor.openapigen.annotations.type.SingleTypeValidator
 
 object LowerCaseValidator : SingleTypeValidator<LowerCase>(getKType<String>(), { LowerCaseValidator }), Validator {
     override fun <T> validate(subject: T?): T? {
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/trim/Trim.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/trim/Trim.kt
@@ -1,4 +1,4 @@
-package com.papsign.ktor.openapigen.validation.string.trim
+package com.papsign.ktor.openapigen.annotations.type.string.trim
 
 import com.papsign.ktor.openapigen.validation.ValidatorAnnotation
 
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/trim/TrimValidator.kt b/src/main/kotlin/com/papsign/ktor/openapigen/annotations/type/string/trim/TrimValidator.kt
@@ -1,8 +1,8 @@
-package com.papsign.ktor.openapigen.validation.string.trim
+package com.papsign.ktor.openapigen.annotations.type.string.trim
 
 import com.papsign.ktor.openapigen.getKType
 import com.papsign.ktor.openapigen.validation.Validator
-import com.papsign.ktor.openapigen.validation.util.SingleTypeValidator
+import com.papsign.ktor.openapigen.annotations.type.SingleTypeValidator
 
 object TrimValidator : SingleTypeValidator<Trim>(getKType<String>(), { TrimValidator }), Validator {
     override fun <T> validate(subject: T?): T? {
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/model/schema/SchemaModel.kt b/src/main/kotlin/com/papsign/ktor/openapigen/model/schema/SchemaModel.kt
@@ -5,32 +5,39 @@ import com.papsign.ktor.openapigen.model.base.RefModel
 
 sealed class SchemaModel<T>: DataModel {
 
+    abstract var example: T?
+    abstract var examples: List<T>?
+
     data class SchemaModelObj<T>(
         var properties: Map<String, SchemaModel<*>>,
         var required: List<String>,
         var nullable: Boolean = false,
-        var example: T? = null,
+        override var example: T? = null,
+        override var examples: List<T>? = null,
         var type: DataType = DataType.`object`
     ) : SchemaModel<T>()
 
     data class SchemaModelMap<T : Map<String, U>, U>(
         var additionalProperties: SchemaModel<U>,
         var nullable: Boolean = false,
-        var example: T? = null,
+        override var example: T? = null,
+        override var examples: List<T>? = null,
         var type: DataType = DataType.`object`
     ) : SchemaModel<T>()
 
     data class SchemaModelEnum<T>(
         var enum: List<String>,
         var nullable: Boolean = false,
-        var example: T? = null,
+        override var example: T? = null,
+        override var examples: List<T>? = null,
         var type: DataType = DataType.string
     ) : SchemaModel<T>()
 
     data class SchemaModelArr<T>(
         var items: SchemaModel<*>?,
         var nullable: Boolean = false,
-        var example: T? = null,
+        override var example: T? = null,
+        override var examples: List<T>? = null,
         var type: DataType = DataType.array
     ) : SchemaModel<T>()
 
@@ -40,10 +47,17 @@ sealed class SchemaModel<T>: DataModel {
         var nullable: Boolean = false,
         var minimum: T? = null,
         var maximum: T? = null,
-        var example: T? = null
+        override var example: T? = null,
+        override var examples: List<T>? = null
     ) : SchemaModel<T>()
 
-    data class SchemaModelRef<T>(override val `$ref`: String) : SchemaModel<T>(), RefModel<SchemaModel<T>>
+    data class SchemaModelRef<T>(override val `$ref`: String) : SchemaModel<T>(), RefModel<SchemaModel<T>> {
+        override var example: T? = null
+        override var examples: List<T>? = null
+    }
 
-    data class OneSchemaModelOf<T>(val oneOf: List<SchemaModel<out T>>) : SchemaModel<T>()
+    data class OneSchemaModelOf<T>(val oneOf: List<SchemaModel<out T>>) : SchemaModel<T>() {
+        override var example: T? = null
+        override var examples: List<T>? = null
+    }
 }
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/route/OpenAPIRoute.kt b/src/main/kotlin/com/papsign/ktor/openapigen/route/OpenAPIRoute.kt
@@ -12,7 +12,7 @@ import com.papsign.ktor.openapigen.modules.openapi.HandlerModule
 import com.papsign.ktor.openapigen.openAPIGen
 import com.papsign.ktor.openapigen.parameters.util.buildParameterHandler
 import com.papsign.ktor.openapigen.route.response.Responder
-import com.papsign.ktor.openapigen.validation.util.ValidationHandler
+import com.papsign.ktor.openapigen.validation.ValidationHandler
 import io.ktor.application.ApplicationCall
 import io.ktor.application.call
 import io.ktor.http.ContentType
diff --git a/src/main/kotlin/com/papsign/ktor/openapigen/validation/ValidationHandler.kt b/src/main/kotlin/com/papsign/ktor/openapigen/validation/ValidationHandler.kt
diff --git a/src/test/kotlin/TestServer.kt b/src/test/kotlin/TestServer.kt

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.papsign.ktor.openapigen.validation.util`
	`1`	`+package com.papsign.ktor.openapigen.annotations.type`
`2`	`2`
`3`	`3`	`import com.papsign.ktor.openapigen.validation.Validator`
`4`	`4`	`import com.papsign.ktor.openapigen.validation.ValidatorBuilder`