Warn if 'because' is not used as expected in a 'module-version' project

#105

Author: jjohannes

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

@@ -24,12 +24,14 @@
 import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.plugins.JavaPlatformPlugin;
 import org.gradle.api.plugins.JavaPlugin;
+import org.gradle.api.provider.Provider;
 import org.gradle.api.tasks.SourceSetContainer;
 import org.gradle.util.GradleVersion;
 import org.gradlex.javamodule.dependencies.dsl.ModuleVersions;
 import org.gradlex.javamodule.dependencies.internal.utils.ModuleInfo;
 import org.gradlex.javamodule.dependencies.tasks.CatalogGenerate;
 
+import javax.annotation.Nullable;
 import java.io.File;
 import java.util.Arrays;
 import java.util.List;
@@ -55,7 +57,9 @@ public void apply(Project project) {
     }
 
     private void setupForJavaPlatformProject(Project project) {
-        setupVersionsDSL(project, project.getConfigurations().getByName(API_CONFIGURATION_NAME));
+        Configuration api = project.getConfigurations().getByName(API_CONFIGURATION_NAME);
+        setupVersionsDSL(project, api);
+        setupConstraintsValidation(project, api);
         registerCatalogTask(project);
     }
 
@@ -84,6 +88,7 @@ private void setupForJavaProject(Project project) {
         }
 
         setupVersionsDSL(project, versions);
+        setupConstraintsValidation(project, versions);
         registerCatalogTask(project);
     }
 
@@ -93,6 +98,22 @@ private void setupVersionsDSL(Project project, Configuration configuration) {
         project.getExtensions().create("moduleInfo", ModuleVersions.class, configuration, javaModuleDependencies);
     }
 
+    private void setupConstraintsValidation(Project project, Configuration configuration) {
+        configuration.getDependencyConstraints().configureEach(d -> {
+            JavaModuleDependenciesExtension javaModuleDependencies = project.getExtensions().getByType(JavaModuleDependenciesExtension.class);
+            String userDefinedReason = d.getReason();
+            String ga = d.getModule().toString();
+            Provider<String> moduleName = javaModuleDependencies.moduleName(ga);
+            if (moduleName.isPresent() && isModuleName(userDefinedReason) && !moduleName.get().equals(userDefinedReason)) {
+                project.getLogger().lifecycle("WARN: Expected module name for '" + ga + "' is '" + moduleName.get() + "' (not '" + userDefinedReason + "')");
+            }
+        });
+    }
+
+    private boolean isModuleName(@Nullable String s) {
+        return s != null && !s.isEmpty() && !s.contains(" ");
+    }
+
     private void registerCatalogTask(Project project) {
         JavaModuleDependenciesExtension javaModuleDependencies = project.getExtensions().getByType(JavaModuleDependenciesExtension.class);
         ModuleVersions moduleVersions = project.getExtensions().getByType(ModuleVersions.class);