Add option to register mappings for a group of modules

Author: jjohannes

README.MD

@@ -89,6 +89,9 @@ javaModuleDependencies {
 }
 ```
 
+There is also the option to register a mapping for all Modules that share a common _name prefix_ and _group_.
+For example: `moduleNamePrefixToGroup.put("com.example.product.module.", "com.example.product")`.
+
 ## Naming patterns for Modules in the build
 
 This plugin makes the following assumption about _Module Names_ of your own Modules in the build to establish dependencies between them:

src/main/java/de/jjohannes/gradle/moduledependencies/JavaModuleDependenciesExtension.java

@@ -30,6 +30,18 @@ public abstract class JavaModuleDependenciesExtension {
      */
     public abstract MapProperty<String, String> getModuleNameToGA();
 
+    /**
+     * If your Module Names all start with a common prefix (e.g. 'com.example.product.module.') followed by a
+     * name that corresponds to the artifact name and all have the group (e.g. 'com.example.product'), you can
+     * register a mapping for all these Modules. and with that allow Gradle to map them correctly even if you
+     * publish some of your Modules or use included builds.
+     *
+     * moduleNamePrefixToGroup.put("com.example.product.module.", "com.example.product")
+     *
+     * @return the mappings from 'Module Name Prefix' to 'group'
+     */
+    public abstract MapProperty<String, String> getModuleNamePrefixToGroup();
+
     /**
      * @return If a Version Catalog is used: print a WARN for missing versions (default is 'true')
      */

src/main/java/de/jjohannes/gradle/moduledependencies/JavaModuleDependenciesPlugin.java

@@ -13,7 +13,9 @@
 import org.gradle.api.artifacts.Configuration;
 import org.gradle.api.artifacts.ConfigurationContainer;
 import org.gradle.api.artifacts.ProjectDependency;
+import org.gradle.api.artifacts.VersionCatalog;
 import org.gradle.api.artifacts.VersionCatalogsExtension;
+import org.gradle.api.artifacts.VersionConstraint;
 import org.gradle.api.file.RegularFile;
 import org.gradle.api.plugins.JavaPlugin;
 import org.gradle.api.provider.Provider;
@@ -32,6 +34,7 @@
 import static de.jjohannes.gradle.moduledependencies.JavaModuleDependenciesExtension.JAVA_MODULE_DEPENDENCIES;
 import static de.jjohannes.gradle.moduledependencies.internal.utils.DependencyDeclarationsUtil.declaredDependencies;
 import static de.jjohannes.gradle.moduledependencies.internal.utils.ModuleNamingUtil.sourceSetToModuleName;
+import static java.util.Optional.empty;
 import static org.gradle.api.plugins.HelpTasksPlugin.HELP_GROUP;
 
 @SuppressWarnings("unused")
@@ -185,9 +188,38 @@ private void declareDependency(String moduleName, @Nullable String ownModuleName
                 warnVersionMissing(moduleName, gav.get(), moduleInfoFile, project, javaModuleDependencies);
             }
         } else {
-            project.getLogger().lifecycle(
-                    "[WARN] [Java Module Dependencies] No mapping registered for module: " + moduleDebugInfo(moduleName, moduleInfoFile, project.getRootDir()) +
-                    " - use 'javaModuleDependencies.moduleNameToGA.put(\"" + moduleName + "\", \"group:artifact\")' to add mapping.");
+            Optional<Map.Entry<String, String>> prefixToGroupMapping =
+                    javaModuleDependencies.getModuleNamePrefixToGroup().get().entrySet().stream()
+                    .filter(e -> moduleName.startsWith(e.getKey())).findFirst();
+            if (prefixToGroupMapping.isPresent()) {
+                String prefix = prefixToGroupMapping.get().getKey();
+
+                String group = prefixToGroupMapping.get().getValue();
+                String artifactName = moduleName.substring(prefix.length());
+
+                VersionCatalog catalog = null;
+                VersionCatalogsExtension versionCatalogs = project.getExtensions().findByType(VersionCatalogsExtension.class);
+                if (versionCatalogs != null) {
+                    String catalogName = javaModuleDependencies.getVersionCatalogName().get();
+                    catalog = versionCatalogs.named(catalogName);
+                }
+                Optional<VersionConstraint> version = catalog == null ? empty() : catalog.findVersion(prefix.replace('_', '.'));
+
+                Map<String, Object> gavFromPrefixMapping = new HashMap<>();
+                gavFromPrefixMapping.put(GAV.GROUP, group);
+                gavFromPrefixMapping.put(GAV.ARTIFACT, artifactName);
+                version.ifPresent(versionConstraint -> gavFromPrefixMapping.put(GAV.VERSION, versionConstraint));
+
+                project.getDependencies().add(configuration.getName(), gavFromPrefixMapping);
+
+                if (!gavFromPrefixMapping.containsKey(GAV.VERSION)) {
+                    warnVersionMissing(prefix, gavFromPrefixMapping, moduleInfoFile, project, javaModuleDependencies);
+                }
+            } else {
+                project.getLogger().lifecycle(
+                        "[WARN] [Java Module Dependencies] No mapping registered for module: " + moduleDebugInfo(moduleName, moduleInfoFile, project.getRootDir()) +
+                                " - use 'javaModuleDependencies.moduleNameToGA.put(\"" + moduleName + "\", \"group:artifact\")' to add mapping.");
+            }
         }
     }