Support using Gradle's 'include' in settings plugin

This allows to configure project paths individually via the
native include("...") statement while still using other functionality
provided by the settings plugin.

Author: jjohannes

CHANGELOG.md

@@ -1,6 +1,7 @@
 # Java Module Dependencies Gradle Plugin - Changelog
 
 ## Version 1.8
+* [#136](https://github.com/gradlex-org/java-module-dependencies/pull/136) Support hierarchical project paths in Settings DSL
 * [#141](https://github.com/gradlex-org/java-module-dependencies/pull/141) Introduce `org.gradlex.java-module-dependencies.register-help-tasks` property
 * [#127](https://github.com/gradlex-org/java-module-dependencies/issues/127) Less configuration cache misses when modifying `module-info.java` (Thanks [TheGoesen](https://github.com/TheGoesen))
 * [#128](https://github.com/gradlex-org/java-module-dependencies/issues/128) Less configuration cache misses when using Settings plugin (Thanks [TheGoesen](https://github.com/TheGoesen))

README.MD

@@ -129,6 +129,19 @@ javaModules { // use instead of 'include(...)'
 }
 ```
 
+If you need more control over the properties of a Gradle subproject, in particular to define a nested project path,
+you can still use Gradle's `include(...)` and then register the subproject with this plugin.
+
+```
+include(":project:with:custom:path")
+javaModules { 
+  module(project(":project:with:custom:path")) {
+    group = "org.example"  // define group early so that all subprojects know all groups
+    plugin("java-library") // apply plugin to the Module's subproject to omit 'build.gradle'
+  }
+}
+```
+
 ## Project structure definition when using this plugin as Project Plugin
 
 In this setup, subprojects with Java Modules are configured as in any traditional Gradle build: by using the

src/main/java/org/gradlex/javamodule/dependencies/initialization/Directory.java

@@ -20,7 +20,6 @@
 import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.provider.ListProperty;
 import org.gradle.api.provider.Property;
-import org.gradle.api.provider.Provider;
 
 import javax.inject.Inject;
 import java.io.File;
@@ -80,8 +79,7 @@ public void module(String subDirectory, Action<Module> action) {
     }
 
     Module addModule(String subDirectory) {
-        Module module = getObjects().newInstance(Module.class, root);
-        module.getDirectory().convention(subDirectory);
+        Module module = getObjects().newInstance(Module.class, new File(root, subDirectory));
         module.getGroup().convention(getGroup());
         module.getPlugins().addAll(getPlugins());
         return module;

src/main/java/org/gradlex/javamodule/dependencies/initialization/JavaModulesExtension.java

@@ -72,10 +72,27 @@ public void module(String directory) {
      * Register and configure Module located in the given folder, relative to the build root directory.
      */
     public void module(String directory, Action<Module> action) {
-        Module module = getObjects().newInstance(Module.class, settings.getRootDir());
-        module.getDirectory().set(directory);
+        Module module = getObjects().newInstance(Module.class, new File(settings.getRootDir(), directory));
         action.execute(module);
-        includeModule(module, new File(settings.getRootDir(), module.getDirectory().get()));
+        includeModule(module, new File(settings.getRootDir(), directory));
+    }
+
+    /**
+     * {@link JavaModulesExtension#module(ProjectDescriptor, Action)}
+     */
+    public void module(ProjectDescriptor project) {
+        module(project, m -> {});
+    }
+
+    /**
+     * Register and configure Module already registered as project by an 'include' statement.
+     */
+    public void module(ProjectDescriptor project, Action<Module> action) {
+        Module module = getObjects().newInstance(Module.class, project.getProjectDir());
+        module.getArtifact().set(project.getName());
+        module.getArtifact().finalizeValue(); // finalize, as the project name can no longer be changed
+        action.execute(module);
+        configureModule(module, project.getProjectDir());
     }
 
     /**
@@ -94,7 +111,7 @@ public void directory(String directory, Action<Directory> action) {
         action.execute(moduleDirectory);
 
         for (Module module : moduleDirectory.customizedModules.values()) {
-            includeModule(module, new File(modulesDirectory, module.getDirectory().get()));
+            includeModule(module, module.directory);
         }
         Provider<List<String>> listProvider = getProviders().of(ValueModuleDirectoryListing.class, spec -> {
             spec.getParameters().getExclusions().set(moduleDirectory.getExclusions());
@@ -128,6 +145,10 @@ private void includeModule(Module module, File projectDir) {
         ProjectDescriptor project = settings.project(":" + artifact);
         project.setProjectDir(projectDir);
 
+        configureModule(module, projectDir);
+    }
+
+    private void configureModule(Module module, File projectDir) {
         String mainModuleName = null;
         for (String path : module.getModuleInfoPaths().get()) {
             ModuleInfo moduleInfo = moduleInfoCache.put(projectDir, path,
@@ -139,7 +160,7 @@ private void includeModule(Module module, File projectDir) {
 
         String group = module.getGroup().getOrNull();
         List<String> plugins = module.getPlugins().get();
-        moduleProjects.add(new ModuleProject(artifact, group, plugins, mainModuleName));
+        moduleProjects.add(new ModuleProject(module.getArtifact().get(), group, plugins, mainModuleName));
     }
 
     private static class ModuleProject {

src/main/java/org/gradlex/javamodule/dependencies/initialization/Module.java

@@ -28,11 +28,6 @@
 
 public abstract class Module {
 
-    /**
-     * The directory, relative to the build root directory, in which the Module is located.
-     */
-    public abstract Property<String> getDirectory();
-
     /**
      * The 'artifact' name of the Module. This corresponds to the Gradle subproject name. If the Module is published
      * to a Maven repository, this is the 'artifact' in the 'group:artifact' identifier to address the published Jar.
@@ -58,14 +53,17 @@ public abstract class Module {
      */
     public abstract ListProperty<String> getPlugins();
 
+    File directory;
+
     @Inject
-    public Module(File root) {
-        getArtifact().convention(getDirectory().map(f -> Paths.get(f).getFileName().toString()));
-        getModuleInfoPaths().convention(getDirectory().map(projectDir -> listChildren(root, projectDir + "/src")
+    public Module(File directory) {
+        this.directory = directory;
+        getArtifact().convention(directory.getName());
+        getModuleInfoPaths().convention(listSrcChildren()
                 .map(srcDir -> new File(srcDir, "java/module-info.java"))
                 .filter(File::exists)
                 .map(moduleInfo -> "src/" + moduleInfo.getParentFile().getParentFile().getName() + "/java")
-                .collect(Collectors.toList())));
+                .collect(Collectors.toList()));
     }
 
     /**
@@ -76,8 +74,8 @@ public void plugin(String id) {
         getPlugins().add(id);
     }
 
-    private Stream<File> listChildren(File root, String projectDir) {
-        File[] children = new File(root, projectDir).listFiles();
+    private Stream<File> listSrcChildren() {
+        File[] children = new File(directory, "src").listFiles();
         return children == null ? Stream.empty() : Arrays.stream(children);
     }
 }