Merge branch 'simplified-stage' into v2

Author: wisebaldone

build.gradle

@@ -1,8 +1,9 @@
 plugins {
-    id 'java'
-    id 'application'
-    id "org.sonarqube" version "6.3.1.5724"
-    id "com.github.ben-manes.versions" version "0.53.0"
+    id("java")
+    id("application")
+    id("org.sonarqube") version "6.3.1.5724"
+    id("com.github.ben-manes.versions") version "0.53.0"
+    id("com.diffplug.spotless") version "8.0.0"
 }
 
 java {
@@ -42,6 +43,7 @@ dependencies {
     implementation 'com.github.therapi:therapi-runtime-javadoc:0.15.0'
     implementation 'com.github.therapi:therapi-runtime-javadoc-scribe:0.15.0'
     implementation 'info.picocli:picocli:4.7.7'
+    implementation 'org.reflections:reflections:0.9.12'
     implementation 'com.google.code.gson:gson:2.13.2'
     implementation 'com.github.gestalt-config:gestalt-core:0.36.0'
     implementation 'com.github.gestalt-config:gestalt-yaml:0.36.0'
@@ -79,3 +81,21 @@ tasks.register('fatJar', Jar) {
     from { configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) } }
     with jar
 }
+
+spotless {
+    format 'misc', {
+        // define the files to apply `misc` to
+        target '*.gradle', '.gitattributes', '.gitignore'
+
+        // Steps
+        trimTrailingWhitespace()
+        leadingTabsToSpaces()
+        endWithNewline()
+    }
+    java {
+        removeUnusedImports()
+        prettier(['prettier': '3.0.3', 'prettier-plugin-java': '2.3.0'])
+                .nodeExecutable("/home/millie/.nvm/versions/node/v25.1.0/bin/node")
+                .config(['parser': 'java', 'tabWidth': 4, 'plugins': ['prettier-plugin-java']])
+    }
+}

src/main/java/chalkbox/ChalkBox.java

@@ -4,11 +4,16 @@
 import picocli.CommandLine;
 import picocli.CommandLine.Command;
 
-@Command(name = "chalkbox", version="2.0", mixinStandardHelpOptions = true, subcommands = { Run.class })
+@Command(
+    name = "chalkbox",
+    version = "2.0",
+    mixinStandardHelpOptions = true,
+    subcommands = { Run.class }
+)
 public class ChalkBox {
 
     public static void main(String[] args) {
         int exitCode = new CommandLine(new ChalkBox()).execute(args);
         System.exit(exitCode);
     }
-}
+}

src/main/java/chalkbox/api/common/Execution.java

@@ -15,6 +15,7 @@
  * Utility class for executing processes
  */
 public class Execution {
+
     /**
      * Execute a process in a working directory
      *
@@ -24,8 +25,11 @@ public class Execution {
      * @return the executed process
      * @throws IOException if an issue occurs executing the process
      */
-    public static ProcessExecution runProcess(File working, int timeout, String... args)
-            throws IOException, TimeoutException {
+    public static ProcessExecution runProcess(
+        File working,
+        int timeout,
+        String... args
+    ) throws IOException, TimeoutException {
         ProcessBuilder builder = new ProcessBuilder(args);
         builder.directory(working);
 
@@ -41,9 +45,11 @@ public static ProcessExecution runProcess(File working, int timeout, String... a
      * @return the executed process
      * @throws IOException if an issue occurs executing the process
      */
-    public static ProcessExecution runProcess(Map<String, String> environment,
-                                     int timeout, String... args)
-            throws IOException, TimeoutException {
+    public static ProcessExecution runProcess(
+        Map<String, String> environment,
+        int timeout,
+        String... args
+    ) throws IOException, TimeoutException {
         ProcessBuilder builder = new ProcessBuilder(args);
         builder.environment().putAll(environment);
 
@@ -60,9 +66,12 @@ public static ProcessExecution runProcess(Map<String, String> environment,
      * @return the executed process
      * @throws IOException if an issue occurs executing the process
      */
-    public static ProcessExecution runProcess(File working, Map<String, String> environment,
-                                     int timeout, String... args)
-            throws IOException, TimeoutException {
+    public static ProcessExecution runProcess(
+        File working,
+        Map<String, String> environment,
+        int timeout,
+        String... args
+    ) throws IOException, TimeoutException {
         ProcessBuilder builder = new ProcessBuilder(args);
         builder.directory(working);
         builder.environment().putAll(environment);
@@ -74,7 +83,7 @@ public static ProcessExecution runProcess(File working, Map<String, String> envi
      * Helper to execute a process.
      */
     private static ProcessExecution run(ProcessBuilder builder, int timeout)
-            throws IOException, TimeoutException {
+        throws IOException, TimeoutException {
         Process process;
         ProcessExecution execution = new ProcessExecution();
         try {
@@ -86,7 +95,9 @@ private static ProcessExecution run(ProcessBuilder builder, int timeout)
                 @Override
                 public void run() {
                     try {
-                        InputStreamReader in = new InputStreamReader(process.getInputStream());
+                        InputStreamReader in = new InputStreamReader(
+                            process.getInputStream()
+                        );
                         int bite;
                         while ((bite = in.read()) != -1) {
                             output.write(bite);
@@ -100,7 +111,9 @@ public void run() {
                 @Override
                 public void run() {
                     try {
-                        InputStreamReader in = new InputStreamReader(process.getErrorStream());
+                        InputStreamReader in = new InputStreamReader(
+                            process.getErrorStream()
+                        );
                         int bite;
                         while ((bite = in.read()) != -1) {
                             error.write(bite);
@@ -141,7 +154,7 @@ public void run() {
      * @throws IOException if an issue occurs executing the process
      */
     public static ProcessExecution runProcess(int timeout, String... args)
-            throws IOException, TimeoutException {
+        throws IOException, TimeoutException {
         return runProcess(new File("."), timeout, args);
     }
 

src/main/java/chalkbox/api/common/ProcessExecution.java

@@ -1,6 +1,7 @@
 package chalkbox.api.common;
 
 public class ProcessExecution {
+
     private String output;
     private String error;
 

src/main/java/chalkbox/api/common/java/Compiler.java

@@ -1,12 +1,12 @@
 package chalkbox.api.common.java;
 
-import javax.tools.JavaCompiler;
-import javax.tools.JavaFileObject;
-import javax.tools.ToolProvider;
 import java.io.File;
 import java.io.StringWriter;
 import java.util.ArrayList;
 import java.util.List;
+import javax.tools.JavaCompiler;
+import javax.tools.JavaFileObject;
+import javax.tools.ToolProvider;
 
 /**
  * Utility class for compiling Java source code.
@@ -25,9 +25,12 @@ public class Compiler {
      *
      * @return true iff the files were compiled successfully.
      */
-    public static boolean compile(Iterable<? extends JavaFileObject> files,
-                                  String classPath, String outputPath,
-                                  StringWriter output) {
+    public static boolean compile(
+        Iterable<? extends JavaFileObject> files,
+        String classPath,
+        String outputPath,
+        StringWriter output
+    ) {
         /* Try to create the output path directory */
         File outFile = new File(outputPath);
         if (!outFile.exists()) {
@@ -39,7 +42,9 @@ public static boolean compile(Iterable<? extends JavaFileObject> files,
 
         List<String> options = new ArrayList<>();
         options.add("-processor");
-        options.add("com.github.therapi.runtimejavadoc.scribe.JavadocAnnotationProcessor");
+        options.add(
+            "com.github.therapi.runtimejavadoc.scribe.JavadocAnnotationProcessor"
+        );
         options.add("-cp");
         options.add(classPath);
         options.add("-d");
@@ -58,14 +63,17 @@ public static boolean compile(Iterable<? extends JavaFileObject> files,
      *
      * @return true iff the files were compiled successfully.
      */
-    public static boolean compile(Iterable<? extends JavaFileObject> files,
-                                  StringWriter output, List<String> options) {
+    public static boolean compile(
+        Iterable<? extends JavaFileObject> files,
+        StringWriter output,
+        List<String> options
+    ) {
         JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
 
         boolean success;
         try {
-            success = compiler.getTask(output, null,
-                    null, options, null, files).call();
+            success =
+            compiler.getTask(output, null, null, options, null, files).call();
         } catch (IllegalStateException e) {
             output.write("Empty submission");
             return false;

src/main/java/chalkbox/api/common/java/JUnitIndividualResult.java

@@ -2,4 +2,14 @@
 
 import chalkbox.stages.Visibility;
 
-public record JUnitIndividualResult(int passes, int fails, int total, String output, String outputFormat, String name, int weight, double classWeight, Visibility visibility) { }
+public record JUnitIndividualResult(
+    int passes,
+    int fails,
+    int total,
+    String output,
+    String outputFormat,
+    String name,
+    int weight,
+    double classWeight,
+    Visibility visibility
+) {}

src/main/java/chalkbox/api/common/java/JUnitListener.java

@@ -1,17 +1,18 @@
 package chalkbox.api.common.java;
 
 import chalkbox.stages.Visibility;
+import java.lang.reflect.Field;
+import java.util.ArrayList;
+import java.util.List;
 import org.junit.Test;
 import org.junit.runner.Description;
 import org.junit.runner.notification.Failure;
 import org.junit.runner.notification.RunListener;
 
-import java.lang.reflect.Field;
-import java.util.ArrayList;
-import java.util.List;
-
 public class JUnitListener extends RunListener {
+
     private static class TestResult {
+
         private final String testName;
         private boolean visible = false;
         private boolean passed = true;
@@ -38,9 +39,12 @@ public JUnitListener() {
     public void testStarted(Description description) throws Exception {
         super.testStarted(description);
 
-        this.currentResult = new TestResult(
-                description.getTestClass().getSimpleName()
-                + "." + description.getMethodName());
+        this.currentResult =
+        new TestResult(
+            description.getTestClass().getSimpleName() +
+            "." +
+            description.getMethodName()
+        );
 
         /* Results of this test should be immediately visible */
         // TODO create a library containing a custom annotation for this
@@ -67,15 +71,17 @@ public void testStarted(Description description) throws Exception {
                  * A large number of milliseconds should be used for the timeout, so that the actual
                  * timeout is not likely to be reached (since global timeout should be used instead).
                  */
-                testWeighting = Math.max(1, (int) (testAnnotation.timeout() % 10));
+                testWeighting =
+                Math.max(1, (int) (testAnnotation.timeout() % 10));
             }
             this.currentResult.weighting = testWeighting;
         }
 
         double classWeighting = 1.0;
 
         if (hasField(description.getTestClass().getFields(), "testWeight")) {
-            classWeighting = description.getTestClass().getField("testWeight").getDouble(null);
+            classWeighting =
+            description.getTestClass().getField("testWeight").getDouble(null);
         }
 
         this.currentResult.classWeighting = classWeighting;
@@ -107,42 +113,45 @@ public void testFailure(Failure failure) throws Exception {
         String failureString = failure.toString();
         if (failureString.equals(failure.getTestHeader() + ": null")) {
             failureString =
-                    failureString.substring(0, failureString.length() - 4);
-                    failureString += "No message given, refer to stack trace.";
+            failureString.substring(0, failureString.length() - 4);
+            failureString += "No message given, refer to stack trace.";
         }
-        
+
         if (this.currentResult != null) {
             this.output.append(failureString);
             this.output.append("\n");
-            this.currentResult.output = failureString + "\n\n```text\n"
-                    + failure.getTrace().replaceAll("\r\n", "\n") + "```";
+            this.currentResult.output =
+            failureString +
+            "\n\n```text\n" +
+            failure.getTrace().replaceAll("\r\n", "\n") +
+            "```";
             this.currentResult.passed = false;
         }
         this.numFailed++;
     }
 
     public JUnitResult getResultsForClass() {
         return new JUnitResult(
-                this.results.size() - this.numFailed,
-                this.numFailed,
-                this.results.size(),
-                this.output.toString()
+            this.results.size() - this.numFailed,
+            this.numFailed,
+            this.results.size(),
+            this.output.toString()
         );
     }
 
     public List<JUnitIndividualResult> getIndividualResults() {
         var results = new ArrayList<JUnitIndividualResult>();
         for (TestResult result : this.results) {
             var data = new JUnitIndividualResult(
-                    result.passed ? 1 : 0,
-                    result.passed ? 0 : 1,
-                    1,
-                    result.output,
-                    "md",
-                    result.testName,
-                    result.weighting,
-                    result.classWeighting,
-                    result.visible ? Visibility.VISIBLE : Visibility.AFTER_PUBLISHED
+                result.passed ? 1 : 0,
+                result.passed ? 0 : 1,
+                1,
+                result.output,
+                "md",
+                result.testName,
+                result.weighting,
+                result.classWeighting,
+                result.visible ? Visibility.VISIBLE : Visibility.AFTER_PUBLISHED
             );
             results.add(data);
         }