Error if Module Name does not match Gradle project and source set names

Resolves #65

Author: jjohannes

src/main/java/org/gradlex/javamodule/dependencies/JavaModuleDependenciesExtension.java

@@ -113,6 +113,12 @@ public abstract class JavaModuleDependenciesExtension {
      */
     public abstract Property<String> getVersionCatalogName();
 
+    /**
+     * Fail the build if a Module Name does not fit the corresponding project and source set names;
+     * defaults to 'true'.
+     */
+    public abstract Property<Boolean> getModuleNameCheck();
+
     /**
      * Set this to true to use the analytic help tasks (like :moduleDependencies) of the plugin without performing
      * the actual dependency calculation.
@@ -126,6 +132,7 @@ public JavaModuleDependenciesExtension(VersionCatalogsExtension versionCatalogs)
         this.moduleInfoCache = getObjects().newInstance(ModuleInfoCache.class);
         getModulesProperties().set(getProject().getRootProject().getLayout().getProjectDirectory().file("gradle/modules.properties"));
         getVersionCatalogName().convention("libs");
+        getModuleNameCheck().convention(true);
         getAnalyseOnly().convention(false);
         getModuleNameToGA().putAll(SharedMappings.mappings);
         getModuleNameToGA().putAll(parsedModulesProperties().orElse(Collections.emptyMap()));
@@ -207,7 +214,7 @@ public Provider<Dependency> create(String moduleName, SourceSet sourceSetWithMod
             Provider<String> coordinates = getModuleNameToGA().getting(moduleName).orElse(mapByPrefix(getProviders().provider(() -> moduleName)));
 
             ModuleInfo moduleInfo = getModuleInfoCache().get(sourceSetWithModuleInfo);
-            String ownModuleNamesPrefix = moduleInfo.moduleNamePrefix(getProject().getName(), sourceSetWithModuleInfo.getName());
+            String ownModuleNamesPrefix = moduleInfo.moduleNamePrefix(getProject().getName(), sourceSetWithModuleInfo.getName(), getModuleNameCheck().get());
 
             String moduleNameSuffix = ownModuleNamesPrefix == null ? null :
                     moduleName.startsWith(ownModuleNamesPrefix + ".") ? moduleName.substring(ownModuleNamesPrefix.length() + 1) :

src/main/java/org/gradlex/javamodule/dependencies/JavaModuleDependenciesPlugin.java

@@ -215,7 +215,7 @@ private void setupOrderingCheckTasks(Project project, TaskProvider<Task> checkAl
                 ModuleInfo moduleInfo = javaModuleDependencies.getModuleInfoCache().get(sourceSet);
 
                 t.getModuleInfoPath().convention(moduleInfo.getFilePath().getAbsolutePath());
-                t.getModuleNamePrefix().convention(moduleInfo.moduleNamePrefix(project.getName(), sourceSet.getName()));
+                t.getModuleNamePrefix().convention(moduleInfo.moduleNamePrefix(project.getName(), sourceSet.getName(), false));
                 t.getModuleInfo().convention(moduleInfo);
             });
 

src/main/java/org/gradlex/javamodule/dependencies/internal/utils/ModuleInfo.java

@@ -82,7 +82,7 @@ public List<String> get(Directive directive) {
     }
 
     @Nullable
-    public String moduleNamePrefix(String projectName, String sourceSetName) {
+    public String moduleNamePrefix(String projectName, String sourceSetName, boolean fail) {
         if (moduleName.equals(projectName)) {
             return "";
         }
@@ -97,6 +97,10 @@ public String moduleNamePrefix(String projectName, String sourceSetName) {
         if (moduleName.endsWith("." + projectName)) {
             return moduleName.substring(0, moduleName.length() - projectName.length() - 1);
         }
+        if (this != EMPTY && fail) {
+            throw new RuntimeException("Module name '" + moduleName + "' does not fit the project and source set names; " +
+                    "expected name '<optional.prefix.>" + projectPlusSourceSetName + "'.");
+        }
         return null;
     }
 
@@ -115,6 +119,7 @@ private boolean parse(String moduleLine, boolean insideComment) {
         List<String> tokens = Arrays.asList(moduleLine
                 .replace(";", "")
                 .replace("{", "")
+                .replace("}", "")
                 .replace(RUNTIME_KEYWORD, "runtime")
                 .replaceAll("/\\*.*?\\*/", " ")
                 .trim().split("\\s+"));

src/main/java/org/gradlex/javamodule/dependencies/tasks/ModulePathAnalysis.java

@@ -75,7 +75,7 @@ public void report() throws IOException {
             if (file.exists()) {
                 try(Stream<String> lines = Files.lines(file.toPath())) {
                     String fileContent = lines.collect(Collectors.joining("\n"));
-                    ownModuleNamesPrefix = new ModuleInfo(fileContent, file).moduleNamePrefix(projectName, main.getName());
+                    ownModuleNamesPrefix = new ModuleInfo(fileContent, file).moduleNamePrefix(projectName, main.getName(), false);
                 }
                 break;
             }

src/test/groovy/org/gradlex/javamodule/dependencies/test/ModuleInfoParseTest.groovy

@@ -21,7 +21,7 @@ class ModuleInfoParseTest extends Specification {
         ''', new File(''))
 
         expect:
-        moduleInfo.moduleNamePrefix("thing", "main") == "some"
+        moduleInfo.moduleNamePrefix("thing", "main", false) == "some"
         moduleInfo.get(REQUIRES) == []
         moduleInfo.get(REQUIRES_TRANSITIVE) == ["foo.bar.la"]
         moduleInfo.get(REQUIRES_STATIC) == []
@@ -38,7 +38,7 @@ class ModuleInfoParseTest extends Specification {
         ''', new File(''))
 
         expect:
-        moduleInfo.moduleNamePrefix("thing", "main") == "some"
+        moduleInfo.moduleNamePrefix("thing", "main", false) == "some"
         moduleInfo.get(REQUIRES) == []
         moduleInfo.get(REQUIRES_TRANSITIVE) == ["foo.bar.la"]
         moduleInfo.get(REQUIRES_STATIC) == []