chore: Move to Kotlin DSL for Gradle build scripts

This change refactors the Gradle build files to use the Kotlin DSL
instead of Groovy. With this change, we have also added support for
building the plugin for non-embedded Kotlin compilers.

Author: fabianishere

README.md

@@ -1,6 +1,7 @@
 # kotlin-plugin-generated
-A Kotlin compiler plugin that annotates Kotlin-generated methods with `lombok.Generated` to signify to code analyzers
-that these methods have been generated by the compiler.
+A Kotlin compiler plugin that annotates Kotlin-generated methods with
+`lombok.Generated` to signify to code analyzers that these methods have been
+generated by the compiler.
 
 ## JaCoCo solution (new)
 Please note that JaCoCo landed support for recognizing Kotlin-generated
@@ -21,7 +22,7 @@ To use the plugin, just apply the plugin in your `build.gradle`:
 
 ```groovy
 plugins {
-    id 'nl.fabianm.kotlin.plugin.generated' version '1.3.0'
+    id 'nl.fabianm.kotlin.plugin.generated' version '1.3.1'
 }
 ```
 
@@ -31,7 +32,7 @@ version you are using:
 | **Kotlin** | **Plugin** |
 |:----------:|:----------:|
 |    1.2.*   |     1.0    |
-|    1.3.*   |    1.3.0   |
+|    1.3.*   |    1.3.1   |
 
 You can optionally configure the plugin as shown below:
 
@@ -46,5 +47,5 @@ kotlinGenerated {
 ```
 
 ## License
-The code is released under the Apache version 2.0 license. See the 
-`LICENSE.txt` file.
+The code is released under the Apache version 2.0 license. See the
+[LICENSE.txt](/LICENSE.txt) file.

build.gradle renamed to build.gradle.kts

@@ -14,14 +14,16 @@
  * limitations under the License.
  */
 
+plugins {
+    kotlin("jvm") version "1.3.31" apply false
+    id("org.jlleitschuh.gradle.ktlint") version "7.4.0" apply false
+    id("com.github.johnrengelman.shadow") version "5.0.0" apply false
+}
+
 allprojects {
-    group = 'nl.fabianm.kotlin.plugin.generated'
-    version = '1.3.0'
+    group = "nl.fabianm.kotlin.plugin.generated"
+    version = "1.3.1"
 
-    ext {
-        kotlin_version = '1.3.0'
-        junit_jupiter_version = '5.3.1'
-        junit_platform_version = '1.3.1'
-    }
+    extra["junitJupiterVersion"] = "5.4.2"
+    extra["junitPlatformVersion"] = "1.4.2"
 }
-

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,21 @@
 #!/usr/bin/env sh
 
+#
+# Copyright 2015 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.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
 ##############################################################################
 ##
 ##  Gradle start up script for UN*X
@@ -28,7 +44,7 @@ APP_NAME="Gradle"
 APP_BASE_NAME=`basename "$0"`
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS=""
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD="maximum"

gradlew

@@ -1,3 +1,19 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      http://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
 @if "%DEBUG%" == "" @echo off
 @rem ##########################################################################
 @rem
@@ -14,7 +30,7 @@ set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
 
 @rem Find java.exe
 if defined JAVA_HOME goto findJavaFromJavaHome

gradlew.bat

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2018 Fabian Mastenbroek.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+    kotlin("jvm")
+    id("org.jlleitschuh.gradle.ktlint")
+    jacoco
+}
+
+repositories {
+    jcenter()
+}
+
+dependencies {
+    compile("org.jetbrains.kotlin:kotlin-stdlib")
+    runtimeOnly(project(":plugin-compiler", configuration = "embeddable"))
+
+    val junitJupiterVersion: String by extra
+    val junitPlatformVersion: String by extra
+
+    testImplementation("org.junit.jupiter:junit-jupiter-api:$junitJupiterVersion")
+    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:$junitJupiterVersion")
+    testImplementation("org.junit.platform:junit-platform-launcher:$junitPlatformVersion")
+}
+
+/* Compilation */
+tasks.withType<KotlinCompile> {
+    kotlinOptions {
+        // Obtain the path to the embeddable (shaded) compiler plugin via the runtime classpath
+        val pluginJar = configurations.runtimeClasspath.get().first { it.name.startsWith("plugin-compiler") }
+
+        jvmTarget = "1.8"
+        // We force the plugin to make the annotations visible at runtime
+        freeCompilerArgs = listOf("-Xplugin=$pluginJar", "-P", "plugin:nl.fabianm.kotlin.plugin.generated:visible=true")
+    }
+}
+
+/* Test setup */
+tasks.test {
+    useJUnitPlatform {}
+
+    testLogging {
+        events("passed", "skipped", "failed")
+    }
+
+    reports {
+        html.isEnabled = true
+    }
+}
+
+tasks.jacocoTestReport {
+    sourceSets(sourceSets.main.get(), sourceSets.test.get())
+}

plugin-compiler-tests/build.gradle

@@ -14,9 +14,12 @@
  * limitations under the License.
  */
 
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
 plugins {
-    id "org.jetbrains.kotlin.jvm" version "1.3.0"
-    id "org.jlleitschuh.gradle.ktlint" version "6.2.1"
+    kotlin("jvm")
+    id("org.jlleitschuh.gradle.ktlint")
+    id("com.github.johnrengelman.shadow")
 }
 
 description = "A compiler plugin for Kotlin that marks Kotlin-generated code with an annotation."
@@ -26,34 +29,24 @@ repositories {
 }
 
 dependencies {
-    compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8"
-    compileOnly "org.jetbrains.kotlin:kotlin-compiler-embeddable"
-
-    testImplementation "org.junit.jupiter:junit-jupiter-api:$junit_jupiter_version"
-    testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junit_jupiter_version"
-    testRuntimeOnly "org.junit.platform:junit-platform-launcher:$junit_platform_version"
+    compile(kotlin("stdlib"))
+    compileOnly(kotlin("compiler"))
 }
 
-compileKotlin {
+/* Compilation */
+tasks.withType<KotlinCompile> {
     kotlinOptions {
         jvmTarget = "1.8"
     }
 }
 
-compileTestKotlin {
-    kotlinOptions {
-        jvmTarget = "1.8"
-    }
+tasks.shadowJar {
+    configurations = listOf()
+    archiveClassifier.set("embeddable")
+    relocate("com.intellij", "org.jetbrains.kotlin.com.intellij")
 }
 
-test {
-    useJUnitPlatform {}
-
-    testLogging {
-        events 'passed', 'skipped', 'failed'
-    }
-
-    reports {
-        html.enabled = true
-    }
+// Create embeddable configuration
+configurations.create("embeddable") {
+    extendsFrom(configurations.shadow.get())
 }

plugin-compiler-tests/build.gradle.kts

@@ -16,14 +16,14 @@
 
 package nl.fabianm.kotlin.plugin.generated
 
+import com.intellij.psi.PsiElement
 import jdk.internal.org.objectweb.asm.Type
 import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity
 import org.jetbrains.kotlin.cli.common.messages.MessageCollector
 import org.jetbrains.kotlin.codegen.ClassBuilder
 import org.jetbrains.kotlin.codegen.ClassBuilderFactory
 import org.jetbrains.kotlin.codegen.DelegatingClassBuilder
 import org.jetbrains.kotlin.codegen.extensions.ClassBuilderInterceptorExtension
-import org.jetbrains.kotlin.com.intellij.psi.PsiElement
 import org.jetbrains.kotlin.descriptors.FunctionDescriptor
 import org.jetbrains.kotlin.diagnostics.DiagnosticSink
 import org.jetbrains.kotlin.name.FqName