Merge pull request #576 from kotlin-orm/dev

vincentlauvlwj · web-flow · commit a1c008d2b1f8 · 2024-09-03T11:34:05.000+08:00
Release 4.1.1
diff --git a/PACKAGES.md b/PACKAGES.md
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -2,17 +2,11 @@
 group = "org.ktorm"
 version = file("ktorm.version").readLines()[0]
 
-task("printClasspath") {
-    doLast {
-        val jars = subprojects
-            .map { it.configurations["compileClasspath"] }
-            .flatMap { it.files }
-            .filterNotTo(HashSet()) { it.name.contains("ktorm") }
-            .onEach { println(it.name) }
+plugins {
+    id("ktorm.dokka")
+}
 
-        val file = file("build/ktorm.classpath")
-        file.parentFile.mkdirs()
-        file.writeText(jars.joinToString(File.pathSeparator) { it.absolutePath })
-        println("Classpath written to build/ktorm.classpath")
-    }
+repositories {
+    mavenCentral()
+    gradlePluginPortal()
 }
diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts
@@ -10,6 +10,8 @@ repositories {
 
 dependencies {
     api("org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23")
+    api("org.jetbrains.dokka:dokka-gradle-plugin:1.9.20")
+    api("org.jetbrains.dokka:dokka-base:1.9.20")
     api("org.moditect:moditect:1.0.0.RC1")
     api("io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.23.6")
 }
diff --git a/buildSrc/src/main/kotlin/ktorm.base.gradle.kts b/buildSrc/src/main/kotlin/ktorm.base.gradle.kts
@@ -30,7 +30,12 @@ java {
 }
 
 tasks {
+    // Lifecycle task for code generation.
+    val codegen by registering { /* do nothing */ }
+
     compileKotlin {
+        dependsOn(codegen)
+
         kotlinOptions {
             jvmTarget = "1.8"
             allWarningsAsErrors = true
diff --git a/buildSrc/src/main/kotlin/ktorm.dokka.gradle.kts b/buildSrc/src/main/kotlin/ktorm.dokka.gradle.kts
@@ -0,0 +1,45 @@
+
+plugins {
+    id("org.jetbrains.dokka")
+}
+
+tasks.named<org.jetbrains.dokka.gradle.DokkaMultiModuleTask>("dokkaHtmlMultiModule") {
+    val tmplDir = System.getProperty("dokka.templatesDir")
+    if (!tmplDir.isNullOrEmpty()) {
+        pluginConfiguration<org.jetbrains.dokka.base.DokkaBase, org.jetbrains.dokka.base.DokkaBaseConfiguration> {
+            templatesDir = File(tmplDir)
+        }
+    }
+}
+
+subprojects {
+    apply(plugin = "org.jetbrains.dokka")
+
+    tasks.dokkaJavadoc {
+        dependsOn("codegen")
+
+        dokkaSourceSets.named("main") {
+            suppressGeneratedFiles.set(false)
+        }
+    }
+
+    tasks.named<org.jetbrains.dokka.gradle.DokkaTaskPartial>("dokkaHtmlPartial") {
+        dependsOn("codegen")
+
+        val tmplDir = System.getProperty("dokka.templatesDir")
+        if (!tmplDir.isNullOrEmpty()) {
+            pluginConfiguration<org.jetbrains.dokka.base.DokkaBase, org.jetbrains.dokka.base.DokkaBaseConfiguration> {
+                templatesDir = File(tmplDir)
+            }
+        }
+
+        dokkaSourceSets.named("main") {
+            suppressGeneratedFiles.set(false)
+            sourceLink {
+                localDirectory.set(file("src/main/kotlin"))
+                remoteUrl.set(java.net.URL("https://github.com/kotlin-orm/ktorm/blob/master/${project.name}/src/main/kotlin"))
+                remoteLineSuffix.set("#L")
+            }
+        }
+    }
+}
diff --git a/buildSrc/src/main/kotlin/ktorm.publish.gradle.kts b/buildSrc/src/main/kotlin/ktorm.publish.gradle.kts
@@ -3,14 +3,18 @@ plugins {
     id("kotlin")
     id("signing")
     id("maven-publish")
+    id("org.jetbrains.dokka")
 }
 
 val jarSources by tasks.registering(Jar::class) {
-    archiveClassifier.set("sources")
+    dependsOn("codegen")
     from(sourceSets.main.map { it.allSource })
+    archiveClassifier.set("sources")
 }
 
 val jarJavadoc by tasks.registering(Jar::class) {
+    dependsOn(tasks.dokkaJavadoc)
+    from(tasks.dokkaJavadoc.flatMap { it.outputDirectory })
     archiveClassifier.set("javadoc")
 }
 
diff --git a/buildSrc/src/main/kotlin/ktorm.tuples-codegen.gradle.kts b/buildSrc/src/main/kotlin/ktorm.tuples-codegen.gradle.kts
@@ -348,10 +348,7 @@ val generateTuples by tasks.registering {
 }
 
 tasks {
-    compileKotlin {
-        dependsOn(generateTuples)
-    }
-    "jarSources" {
+    "codegen" {
         dependsOn(generateTuples)
     }
 }
diff --git a/detekt.yml b/detekt.yml
@@ -402,7 +402,7 @@ style:
     active: true
     maxJumpCount: 2
   MagicNumber:
-    active: true
+    active: false
     ignoreNumbers: ['-1', '0', '1', '2', '3', '60']
     ignoreHashCodeFunction: true
     ignorePropertyDeclaration: false
diff --git a/ktorm-core/src/main/kotlin/org/ktorm/schema/SqlTypes.kt b/ktorm-core/src/main/kotlin/org/ktorm/schema/SqlTypes.kt
@@ -450,7 +450,6 @@ public fun BaseTable<*>.yearMonth(name: String): Column<YearMonth> {
 /**
  * [SqlType] implementation used to save [YearMonth] instances, formatting them to strings with pattern `yyyy-MM`.
  */
-@Suppress("MagicNumber")
 public object YearMonthSqlType : SqlType<YearMonth>(Types.VARCHAR, "varchar") {
     private val formatter = DateTimeFormatterBuilder()
         .appendValue(ChronoField.YEAR, 4, 10, SignStyle.EXCEEDS_PAD)
diff --git a/ktorm-jackson/ktorm-jackson.gradle.kts b/ktorm-jackson/ktorm-jackson.gradle.kts
@@ -23,10 +23,7 @@ val generatePackageVersion by tasks.registering(Copy::class) {
 }
 
 tasks {
-    compileKotlin {
-        dependsOn(generatePackageVersion)
-    }
-    "jarSources" {
+    codegen {
         dependsOn(generatePackageVersion)
     }
 }
diff --git a/ktorm-ksp-annotations/src/main/kotlin/org/ktorm/ksp/annotation/Undefined.kt b/ktorm-ksp-annotations/src/main/kotlin/org/ktorm/ksp/annotation/Undefined.kt
@@ -145,7 +145,7 @@ public object Undefined {
             return defineClass(name, bytes, null)
         }
 
-        @Suppress("MagicNumber", "NoMultipleSpaces")
+        @Suppress("NoMultipleSpaces")
         private fun generateByteCode(className: ByteArray, superClassName: ByteArray): ByteBuffer {
             val buf = ByteBuffer.allocate(1024)
             buf.putInt(0xCAFEBABE.toInt())                          // magic
diff --git a/ktorm-ksp-compiler/src/main/kotlin/org/ktorm/ksp/compiler/KtormProcessorProvider.kt b/ktorm-ksp-compiler/src/main/kotlin/org/ktorm/ksp/compiler/KtormProcessorProvider.kt
@@ -65,7 +65,8 @@ public class KtormProcessorProvider : SymbolProcessorProvider {
                 val fileSpec = FileGenerator.generate(table, environment)
 
                 // Beautify the generated code.
-                val formattedCode = formatter.format(fileSpec.toString())
+                val fileName = fileSpec.packageName.replace('.', '/') + "/" + fileSpec.name + ".kt"
+                val formattedCode = formatter.format(fileName, fileSpec.toString())
 
                 // Output the formatted code.
                 val dependencies = Dependencies(false, *table.getDependencyFiles().toTypedArray())
@@ -88,7 +89,7 @@ public class KtormProcessorProvider : SymbolProcessorProvider {
         } catch (_: NoClassDefFoundError) {
         }
 
-        return CodeFormatter { code -> code }
+        return CodeFormatter { _, code -> code }
     }
 
     private fun TableMetadata.getDependencyFiles(): List<KSFile> {
diff --git a/ktorm-ksp-compiler/src/main/kotlin/org/ktorm/ksp/compiler/formatter/CodeFormatter.kt b/ktorm-ksp-compiler/src/main/kotlin/org/ktorm/ksp/compiler/formatter/CodeFormatter.kt
@@ -24,5 +24,5 @@ internal fun interface CodeFormatter {
     /**
      * Format the generated code to the community recommended coding style.
      */
-    fun format(code: String): String
+    fun format(fileName: String, code: String): String
 }
diff --git a/ktorm-ksp-compiler/src/main/kotlin/org/ktorm/ksp/compiler/formatter/KtLintCodeFormatter.kt b/ktorm-ksp-compiler/src/main/kotlin/org/ktorm/ksp/compiler/formatter/KtLintCodeFormatter.kt
@@ -38,7 +38,7 @@ internal class KtLintCodeFormatter(val environment: SymbolProcessorEnvironment)
         )
     )
 
-    override fun format(code: String): String {
+    override fun format(fileName: String, code: String): String {
         try {
             // Manually fix some code styles before formatting.
             val snippet = code
diff --git a/ktorm-ksp-compiler/src/main/kotlin/org/ktorm/ksp/compiler/formatter/StandaloneKtLintCodeFormatter.kt b/ktorm-ksp-compiler/src/main/kotlin/org/ktorm/ksp/compiler/formatter/StandaloneKtLintCodeFormatter.kt
@@ -18,19 +18,25 @@ package org.ktorm.ksp.compiler.formatter
 
 import com.google.devtools.ksp.processing.SymbolProcessorEnvironment
 import java.io.File
+import java.util.concurrent.TimeUnit
 
 internal class StandaloneKtLintCodeFormatter(val environment: SymbolProcessorEnvironment) : CodeFormatter {
+    private val logger = environment.logger
     private val command = buildCommand()
 
     init {
-        environment.logger.info("[ktorm-ksp-compiler] init ktlint formatter with command: ${command.joinToString(" ")}")
+        logger.info("[ktorm-ksp-compiler] init ktlint formatter with command: ${command.joinToString(" ")}")
     }
 
-    override fun format(code: String): String {
+    override fun format(fileName: String, code: String): String {
         try {
             val p = ProcessBuilder(command).start()
             p.outputStream.bufferedWriter(Charsets.UTF_8).use { it.write(preprocessCode(code)) }
-            p.waitFor()
+
+            if (!p.waitFor(30, TimeUnit.SECONDS)) {
+                logger.info("[ktorm-ksp-compiler] ktlint execution timeout, skip code formatting for file: $fileName")
+                return code
+            }
 
             val formattedCode = p.inputStream.bufferedReader(Charsets.UTF_8).use { it.readText() }
             if (p.exitValue() == 0) {
@@ -43,12 +49,12 @@ internal class StandaloneKtLintCodeFormatter(val environment: SymbolProcessorEnv
                 } else {
                     // Exit exceptionally.
                     val msg = p.errorStream.bufferedReader(Charsets.UTF_8).use { it.readText() }
-                    environment.logger.error("[ktorm-ksp-compiler] ktlint exit with code: ${p.exitValue()}\n$msg")
+                    logger.error("[ktorm-ksp-compiler] ktlint exit with code: ${p.exitValue()}\n$msg")
                     return code
                 }
             }
         } catch (e: Throwable) {
-            environment.logger.exception(e)
+            logger.exception(e)
             return code
         }
     }
diff --git a/ktorm-ksp-compiler/src/main/kotlin/org/ktorm/ksp/compiler/generator/PseudoConstructorFunctionGenerator.kt b/ktorm-ksp-compiler/src/main/kotlin/org/ktorm/ksp/compiler/generator/PseudoConstructorFunctionGenerator.kt
@@ -90,7 +90,7 @@ internal object PseudoConstructorFunctionGenerator {
             }
 
             if (!prop._type.isMarkedNullable) {
-                statement += "·?:·error(\"`%1L` should not be null.\")"
+                statement += "·?:·error(\"`%1L`·should·not·be·null.\")"
             }
 
             addStatement(statement, prop.simpleName.asString())
diff --git a/ktorm.version b/ktorm.version
@@ -1 +1 @@
-4.1.0
+4.1.1
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,6 +1,6 @@
 
 plugins {
-    id("com.gradle.enterprise") version("3.14.1")
+    id("com.gradle.enterprise") version "3.14.1"
 }
 
 include("ktorm-core")

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@ repositories {`
`10`	`10`
`11`	`11`	`dependencies {`
`12`	`12`	`api("org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.23")`
	`13`	`+ api("org.jetbrains.dokka:dokka-gradle-plugin:1.9.20")`
	`14`	`+ api("org.jetbrains.dokka:dokka-base:1.9.20")`
`13`	`15`	`api("org.moditect:moditect:1.0.0.RC1")`
`14`	`16`	`api("io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.23.6")`
`15`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3,14 +3,18 @@ plugins {`
`3`	`3`	`id("kotlin")`
`4`	`4`	`id("signing")`
`5`	`5`	`id("maven-publish")`
	`6`	`+ id("org.jetbrains.dokka")`
`6`	`7`	`}`
`7`	`8`
`8`	`9`	`val jarSources by tasks.registering(Jar::class) {`
`9`		`- archiveClassifier.set("sources")`
	`10`	`+ dependsOn("codegen")`
`10`	`11`	`from(sourceSets.main.map { it.allSource })`
	`12`	`+ archiveClassifier.set("sources")`
`11`	`13`	`}`
`12`	`14`
`13`	`15`	`val jarJavadoc by tasks.registering(Jar::class) {`
	`16`	`+ dependsOn(tasks.dokkaJavadoc)`
	`17`	`+ from(tasks.dokkaJavadoc.flatMap { it.outputDirectory })`
`14`	`18`	`archiveClassifier.set("javadoc")`
`15`	`19`	`}`
`16`	`20`
Original file line number	Diff line number	Diff line change
`@@ -348,10 +348,7 @@ val generateTuples by tasks.registering {`
`348`	`348`	`}`
`349`	`349`
`350`	`350`	`tasks {`
`351`		`- compileKotlin {`
`352`		`- dependsOn(generateTuples)`
`353`		`- }`
`354`		`- "jarSources" {`
	`351`	`+ "codegen" {`
`355`	`352`	`dependsOn(generateTuples)`
`356`	`353`	`}`
`357`	`354`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,10 +23,7 @@ val generatePackageVersion by tasks.registering(Copy::class) {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`tasks {`
`26`		`- compileKotlin {`
`27`		`- dependsOn(generatePackageVersion)`
`28`		`- }`
`29`		`- "jarSources" {`
	`26`	`+ codegen {`
`30`	`27`	`dependsOn(generatePackageVersion)`
`31`	`28`	`}`
`32`	`29`	`}`