Reimplement path file management system.

.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "maven"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    assignees:
+      - "ascopes"
+    labels:
+      - "enhancement"
+      - "housekeeping"

.github/workflows/build.yml

@@ -39,6 +39,7 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     strategy:
+      fail-fast: false
       matrix:
         os: [windows-latest, ubuntu-latest]
         java-version: [ 11, 12, 13, 14, 15, 16, 17, 18 ]
@@ -73,7 +74,7 @@ jobs:
       - name: Annotate test reports
         if: always()
         run: >-
-          .github/scripts/prepare-test-outputs-for-merge.sh 
+          scripts/prepare-test-outputs-for-merge.sh 
           ${{ matrix.java-version }} 
           ${{ matrix.os }}
 

.gitignore

@@ -3,9 +3,11 @@ build/
 out/
 target/
 
-# IntelliJ
-.idea/
+# IntelliJ junk
 *.iml
+.idea/*
+# Allow providing file templates for simplicity.
+!.idea/fileTemplates
 
 # VSCode
 .vscode/

.mvn/checkstyle/checkstyle.xml

@@ -47,8 +47,13 @@
   <module name="LineLength">
     <property name="fileExtensions" value="java"/>
     <property name="max" value="100"/>
+    <!--
+      NOTE(ascopes): modified this to also ignore extends/implements clauses in class
+      and interface declarations, as formatting becomes less readable if we follow the google style
+      here.
+    -->
     <property name="ignorePattern"
-      value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
+      value="^package.*|^import.*|a href|href|http://|https://|ftp://|\s+extends |\s+implements "/>
   </module>
 
   <module name="TreeWalker">

README.md

@@ -27,95 +27,113 @@ prevent future issues for any projects deciding to use it.
 **This module is still under development.** Any contributions or feedback
 are always welcome!
 
-## Example
+## Examples
 
-The following is an example of using this library with JUnit Jupiter to run both javac and ECJ:
+The following is an example of using this library with JUnit Jupiter to run both javac and ECJ
+across a single package:
 
 ```java
-class HelloWorldTest {
 
-    @Test
-    void i_can_compile_hello_world_with_javac() {
-        // Given
-        var sources = RamPath
-                .createPath("sources")
-                .createFile(
-                        "org/me/test/examples/HelloWorld.java",
-                        "package org.me.test.examples;",
-                        "",
-                        "public class HelloWorld {",
-                        "  public static void main(String[] args) {",
-                        "    System.out.println(\"Hello, World!\");",
-                        "  }",
-                        "}"
-                )
+@DisplayName("Example tests")
+class ExampleTest {
+
+    @DisplayName("I can compile a Hello World application")
+    @EcjCompilers
+    @JavacCompilers
+    @ParameterizedTest(name = "using {0}")
+    void canCompileHelloWorld(Compilable<?, ?> compiler) {
+        var sources = createPath("src")
                 .createFile(
-                        "module-info.java",
-                        "module org.me.test.examples {",
-                        "  exports org.me.test.examples;",
-                        "}"
+                        "org/example/Message.java",
+                        """
+                        package org.example;
+
+                        import lombok.Data;
+                        import lombok.NonNull;
+
+                        @Data
+                        public class HelloWorld {
+                            public static void main(String[] args) {
+                                System.out.println("Hello, World!");
+                            }
+                        }
+                        """
                 );
 
         // When
-        var compilation = Compilers
-                .javac()
-                .addSourceRamPaths(sources)
-                .release(11)
+        var compilation = compiler
+                .addSourcePath(sources)
                 .compile();
 
         // Then
-        assertThatCompilation(compilation).isSuccessfulWithoutWarnings();
-        assertThatCompilation(compilation).diagnostics().isEmpty();
-        assertThatCompilation(compilation).classOutput()
-                .file("org/me/test/examples/HelloWorld.class")
-                .exists()
-                .isNotEmptyFile();
-        assertThatCompilation(compilation).classOutput()
-                .file("module-info.class")
-                .exists()
-                .isNotEmptyFile();
+        assertThatCompilation(compilation)
+                .isSuccessfulWithoutWarnings();
     }
+}
+```
+
+Likewise, the following shows an example of compiling a multi-module style application with JPMS
+support, running the Lombok annotation processor over the input. This assumes that the Lombok
+JAR is already on the classpath for the JUnit test runner.
+
+```java
+@DisplayName("Example tests")
+class ExampleTest {
 
-    @Test
-    void i_can_compile_hello_world_with_ecj() {
+    @DisplayName("I can compile a module that is using Lombok")
+    @JavacCompilers(modules = true)
+    @ParameterizedTest(name = "using {0}")
+    void canCompileModuleUsingLombok(Compilable<?, ?> compiler) {
         // Given
-        var sources = RamPath
-                .createPath("sources")
+        var sources = createPath("hello.world")
+                .createFile(
+                        "org/example/Message.java",
+                        """
+                        package org.example;
+
+                        import lombok.Data;
+                        import lombok.NonNull;
+
+                        @Data
+                        public class Message {
+                            @NonNull
+                            private final String content;
+                        }
+                        """
+                )
                 .createFile(
-                        "org/me/test/examples/HelloWorld.java",
-                        "package org.me.test.examples;",
-                        "",
-                        "public class HelloWorld {",
-                        "  public static void main(String[] args) {",
-                        "    System.out.println(\"Hello, World!\");",
-                        "  }",
-                        "}"
+                        "org/example/Main.java",
+                        """
+                        package org.example;
+
+                        public class Main {
+                            public static void main(String[] args) {
+                                for (var arg : args) {
+                                    var message = new Message(arg);
+                                    System.out.println(arg);
+                                }
+                            }
+                        }
+                        """
                 )
                 .createFile(
                         "module-info.java",
-                        "module org.me.test.examples {",
-                        "  exports org.me.test.examples;",
-                        "}"
+                        """
+                        module hello.world {
+                            requires java.base;
+                            requires static lombok;
+                        }
+                        """
                 );
 
         // When
-        var compilation = Compilers
-                .ecj()
-                .addSourceRamPaths(sources)
-                .release(11)
+        var compilation = compiler
+                .addModuleSourcePath("hello.world", sources)
                 .compile();
 
         // Then
-        assertThatCompilation(compilation).isSuccessfulWithoutWarnings();
-        assertThatCompilation(compilation).diagnostics().isEmpty();
-        assertThatCompilation(compilation).classOutput()
-                .file("org/me/test/examples/HelloWorld.class")
-                .exists()
-                .isNotEmptyFile();
-        assertThatCompilation(compilation).classOutput()
-                .file("module-info.class")
-                .exists()
-                .isNotEmptyFile();
+        assertThatCompilation(compilation)
+                .isSuccessfulWithoutWarnings();
     }
 }
 ```