Merge pull request #576 from kotlin-orm/dev

Release 4.1.1

Author: vincentlauvlwj

PACKAGES.md

@@ -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()
 }

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")
 }

buildSrc/build.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

buildSrc/src/main/kotlin/ktorm.base.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")
+            }
+        }
+    }
+}

buildSrc/src/main/kotlin/ktorm.dokka.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")
 }
 

buildSrc/src/main/kotlin/ktorm.publish.gradle.kts

@@ -348,10 +348,7 @@ val generateTuples by tasks.registering {
 }
 
 tasks {
-    compileKotlin {
-        dependsOn(generateTuples)
-    }
-    "jarSources" {
+    "codegen" {
         dependsOn(generateTuples)
     }
 }

buildSrc/src/main/kotlin/ktorm.tuples-codegen.gradle.kts

@@ -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

detekt.yml

@@ -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)

ktorm-core/src/main/kotlin/org/ktorm/schema/SqlTypes.kt

@@ -23,10 +23,7 @@ val generatePackageVersion by tasks.registering(Copy::class) {
 }
 
 tasks {
-    compileKotlin {
-        dependsOn(generatePackageVersion)
-    }
-    "jarSources" {
+    codegen {
         dependsOn(generatePackageVersion)
     }
 }