Fixed gradle project setup (including ensuring unit tests are run), updated readme

Author: YetAnotherMatt

README.md

@@ -6,9 +6,55 @@ This project aims to be a minimal viable replacement for the Lombok @Builder plu
 [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
 
 ## Usage
-TODO: gradle and maven
+#### Import `kotlin-builder-annotation` and `kotlin-builder-processor`
+And configure the [Kotlin annotation processor (kapt)](https://kotlinlang.org/docs/reference/kapt.html).
+##### Gradle
+```gradle
+...
+apply plugin: 'kotlin-kapt'
+...
+dependencies {
+    ...
+    implementation 'com.thinkinglogic.builder:kotlin-builder-annotation:1.0.2'
+    kapt 'com.thinkinglogic.builder:kotlin-builder-processor:1.0.2'
+}
+```
+##### Maven
+```maven
+...
+<dependencies>
+    <dependency>
+        <groupId>com.thinkinglogic.builder</groupId>
+        <artifactId>kotlin-builder-annotation</artifactId>
+        <version>1.0.2</version>
+    </dependency>
+    ...
+</dependencies>
+...
+<execution>
+    <id>kapt</id>
+    <goals>
+        <goal>kapt</goal>
+    </goals>
+    <configuration>
+        <sourceDirs>
+            <sourceDir>src/main/kotlin</sourceDir>
+            <sourceDir>src/main/java</sourceDir>
+        </sourceDirs>
+        <annotationProcessorPaths>
+            <!-- Specify your annotation processors here. -->
+            <annotationProcessorPath>
+                <groupId>com.thinkinglogic.builder</groupId>
+                <artifactId>kotlin-builder-processor</artifactId>
+                <version>1.0.2</version>
+            </annotationProcessorPath>
+        </annotationProcessorPaths>
+    </configuration>
+</execution>
 
-#### Annotate your class with the @Builder annotation
+```
+
+#### Annotate your class(es) with the @Builder annotation
 ```kotlin
 import com.thinkinglogic.builder.annotation.Builder
 
@@ -20,8 +66,8 @@ data class MyDataClass(
 ```
 That's it! Client code can now use a builder to construct instances of your class.
 
-Unlike Lombok there's no bytecode manipulation, so we don't have a `MyDataClass.builder()` static method.
-Instead we create a `new MyDataClassBuilder()`:
+Unlike Lombok there's no bytecode manipulation, so we don't expose a `MyDataClass.builder()` static method.
+Instead clients create a `new MyDataClassBuilder()`, for instance:
 
 ```java
 public class MyDataFactory {
@@ -72,7 +118,7 @@ data class MyDataClass(
 ```
 
 #### Mutable collections
-Information about the mutability of collections and maps is lost during compilation, so there is a `@Mutable` annotation:
+Information about the mutability of collections and maps is lost during compilation, so there is an `@Mutable` annotation:
 ```kotlin
 import com.thinkinglogic.builder.annotation.Builder
 import com.thinkinglogic.builder.annotation.Mutable
@@ -85,7 +131,7 @@ data class MyDataClass(
 ```
 
 #### Constructor parameters
-The `@Builder` annotation should be placed on a constructor instead of the class if you have constructor-only parameters:
+The `@Builder` annotation may be placed on a constructor instead of the class - useful if you have constructor-only parameters:
 ```kotlin
 import com.thinkinglogic.builder.annotation.Builder
 
@@ -99,7 +145,7 @@ constructor(
     val fullName = "$forename $surname"
 }
 ```  
-
+Examples of all of the above may be found in the [kotlin-builder-example-usage](tree/develop/kotlin-builder-example-usage/src/main/kotlin/com/thinkinglogic/example) project.
 ## License
 This software is Licenced under the [MIT License](LICENSE.md).
 

build.gradle

@@ -1,5 +1,7 @@
 buildscript {
-    ext.kotlin_version = '1.2.60'
+    ext.kotlin_version = '1.2.71'
+    ext.kotlintest_version = '3.1.10'
+    ext.junit_jupiter_version = '5.3.1'
 
     repositories {
         mavenCentral()
@@ -12,20 +14,19 @@ buildscript {
     }
 }
 
-allprojects {
-    group = 'com.thinkinglogic'
-    version = '1.0.1'
-}
 /*
  * to publish:
  * gradle clean publish bintrayUpload
  */
 
 allprojects {
+    group = 'com.thinkinglogic.builder'
+    version = '1.0.3'
     apply plugin: "kotlin"
 
     repositories {
         mavenCentral()
+        jcenter()
     }
 
     compileKotlin {
@@ -44,6 +45,13 @@ allprojects {
 
     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"
     }
 
+    test {
+        useJUnitPlatform()
+    }
 }

kotlin-builder-annotation/build.gradle

@@ -18,7 +18,8 @@ task javadocJar(type: Jar) {
 publishing {
     publications {
         MyPublication(MavenPublication) {
-            artifactId = 'kotlin-builder-annotation'
+            groupId 'com.thinkinglogic.builder'
+            artifactId 'kotlin-builder-annotation'
             from components.java
             artifact sourcesJar
             artifact javadocJar
@@ -61,6 +62,7 @@ javadoc {
         options.addBooleanOption('html4', true)
     }
 }
+/* see: https://github.com/bintray/gradle-bintray-plugin */
 bintray {
     user = System.getenv('BINTRAY_USER')
     key = System.getenv('BINTRAY_API_KEY')

kotlin-builder-example-usage/build.gradle

@@ -1,15 +1,13 @@
 apply plugin: 'kotlin-kapt'
 
 dependencies {
-    compile project(':kotlin-builder-annotation')
-
-    kapt project(':kotlin-builder-processor')
-
+    implementation project(':kotlin-builder-annotation')
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
     implementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version"
 
-    testCompile group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.2.0'
-    testCompile group: 'com.willowtreeapps.assertk', name: 'assertk', version: '0.10'
-    testCompile group: 'org.assertj', name: 'assertj-core', version: '3.10.0'
+    kapt project(':kotlin-builder-processor')
+    
+    testCompile "org.assertj:assertj-core:3.10.0"
+    testCompile "com.willowtreeapps.assertk:assertk:0.10"
 
 }

kotlin-builder-example-usage/src/main/kotlin/com/thinkinglogic/example/ArraysDataClass.kt

@@ -14,6 +14,7 @@ data class ArraysDataClass(
         val arrayOfDates: Array<LocalDate>
 
 ) {
+    // Due to the way the JVM uses instance equality for arrays, we should override equals and hashcode
     override fun equals(other: Any?): Boolean {
         if (this === other) return true
         if (javaClass != other?.javaClass) return false

kotlin-builder-example-usage/src/main/kotlin/com/thinkinglogic/example/CollectionsDataClass.kt

@@ -14,5 +14,4 @@ data class CollectionsDataClass(
         val collectionOfDates: Collection<LocalDate>,
         @NullableType val mapOfStringToNullableDates: Map<String, LocalDate?>,
         val treeMap: TreeMap<String, LocalDate>
-
 )

kotlin-builder-example-usage/src/test/java/com/thinkinglogic/example/SimpleDataClassJavaTest.java

@@ -15,6 +15,7 @@ void builderShouldRejectNullValueForRequiredFields() {
         // when
         Throwable exception = catchThrowable(() -> builder.notNullString(null));
 
+        // then
         then(exception)
                 .isInstanceOf(IllegalArgumentException.class)
                 .hasMessageContaining("notNullString");

kotlin-builder-example-usage/src/test/kotlin/com/thinkinglogic/example/ArraysDataClassTest.kt

@@ -22,6 +22,7 @@ internal class ArraysDataClassTest {
                 .arrayOfDates(expected.arrayOfDates)
                 .arrayOfLongs(expected.arrayOfLongs)
                 .arrayOfStrings(expected.arrayOfStrings)
+                .arrayOfNullableStrings(expected.arrayOfNullableStrings)
                 .arrayOfListOfStrings(expected.arrayOfListOfStrings)
                 .build()
 

kotlin-builder-example-usage/src/test/kotlin/com/thinkinglogic/example/CollectionsDataClassTest.kt

@@ -26,6 +26,7 @@ internal class CollectionsDataClassTest {
                 .collectionOfDates(expected.collectionOfDates)
                 .listOfStrings(expected.listOfStrings)
                 .setOfLongs(expected.setOfLongs)
+                .setOfNullableLongs(expected.setOfNullableLongs)
                 .treeMap(expected.treeMap)
                 .mapOfStringToNullableDates(expected.mapOfStringToNullableDates)
                 .build()

kotlin-builder-example-usage/src/test/kotlin/com/thinkinglogic/example/SimpleDataClassTest.kt

@@ -46,6 +46,7 @@ internal class SimpleDataClassTest {
 
         // when
         val actual = SimpleDataClassBuilder()
+                .notNullString(expected.notNullString)
                 .notNullLong(expected.notNullLong)
                 .nullableLong(expected.nullableLong)
                 .date(expected.date)

kotlin-builder-processor/build.gradle

@@ -24,7 +24,8 @@ task javadocJar(type: Jar) {
 publishing {
     publications {
         MyPublication(MavenPublication) {
-            artifactId = 'kotlin-builder-processor'
+            groupId 'com.thinkinglogic.builder'
+            artifactId 'kotlin-builder-processor'
             from components.java
             artifact sourcesJar
             artifact javadocJar
@@ -67,7 +68,7 @@ javadoc {
         options.addBooleanOption('html4', true)
     }
 }
-
+/* see: https://github.com/bintray/gradle-bintray-plugin */
 bintray {
     user = System.getenv('BINTRAY_USER')
     key = System.getenv('BINTRAY_API_KEY')

settings.gradle

@@ -1,2 +1,2 @@
 rootProject.name = 'kotlin-builder-annotation-parent'
-include ':kotlin-builder-annotation', ':kotlin-builder-processor', ':example-usage'
+include ':kotlin-builder-annotation', ':kotlin-builder-processor', ':kotlin-builder-example-usage'