Merge branch 'develop' into release

SMILEY4 · May 17, 2024 · b8ac074 · b8ac074
2 parents f1624e5 + 83cfc00
commit b8ac074
Show file tree

Hide file tree

Showing 11 changed files with 101 additions and 36 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,9 @@
 # Schema-Kenerator
 
+[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.smiley4/schema-kenerator-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.smiley4/schema-kenerator-core)
+[![Checks Passing](https://github.com/SMILEY4/schema-kenerator/actions/workflows/checks.yml/badge.svg?branch=develop)](https://github.com/SMILEY4/schema-kenerator/actions/workflows/checks.yml)
+
+
 Customizable kotlin library to extract information from classes using reflection or kotlinx-serialization and generate schemas (json-schema, swagger) from the resulting information.
 
 
@@ -25,19 +29,16 @@ Customizable kotlin library to extract information from classes using reflection
 A wiki with a short documentation is available [here](https://github.com/SMILEY4/schema-kenerator/wiki).
 
 
-
-## Installation
+## Example (json-schema & reflection)
 
 ```kotlin
 dependencies {
-    implementation "io.github.smiley4:schema-kenerator:<VERSION>"
+    implementation("io.github.smiley4:schema-kenerator-core:<VERSION>")
+    implementation("io.github.smiley4:schema-kenerator-reflection:<VERSION>")
+    implementation("io.github.smiley4:schema-kenerator-jsonschema:<VERSION>")
 }
 ```
 
-
-
-## Example (json-schema & reflection)
-
 ```kotlin
 class MyExampleClass(
     val someText: String,
@@ -52,7 +53,7 @@ val jsonSchema = typeOf<MyExampleClass>()
     .generateJsonSchema()
     .compileInlining()
     .json
-    .prettyPrint()        
+    .prettyPrint()
 ```
 
 ```json
@@ -61,32 +62,40 @@ val jsonSchema = typeOf<MyExampleClass>()
    "title": "MyExampleClass",
    "required": [ "someBoolList", "someText" ],
    "properties": {
-      "someBoolList": {
-         "type": "array",
-         "title": "List<Boolean>",         
-         "items": {
-            "type": "boolean",
-            "title": "Boolean"
-         }
-      },
-      "someNullableInt": {
-         "type": "integer",
-         "title": "Int",
-         "minimum": -2147483648,
-         "maximum": 2147483647
-      },
-      "someText": {
-         "type": "string",
-         "title": "String"
-      }
-
+     "someBoolList": {
+       "type": "array",
+       "title": "List<Boolean>",
+       "items": {
+         "type": "boolean",
+         "title": "Boolean"
+       }
+     },
+     "someNullableInt": {
+       "type": "integer",
+       "title": "Int",
+       "minimum": -2147483648,
+       "maximum": 2147483647
+     },
+     "someText": {
+       "type": "string",
+       "title": "String"
+     }
+   }
 }
 ```
 
 
 
 ## Example (swagger & kotlinx-serialization)
 
+```kotlin
+dependencies {
+    implementation("io.github.smiley4:schema-kenerator-core:<VERSION>")
+    implementation("io.github.smiley4:schema-kenerator-serialization:<VERSION>")
+    implementation("io.github.smiley4:schema-kenerator-swagger:<VERSION>")
+}
+```
+
 ```kotlin
 @Serializable
 class MyExampleClass(

diff --git a/gradle.properties b/gradle.properties
@@ -3,7 +3,7 @@ kotlin.code.style=official
 # project id
 projectGroupId=io.github.smiley4
 projectArtifactIdBase=schema-kenerator
-projectVersion=0.1
+projectVersion=0.1.1
 
 # publishing information
 projectNameBase=Schema-Kenerator

diff --git a/schema-kenerator-core/build.gradle.kts b/schema-kenerator-core/build.gradle.kts
@@ -20,17 +20,21 @@ repositories {
 
 dependencies {
     val versionKotest: String by project
+    val versionKotlinTest: String by project
     testImplementation("io.kotest:kotest-runner-junit5:$versionKotest")
     testImplementation("io.kotest:kotest-assertions-core:$versionKotest")
     testImplementation("io.kotest:kotest-framework-datatest:$versionKotest")
-    val versionKotlinTest: String by project
     testImplementation("org.jetbrains.kotlin:kotlin-test:$versionKotlinTest")
 }
 
 kotlin {
     jvmToolchain(11)
 }
 
+tasks.withType<Test>().configureEach {
+    useJUnitPlatform()
+}
+
 detekt {
     ignoreFailures = false
     buildUponDefaultConfig = true

diff --git a/schema-kenerator-core/src/main/kotlin/io/github/smiley4/schemakenerator/core/data/TypeId.kt b/schema-kenerator-core/src/main/kotlin/io/github/smiley4/schemakenerator/core/data/TypeId.kt
@@ -80,10 +80,9 @@ class TypeId(
         }
 
         private fun parseTypeParameters(fullTypeId: String): List<TypeId> {
-            if (fullTypeId.contains("<")) {
+            if (!fullTypeId.contains("<") || !fullTypeId.contains(">")) {
                 return emptyList()
             }
-            var typeParameters = emptyList<TypeId>()
             val paramList = fullTypeId
                 .split("<")
                 .toMutableList().also { it.removeFirst() }
@@ -124,8 +123,7 @@ class TypeId(
                 }
             }
             paramFullIds.add(current)
-            typeParameters = paramFullIds.map { parse(it) }
-            return typeParameters
+            return paramFullIds.map { parse(it) }
         }
 
         private fun parseAdditionalId(fullTypeId: String): String? {

diff --git a/schema-kenerator-jackson/build.gradle.kts b/schema-kenerator-jackson/build.gradle.kts
@@ -20,15 +20,19 @@ repositories {
 }
 
 dependencies {
-    implementation(project(":schema-kenerator-core"))
     val versionJackson: String by project
+    implementation(project(":schema-kenerator-core"))
     implementation("com.fasterxml.jackson.module:jackson-module-kotlin:$versionJackson")
 }
 
 kotlin {
     jvmToolchain(11)
 }
 
+tasks.withType<Test>().configureEach {
+    useJUnitPlatform()
+}
+
 detekt {
     ignoreFailures = false
     buildUponDefaultConfig = true

diff --git a/schema-kenerator-jsonschema/build.gradle.kts b/schema-kenerator-jsonschema/build.gradle.kts
@@ -26,6 +26,10 @@ kotlin {
     jvmToolchain(11)
 }
 
+tasks.withType<Test>().configureEach {
+    useJUnitPlatform()
+}
+
 detekt {
     ignoreFailures = false
     buildUponDefaultConfig = true

diff --git a/schema-kenerator-reflection/build.gradle.kts b/schema-kenerator-reflection/build.gradle.kts
@@ -27,6 +27,10 @@ kotlin {
     jvmToolchain(11)
 }
 
+tasks.withType<Test>().configureEach {
+    useJUnitPlatform()
+}
+
 detekt {
     ignoreFailures = false
     buildUponDefaultConfig = true

diff --git a/schema-kenerator-serialization/build.gradle.kts b/schema-kenerator-serialization/build.gradle.kts
@@ -20,16 +20,20 @@ repositories {
 }
 
 dependencies {
+    val versionKotlinxSerializationJson: String by project
     implementation(project(":schema-kenerator-core"))
     implementation(kotlin("reflect"))
-    val versionKotlinxSerializationJson: String by project
     implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:$versionKotlinxSerializationJson")
 }
 
 kotlin {
     jvmToolchain(11)
 }
 
+tasks.withType<Test>().configureEach {
+    useJUnitPlatform()
+}
+
 detekt {
     ignoreFailures = false
     buildUponDefaultConfig = true

diff --git a/schema-kenerator-swagger/build.gradle.kts b/schema-kenerator-swagger/build.gradle.kts
@@ -21,15 +21,19 @@ repositories {
 }
 
 dependencies {
-    implementation(project(":schema-kenerator-core"))
     val versionSwaggerParser: String by project
+    implementation(project(":schema-kenerator-core"))
     implementation("io.swagger.parser.v3:swagger-parser:$versionSwaggerParser")
 }
 
 kotlin {
     jvmToolchain(11)
 }
 
+tasks.withType<Test>().configureEach {
+    useJUnitPlatform()
+}
+
 detekt {
     ignoreFailures = false
     buildUponDefaultConfig = true

diff --git a/schema-kenerator-test/build.gradle.kts b/schema-kenerator-test/build.gradle.kts
@@ -26,4 +26,8 @@ dependencies {
     testImplementation(project(":schema-kenerator-jsonschema"))
     testImplementation(project(":schema-kenerator-swagger"))
     testImplementation(project(":schema-kenerator-jackson"))
+}
+
+tasks.withType<Test>().configureEach {
+    useJUnitPlatform()
 }
diff --git a/schema-kenerator-test/src/test/kotlin/io/github/smiley4/schemakenerator/test/Test.kt b/schema-kenerator-test/src/test/kotlin/io/github/smiley4/schemakenerator/test/Test.kt
@@ -0,0 +1,30 @@
+package io.github.smiley4.schemakenerator.test
+
+import io.github.smiley4.schemakenerator.serialization.processKotlinxSerialization
+import io.github.smiley4.schemakenerator.swagger.compileInlining
+import io.github.smiley4.schemakenerator.swagger.data.TitleType
+import io.github.smiley4.schemakenerator.swagger.generateSwaggerSchema
+import io.github.smiley4.schemakenerator.swagger.withAutoTitle
+import io.swagger.v3.oas.models.media.Schema
+import kotlinx.serialization.Serializable
+import kotlin.reflect.typeOf
+
+@Serializable
+class MyExampleClass(
+    val someText: String,
+    val someNullableInt: Int?,
+    val someBoolList: List<Boolean>,
+)
+
+fun main() {
+
+    val swaggerSchema: Schema<*> = typeOf<MyExampleClass>()
+        .processKotlinxSerialization()
+        .generateSwaggerSchema()
+        .withAutoTitle(TitleType.SIMPLE)
+        .compileInlining()
+        .swagger
+
+    println(swaggerSchema)
+
+}