Organize code and add comments to new public properties

Author: jjohannes

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

@@ -54,8 +54,19 @@ public Directory(File root) {
     @Inject
     protected abstract ObjectFactory getObjects();
 
+    /**
+     * Configure which folders should be ignored when searching for Modules.
+     * This can be tweaked to optimize the configuration cache hit ratio.
+     * Defaults to: 'build', '.*'
+     */
     public abstract ListProperty<String> getExclusions();
 
+    /**
+     * Configure if only folders that contain a 'build.gradle' or 'build.gradle.kts'
+     * should be considered when searching for Modules.
+     * Setting this to true may improve configuration cache hit ratio if you know
+     * that all modules have build files in addition to the 'module-info.java' files.
+     */
     public abstract Property<Boolean> getRequiresBuildFile();
 
     /**

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

@@ -29,12 +29,12 @@
 import org.gradle.api.plugins.JavaPlatformPlugin;
 import org.gradle.api.provider.Provider;
 import org.gradle.api.provider.ProviderFactory;
-import org.gradle.api.provider.ValueSourceSpec;
 import org.gradlex.javamodule.dependencies.JavaModuleDependenciesExtension;
 import org.gradlex.javamodule.dependencies.JavaModuleDependenciesPlugin;
 import org.gradlex.javamodule.dependencies.JavaModuleVersionsPlugin;
 import org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo;
 import org.gradlex.javamodule.dependencies.internal.utils.ModuleInfoCache;
+import org.gradlex.javamodule.dependencies.internal.utils.ValueModuleDirectoryListing;
 
 import javax.annotation.Nullable;
 import javax.inject.Inject;
@@ -91,18 +91,14 @@ public void directory(String directory, Action<Directory> action) {
         Directory moduleDirectory = getObjects().newInstance(Directory.class, modulesDirectory);
         action.execute(moduleDirectory);
 
-
         for (Module module : moduleDirectory.customizedModules.values()) {
             includeModule(module, new File(modulesDirectory, module.getDirectory().get()));
         }
-        Provider<List<String>> listProvider = getProviders().of(ValueSourceDirectoryListing.class, new Action<ValueSourceSpec<ValueSourceDirectoryListing.DirectoryListingParameter>>() {
-            @Override
-            public void execute(ValueSourceSpec<ValueSourceDirectoryListing.DirectoryListingParameter> spec) {
-                spec.getParameters().getRegexExclusions().set(moduleDirectory.getExclusions());
-                spec.getParameters().getExclusions().set(moduleDirectory.customizedModules.keySet());
-                spec.getParameters().getDir().set(modulesDirectory);
-                spec.getParameters().getRequiresBuildFile().set(moduleDirectory.getRequiresBuildFile());
-            }
+        Provider<List<String>> listProvider = getProviders().of(ValueModuleDirectoryListing.class, spec -> {
+            spec.getParameters().getExclusions().set(moduleDirectory.getExclusions());
+            spec.getParameters().getExplicitlyConfiguredFolders().set(moduleDirectory.customizedModules.keySet());
+            spec.getParameters().getDir().set(modulesDirectory);
+            spec.getParameters().getRequiresBuildFile().set(moduleDirectory.getRequiresBuildFile());
         });
 
         for (String projectDir : listProvider.get()) {

src/main/java/org/gradlex/javamodule/dependencies/initialization/ValueSourceDirectoryListing.java renamed to src/main/java/org/gradlex/javamodule/dependencies/internal/utils/ValueModuleDirectoryListing.java

@@ -14,69 +14,51 @@
  * limitations under the License.
  */
 
-package org.gradlex.javamodule.dependencies.initialization;
+package org.gradlex.javamodule.dependencies.internal.utils;
 
 import org.gradle.api.provider.Property;
 import org.gradle.api.provider.SetProperty;
 import org.gradle.api.provider.ValueSource;
 import org.gradle.api.provider.ValueSourceParameters;
 
 import java.io.File;
-import java.io.FileFilter;
 import java.io.IOException;
-import java.nio.file.DirectoryStream;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.attribute.BasicFileAttributes;
-import java.util.Arrays;
 import java.util.List;
-import java.util.function.BiPredicate;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-public abstract class ValueSourceDirectoryListing implements ValueSource<List<String>, ValueSourceDirectoryListing.DirectoryListingParameter> {
+public abstract class ValueModuleDirectoryListing implements ValueSource<List<String>, ValueModuleDirectoryListing.Parameter> {
 
+    public interface Parameter extends ValueSourceParameters {
+        Property<File> getDir();
+        SetProperty<String> getExplicitlyConfiguredFolders();
+        SetProperty<String> getExclusions();
+        Property<Boolean> getRequiresBuildFile();
+    }
 
     @Override
     public List<String> obtain() {
         Path path = getParameters().getDir().get().toPath();
-        File file = getParameters().getDir().get();
-        try (Stream<Path> directoryStream = Files.find(path, 1, new BiPredicate<Path, BasicFileAttributes>() {
-            @Override
-            public boolean test(Path path, BasicFileAttributes basicFileAttributes) {
-                return basicFileAttributes.isDirectory();
-            }
-        })) {
-            return directoryStream.filter(x -> !getParameters().getExclusions().get().contains(x.getFileName().toString()))
-                    .filter(x -> getParameters().getRegexExclusions().get().stream().noneMatch(r -> x.getFileName().toString().matches(r)))
+        try (Stream<Path> directoryStream = Files.find(path, 1, (unused, basicFileAttributes) -> basicFileAttributes.isDirectory())) {
+            return directoryStream
+                    .filter(x -> !getParameters().getExplicitlyConfiguredFolders().get().contains(x.getFileName().toString()))
+                    .filter(x -> getParameters().getExclusions().get().stream().noneMatch(r -> x.getFileName().toString().matches(r)))
                     .filter(x -> checkBuildFile(x, getParameters()))
                     .map(x -> x.getFileName().toString())
                     .sorted()
                     .collect(Collectors.toList());
 
         } catch (IOException e) {
-            throw new RuntimeException("Failed on " + file, e);
+            throw new RuntimeException("Failed to inspect: " + path, e);
         }
-
-
     }
 
-    private boolean checkBuildFile(Path x, DirectoryListingParameter parameters) {
+    private boolean checkBuildFile(Path x, Parameter parameters) {
         if (!parameters.getRequiresBuildFile().get()) {
             return true;
         }
         return Files.isRegularFile(x.resolve("build.gradle.kts")) || Files.isRegularFile(x.resolve("build.gradle"));
     }
-
-    interface DirectoryListingParameter extends ValueSourceParameters {
-
-        Property<Boolean> getRequiresBuildFile();
-
-        Property<File> getDir();
-
-        SetProperty<String> getExclusions();
-
-        SetProperty<String> getRegexExclusions();
-
-    }
 }

src/test/groovy/org/gradlex/javamodule/dependencies/test/initialization/SettingsPluginTest.groovy

@@ -110,7 +110,6 @@ class SettingsPluginTest extends Specification {
             }
         '''
 
-
         def runner = runner(':app:compileJava')
         when:
         def result = runner.build()
@@ -141,7 +140,6 @@ class SettingsPluginTest extends Specification {
             }
         '''
 
-
         def runner = runner(':app:compileJava')
         when:
         def result = runner.build()
@@ -155,10 +153,9 @@ class SettingsPluginTest extends Specification {
         result = runner.build()
 
         then:
-        result.getOutput().contains("Calculating task graph as configuration cache cannot be reused because a build logic input of type 'ValueSourceDirectoryListing' has changed.")
+        result.getOutput().contains("Calculating task graph as configuration cache cannot be reused because a build logic input of type 'ValueModuleDirectoryListing' has changed.")
     }
 
-
     def "configurationCacheHitIrrelevantChange"() {
         given:
         settingsFile << '''