GradleUtils Shared stricter impl details, Gradle 9, Java 17

Dedicated `#report` and `#throwing` in enhanced problems

Add enhanced plugin #rootProjectDirectory

Documentation and shit

Author: Jonathing

build.gradle

@@ -29,31 +29,20 @@ java {
     withJavadocJar()
 }
 
-configurations {
-    // NOTE: If you are making a new Gradle plugin, do not copy this block!
-    configureEach {
-        resolutionStrategy.dependencySubstitution {
-            // NOTE: We build this in this repo, but enforce the module using a dependency substitution
-            //  That way, new plugins can effectively copy this buildscript just without this section
-            //  The "shadowed" attribute is declared here since project dependencies do not read the published module file
-            substitute module('net.minecraftforge:gradleutils-shared') using variant(project(':gradleutils-shared')) {
-                attributes {
-                    attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling, Bundling.SHADOWED))
-                }
-            } because 'Project dependencies do not read the published module file, so the shadowed attribute is manually declared.'
-        }
-    }
-
-    // Applies the "Gradle Plugin API Version" attribute to configuration
-    // This was added in Gradle 7, gives consumers useful errors if they are on an old version
-    def applyGradleVersionAttribute = { Configuration configuration ->
-        configuration.attributes {
-            attribute(GradlePluginApiVersion.GRADLE_PLUGIN_API_VERSION_ATTRIBUTE, objects.named(GradlePluginApiVersion, gradleutils.unpack(libs.versions.gradle)))
-        }
+gradleutils.pluginDevDefaults(configurations, libs.versions.gradle)
+
+// NOTE: If you are making a new Gradle plugin, do not copy this block!
+configurations.configureEach {
+    resolutionStrategy.dependencySubstitution {
+        // NOTE: We build this in this repo, but enforce the module using a dependency substitution
+        //  That way, new plugins can effectively copy this buildscript just without this section
+        //  The "shadowed" attribute is declared here since project dependencies do not read the published module file
+        substitute module('net.minecraftforge:gradleutils-shared') using variant(project(':gradleutils-shared')) {
+            attributes {
+                attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling, Bundling.SHADOWED))
+            }
+        } because 'Project dependencies do not read the published module file, so the shadowed attribute is manually declared.'
     }
-
-    named(JavaPlugin.RUNTIME_ELEMENTS_CONFIGURATION_NAME, applyGradleVersionAttribute)
-    named(ShadowJavaPlugin.SHADOW_RUNTIME_ELEMENTS_CONFIGURATION_NAME, applyGradleVersionAttribute)
 }
 
 dependencies {

gradleutils-shared/build.gradle

@@ -13,14 +13,14 @@ plugins {
     alias libs.plugins.shadow
 }
 
-gradleutils.displayName = 'Minecraft Forge Shared Plugin Base'
-description = 'The shared base used by all of Minecraft Forge\'s Gradle plugins'
+gradleutils.displayName = 'GradleUtils Shared'
+description = 'The shared base used by all of Forge\'s Gradle plugins.'
 base.archivesName = 'gradleutils-shared'
 group = 'net.minecraftforge'
 // version set by gitversion in settings.gradle
 
 java {
-    toolchain.languageVersion = JavaLanguageVersion.of(8)
+    toolchain.languageVersion = JavaLanguageVersion.of(17)
     withSourcesJar()
     withJavadocJar()
 }
@@ -30,7 +30,7 @@ dependencies {
     compileOnly libs.nulls
 
     // Gradle API
-    compileOnly sharedLibs.gradle
+    compileOnly libs.gradle
 
     // Tools
     implementation sharedLibs.bundles.utils

gradleutils-shared/src/main/java/net/minecraftforge/gradleutils/shared/Closures.java

@@ -11,6 +11,7 @@
 import org.gradle.api.Action;
 import org.jetbrains.annotations.UnknownNullability;
 
+import java.io.Serial;
 import java.util.concurrent.Callable;
 import java.util.function.Consumer;
 import java.util.function.Function;
@@ -61,13 +62,13 @@ public final class Closures {
 
     @SuppressWarnings({"rawtypes", "unchecked"})
     private static <T> @UnknownNullability T invokeInternal(Closure closure, Object... object) {
-        ClassLoader original = Thread.currentThread().getContextClassLoader();
+        var original = Thread.currentThread().getContextClassLoader();
         Thread.currentThread().setContextClassLoader(closure.getClass().getClassLoader());
         try {
-            Object ret = closure.getMaximumNumberOfParameters() == 0 ? closure.call() : closure.call(object);
+            var ret = closure.getMaximumNumberOfParameters() == 0 ? closure.call() : closure.call(object);
             return ret != null ? (T) ret : null;
         } catch (InvokerInvocationException e) {
-            Throwable cause = e.getCause();
+            var cause = e.getCause();
             throw cause instanceof RuntimeException ? (RuntimeException) cause : e;
         } finally {
             Thread.currentThread().setContextClassLoader(original);
@@ -248,7 +249,7 @@ public static Closure<Void> empty(Object owner) {
     }
 
     private static final class Functional<T, R> extends Closure<R> {
-        private static final long serialVersionUID = -8736820647200105725L;
+        private static final @Serial long serialVersionUID = -8736820647200105725L;
 
         private final Function<? super T, ? extends R> function;
 
@@ -264,7 +265,7 @@ public R doCall(T object) {
     }
 
     private static final class Supplying<R> extends Closure<R> {
-        private static final long serialVersionUID = 1281109313872080614L;
+        private static final @Serial long serialVersionUID = 1281109313872080614L;
 
         private final Callable<? extends R> supplier;
 
@@ -280,7 +281,7 @@ public R doCall() throws Exception {
     }
 
     private static final class Consuming<T> extends Closure<Void> {
-        private static final long serialVersionUID = 1165200476195312981L;
+        private static final @Serial long serialVersionUID = 1165200476195312981L;
 
         private final Consumer<? super T> consumer;
 
@@ -297,7 +298,7 @@ public Void doCall(T object) {
     }
 
     private static final class Running extends Empty {
-        private static final long serialVersionUID = -3453835628821302135L;
+        private static final @Serial long serialVersionUID = -3453835628821302135L;
 
         private final Runnable runnable;
 
@@ -314,7 +315,7 @@ public Void doCall() {
     }
 
     private static class Empty extends Closure<Void> {
-        private static final long serialVersionUID = 6072707343050307552L;
+        private static final @Serial long serialVersionUID = 6072707343050307552L;
 
         private Empty(Object owner) {
             super(owner, owner);

gradleutils-shared/src/main/java/net/minecraftforge/gradleutils/shared/EnhancedFlowAction.java

@@ -80,7 +80,7 @@ protected EnhancedFlowAction() { }
     /// @param s The string to match for (ignoring case)
     /// @return If the throwable's message contains the string
     protected static boolean contains(Throwable e, String s) {
-        for (Throwable cause = e; cause != null; cause = cause.getCause()) {
+        for (var cause = e; cause != null; cause = cause.getCause()) {
             if (StringGroovyMethods.containsIgnoreCase(s, cause.getMessage()))
                 return true;
         }
@@ -99,7 +99,7 @@ public final void execute(P parameters) {
             this.run(parameters);
         } catch (Exception e) {
             // wrapping in this exception will prevent gradle from eating the stacktrace
-            throw new RuntimeException(e);
+            throw e instanceof RuntimeException rte ? rte : new RuntimeException(e);
         }
     }
 

gradleutils-shared/src/main/java/net/minecraftforge/gradleutils/shared/EnhancedPlugin.java

@@ -29,7 +29,7 @@
 /// needing to duplicate code across projects.
 ///
 /// @param <T> The type of target
-public abstract class EnhancedPlugin<T> implements Plugin<T>, EnhancedPluginAdditions {
+public non-sealed abstract class EnhancedPlugin<T> implements Plugin<T>, EnhancedPluginAdditions {
     private final String name;
     private final String displayName;
     private final @Nullable String toolsExtName;
@@ -87,8 +87,9 @@ protected EnhancedPlugin(String name, String displayName) {
     /// plugin's [global][#globalCaches()] and [local][#localCaches()] caches. Additionally, the name is used to
     /// create the cache folders (`minecraftforge/name`).
     ///
-    /// @param name        The name for this plugin (must be machine-friendly)
-    /// @param displayName The display name for this plugin
+    /// @param name         The name for this plugin (must be machine-friendly)
+    /// @param displayName  The display name for this plugin
+    /// @param toolsExtName The name for the tools extension to used, or `null` if it should not be created
     protected EnhancedPlugin(String name, String displayName, @Nullable String toolsExtName) {
         this.name = name;
         this.displayName = displayName;
@@ -104,8 +105,8 @@ protected EnhancedPlugin(String name, String displayName, @Nullable String tools
     public final void apply(T target) {
         this.setup(this.target = target);
 
-        if (this.toolsExtName != null && target instanceof ExtensionAware)
-            this.tools = ((ExtensionAware) target).getExtensions().create(this.toolsExtName, ToolsExtensionImpl.class, (Callable<? extends JavaToolchainService>) this::toolchainsForTools);
+        if (this.toolsExtName != null && target instanceof ExtensionAware extensionAware)
+            this.tools = extensionAware.getExtensions().create(this.toolsExtName, ToolsExtensionImpl.class, (Callable<? extends JavaToolchainService>) this::toolchainsForTools);
 //        else
 //            this.tools = this.getObjects().newInstance(ToolsExtensionImpl.class, (Callable<? extends JavaToolchainService>) this::toolchainsForTools);
     }
@@ -164,8 +165,8 @@ public final DirectoryProperty globalCaches() {
 
     private DirectoryProperty makeGlobalCaches() {
         try {
-            Gradle gradle = ((Gradle) InvokerHelper.getProperty(this.target, "gradle"));
-            DirectoryProperty gradleUserHomeDir = this.getObjects().directoryProperty().fileValue(gradle.getGradleUserHomeDir());
+            var gradle = ((Gradle) InvokerHelper.getProperty(this.target, "gradle"));
+            var gradleUserHomeDir = this.getObjects().directoryProperty().fileValue(gradle.getGradleUserHomeDir());
 
             return this.getObjects().directoryProperty().convention(
                 gradleUserHomeDir.dir("caches/minecraftforge/" + this.name).map(this.problemsInternal.ensureFileLocation())
@@ -207,6 +208,32 @@ private DirectoryProperty makeLocalCaches() {
         }
     }
 
+    private final Lazy<DirectoryProperty> rootProjectDirectory = Lazy.simple(this::makeRootProjectDirectory);
+
+    @Override
+    public final DirectoryProperty rootProjectDirectory() {
+        return this.rootProjectDirectory.get();
+    }
+
+    private DirectoryProperty makeRootProjectDirectory() {
+        var target = this.getTarget();
+        try {
+            var rootProjectDirectory = this.getObjects().directoryProperty();
+            if (target instanceof Project project) {
+                return rootProjectDirectory.value(project.getRootProject().getLayout().getProjectDirectory());
+            } else if (target instanceof Settings) {
+                return rootProjectDirectory.value(this.getBuildLayout().getRootDirectory());
+            } else {
+                throw new IllegalStateException("Cannot get root project directory with an unsupported type (must be project or settings)");
+            }
+        } catch (Exception e) {
+            throw this.problemsInternal.illegalPluginTarget(
+                new IllegalArgumentException("Failed to get %s root project directory for target: %s".formatted(this.displayName, target), e),
+                Project.class, Settings.class
+            );
+        }
+    }
+
     private final Lazy<DirectoryProperty> workingProjectDirectory = Lazy.simple(this::makeWorkingProjectDirectory);
 
     @Override
@@ -215,18 +242,19 @@ public final DirectoryProperty workingProjectDirectory() {
     }
 
     private DirectoryProperty makeWorkingProjectDirectory() {
+        var target = this.getTarget();
         try {
-            DirectoryProperty workingProjectDirectory = this.getObjects().directoryProperty();
-            if (this.target instanceof Project) {
+            var workingProjectDirectory = this.getObjects().directoryProperty();
+            if (target instanceof Project) {
                 return workingProjectDirectory.value(this.getProjectLayout().getProjectDirectory());
-            } else if (this.target instanceof Settings) {
+            } else if (target instanceof Settings) {
                 return workingProjectDirectory.value(this.getBuildLayout().getRootDirectory());
             } else {
                 throw new IllegalStateException("Cannot get working project directory with an unsupported type (must be project or settings)");
             }
         } catch (Exception e) {
             throw this.problemsInternal.illegalPluginTarget(
-                new IllegalArgumentException(String.format("Failed to get %s working project directory for target: %s", this.displayName, this.getTarget()), e),
+                new IllegalArgumentException("Failed to get %s working project directory for target: %s".formatted(this.displayName, target), e),
                 Project.class, Settings.class
             );
         }

gradleutils-shared/src/main/java/net/minecraftforge/gradleutils/shared/EnhancedPluginAdditions.java

@@ -5,13 +5,10 @@
 package net.minecraftforge.gradleutils.shared;
 
 import org.gradle.api.file.DirectoryProperty;
-import org.gradle.api.provider.Provider;
-
-import java.io.File;
 
 /// This interface defines the additional methods added by [EnhancedPlugin]. They are additionally accessible in tasks
 /// that implement [EnhancedTask].
-public interface EnhancedPluginAdditions {
+public sealed interface EnhancedPluginAdditions permits EnhancedPlugin, EnhancedTask {
     /// Gets a provider to the file for a [Tool] to be used. The tool's state is managed by Gradle through the
     /// [org.gradle.api.provider.ValueSource] API and will not cause caching issues.
     ///
@@ -35,16 +32,28 @@ public interface EnhancedPluginAdditions {
     /// It is located in `project/build/minecraftforge/plugin`.
     ///
     /// @return The global caches
-    /// @throws RuntimeException If this plugin cannot access global caches (i.e. the target is not
+    /// @throws RuntimeException If this plugin cannot access local caches (i.e. the target is not
     ///                          [org.gradle.api.Project] or [org.gradle.api.initialization.Settings])
     DirectoryProperty localCaches();
 
-    /// Gets the working project directory to be used for this plugin. This directory is either the
-    /// [org.gradle.api.file.ProjectLayout#getProjectDirectory()] of the [org.gradle.api.Project] or the
-    /// [org.gradle.api.file.BuildLayout#getRootDirectory()] of the [org.gradle.api.initialization.Settings]. Attempting
-    /// to call this when the plugin target is not either type will throw an exception.
+    /// Gets the root project directory to be used for this plugin.
     ///
-    /// It is located in `project/build/minecraftforge/plugin`.
+    /// This directory is either the [org.gradle.api.file.ProjectLayout#getProjectDirectory()] of
+    /// [org.gradle.api.Project#getRootProject()] or the [org.gradle.api.file.BuildLayout#getRootDirectory()] of the
+    /// [org.gradle.api.initialization.Settings]. Attempting to call this when the plugin target is neither type will
+    /// throw an exception.
+    ///
+    /// @return The root project directory
+    /// @throws RuntimeException If this plugin cannot access the root project directory (i.e. the target is not
+    ///                          [org.gradle.api.Project] or [org.gradle.api.initialization.Settings])
+    DirectoryProperty rootProjectDirectory();
+
+    /// Gets the working project directory to be used for this plugin.
+    ///
+    /// This directory is either the [org.gradle.api.file.ProjectLayout#getProjectDirectory()] of the
+    /// [org.gradle.api.Project] or the [org.gradle.api.file.BuildLayout#getRootDirectory()] of the
+    /// [org.gradle.api.initialization.Settings]. Attempting to call this when the plugin target is neither type will
+    /// throw an exception.
     ///
     /// @return The working project directory
     /// @throws RuntimeException If this plugin cannot access the working project directory (i.e. the target is not