Merge pull request #23 from ThinkingLogic/feature/version-update

Feature/version update

Author: YetAnotherMatt

README.md

@@ -1,5 +1,5 @@
 # kotlin-builder-annotation
-A builder annotation for Kotlin interoperability with Java.
+A builder annotation for Kotlin interoperability with Java - to give Java clients a clean way to construct Kotlin objects.
 This project aims to be a minimal viable replacement for the Lombok @Builder plugin for Kotlin code.
 
 [![Build Status](https://travis-ci.com/ThinkingLogic/kotlin-builder-annotation.svg?branch=master)](https://travis-ci.com/ThinkingLogic/kotlin-builder-annotation)

build.gradle

@@ -2,6 +2,7 @@ buildscript {
     ext.kotlin_version = '1.3.50'
     ext.kotlintest_version = '3.3.2'
     ext.junit_jupiter_version = '5.3.1'
+    ext.nexus_plugin_version = '1.1.0'
 
     repositories {
         mavenCentral()
@@ -10,18 +11,37 @@ buildscript {
 
     dependencies {
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
-        classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.+'
     }
 }
 
-/*
- * to publish:
- * gradle clean publish bintrayUpload
- */
+plugins {
+    id 'signing'
+    id "org.jetbrains.dokka" version "1.4.20"
+    id 'maven-publish'
+    id 'io.github.gradle-nexus.publish-plugin' version "$nexus_plugin_version"
+}
+/**
+ * to publish: (just run `./gradlew clean publish closeAndReleaseStagingRepository` if you're feeling confident)
+ * 1 `./gradlew clean publish`
+ * 2 visit https://oss.sonatype.org/#nexus-search;quick~com.thinkinglogic.builder to confirm it looks correct
+ * 3 visit https://oss.sonatype.org/#stagingRepositories and close then release the staging repository
+ *
+ * Note that this requires your pgp key to be publically identifiable, e.g. at https://keys.openpgp.org/
+ * see: https://github.com/gradle-nexus/publish-plugin,  https://h4pehl.medium.com/publish-your-gradle-artifacts-to-maven-central-f74a0af085b1
+ **/
+nexusPublishing {
+    repositories {
+        sonatype {
+            username = System.getenv('SONATYPE_USER')
+            password = System.getenv('SONATYPE_PASSWORD')
+        }
+    }
+}
+
 
 allprojects {
     group = 'com.thinkinglogic.builder'
-    version = '1.2.1'
+    version = '1.2.3'
     apply plugin: "kotlin"
 
     repositories {
@@ -31,24 +51,24 @@ allprojects {
 
     compileKotlin {
         kotlinOptions {
-            jvmTarget = "1.8"
+            jvmTarget = "11"
             javaParameters = true
         }
     }
 
     compileTestKotlin {
         kotlinOptions {
-            jvmTarget = "1.8"
+            jvmTarget = "11"
             javaParameters = true
         }
     }
 
     dependencies {
-        compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
-        testCompile "org.junit.jupiter:junit-jupiter-engine:$junit_jupiter_version"
-        testCompile "org.junit.jupiter:junit-jupiter-api:$junit_jupiter_version"
-        testCompile "io.kotlintest:kotlintest-runner-junit5:$kotlintest_version"
-        testCompile "io.kotlintest:kotlintest-core:$kotlintest_version"
+        implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
+        testImplementation "org.junit.jupiter:junit-jupiter-engine:$junit_jupiter_version"
+        testImplementation "org.junit.jupiter:junit-jupiter-api:$junit_jupiter_version"
+        testImplementation "io.kotlintest:kotlintest-runner-junit5:$kotlintest_version"
+        testImplementation "io.kotlintest:kotlintest-core:$kotlintest_version"
     }
 
     test {

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-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
+#
+#      https://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"
@@ -66,6 +82,7 @@ esac
 
 CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
 
+
 # Determine the Java command to use to start the JVM.
 if [ -n "$JAVA_HOME" ] ; then
     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
@@ -109,10 +126,11 @@ if $darwin; then
     GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
 fi
 
-# For Cygwin, switch paths to Windows format before running java
-if $cygwin ; then
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+
     JAVACMD=`cygpath --unix "$JAVACMD"`
 
     # We build the pattern for arguments to be converted via cygpath
@@ -138,19 +156,19 @@ if $cygwin ; then
         else
             eval `echo args$i`="\"$arg\""
         fi
-        i=$((i+1))
+        i=`expr $i + 1`
     done
     case $i in
-        (0) set -- ;;
-        (1) set -- "$args0" ;;
-        (2) set -- "$args0" "$args1" ;;
-        (3) set -- "$args0" "$args1" "$args2" ;;
-        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
-        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
-        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
-        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
-        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
-        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+        0) set -- ;;
+        1) set -- "$args0" ;;
+        2) set -- "$args0" "$args1" ;;
+        3) set -- "$args0" "$args1" "$args2" ;;
+        4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
     esac
 fi
 
@@ -159,14 +177,9 @@ save () {
     for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
     echo " "
 }
-APP_ARGS=$(save "$@")
+APP_ARGS=`save "$@"`
 
 # Collect all arguments for the java command, following the shell quoting and substitution rules
 eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
 
-# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
-if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
-  cd "$(dirname "$0")"
-fi
-
 exec "$JAVACMD" "$@"

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      https://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
@@ -13,15 +29,18 @@ if "%DIRNAME%" == "" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
 @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
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto init
+if "%ERRORLEVEL%" == "0" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -35,7 +54,7 @@ goto fail
 set JAVA_HOME=%JAVA_HOME:"=%
 set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
-if exist "%JAVA_EXE%" goto init
+if exist "%JAVA_EXE%" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
@@ -45,28 +64,14 @@ echo location of your Java installation.
 
 goto fail
 
-:init
-@rem Get command-line arguments, handling Windows variants
-
-if not "%OS%" == "Windows_NT" goto win9xME_args
-
-:win9xME_args
-@rem Slurp the command line arguments.
-set CMD_LINE_ARGS=
-set _SKIP=2
-
-:win9xME_args_slurp
-if "x%~1" == "x" goto execute
-
-set CMD_LINE_ARGS=%*
-
 :execute
 @rem Setup the command line
 
 set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
+
 @rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
 
 :end
 @rem End local scope for the variables with windows NT shell

gradlew.bat

@@ -1,5 +1,3 @@
-apply plugin: 'com.jfrog.bintray'
-apply plugin: 'maven-publish'
 
 dependencies {
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
@@ -17,7 +15,7 @@ task javadocJar(type: Jar) {
 
 publishing {
     publications {
-        MyPublication(MavenPublication) {
+        BuilderAnnotation(MavenPublication) {
             groupId 'com.thinkinglogic.builder'
             artifactId 'kotlin-builder-annotation'
             from components.java
@@ -57,32 +55,15 @@ publishing {
     }
 }
 
+signing {
+    def signingKey = System.getenv('SONATYPE_GPG_SECRET_KEY')
+    def signingPassword = System.getenv('SONATYPE_GPG_PASSPHRASE')
+    useInMemoryPgpKeys(signingKey, signingPassword)
+    sign publishing.publications.BuilderAnnotation
+}
+
 javadoc {
     if(JavaVersion.current().isJava9Compatible()) {
         options.addBooleanOption('html4', true)
     }
 }
-/* see: https://github.com/bintray/gradle-bintray-plugin */
-bintray {
-    user = System.getenv('BINTRAY_USER')
-    key = System.getenv('BINTRAY_API_KEY')
-    publications = ['MyPublication']
-    pkg {
-        repo = 'maven'
-        name = 'kotlin-builder-annotation'
-        userOrg = 'thinkinglogic'
-        licenses = ['MIT']
-        labels = ['kotlin', 'builder', 'annotation']
-        vcsUrl = 'https://github.com/ThinkingLogic/kotlin-builder-annotation.git'
-        version {
-            name = project.version
-            desc = '@Builder annotation for Kotlin'
-            released  = new Date()
-            vcsTag = project.version
-            attributes = ['kotlin-builder-annotation': 'com.thinkinglogic:com.thinkinglogic.builder:kotlin-builder-annotation']
-            gpg {
-                sign = true
-            }
-        }
-    }
-}

kotlin-builder-annotation/build.gradle

@@ -7,7 +7,7 @@ dependencies {
 
     kapt project(':kotlin-builder-processor')
 
-    testCompile "org.assertj:assertj-core:3.10.0"
-    testCompile "com.willowtreeapps.assertk:assertk:0.10"
+    testImplementation "org.assertj:assertj-core:3.10.0"
+    testImplementation "com.willowtreeapps.assertk:assertk:0.10"
 
 }

kotlin-builder-example-usage/build.gradle

@@ -0,0 +1,12 @@
+# Debugging the builder processor
+
+A note to self as I keep forgetting ;)
+
+There is a `run-gradle-for-debug.sh` script that passes the following options to the kotlin daemon:
+```
+-Xdebug,-Xrunjdwp:transport=dt_socket\,address=5005\,server=y\,suspend=n
+```
+
+Run this script, then attach a debugger in Intellij. 
+You may have to try attaching again if the process finishes without hitting your breakpoint, 
+as there's more than one kotlin process that runs.