naijun0403/kompendium
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

chore: prep for 3.3.0 (#319)

Browse Source
This commit is contained in:
Ryan Brink
2022-09-15 08:27:17 -05:00
committed by GitHub
parent fdcc64d29c
commit 95ae274f1d
36 changed files with 138 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
core/build.gradle.kts
View File

@ -22,6 +22,7 @@ dependencies {
// VERSIONS
val kotestVersion: String by project
val ktorVersion: String by project
val detektVersion: String by project
// IMPLEMENTATION
@ -35,6 +36,9 @@ dependencies {
implementation("io.ktor:ktor-serialization-kotlinx-json:$ktorVersion")
implementation("ch.qos.logback:logback-classic:1.4.1")
// Formatting
detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:$detektVersion")
// TEST FIXTURES
testFixturesApi("io.kotest:kotest-runner-junit5-jvm:$kotestVersion")

3
core/src/main/kotlin/io/bkbn/kompendium/core/metadata/DeleteInfo.kt
View File

@ -13,7 +13,7 @@ class DeleteInfo private constructor(
override val operationId: String?,
override val deprecated: Boolean,
override val parameters: List<Parameter>
): MethodInfo {
) : MethodInfo {
companion object {
fun builder(init: Builder.() -> Unit): DeleteInfo {
@ -36,5 +36,4 @@ class DeleteInfo private constructor(
parameters = parameters
)
}
}

3
core/src/main/kotlin/io/bkbn/kompendium/core/metadata/GetInfo.kt
View File

@ -13,7 +13,7 @@ class GetInfo private constructor(
override val operationId: String?,
override val deprecated: Boolean,
override val parameters: List<Parameter>
): MethodInfo {
) : MethodInfo {
companion object {
fun builder(init: Builder.() -> Unit): GetInfo {
@ -36,5 +36,4 @@ class GetInfo private constructor(
parameters = parameters
)
}
}

3
core/src/main/kotlin/io/bkbn/kompendium/core/metadata/HeadInfo.kt
View File

@ -13,7 +13,7 @@ class HeadInfo private constructor(
override val operationId: String?,
override val deprecated: Boolean,
override val parameters: List<Parameter>
): MethodInfo {
) : MethodInfo {
companion object {
fun builder(init: Builder.() -> Unit): HeadInfo {
@ -36,5 +36,4 @@ class HeadInfo private constructor(
parameters = parameters
)
}
}

2
core/src/main/kotlin/io/bkbn/kompendium/core/metadata/MethodInfoWithRequest.kt
View File

@ -3,7 +3,7 @@ package io.bkbn.kompendium.core.metadata
sealed interface MethodInfoWithRequest : MethodInfo {
val request: RequestInfo
abstract class Builder<T: MethodInfoWithRequest> : MethodInfo.Builder<T>() {
abstract class Builder<T : MethodInfoWithRequest> : MethodInfo.Builder<T>() {
internal var request: RequestInfo? = null
fun request(init: RequestInfo.Builder.() -> Unit) = apply {

3
core/src/main/kotlin/io/bkbn/kompendium/core/metadata/OptionsInfo.kt
View File

@ -13,7 +13,7 @@ class OptionsInfo private constructor(
override val operationId: String?,
override val deprecated: Boolean,
override val parameters: List<Parameter>
): MethodInfo {
) : MethodInfo {
companion object {
fun builder(init: Builder.() -> Unit): OptionsInfo {
@ -36,5 +36,4 @@ class OptionsInfo private constructor(
parameters = parameters
)
}
}

3
core/src/main/kotlin/io/bkbn/kompendium/core/metadata/PatchInfo.kt
View File

@ -14,7 +14,7 @@ class PatchInfo private constructor(
override val operationId: String?,
override val deprecated: Boolean,
override val parameters: List<Parameter>
): MethodInfoWithRequest {
) : MethodInfoWithRequest {
companion object {
fun builder(init: Builder.() -> Unit): PatchInfo {
@ -38,5 +38,4 @@ class PatchInfo private constructor(
parameters = parameters
)
}
}

3
core/src/main/kotlin/io/bkbn/kompendium/core/metadata/PostInfo.kt
View File

@ -14,7 +14,7 @@ class PostInfo private constructor(
override val operationId: String?,
override val deprecated: Boolean,
override val parameters: List<Parameter>
): MethodInfoWithRequest {
) : MethodInfoWithRequest {
companion object {
fun builder(init: Builder.() -> Unit): PostInfo {
@ -38,5 +38,4 @@ class PostInfo private constructor(
parameters = parameters
)
}
}

3
core/src/main/kotlin/io/bkbn/kompendium/core/metadata/PutInfo.kt
View File

@ -14,7 +14,7 @@ class PutInfo private constructor(
override val operationId: String?,
override val deprecated: Boolean,
override val parameters: List<Parameter>
): MethodInfoWithRequest {
) : MethodInfoWithRequest {
companion object {
fun builder(init: Builder.() -> Unit): PutInfo {
@ -38,5 +38,4 @@ class PutInfo private constructor(
parameters = parameters
)
}
}

1
core/src/main/kotlin/io/bkbn/kompendium/core/metadata/RequestInfo.kt
View File

@ -41,5 +41,4 @@ class RequestInfo private constructor(
examples = examples
)
}
}

6
core/src/main/kotlin/io/bkbn/kompendium/core/plugin/NotarizedRoute.kt
View File

@ -54,9 +54,9 @@ object NotarizedRoute {
pluginConfig.path?.addDefaultAuthMethods(authMethods)
require(spec.paths[routePath] == null) {
"""
The specified path ${Parameter.Location.path} has already been documented!
Please make sure that all notarized paths are unique
""".trimIndent()
The specified path ${Parameter.Location.path} has already been documented!
Please make sure that all notarized paths are unique
""".trimIndent()
}
spec.paths[routePath] = pluginConfig.path
?: error("This indicates a bug in Kompendium. Please file a GitHub issue!")

2
core/src/main/kotlin/io/bkbn/kompendium/core/routes/Redoc.kt
View File

@ -46,7 +46,7 @@ fun Route.redoc(pageTitle: String = "Docs", specUrl: String = "/openapi.json") {
}
}
body {
unsafe { +"<redoc spec-url='${specUrl}'></redoc>" }
unsafe { +"<redoc spec-url='$specUrl'></redoc>" }
script {
src = "https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"
}

2
core/src/main/kotlin/io/bkbn/kompendium/core/util/Helpers.kt
View File

@ -10,8 +10,8 @@ import io.bkbn.kompendium.core.metadata.PatchInfo
import io.bkbn.kompendium.core.metadata.PostInfo
import io.bkbn.kompendium.core.metadata.PutInfo
import io.bkbn.kompendium.core.metadata.ResponseInfo
import io.bkbn.kompendium.json.schema.SchemaGenerator
import io.bkbn.kompendium.json.schema.SchemaConfigurator
import io.bkbn.kompendium.json.schema.SchemaGenerator
import io.bkbn.kompendium.json.schema.definition.ReferenceDefinition
import io.bkbn.kompendium.json.schema.util.Helpers.getReferenceSlug
import io.bkbn.kompendium.json.schema.util.Helpers.getSimpleSlug

16
core/src/test/kotlin/io/bkbn/kompendium/core/KompendiumTest.kt
View File

@ -10,11 +10,6 @@ import io.bkbn.kompendium.core.util.TestModules.defaultAuthConfig
import io.bkbn.kompendium.core.util.TestModules.defaultField
import io.bkbn.kompendium.core.util.TestModules.defaultParameter
import io.bkbn.kompendium.core.util.TestModules.exampleParams
import io.bkbn.kompendium.core.util.TestModules.nestedUnderRoot
import io.bkbn.kompendium.core.util.TestModules.nonRequiredParams
import io.bkbn.kompendium.core.util.TestModules.notarizedDelete
import io.bkbn.kompendium.core.util.TestModules.notarizedGet
import io.bkbn.kompendium.core.util.TestModules.singleException
import io.bkbn.kompendium.core.util.TestModules.genericException
import io.bkbn.kompendium.core.util.TestModules.genericPolymorphicResponse
import io.bkbn.kompendium.core.util.TestModules.genericPolymorphicResponseMultipleImpls
@ -27,8 +22,11 @@ import io.bkbn.kompendium.core.util.TestModules.nestedGenericCollection
import io.bkbn.kompendium.core.util.TestModules.nestedGenericMultipleParamsCollection
import io.bkbn.kompendium.core.util.TestModules.nestedGenericResponse
import io.bkbn.kompendium.core.util.TestModules.nestedTypeName
import io.bkbn.kompendium.core.util.TestModules.nestedUnderRoot
import io.bkbn.kompendium.core.util.TestModules.nonRequiredParam
import io.bkbn.kompendium.core.util.TestModules.polymorphicException
import io.bkbn.kompendium.core.util.TestModules.nonRequiredParams
import io.bkbn.kompendium.core.util.TestModules.notarizedDelete
import io.bkbn.kompendium.core.util.TestModules.notarizedGet
import io.bkbn.kompendium.core.util.TestModules.notarizedHead
import io.bkbn.kompendium.core.util.TestModules.notarizedOptions
import io.bkbn.kompendium.core.util.TestModules.notarizedPatch
@ -39,6 +37,7 @@ import io.bkbn.kompendium.core.util.TestModules.nullableField
import io.bkbn.kompendium.core.util.TestModules.nullableNestedObject
import io.bkbn.kompendium.core.util.TestModules.nullableReference
import io.bkbn.kompendium.core.util.TestModules.polymorphicCollectionResponse
import io.bkbn.kompendium.core.util.TestModules.polymorphicException
import io.bkbn.kompendium.core.util.TestModules.polymorphicMapResponse
import io.bkbn.kompendium.core.util.TestModules.polymorphicResponse
import io.bkbn.kompendium.core.util.TestModules.primitives
@ -49,6 +48,7 @@ import io.bkbn.kompendium.core.util.TestModules.rootRoute
import io.bkbn.kompendium.core.util.TestModules.simpleGenericResponse
import io.bkbn.kompendium.core.util.TestModules.simplePathParsing
import io.bkbn.kompendium.core.util.TestModules.simpleRecursive
import io.bkbn.kompendium.core.util.TestModules.singleException
import io.bkbn.kompendium.core.util.TestModules.trailingSlash
import io.bkbn.kompendium.core.util.TestModules.unbackedFieldsResponse
import io.bkbn.kompendium.core.util.TestModules.withOperationId
@ -189,7 +189,9 @@ class KompendiumTest : DescribeSpec({
openApiTestAllSerializers("T0039__nested_generic_collection.json") { nestedGenericCollection() }
}
it("Can support nested generics with multiple type parameters") {
openApiTestAllSerializers("T0040__nested_generic_multiple_type_params.json") { nestedGenericMultipleParamsCollection() }
openApiTestAllSerializers("T0040__nested_generic_multiple_type_params.json") {
nestedGenericMultipleParamsCollection()
}
}
it("Can handle a really gnarly generic example") {
openApiTestAllSerializers("T0043__gnarly_generic_example.json") { gnarlyGenericResponse() }

26
core/src/test/kotlin/io/bkbn/kompendium/core/util/TestModules.kt
View File

@ -1,6 +1,30 @@
package io.bkbn.kompendium.core.util
import io.bkbn.kompendium.core.fixtures.*
import io.bkbn.kompendium.core.fixtures.Barzo
import io.bkbn.kompendium.core.fixtures.ColumnSchema
import io.bkbn.kompendium.core.fixtures.ComplexRequest
import io.bkbn.kompendium.core.fixtures.DateTimeString
import io.bkbn.kompendium.core.fixtures.DefaultField
import io.bkbn.kompendium.core.fixtures.ExceptionResponse
import io.bkbn.kompendium.core.fixtures.Flibbity
import io.bkbn.kompendium.core.fixtures.FlibbityGibbit
import io.bkbn.kompendium.core.fixtures.Foosy
import io.bkbn.kompendium.core.fixtures.Gibbity
import io.bkbn.kompendium.core.fixtures.ManyThings
import io.bkbn.kompendium.core.fixtures.MultiNestedGenerics
import io.bkbn.kompendium.core.fixtures.Nested
import io.bkbn.kompendium.core.fixtures.NullableEnum
import io.bkbn.kompendium.core.fixtures.NullableField
import io.bkbn.kompendium.core.fixtures.Page
import io.bkbn.kompendium.core.fixtures.ProfileUpdateRequest
import io.bkbn.kompendium.core.fixtures.SerialNameObject
import io.bkbn.kompendium.core.fixtures.TestCreatedResponse
import io.bkbn.kompendium.core.fixtures.TestNested
import io.bkbn.kompendium.core.fixtures.TestRequest
import io.bkbn.kompendium.core.fixtures.TestResponse
import io.bkbn.kompendium.core.fixtures.TestSimpleRequest
import io.bkbn.kompendium.core.fixtures.TransientObject
import io.bkbn.kompendium.core.fixtures.UnbakcedObject
import io.bkbn.kompendium.core.metadata.DeleteInfo
import io.bkbn.kompendium.core.metadata.GetInfo
import io.bkbn.kompendium.core.metadata.HeadInfo