Merge pull request #279 from wuseal/3.6.0/jsonschema

3.6.0/jsonschema

Author: wuseal

.travis.yml

@@ -3,6 +3,7 @@ before_install:
   - chmod +x library/gradlew
   - chmod +x library/gradle/wrapper/gradle-wrapper.jar
 script:
+  - ./gradlew check
   - cd library && ./gradlew build test
   - cd ../
 deploy:

build.gradle

@@ -1,5 +1,5 @@
 buildscript {
-    ext.kotlin_version = '1.3.41'
+    ext.kotlin_version = '1.3.61'
 
     repositories {
         mavenLocal()
@@ -49,4 +49,9 @@ dependencies {
         exclude group: "org.jetbrains.kotlin"
     }
 }
+compileKotlin {
+    kotlinOptions {
+        languageVersion = "1.3"
+    }
+}
 

src/main/kotlin/wu/seal/jsontokotlin/JSON_SCHEMA_FORMAT_MAPPINGS.kt

@@ -0,0 +1,19 @@
+package wu.seal.jsontokotlin
+
+import java.math.BigDecimal
+
+/**
+ * Created by Rody66 in 2019-04-18 3:16
+ *
+ * @author Rody66
+ */
+//https://json-schema.org/understanding-json-schema/reference/string.html#format
+//TODO this map should be moved to ConfigManager (UI)
+val JSON_SCHEMA_FORMAT_MAPPINGS = mapOf(
+    "date-time" to "org.threeten.bp.OffsetDateTime",
+    "date" to "org.threeten.bp.LocalDate",
+    "time" to "org.threeten.bp.LocalTime",
+    "decimal" to BigDecimal::class.java.canonicalName
+
+    //here can be another formats
+)

src/main/kotlin/wu/seal/jsontokotlin/JsonSchemaTypeMappings.kt

@@ -0,0 +1,19 @@
+package wu.seal.jsontokotlin
+
+/**
+ * Created by kezhenxu94 in 2019-03-28 22:21
+ *
+ * @author kezhenxu94 (kezhenxu94 at 163 dot com)
+ */
+val JSON_SCHEMA_TYPE_MAPPINGS = mapOf(
+    "object" to Any::class,
+    "array" to Array<Any>::class,
+    "string" to String::class,
+    "integer" to Int::class,
+    "number" to Double::class,
+    "boolean" to Boolean::class,
+    "enum" to Enum::class,
+
+    //See: https://json-schema.org/understanding-json-schema/reference/null.html
+    "null" to Any::class
+)

src/main/kotlin/wu/seal/jsontokotlin/feedback/ExceptionHandler.kt

@@ -1,5 +1,6 @@
 package wu.seal.jsontokotlin.feedback
 
+import com.google.gson.Gson
 import com.google.gson.GsonBuilder
 import com.intellij.openapi.ui.Messages
 import java.io.PrintWriter
@@ -17,7 +18,7 @@ import java.util.*
  * handler the exception
  */
 
-val prettyPrintGson = GsonBuilder().setPrettyPrinting().create()
+val prettyPrintGson: Gson = GsonBuilder().setPrettyPrinting().create()
 
 fun getUncaughtExceptionHandler(jsonString: String, callBack: () -> Unit): Thread.UncaughtExceptionHandler = Thread.UncaughtExceptionHandler { _, e ->
     val logBuilder = StringBuilder()

src/main/kotlin/wu/seal/jsontokotlin/model/classscodestruct/DataClass.kt

@@ -4,14 +4,17 @@ import wu.seal.jsontokotlin.interceptor.IKotlinClassInterceptor
 import wu.seal.jsontokotlin.utils.LogUtil
 import wu.seal.jsontokotlin.utils.getCommentCode
 import wu.seal.jsontokotlin.utils.getIndent
+import wu.seal.jsontokotlin.utils.toAnnotationComments
 import java.lang.IllegalStateException
 
 data class DataClass(
         val annotations: List<Annotation> = listOf(),
         override val name: String,
         val properties: List<Property> = listOf(),
         val parentClassTemplate: String = "",
-        override val modifiable: Boolean = true
+        override val modifiable: Boolean = true,
+        val comments: String = "",
+        val fromJsonSchema: Boolean = false
 ) : ModifiableKotlinClass, NoGenericKotlinClass {
 
     override val hasGeneric: Boolean = false
@@ -45,7 +48,8 @@ data class DataClass(
             property.typeObject.let {
                 val newTypObj = when (it) {
                     is GenericKotlinClass -> property.typeObject.replaceReferencedClasses(replaceRule)
-                    is ModifiableKotlinClass -> replaceRule[property.typeObject] ?: error("Modifiable Kotlin Class Must have a replacement")
+                    is ModifiableKotlinClass -> replaceRule[property.typeObject]
+                            ?: error("Modifiable Kotlin Class Must have a replacement")
                     else -> it
                 }
                 LogUtil.i("replace type: ${property.type} to ${newTypObj.name}")
@@ -57,8 +61,10 @@ data class DataClass(
     }
 
     override fun getCode(): String {
+        if (fromJsonSchema && properties.isEmpty()) return ""
         val indent = getIndent()
-        val code = buildString {
+        return buildString {
+            append(comments.toAnnotationComments())
             if (annotations.isNotEmpty()) {
                 val annotationsCode = annotations.joinToString("\n") { it.getAnnotationString() }
                 if (annotationsCode.isNotBlank()) {
@@ -72,10 +78,16 @@ data class DataClass(
             }
             properties.forEachIndexed { index, property ->
                 val code = property.getCode()
-                val addIndentCode = code.split("\n").joinToString("\n") { indent + it }
-                append(addIndentCode)
+                val commentCode = getCommentCode(property.comment)
+                if (fromJsonSchema && commentCode.isNotBlank()) {
+                    append("/**\n * $commentCode\n */\n".split("\n").joinToString("\n") { indent + it })
+                    append(code)
+                }else{
+                    val addIndentCode = code.split("\n").joinToString("\n") { indent + it }
+                    append(addIndentCode)
+                }
                 if (index != properties.size - 1) append(",")
-                if (property.comment.isNotBlank()) append(" // ").append(getCommentCode(property.comment))
+                if (!fromJsonSchema && commentCode.isNotBlank()) append(" // ").append(commentCode)
                 append("\n")
             }
             append(")")
@@ -93,7 +105,6 @@ data class DataClass(
                 append("}")
             }
         }
-        return code
     }
 
 

src/main/kotlin/wu/seal/jsontokotlin/model/classscodestruct/EnumClass.kt

@@ -0,0 +1,50 @@
+package wu.seal.jsontokotlin.model.classscodestruct
+
+import wu.seal.jsontokotlin.utils.getIndent
+import wu.seal.jsontokotlin.utils.toAnnotationComments
+import java.lang.StringBuilder
+
+/**
+ * Created by ted on 2020/3/14 18:14.
+ */
+data class EnumClass(
+        override val name: String,
+        val xEnumNames: List<String>?,
+        override val generic: KotlinClass,
+        override val referencedClasses: List<KotlinClass> = listOf(generic),
+        val enum: List<Any>,
+        val comments: String = "",
+        override val modifiable: Boolean = true
+) : ModifiableKotlinClass, NoGenericKotlinClass {
+
+    override fun getOnlyCurrentCode(): String {
+        val indent = getIndent()
+        return StringBuilder().append(comments.toAnnotationComments())
+                .append("enum class $name(val value: ${generic.name}) {\n")
+                .append(generateValues().joinToString("\n\n") { "$indent$it" })
+                .append("\n}").toString()
+    }
+
+    override fun rename(newName: String): KotlinClass = copy(name = newName)
+
+    private fun generateValues(): List<String> {
+        val list = mutableListOf<String>()
+        for (i in enum.indices) {
+            val constantValue: Any = if (generic == KotlinClass.INT) (enum[i] as Double).toInt()
+            else enum[i].toString()
+            val constantName = xEnumNames?.get(i)
+                    ?: if (constantValue is Int) "_$constantValue" else constantValue.toString()
+            val finalValue = "${constantName}(${constantValue})" + if (i != enum.size - 1) "," else ";"
+            list.add(finalValue)
+        }
+        return list
+    }
+
+    override fun getCode(): String {
+        return getOnlyCurrentCode()
+    }
+
+    override fun replaceReferencedClasses(replaceRule: Map<KotlinClass, KotlinClass>): EnumClass {
+        return if (replaceRule.isEmpty()) this else copy(generic = replaceRule.values.toList()[0], referencedClasses = replaceRule.values.toList())
+    }
+}

src/main/kotlin/wu/seal/jsontokotlin/model/classscodestruct/NormalClass.kt

@@ -63,7 +63,7 @@ data class NormalClass(
 
     override fun getCode(): String {
         val indent = getIndent()
-        val code = buildString {
+        return buildString {
             if (annotations.isNotEmpty()) {
                 val annotationsCode = annotations.joinToString("\n") { it.getAnnotationString() }
                 if (annotationsCode.isNotBlank()) {
@@ -98,7 +98,6 @@ data class NormalClass(
                 append("}")
             }
         }
-        return code
     }
 
 

src/main/kotlin/wu/seal/jsontokotlin/model/classscodestruct/Property.kt

@@ -1,16 +1,17 @@
 package wu.seal.jsontokotlin.model.classscodestruct
 
 data class Property(
-    val annotations: List<Annotation> = listOf(),
-    val keyword: String = "val",
-    val originName: String,
-    val originJsonValue: String? = "",
-    val name: String = originName,
-    val type: String,
-    val value: String = "",
-    val comment: String = "",
-    val typeObject: KotlinClass,
-    private var separatorBetweenAnnotationAndProperty:String = "\n"
+        val annotations: List<Annotation> = listOf(),
+        val keyword: String = "val",
+        val originName: String,
+        val originJsonValue: String? = "",
+        val name: String = originName,
+        val type: String,
+        val value: String = "",
+        val comment: String = "",
+        val typeObject: KotlinClass,
+        private var separatorBetweenAnnotationAndProperty: String = "\n",
+        val nullable: Boolean = false
 ) {
     fun letLastAnnotationStayInSameLine() {
         separatorBetweenAnnotationAndProperty = " "
@@ -26,6 +27,7 @@ data class Property(
                 }
             }
             append(keyword).append(" ").append(name).append(": ").append(type)
+            if(nullable) append("?")
             if (value.isNotBlank()) {
                 append(" = ").append(value)
             }

src/main/kotlin/wu/seal/jsontokotlin/model/jsonschema/JsonObjectDef.kt

@@ -0,0 +1,48 @@
+package wu.seal.jsontokotlin.model.jsonschema
+
+import com.google.gson.annotations.SerializedName
+
+open class JsonObjectDef(
+    //See: https://json-schema.org/understanding-json-schema/structuring.html
+        @SerializedName("\$id")
+    val id: String? = null,
+        @SerializedName("\$ref")
+    val ref: String? = null,
+
+        val title: String? = null,
+        val description: String? = null,
+
+        /** type may contains a string or an array of string (ArrayList),
+     * where usually the first entry is "null" (property isTypeNullable)
+     * and the second entry is the type string (property typeString)
+     * */
+    protected val type: Any? = null,
+
+        val properties: Map<String, PropertyDef>? = null,
+        val additionalProperties: Any? = null,
+        val required: Array<String>? = null,
+
+        /** See: https://json-schema.org/understanding-json-schema/reference/combining.html */
+    val oneOf: Array<PropertyDef>? = null,
+        val allOf: Array<PropertyDef>? = null,
+        val anyOf: Array<PropertyDef>? = null,
+        val not: Array<PropertyDef>? = null,
+
+        @SerializedName("x-abstract")
+    val x_abstract: Boolean? = null
+
+) {
+
+    /** returns correct JsonSchema type as string */
+    val typeString: String?
+        get() = if (type is ArrayList<*>) type.first { it != "null" } as String else type as? String
+
+    /** returns true if the object can be null */
+    val isTypeNullable: Boolean
+        get() = when {
+            type is ArrayList<*> -> type.any { it == "null" }
+            oneOf?.any { it.type == "null" } == true -> true
+            else -> typeString == "null"
+        }
+
+}