Add 'gav()' method to extension

Author: jjohannes

samples/custom-catalog/app/build.gradle.kts

@@ -7,9 +7,3 @@ application {
     mainClass.set("org.my.app.App")
     mainModule.set("org.my.app")
 }
-
-dependencies.constraints {
-    implementation(javaModuleDependencies.ga("com.fasterxml.jackson.databind")) {
-        version { require("2.12.5") }
-    }
-}

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

@@ -1,5 +1,8 @@
 package de.jjohannes.gradle.moduledependencies;
 
+import org.gradle.api.artifacts.VersionCatalog;
+import org.gradle.api.artifacts.VersionCatalogsExtension;
+import org.gradle.api.artifacts.VersionConstraint;
 import org.gradle.api.provider.MapProperty;
 import org.gradle.api.provider.Property;
 import org.gradle.api.provider.Provider;
@@ -8,9 +11,12 @@
 import java.io.InputStream;
 import java.util.Properties;
 
+@SuppressWarnings("UnstableApiUsage")
 public abstract class JavaModuleDependenciesExtension {
     public static String JAVA_MODULE_DEPENDENCIES = "javaModuleDependencies";
 
+    private final VersionCatalogsExtension versionCatalogs;
+
     private Properties globalModuleNameToGA;
 
     public abstract MapProperty<String, String> getModuleNameToGA();
@@ -21,6 +27,10 @@ public abstract class JavaModuleDependenciesExtension {
 
     public abstract Property<String> getVersionCatalogName();
 
+    public JavaModuleDependenciesExtension(VersionCatalogsExtension versionCatalogs) {
+        this.versionCatalogs = versionCatalogs;
+    }
+
     public String ga(String moduleName) {
         Provider<String> customMapping = getModuleNameToGA().getting(moduleName);
         if (customMapping.isPresent()) {
@@ -30,6 +40,18 @@ public String ga(String moduleName) {
         }
     }
 
+    public String gav(String moduleName) {
+        String ga = ga(moduleName);
+        String catalogName = getVersionCatalogName().forUseAtConfigurationTime().get();
+        VersionCatalog catalog = versionCatalogs.named(catalogName);
+        VersionConstraint version = catalog.findVersion(moduleName).orElse(null);
+        if (version == null) {
+            return ga;
+        } else {
+            return ga + ":" + version.getRequiredVersion();
+        }
+    }
+
     private Properties getGlobalModuleNameToGA() {
         if (this.globalModuleNameToGA != null) {
             return this.globalModuleNameToGA;

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

@@ -28,7 +28,8 @@
 public abstract class JavaModuleDependenciesPlugin implements Plugin<Project> {
 
     private final Map<File, ModuleInfo> moduleInfo = new HashMap<>();
-    private boolean catalogFound = true;
+    private VersionCatalogsExtension versionCatalogs = null;
+    private boolean catalogNotFoundWarningPrinted = false;
 
     @Override
     public void apply(Project project) {
@@ -37,8 +38,11 @@ public void apply(Project project) {
         }
 
         project.getPlugins().apply(JavaPlugin.class);
+
+        versionCatalogs = project.getExtensions().findByType(VersionCatalogsExtension.class);
+
         JavaModuleDependenciesExtension javaModuleDependenciesExtension = project.getExtensions().create(
-                JAVA_MODULE_DEPENDENCIES, JavaModuleDependenciesExtension.class);
+                JAVA_MODULE_DEPENDENCIES, JavaModuleDependenciesExtension.class, versionCatalogs);
         javaModuleDependenciesExtension.getOwnModuleNamesPrefix().convention(
                 project.provider(() -> project.getGroup().toString()));
         javaModuleDependenciesExtension.getWarnForMissingVersions().convention(true);
@@ -110,10 +114,9 @@ private Map<String, Object> toGAV(String moduleName, String ga, Project project,
         Map<String, Object> gav = new HashMap<>();
 
         VersionConstraint version = null;
-        VersionCatalogsExtension versionCatalogs = project.getExtensions().findByType(VersionCatalogsExtension.class);
         if (versionCatalogs == null) {
             warnVersionMissing(project.getLogger(), javaModuleDependenciesExtension, "Version catalog feature not enabled in settings.gradle(.kts) - add 'enableFeaturePreview(\"VERSION_CATALOGS\")'");
-            catalogFound = false;
+            catalogNotFoundWarningPrinted = true;
         } else {
             String catalogName = javaModuleDependenciesExtension.getVersionCatalogName().forUseAtConfigurationTime().get();
             VersionCatalog catalog = versionCatalogs.named(catalogName);
@@ -134,7 +137,7 @@ private Map<String, Object> toGAV(String moduleName, String ga, Project project,
     }
 
     private void warnVersionMissing(Logger logger, JavaModuleDependenciesExtension javaModuleDependenciesExtension, String message) {
-        if (catalogFound && javaModuleDependenciesExtension.getWarnForMissingVersions().forUseAtConfigurationTime().get()) {
+        if (!catalogNotFoundWarningPrinted && javaModuleDependenciesExtension.getWarnForMissingVersions().forUseAtConfigurationTime().get()) {
             logger.warn("[WARN] [Java Module Dependencies] " + message);
         }
     }