Add Scala example project (#246)

Also moved Kotlin/Scala to subprojects rather than applying to all.

Author: will-molloy

README.md

@@ -3,7 +3,7 @@
 [![build](https://github.com/will-molloy/java-template/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/will-molloy/java-template/actions/workflows/build.yml)
 [![codecov](https://codecov.io/gh/will-molloy/java-template/branch/main/graph/badge.svg)](https://codecov.io/gh/will-molloy/java-template)
 
-template repo for Java/Kotlin Gradle projects
+template repo for Java (or Kotlin/Scala) Gradle projects
 
 ## Features
 
@@ -13,7 +13,7 @@ template repo for Java/Kotlin Gradle projects
 - Automatic code formatting via [Spotless](https://github.com/diffplug/spotless)
   - Java: [`google-java-format`](https://github.com/google/google-java-format)
   - Kotlin: [`ktfmt`](https://github.com/facebook/ktfmt)
-  - Kotlin Gradle: [`ktlint`](https://github.com/pinterest/ktlint)
+  - Scala: [`scalafmt`](https://github.com/scalameta/scalafmt)
 - Code style analysis via [Checkstyle](https://github.com/checkstyle/checkstyle)
 - Static analysis via [SpotBugs](https://spotbugs.github.io/)
 - Unit and integration test support via [JUnit 5](https://junit.org/junit5/) and [TestSets plugin](https://github.com/unbroken-dome/gradle-testsets-plugin)

build.gradle.kts

@@ -5,14 +5,12 @@ import com.github.spotbugs.snom.SpotBugsExtension
 import com.github.spotbugs.snom.SpotBugsTask
 import org.gradle.api.tasks.testing.logging.TestExceptionFormat
 import org.gradle.api.tasks.testing.logging.TestLogEvent
-import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
 
 logger.quiet("Java version: ${JavaVersion.current()}")
 logger.quiet("Gradle version: ${gradle.gradleVersion}")
 
 plugins {
   id("java-library")
-  kotlin("jvm") version libs.versions.kotlin
   alias(libs.plugins.spotless)
   alias(libs.plugins.spotbugs)
   alias(libs.plugins.buildtimetracker)
@@ -30,11 +28,6 @@ allprojects {
     targetCompatibility = JavaVersion.VERSION_21
   }
 
-  apply(plugin = "kotlin")
-  configure<KotlinJvmProjectExtension> {
-    jvmToolchain(21)
-  }
-
   apply(plugin = "com.diffplug.spotless")
   configure<SpotlessExtension> {
     // https://github.com/diffplug/spotless/tree/main/plugin-gradle#java
@@ -55,9 +48,15 @@ allprojects {
       trimTrailingWhitespace()
       endWithNewline()
     }
+    // https://github.com/diffplug/spotless/tree/main/plugin-gradle#scala
+    scala {
+      scalafmt().configFile("$rootDir/scalafmt.conf")
+      trimTrailingWhitespace()
+      endWithNewline()
+    }
   }
 
-  // TODO Kotlin alternative?
+  // TODO Kotlin/Scala alternative?
   apply(plugin = "checkstyle")
   configure<CheckstyleExtension> {
     toolVersion = "10.12.0"
@@ -112,23 +111,8 @@ allprojects {
     }
   }
 
-  val previewFeatures = emptyList<String>()
-  tasks.withType<JavaCompile> {
-    options.compilerArgs = previewFeatures
-  }
-  tasks.withType<Test> {
-    jvmArgs = previewFeatures
-  }
-  tasks.withType<JavaExec> {
-    jvmArgs = previewFeatures
-  }
-
   dependencies {
-    implementation(rootProject.libs.log4j.core)
-    implementation(rootProject.libs.log4j.api)
-    implementation(rootProject.libs.log4j.slf4j2)
     implementation(rootProject.libs.spotbugs.annotations)
-    implementation(rootProject.libs.guava)
 
     testImplementation(rootProject.libs.junit)
     testImplementation(rootProject.libs.truth)
@@ -138,10 +122,6 @@ allprojects {
     configurations.all {
       exclude(group = "org.assertj")
       exclude(group = "junit")
-      resolutionStrategy {
-        // exclude android version
-        force("com.google.guava:guava:${rootProject.libs.versions.guava.get()}")
-      }
     }
   }
 }

example-java/build.gradle.kts

@@ -1,3 +1,13 @@
-plugins { alias(libs.plugins.testsets) }
+plugins {
+  alias(libs.plugins.testsets)
+}
 
-testSets { create("integrationTest") }
+testSets {
+  create("integrationTest")
+}
+
+dependencies {
+  implementation(rootProject.libs.log4j.core)
+  implementation(rootProject.libs.log4j.api)
+  implementation(rootProject.libs.log4j.slf4j2)
+}

…illmolloy/HelloWorldIntegrationTest.java …willmolloy/HelloJavaIntegrationTest.javaexample-java/src/integrationTest/java/com/willmolloy/HelloWorldIntegrationTest.java renamed to example-java/src/integrationTest/java/com/willmolloy/HelloJavaIntegrationTest.java example-java/src/integrationTest/java/com/willmolloy/HelloWorldIntegrationTest.java renamed to example-java/src/integrationTest/java/com/willmolloy/HelloJavaIntegrationTest.java

@@ -5,14 +5,14 @@
 import org.junit.jupiter.api.Test;
 
 /**
- * Integration tests for {@link HelloWorld}.
+ * Integration tests for {@link HelloJava}.
  *
  * @author <a href=https://willmolloy.com>Will Molloy</a>
  */
-class HelloWorldIntegrationTest {
+class HelloJavaIntegrationTest {
 
   @Test
   void test_hello() {
-    assertThat(new HelloWorld().hello("world")).isEqualTo("Hello world!");
+    assertThat(new HelloJava().hello("world")).isEqualTo("Hello world!");
   }
 }

…main/java/com/willmolloy/HelloWorld.java …/main/java/com/willmolloy/HelloJava.javaexample-java/src/main/java/com/willmolloy/HelloWorld.java renamed to example-java/src/main/java/com/willmolloy/HelloJava.java example-java/src/main/java/com/willmolloy/HelloWorld.java renamed to example-java/src/main/java/com/willmolloy/HelloJava.java

@@ -8,7 +8,7 @@
  *
  * @author <a href=https://willmolloy.com>Will Molloy</a>
  */
-class HelloWorld {
+class HelloJava {
   private static final Logger log = LogManager.getLogger();
 
   String hello(String text) {

…/java/com/willmolloy/HelloWorldTest.java …t/java/com/willmolloy/HelloJavaTest.javaexample-java/src/test/java/com/willmolloy/HelloWorldTest.java renamed to example-java/src/test/java/com/willmolloy/HelloJavaTest.java example-java/src/test/java/com/willmolloy/HelloWorldTest.java renamed to example-java/src/test/java/com/willmolloy/HelloJavaTest.java

@@ -5,14 +5,14 @@
 import org.junit.jupiter.api.Test;
 
 /**
- * Unit tests for {@link HelloWorld}.
+ * Unit tests for {@link HelloJava}.
  *
  * @author <a href=https://willmolloy.com>Will Molloy</a>
  */
-class HelloWorldTest {
+class HelloJavaTest {
 
   @Test
   void test_hello() {
-    assertThat(new HelloWorld().hello("world")).isEqualTo("Hello world!");
+    assertThat(new HelloJava().hello("world")).isEqualTo("Hello world!");
   }
 }

example-kotlin/build.gradle.kts

@@ -1 +1,12 @@
+plugins {
+  kotlin("jvm") version libs.versions.kotlin
+}
 
+kotlin {
+  jvmToolchain(21)
+}
+
+// TODO disabling on Kotlin/Scala atm... too many false positives
+spotbugs {
+  ignoreFailures.set(true)
+}

…main/kotlin/com/willmolloy/HelloWorld.kt …ain/kotlin/com/willmolloy/HelloKotlin.ktexample-kotlin/src/main/kotlin/com/willmolloy/HelloWorld.kt renamed to example-kotlin/src/main/kotlin/com/willmolloy/HelloKotlin.kt example-kotlin/src/main/kotlin/com/willmolloy/HelloWorld.kt renamed to example-kotlin/src/main/kotlin/com/willmolloy/HelloKotlin.kt

@@ -5,9 +5,7 @@ package com.willmolloy
  *
  * @author <a href=https://willmolloy.com>Will Molloy</a>
  */
-class HelloWorld {
+object HelloKotlin {
 
-  fun hello(text: String): String {
-    return "Hello $text!"
-  }
+  fun hello(text: String): String = "Hello $text, from Kotlin!"
 }

…/kotlin/com/willmolloy/HelloWorldTest.kt …kotlin/com/willmolloy/HelloKotlinTest.ktexample-kotlin/src/test/kotlin/com/willmolloy/HelloWorldTest.kt renamed to example-kotlin/src/test/kotlin/com/willmolloy/HelloKotlinTest.kt example-kotlin/src/test/kotlin/com/willmolloy/HelloWorldTest.kt renamed to example-kotlin/src/test/kotlin/com/willmolloy/HelloKotlinTest.kt

@@ -3,11 +3,11 @@ package com.willmolloy
 import com.google.common.truth.Truth.assertThat
 import org.junit.jupiter.api.Test
 
-/** Unit tests for [HelloWorld]. */
-class HelloWorldTest {
+/** Unit tests for [HelloKotlin]. */
+class HelloKotlinTest {
 
   @Test
   fun `test hello`() {
-    assertThat(HelloWorld().hello("world")).isEqualTo("Hello world!")
+    assertThat(HelloKotlin.hello("world")).isEqualTo("Hello world, from Kotlin!")
   }
 }

example-scala/build.gradle.kts

@@ -0,0 +1,12 @@
+plugins {
+  scala
+}
+
+dependencies {
+  implementation(libs.scala.library)
+}
+
+// TODO disabling on Kotlin/Scala atm... too many false positives
+spotbugs {
+  ignoreFailures.set(true)
+}