Centralized usage of caches, tools, and utils in the plugin

Author: Jonathing

src/main/groovy/net/minecraftforge/gradle/ForgeGradleExtensionImpl.java

@@ -5,9 +5,10 @@
 package net.minecraftforge.gradle;
 
 import org.gradle.api.plugins.ExtensionAware;
+import org.gradle.api.plugins.PluginAware;
 
 record ForgeGradleExtensionImpl() implements ForgeGradleExtension {
-    static void register(ExtensionAware target) {
+    static <T extends ExtensionAware & PluginAware> void register(T target) {
         target.getExtensions().add(
             ForgeGradleExtension.class,
             ForgeGradleExtension.NAME,

src/main/groovy/net/minecraftforge/gradle/ForgeGradlePlugin.groovy

@@ -11,6 +11,7 @@ import groovy.transform.PackageScopeTarget
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.file.ArchiveOperations
+import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.file.FileSystemOperations
 import org.gradle.api.file.ProjectLayout
 import org.gradle.api.flow.FlowProviders
@@ -21,7 +22,9 @@ import org.gradle.api.model.ObjectFactory
 import org.gradle.api.plugins.ExtensionAware
 import org.gradle.api.plugins.PluginAware
 import org.gradle.api.problems.Problems
+import org.gradle.api.provider.Provider
 import org.gradle.api.provider.ProviderFactory
+import org.jetbrains.annotations.Nullable
 
 import javax.inject.Inject
 
@@ -36,7 +39,7 @@ class ForgeGradlePlugin<T extends ExtensionAware & PluginAware> implements Plugi
     /** The global logger for ForgeGradle, mostly used within {@link ForgeGradleProblems}. */
     static final Logger LOGGER = Logging.getLogger("ForgeGradle")
 
-    private final ForgeGradleProblems enhancedProblems
+    final ForgeGradleProblems enhancedProblems
 
     /**
      * The default constructor for the ForgeGradle plugin, which is invoked by Gradle to create this plugin.
@@ -48,6 +51,8 @@ class ForgeGradlePlugin<T extends ExtensionAware & PluginAware> implements Plugi
         this.enhancedProblems = new ForgeGradleProblems(this.&getProblems, this.&getProviders)
     }
 
+    private @Nullable DirectoryProperty globalCaches
+
     /**
      * Applies the ForgeGradle plugin to the target.
      * <p>The target will have the {@linkplain ForgeGradleExtension ForgeGradle} and
@@ -58,7 +63,7 @@ class ForgeGradlePlugin<T extends ExtensionAware & PluginAware> implements Plugi
      */
     @Override
     void apply(T target) {
-        final globalCaches = this.objects.directoryProperty().convention(
+        this.globalCaches = this.objects.directoryProperty().convention(
             this.objects.directoryProperty().fileValue(this.getGradleUserHomeDir(target)).dir(Constants.CACHES_LOCATION).map(this.enhancedProblems.ensureDirectory())
         )
 
@@ -68,8 +73,7 @@ class ForgeGradlePlugin<T extends ExtensionAware & PluginAware> implements Plugi
 
         MinecraftExtensionImpl.register(
             target,
-            globalCaches,
-            this.enhancedProblems,
+            this,
             this.&getFlowScope,
             this.&getFlowProviders,
             this.&getObjects,
@@ -80,6 +84,19 @@ class ForgeGradlePlugin<T extends ExtensionAware & PluginAware> implements Plugi
         )
     }
 
+    @PackageScope DirectoryProperty getGlobalCaches() {
+        try {
+            Objects.requireNonNull(this.globalCaches)
+        } catch (Throwable e) {
+            throw this.enhancedProblems.pluginNotYetApplied(new IllegalStateException("ForgeGradle does not have global caches", e))
+        }
+    }
+
+    @SuppressWarnings('GrDeprecatedAPIUsage') // Intentional deprecation, please use this method
+    @PackageScope Provider<File> getTool(Tools tool) {
+        tool.get(this.globalCaches, this.providers)
+    }
+
     @CompileDynamic
     private File getGradleUserHomeDir(T target) {
         try {

src/main/groovy/net/minecraftforge/gradle/ForgeGradleProblems.java

@@ -88,6 +88,18 @@ RuntimeException illegalPluginTarget(Exception e) {
             .solution("Use a valid plugin target (Project, Settings, Gradle)")
             .solution(HELP_MESSAGE));
     }
+
+    RuntimeException pluginNotYetApplied(Exception e) {
+        return this.getReporter().throwing(e, id("plugin-not-yet-applied", "ForgeGradle is not applied"), spec -> spec
+            .details("""
+                Attempted to get details from the ForgeGradle plugin, but it has not yet been applied to the target.""")
+            .severity(Severity.ERROR)
+            .stackLocation()
+            .solution("Apply the ForgeGradle plugin before attempting to use it from the target's plugin manager.")
+            .solution("Apply the ForgeGradle plugin before attempting to register any of its tasks that require in-house caching or tools.")
+            .solution(HELP_MESSAGE)
+        );
+    }
     //endregion
 
     //region Minecraft

src/main/groovy/net/minecraftforge/gradle/Lazy.java

@@ -12,6 +12,7 @@ import groovy.transform.PackageScopeTarget
 import groovy.transform.stc.ClosureParams
 import groovy.transform.stc.SimpleType
 import net.minecraftforge.accesstransformers.gradle.AccessTransformersContainer
+import net.minecraftforge.accesstransformers.gradle.AccessTransformersExtension
 import net.minecraftforge.util.data.json.JsonData
 import net.minecraftforge.util.data.json.RunConfig
 import org.gradle.api.NamedDomainObjectContainer
@@ -31,6 +32,7 @@ import org.gradle.api.flow.FlowScope
 import org.gradle.api.initialization.Settings
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.plugins.ExtensionAware
+import org.gradle.api.plugins.PluginAware
 import org.gradle.api.provider.MapProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
@@ -46,22 +48,18 @@ import java.util.concurrent.Callable
     private static final String EXT_MAVEN_REPOS = 'fg_mc_maven_repos'
     private static final String EXT_MAPPINGS = 'fg_mc_mappings'
 
-    private final ForgeGradleProblems problems
+    private final ForgeGradlePlugin plugin
     private final ObjectFactory objects
 
-    // Caches
-    private final DirectoryProperty globalCaches
-
     // MCMaven
     private final DirectoryProperty output
 
     // Dependencies
     private final Property<Mappings> mappingsProp
 
-    @PackageScope static void register(
-        ExtensionAware target,
-        DirectoryProperty globalCaches,
-        ForgeGradleProblems problems,
+    @PackageScope static <T extends ExtensionAware & PluginAware> void register(
+        T target,
+        ForgeGradlePlugin plugin,
         Callable<? extends FlowScope> flowScope,
         Callable<? extends FlowProviders> flowProviders,
         Callable<? extends ObjectFactory> objects,
@@ -70,7 +68,7 @@ import java.util.concurrent.Callable
         Callable<? extends FileSystemOperations> fileSystemOperations,
         Callable<? extends ArchiveOperations> archiveOperations
     ) {
-        final minecraft = new MinecraftExtensionImpl(globalCaches, problems, objects.call())
+        final minecraft = new MinecraftExtensionImpl(plugin, objects.call())
 
         if (target instanceof Project) {
             target.extensions.add(MinecraftExtension.ForProject, MinecraftExtension.NAME, minecraft.forProject(target, flowScope.call(), flowProviders.call(), layout.call(), providers.call(), fileSystemOperations.call(), archiveOperations.call()))
@@ -81,17 +79,19 @@ import java.util.concurrent.Callable
         }
     }
 
-    private MinecraftExtensionImpl(DirectoryProperty globalCaches, ForgeGradleProblems problems, ObjectFactory objects) {
-        this.problems = problems
+    private MinecraftExtensionImpl(ForgeGradlePlugin plugin, ObjectFactory objects) {
+        this.plugin = plugin
         this.objects = objects
 
-        this.globalCaches = globalCaches
-
-        this.output = objects.directoryProperty().convention(this.globalCaches.dir('mc-maven/output').map(problems.ensureDirectory()))
+        this.output = objects.directoryProperty().convention(plugin.globalCaches.dir('mc-maven/output').map(problems.ensureDirectory()))
 
         this.mappingsProp = objects.property(Mappings)
     }
 
+    @PackageScope ForgeGradleProblems getProblems() {
+        this.plugin.enhancedProblems
+    }
+
     private MinecraftExtension forSettings(Settings target) {
         target.gradle.settingsEvaluated { Settings settings ->
             if (settings !== target) return
@@ -167,7 +167,7 @@ import java.util.concurrent.Callable
         final NamedDomainObjectContainer<SlimeLauncherOptions> runs
         private final MapProperty<String, RunConfig> configs
 
-        private final Lazy.Actionable<AccessTransformersContainer> atContainer = Lazy.Actionable.of {
+        private final Util.ActionableLazy<AccessTransformersContainer> atContainer = Util.lazy {
             this.project.pluginManager.apply('net.minecraftforge.accesstransformers')
             AccessTransformersContainer.register(this.project, Attribute.of('net.minecraftforge.gradle.accesstransformed', Boolean)) { }
         }
@@ -219,7 +219,7 @@ import java.util.concurrent.Callable
                     it.attributes(this.&applyAttributes)
             }
 
-            SyncMinecraftMaven.register(project, MinecraftExtensionImpl.this.globalCaches, this.minecraft)
+            SyncMinecraftMaven.register(project, this.minecraft)
 
             var repositories = project.extensions.extraProperties.has(EXT_MAVEN_REPOS)
                 ? new AppliedRepos(project.extensions.extraProperties.get(EXT_MAVEN_REPOS) as List<? extends MavenArtifactRepository>)
@@ -234,7 +234,7 @@ import java.util.concurrent.Callable
             if (!repositories.mclibs)
                 MinecraftExtensionImpl.this.problems.reportMcLibsMavenNotDeclared()
 
-            var cacheDir = MinecraftExtensionImpl.this.globalCaches.dir("slime-launcher/cache/${this.minecraft.group.replace('.', '/')}/${this.minecraft.name}/${this.minecraft.version}").map(MinecraftExtensionImpl.this.problems.ensureDirectory())
+            var cacheDir = MinecraftExtensionImpl.this.plugin.globalCaches.dir("slime-launcher/cache/${this.minecraft.group.replace('.', '/')}/${this.minecraft.name}/${this.minecraft.version}").map(MinecraftExtensionImpl.this.problems.ensureDirectory())
             var metadataDir = MinecraftExtensionImpl.this.objects.directoryProperty().value(cacheDir).dir('metadata').map(MinecraftExtensionImpl.this.problems.ensureDirectory())
             var metadataZip = MinecraftExtensionImpl.this.output.file(Util.artifactPath(this.minecraft.group, this.minecraft.name, this.minecraft.version, 'metadata', 'zip'))
 
@@ -254,13 +254,13 @@ import java.util.concurrent.Callable
             }
 
             this.runs.forEach { options ->
-                SlimeLauncherExec.register(project, options, this.configs.getOrElse(Map.of()), MinecraftExtensionImpl.this.globalCaches, this.minecraft, metadataZip)
+                SlimeLauncherExec.register(project, options, this.configs.getOrElse(Map.of()), this.minecraft, metadataZip)
             }
 
             flowScope.always(ForgeGradleFlowAction.WelcomeMessage) {
                 it.parameters {
                     it.failure.set flowProviders.buildWorkResult.map { it.failure.orElse(null) }
-                    it.messagesDir.set MinecraftExtensionImpl.this.globalCaches.dir('messages')
+                    it.messagesDir.set MinecraftExtensionImpl.this.plugin.globalCaches.dir('messages')
                     it.displayOption.set this.providers.gradleProperty('net.minecraftforge.gradle.messages.welcome').map {
                         ForgeGradleFlowAction.WelcomeMessage.DisplayOption.valueOf(it.toUpperCase(Locale.ROOT))
                     }

src/main/groovy/net/minecraftforge/gradle/MinecraftExtensionImpl.groovy

@@ -39,22 +39,24 @@ import java.nio.file.Files
  */
 @CompileStatic
 @PackageScope abstract class SlimeLauncherExec extends JavaExec {
-    @PackageScope static TaskProvider<SlimeLauncherExec> register(Project project, SlimeLauncherOptions options, Map<String, RunConfig> configs, DirectoryProperty globalCaches, Dependency dependency, Provider<RegularFile> metadataZip) {
+    @PackageScope static TaskProvider<SlimeLauncherExec> register(Project project, SlimeLauncherOptions options, Map<String, RunConfig> configs, Dependency dependency, Provider<RegularFile> metadataZip) {
         project.tasks.register(options.taskName.get(), SlimeLauncherExec) { task ->
+            final plugin = project.plugins.getPlugin(ForgeGradlePlugin)
+
             task.description = "Runs the '$options.name' Slime Launcher run configuration."
 
             task.classpath = task.objectFactory.fileCollection().from(
                 task.providerFactory.provider { task.project.extensions.getByType(JavaPluginExtension).sourceSets.getByName(SourceSet.MAIN_SOURCE_SET_NAME).runtimeClasspath }
             )
 
-            var caches = task.objectFactory.directoryProperty().value(globalCaches.dir("slime-launcher/cache/${dependency.group.replace('.', '/')}/${dependency.name}/${dependency.version}"))
+            var caches = task.objectFactory.directoryProperty().value(plugin.globalCaches.dir("slime-launcher/cache/${dependency.group.replace('.', '/')}/${dependency.name}/${dependency.version}"))
             task.cacheDir.set caches.map(task.problems.ensureDirectory())
             task.metadataZip.set metadataZip
 
             task.inherit(configs, options.name)
             options.apply(task)
 
-            task.classpath Tools.SLIME_LAUNCHER.get(globalCaches, task.providerFactory)
+            task.classpath plugin.getTool(Tools.SLIME_LAUNCHER)
 
             if (task.buildAllProjects)
                 task.dependsOn project.allprojects.collect { it.tasks.named(LifecycleBasePlugin.ASSEMBLE_TASK_NAME) }.toArray()

src/main/groovy/net/minecraftforge/gradle/SlimeLauncherExec.groovy

@@ -32,23 +32,25 @@ abstract class SyncMinecraftMaven extends JavaExec {
     /** The name of the task that is used to sync the Minecraft Maven. */
     static final String NAME = 'syncMinecraftMaven'
 
-    @PackageScope static TaskProvider<SyncMinecraftMaven> register(Project project, DirectoryProperty globalCaches, Dependency dependency) {
-        project.tasks.register(NAME, SyncMinecraftMaven) {
-            it.group = 'Build Setup'
-            it.description = 'Syncs the Minecraft Maven dependencies.'
+    @PackageScope static TaskProvider<SyncMinecraftMaven> register(Project project, Dependency dependency) {
+        project.tasks.register(NAME, SyncMinecraftMaven) { task ->
+            final plugin = project.plugins.getPlugin(ForgeGradlePlugin)
 
-            it.classpath = it.objectFactory.fileCollection().from(Tools.MINECRAFT_MAVEN.get(globalCaches, it.providerFactory))
+            task.group = 'Build Setup'
+            task.description = 'Syncs the Minecraft Maven dependencies.'
 
-            it.cacheDir.set globalCaches.dir('mc-maven/cache').map(it.problems.ensureDirectory())
-            it.jdkCacheDir.set globalCaches.dir('mc-maven/cache/jdks').map(it.problems.ensureDirectory())
-            it.outputDir.set globalCaches.dir('mc-maven/output').map(it.problems.ensureDirectory())
+            task.classpath = task.objectFactory.fileCollection().from(plugin.getTool(Tools.MINECRAFT_MAVEN))
 
-            it.artifact.set "${dependency.group}:${dependency.name}".toString()
-            it.artifactVersion.set dependency.version
+            task.cacheDir.set plugin.globalCaches.dir('mc-maven/cache').map(task.problems.ensureDirectory())
+            task.jdkCacheDir.set plugin.globalCaches.dir('mc-maven/cache/jdks').map(task.problems.ensureDirectory())
+            task.outputDir.set plugin.globalCaches.dir('mc-maven/output').map(task.problems.ensureDirectory())
+
+            task.artifact.set "${dependency.group}:${dependency.name}".toString()
+            task.artifactVersion.set dependency.version
         }.tap {
             // TODO [ForgeGradle7][MinecraftMaven] This might cause problems if a consumer manually runs this task with custom arguments.
             //  Consider re-implementing Util#runFirst.
-            Util.runFirst project, it
+            Util.runFirst(project, it)
         }
     }
 

src/main/groovy/net/minecraftforge/gradle/SyncMinecraftMaven.groovy

@@ -36,7 +36,15 @@ enum Tools {
         this.downloadUrl = downloadUrl;
     }
 
-    public Provider<File> get(DirectoryProperty cachesDir, ProviderFactory providers) {
+    /// Gets a provider for this tool using the given caches directory and provider factory.
+    ///
+    /// @param cachesDir The caches directory to store the tool
+    /// @param providers The provider factory to use
+    /// @return A provider for the tool as a [file][File]
+    /// @deprecated Use [ForgeGradlePlugin#getTool(Tools)] <- [org.gradle.api.plugins.PluginContainer#getPlugin(Class)]
+    ///  <- [org.gradle.api.plugins.PluginAware#getPlugins()]
+    @Deprecated
+    Provider<File> get(DirectoryProperty cachesDir, ProviderFactory providers) {
         return providers.of(Source.class, spec -> spec.parameters(parameters -> {
             parameters.getInputFile().set(cachesDir.file("tools/" + this.fileName));
             parameters.getDownloadUrl().set(this.downloadUrl);