Merge pull request #462 from kotlin-orm/v3.6.x

Release v3.6.0

Author: vincentlauvlwj

.github/workflows/build.yml

@@ -9,16 +9,21 @@ on:
 
 jobs:
   build:
+    name: Build with JDK ${{ matrix.java }}
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        java: [8, 11, 17, 19]
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup Java
-        uses: actions/setup-java@v2
+        uses: actions/setup-java@v3
         with:
-          distribution: temurin
-          java-version: 8
+          distribution: zulu
+          java-version: ${{ matrix.java }}
 
       - name: Setup Gradle
         uses: gradle/gradle-build-action@v2
@@ -29,6 +34,64 @@ jobs:
       - name: Run Tests
         run: ./gradlew check
 
+      - name: Generate JaCoCo Report
+        run: ./gradlew jacocoTestReport
+
+      - name: Generate JaCoCo Badges
+        uses: cicirello/jacoco-badge-generator@v2
+        with:
+          generate-branches-badge: true
+          jacoco-csv-file: >
+            ktorm-core/build/reports/jacoco/test/jacocoTestReport.csv
+            ktorm-global/build/reports/jacoco/test/jacocoTestReport.csv
+            ktorm-jackson/build/reports/jacoco/test/jacocoTestReport.csv
+            ktorm-support-mysql/build/reports/jacoco/test/jacocoTestReport.csv
+            ktorm-support-oracle/build/reports/jacoco/test/jacocoTestReport.csv
+            ktorm-support-postgresql/build/reports/jacoco/test/jacocoTestReport.csv
+            ktorm-support-sqlite/build/reports/jacoco/test/jacocoTestReport.csv
+            ktorm-support-sqlserver/build/reports/jacoco/test/jacocoTestReport.csv
+
+      - name: Upload Jacoco Badges
+        if: matrix.java == '8'
+        continue-on-error: true
+        run: |
+          REPO_DIR=~/.ktorm/temp/repo/ktorm-docs
+          git clone --depth=1 --branch=master https://github.com/kotlin-orm/ktorm-docs.git "$REPO_DIR"
+
+          cp .github/badges/jacoco.svg "$REPO_DIR/source/images"
+          cp .github/badges/branches.svg "$REPO_DIR/source/images"
+          cd "$REPO_DIR"
+
+          if [[ `git status --porcelain` ]]; then
+            git config user.name 'vince'
+            git config user.email '[email protected]'
+            git add . 
+            git commit -m "[github actions] update jacoco badges"
+            git push "https://[email protected]/kotlin-orm/ktorm-docs.git" master
+          fi
+        env:
+          GIT_PUSH_TOKEN: ${{secrets.GIT_PUSH_TOKEN}}
+
+  publish:
+    name: Publish Artifacts
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Setup Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: zulu
+          java-version: 8
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+
+      - name: Assemble the Project
+        run: ./gradlew assemble
+
       - name: Publish Artifacts
         run: |
           if [[ $(cat "ktorm.version") =~ "SNAPSHOT" ]] ; then
@@ -45,4 +108,4 @@ jobs:
           OSSRH_PASSWORD: ${{secrets.OSSRH_PASSWORD}}
           GPG_KEY_ID: ${{secrets.GPG_KEY_ID}}
           GPG_PASSWORD: ${{secrets.GPG_PASSWORD}}
-          GPG_SECRET_KEY: ${{secrets.GPG_SECRET_KEY}}
+          GPG_SECRET_KEY: ${{secrets.GPG_SECRET_KEY}}

CONTRIBUTING.md

@@ -9,4 +9,4 @@ Pull requests are always welcome and can be a quick way to get your fix or impro
 - By contributing to Ktorm, you agree that your contributions will be licensed under [Apache License 2.0](LICENSE).
 - Coding Conventions are very important. Refer to the [Kotlin Style Guide](https://kotlinlang.org/docs/reference/coding-conventions.html) for the recommended coding standards of Ktorm.
 - If you've added code that should be tested, add tests and ensure they all pass. If you've changed APIs, update the documentation. 
-- If it's your first time contributing to Ktorm, please also update [this file](buildSrc/src/main/kotlin/ktorm.maven-publish.gradle.kts), add your GitHub ID to the developer's info, which will let more people know your contributions.
+- If it's your first time contributing to Ktorm, please also update [this file](buildSrc/src/main/kotlin/ktorm.publish.gradle.kts), add your GitHub ID to the developer's info, which will let more people know your contributions.

build.gradle.kts

@@ -1,6 +1,6 @@
 
 group = "org.ktorm"
-version = file("ktorm.version").readText()
+version = file("ktorm.version").readLines()[0]
 
 task("printClasspath") {
     doLast {

buildSrc/build.gradle.kts

@@ -1,6 +1,6 @@
 
 plugins {
-    id("org.gradle.kotlin.kotlin-dsl") version "2.1.7"
+    id("org.gradle.kotlin.kotlin-dsl") version "2.4.1"
 }
 
 repositories {
@@ -9,6 +9,7 @@ repositories {
 }
 
 dependencies {
-    api("org.jetbrains.kotlin:kotlin-gradle-plugin:1.5.32")
+    api("org.jetbrains.kotlin:kotlin-gradle-plugin:1.7.22")
+    api("org.moditect:moditect-gradle-plugin:1.0.0-rc3")
     api("io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.20.0")
 }

buildSrc/src/main/kotlin/ktorm.module-conventions.gradle.kts

@@ -0,0 +1,78 @@
+
+group = rootProject.group
+version = rootProject.version
+
+plugins {
+    id("kotlin")
+    id("org.gradle.jacoco")
+    id("org.moditect.gradleplugin")
+    id("io.gitlab.arturbosch.detekt")
+    id("ktorm.source-header-check")
+    id("ktorm.publish")
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    api(kotlin("stdlib"))
+    api(kotlin("reflect"))
+    testImplementation(kotlin("test-junit"))
+    detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:${detekt.toolVersion}")
+}
+
+moditect {
+    // Generate a multi-release jar, the module descriptor will be located at META-INF/versions/9/module-info.class
+    addMainModuleInfo {
+        jvmVersion.set("9")
+        overwriteExistingFiles.set(true)
+        module {
+            moduleInfoFile = file("src/main/moditect/module-info.java")
+        }
+    }
+
+    // Let kotlin compiler know the module descriptor.
+    if (JavaVersion.current() >= JavaVersion.VERSION_1_9) {
+        sourceSets.main {
+            kotlin.srcDir("src/main/moditect")
+        }
+    }
+
+    // Workaround to avoid circular task dependencies, see https://github.com/moditect/moditect-gradle-plugin/issues/14
+    afterEvaluate {
+        val compileJava = tasks.compileJava.get()
+        val addDependenciesModuleInfo = tasks.addDependenciesModuleInfo.get()
+        compileJava.setDependsOn(compileJava.dependsOn - addDependenciesModuleInfo)
+    }
+}
+
+detekt {
+    source = files("src/main/kotlin")
+    config = files("${project.rootDir}/detekt.yml")
+}
+
+tasks {
+    compileKotlin {
+        kotlinOptions {
+            jvmTarget = "1.8"
+            allWarningsAsErrors = true
+            freeCompilerArgs = listOf("-Xexplicit-api=strict")
+        }
+    }
+
+    compileTestKotlin {
+        kotlinOptions {
+            jvmTarget = "1.8"
+            freeCompilerArgs = listOf("-Xjvm-default=all")
+        }
+    }
+
+    jacocoTestReport {
+        reports {
+            csv.required.set(true)
+            xml.required.set(true)
+            html.required.set(true)
+        }
+    }
+}

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

@@ -131,6 +131,30 @@ publishing {
                         name.set("ccr")
                         email.set("[email protected]")
                     }
+                    developer {
+                        id.set("zuisong")
+                        name.set("zuisong")
+                        email.set("[email protected]")
+                    }
+                    developer {
+                        id.set("svenallers")
+                        name.set("Sven Allers")
+                        email.set("[email protected]")
+                    }
+                    developer {
+                        id.set("lookup-cat")
+                        name.set("夜里的向日葵")
+                        email.set("[email protected]")
+                    }
+                    developer {
+                        id.set("michaelfyc")
+                        name.set("michaelfyc")
+                        email.set("[email protected]")
+                    }
+                    developer {
+                        id.set("brohacz")
+                        name.set("Michal Brosig")
+                    }
                 }
             }
         }

buildSrc/src/main/kotlin/ktorm.maven-publish.gradle.kts renamed to buildSrc/src/main/kotlin/ktorm.publish.gradle.kts

@@ -5,7 +5,7 @@ plugins {
 
 val licenseHeaderText = """
 /*
- * Copyright 2018-2022 the original author or authors.
+ * Copyright 2018-2023 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -38,4 +38,6 @@ val checkSourceHeader by tasks.registering {
     }
 }
 
-tasks["check"].dependsOn(checkSourceHeader)
+tasks.check {
+    dependsOn(checkSourceHeader)
+}

buildSrc/src/main/kotlin/ktorm.source-header-check.gradle.kts

@@ -282,7 +282,7 @@ val generateTuples by tasks.registering {
         outputFile.bufferedWriter().use { writer ->
             writer.write("""
                 /*
-                 * Copyright 2018-2022 the original author or authors.
+                 * Copyright 2018-2023 the original author or authors.
                  *
                  * Licensed under the Apache License, Version 2.0 (the "License");
                  * you may not use this file except in compliance with the License.
@@ -297,7 +297,7 @@ val generateTuples by tasks.registering {
                  * limitations under the License.
                  */
                 
-                // Auto-generated by ktorm.tuples-generation.gradle.kts, DO NOT EDIT!
+                // Auto-generated by ktorm.tuples-codegen.gradle.kts, DO NOT EDIT!
                 
                 package org.ktorm.entity
                 
@@ -347,9 +347,15 @@ val generateTuples by tasks.registering {
     }
 }
 
-sourceSets.main {
-    java.srcDirs(generatedSourceDir)
+tasks {
+    compileKotlin {
+        dependsOn(generateTuples)
+    }
+    "jarSources" {
+        dependsOn(generateTuples)
+    }
 }
 
-tasks["compileKotlin"].dependsOn(generateTuples)
-tasks["jarSources"].dependsOn(generateTuples)
+sourceSets.main {
+    kotlin.srcDir(generatedSourceDir)
+}

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

@@ -54,7 +54,7 @@ complexity:
     includeStaticDeclarations: false
   ComplexMethod:
     active: true
-    threshold: 15
+    threshold: 20
     ignoreSingleWhenExpression: true
     ignoreSimpleWhenEntries: true
   LabeledExpression:
@@ -197,7 +197,7 @@ formatting:
     indentSize: 4
     continuationIndentSize: 4
   MaximumLineLength:
-    active: true
+    active: false
     maxLineLength: 120
   ModifierOrdering:
     active: true
@@ -409,7 +409,7 @@ style:
     maxJumpCount: 2
   MagicNumber:
     active: true
-    ignoreNumbers: '-1,0,1,2,3'
+    ignoreNumbers: '-1,0,1,2,3,60'
     ignoreHashCodeFunction: true
     ignorePropertyDeclaration: false
     ignoreConstantDeclaration: true
@@ -460,7 +460,7 @@ style:
   SpacingBetweenPackageAndImports:
     active: true
   ThrowsCount:
-    active: true
+    active: false
     max: 2
   TrailingWhitespace:
     active: true