plugin-dev, repository: Use new mammoth additions to reduce duplication

zml2008 · zml2008 · commit 53a5f8eeacd5 · 2022-10-07T19:53:14.000-07:00
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -114,6 +114,7 @@ subprojects {
             standardOptions()
             formatAnnotations()
             importOrderFile(rootProject.file(".spotless/sponge.importorder"))
+            removeUnusedImports()
         }
 
         project.plugins.withId("groovy") {
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -5,8 +5,8 @@ version = "1.0"
 indra = "3.0.0"
 pluginPublish = "1.0.0"
 spotless = "6.11.0"
-junit = "5.9.0"
-mammoth = "1.2.0"
+junit = "5.9.1"
+mammoth = "1.3.0"
 
 [libraries]
 gson = { module = "com.google.code.gson:gson", version = "2.9.1" }
diff --git a/plugin-development/build.gradle.kts b/plugin-development/build.gradle.kts
@@ -2,6 +2,7 @@ dependencies {
     implementation(libs.pluginMeta) {
         exclude(group = "org.checkerframework", module = "checker-qual")
     }
+    api(libs.mammoth)
     // implementation("org.spongepowered:vanillagradle:0.2-SNAPSHOT")
     // implementation("gradle.plugin.org.jetbrains.gradle.plugin.idea-ext:gradle-idea-ext:0.10")
 }
diff --git a/plugin-development/src/main/java/org/spongepowered/gradle/plugin/SpongePluginGradle.java b/plugin-development/src/main/java/org/spongepowered/gradle/plugin/SpongePluginGradle.java
@@ -24,10 +24,9 @@
  */
 package org.spongepowered.gradle.plugin;
 
+import net.kyori.mammoth.ProjectOrSettingsPlugin;
 import org.gradle.api.Action;
-import org.gradle.api.GradleException;
 import org.gradle.api.NamedDomainObjectProvider;
-import org.gradle.api.Plugin;
 import org.gradle.api.Project;
 import org.gradle.api.Task;
 import org.gradle.api.artifacts.Configuration;
@@ -39,14 +38,16 @@
 import org.gradle.api.file.Directory;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.initialization.Settings;
-import org.gradle.api.invocation.Gradle;
+import org.gradle.api.plugins.ExtensionContainer;
 import org.gradle.api.plugins.JavaLibraryPlugin;
 import org.gradle.api.plugins.JavaPlugin;
+import org.gradle.api.plugins.PluginContainer;
 import org.gradle.api.provider.Property;
 import org.gradle.api.provider.Provider;
 import org.gradle.api.tasks.JavaExec;
 import org.gradle.api.tasks.SourceSet;
 import org.gradle.api.tasks.SourceSetContainer;
+import org.gradle.api.tasks.TaskContainer;
 import org.gradle.api.tasks.TaskProvider;
 import org.gradle.api.tasks.bundling.AbstractArchiveTask;
 import org.gradle.process.CommandLineArgumentProvider;
@@ -62,42 +63,31 @@
 import java.nio.file.Path;
 import java.util.Collections;
 
-public final class SpongePluginGradle implements Plugin<Object> {
+public final class SpongePluginGradle implements ProjectOrSettingsPlugin {
 
     private @UnknownNullability Project project;
 
     @Override
-    public void apply(final @NotNull Object target) {
-        if (target instanceof Project) {
-            this.applyToProject((Project) target);
-        } else if (target instanceof Settings) {
-            this.applyToSettings((Settings) target);
-        } else if (target instanceof Gradle) {
-             // no-op
-        } else {
-            throw new GradleException(
-                    "Sponge gradle plugin target '" + target
-                            + "' is of unexpected type " + target.getClass()
-                            + ", expecting a Project or Settings instance"
-            );
-        }
-    }
-
-    public void applyToProject(final Project project) {
-        this.project = project;
+    public void applyToProject(
+        final @NotNull Project target,
+        final @NotNull PluginContainer plugins,
+        final @NotNull ExtensionContainer extensions,
+        final @NotNull TaskContainer tasks
+    ) {
+        this.project = target;
 
         project.getLogger().lifecycle("SpongePowered Plugin 'GRADLE' Toolset Version '{}'", Constants.VERSION);
-        project.getPlugins().apply(JavaLibraryPlugin.class);
+        plugins.apply(JavaLibraryPlugin.class);
         // project.getPlugins().apply(ProvideMinecraftPlugin.class);
         // project.getPlugins().apply(IdeaExtPlugin.class);
         // project.getPlugins().apply(EclipsePlugin.class);
 
         // final MinecraftExtension minecraft = project.getExtensions().getByType(MinecraftExtension.class);
-        final SpongePluginExtension sponge = project.getExtensions().create("sponge", SpongePluginExtension.class);
+        final SpongePluginExtension sponge = extensions.create("sponge", SpongePluginExtension.class);
 
         // Only inject repositories if the project does not have sponge repos from other sources
         sponge.injectRepositories().convention(
-            !project.getGradle().getPlugins().hasPlugin(SpongePluginGradle.class)
+            !this.isAppliedToSettingsOf(target)
                 && !project.getGradle().getPlugins().hasPlugin("org.spongepowered.gradle.repository")
         );
 
@@ -134,9 +124,9 @@ public void applyToProject(final Project project) {
         });
     }
 
-    private void applyToSettings(final Settings settings) {
-       SpongePluginGradle.addRepository(settings.getDependencyResolutionManagement().getRepositories());
-       settings.getGradle().getPlugins().apply(SpongePluginGradle.class);
+    @Override
+    public void applyToSettings(@NotNull Settings target, @NotNull PluginContainer plugins, @NotNull ExtensionContainer extensions) {
+       SpongePluginGradle.addRepository(target.getDependencyResolutionManagement().getRepositories());
     }
 
     private static void addRepository(final RepositoryHandler handler) {
diff --git a/repository/build.gradle.kts b/repository/build.gradle.kts
@@ -1,3 +1,7 @@
+dependencies {
+    api(libs.mammoth)
+}
+
 indraPluginPublishing {
     plugin(
         "repository",
diff --git a/repository/src/functionalTest/java/org/spongepowered/gradle/repository/RepositoriesFunctionalTest.java b/repository/src/functionalTest/java/org/spongepowered/gradle/repository/RepositoriesFunctionalTest.java
@@ -24,10 +24,7 @@
  */
 package org.spongepowered.gradle.repository;
 
-import net.kyori.mammoth.test.GradleFunctionalTest;
 import net.kyori.mammoth.test.TestContext;
-import org.junit.jupiter.api.Disabled;
-import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.DisplayNameGeneration;
 import org.spongepowered.gradle.build.FunctionalTestDisplayNameGenerator;
 import org.spongepowered.gradle.build.SpongeGradleFunctionalTest;
diff --git a/repository/src/main/java/org/spongepowered/gradle/repository/RepositoryPlugin.java b/repository/src/main/java/org/spongepowered/gradle/repository/RepositoryPlugin.java
@@ -24,50 +24,52 @@
  */
 package org.spongepowered.gradle.repository;
 
-import org.gradle.api.GradleException;
-import org.gradle.api.Plugin;
+import net.kyori.mammoth.ProjectOrSettingsPlugin;
 import org.gradle.api.Project;
 import org.gradle.api.artifacts.dsl.RepositoryHandler;
 import org.gradle.api.initialization.Settings;
-import org.gradle.api.invocation.Gradle;
 import org.gradle.api.plugins.ExtensionAware;
+import org.gradle.api.plugins.ExtensionContainer;
+import org.gradle.api.plugins.PluginContainer;
+import org.gradle.api.tasks.TaskContainer;
+import org.gradle.util.GradleVersion;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
-public class RepositoryPlugin implements Plugin<Object> {
+public class RepositoryPlugin implements ProjectOrSettingsPlugin {
 
-    @Override
-    public void apply(final @NotNull Object target) {
-        if (target instanceof Project) {
-            this.applyToProject((Project) target);
-        } else if (target instanceof Settings) {
-            this.applyToSettings((Settings) target);
-        } else if (target instanceof Gradle) {
-            // no-op
-        } else {
-            throw new GradleException(
-                    "Sponge repository plugin target '" + target
-                            + "' is of unexpected type " + target.getClass()
-                            + ", expecting a Project or Settings instance"
-            );
-        }
-    }
+    private static final GradleVersion MINIMUM_VERSION = GradleVersion.version("7.4"); // when kts codegen was added for extensions on repositories
 
-    private void applyToProject(final Project project) {
-        this.registerExtension(project.getRepositories());
+    @Override
+    public void applyToProject(
+        final @NotNull Project target,
+        final @NotNull PluginContainer plugins,
+        final @NotNull ExtensionContainer extensions,
+        final @NotNull TaskContainer tasks
+    ) {
+        this.registerExtension(target.getRepositories());
     }
 
-    private void applyToSettings(final Settings settings) {
-        settings.getGradle().getPlugins().apply(RepositoryPlugin.class);
-        this.registerExtension(settings.getDependencyResolutionManagement().getRepositories());
+    @Override
+    public void applyToSettings(
+        final @NotNull Settings target,
+        final @NotNull PluginContainer plugins,
+        final @NotNull ExtensionContainer extensions
+    ) {
+        this.registerExtension(target.getDependencyResolutionManagement().getRepositories());
     }
 
     private void registerExtension(final RepositoryHandler repositories) {
         ((ExtensionAware) repositories).getExtensions().create(
-            SpongeRepositoryExtension.class,
-            "sponge",
-            SpongeRepositoryExtensionImpl.class,
-            repositories
+                SpongeRepositoryExtension.class,
+                "sponge",
+                SpongeRepositoryExtensionImpl.class,
+                repositories
         );
     }
 
+    @Override
+    public @Nullable GradleVersion minimumGradleVersion() {
+        return MINIMUM_VERSION;
+    }
 }
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -8,9 +8,7 @@ pluginManagement {
 
 dependencyResolutionManagement {
     repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
-    repositories {
-        pluginManagement.repositories.forEach { add(it) }
-    }
+    repositories { pluginManagement.repositories.forEach { add(it) } }
 }
 
 rootProject.name = "SpongeGradle"

Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,7 @@ subprojects {`
`114`	`114`	`standardOptions()`
`115`	`115`	`formatAnnotations()`
`116`	`116`	`importOrderFile(rootProject.file(".spotless/sponge.importorder"))`
	`117`	`+ removeUnusedImports()`
`117`	`118`	`}`
`118`	`119`
`119`	`120`	`project.plugins.withId("groovy") {`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@ dependencies {`
`2`	`2`	`implementation(libs.pluginMeta) {`
`3`	`3`	`exclude(group = "org.checkerframework", module = "checker-qual")`
`4`	`4`	`}`
	`5`	`+ api(libs.mammoth)`
`5`	`6`	`// implementation("org.spongepowered:vanillagradle:0.2-SNAPSHOT")`
`6`	`7`	`// implementation("gradle.plugin.org.jetbrains.gradle.plugin.idea-ext:gradle-idea-ext:0.10")`
`7`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,7 @@ pluginManagement {`
`8`	`8`
`9`	`9`	`dependencyResolutionManagement {`
`10`	`10`	`repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)`
`11`		`- repositories {`
`12`		`- pluginManagement.repositories.forEach { add(it) }`
`13`		`- }`
	`11`	`+ repositories { pluginManagement.repositories.forEach { add(it) } }`
`14`	`12`	`}`
`15`	`13`
`16`	`14`	`rootProject.name = "SpongeGradle"`