Move pluginJars to RunWithPlugins class

Author: jpenilla

src/main/kotlin/xyz/jpenilla/runpaper/task/RunServer.kt

@@ -22,7 +22,7 @@ import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.Optional
 import xyz.jpenilla.runtask.service.DownloadsAPIService
-import xyz.jpenilla.runtask.task.AbstractRun
+import xyz.jpenilla.runtask.task.RunWithPlugins
 import xyz.jpenilla.runtask.util.FileCopyingPluginHandler
 import java.io.File
 import java.nio.file.Path
@@ -32,7 +32,7 @@ import java.nio.file.Path
  *
  * Note that configuring [version] is required for this task type.
  */
-public abstract class RunServer : AbstractRun() {
+public abstract class RunServer : RunWithPlugins() {
   /**
    * Run Paper makes use of Paper's `add-plugin` command line option in order to
    * load the files in [pluginJars] as plugins. This option was implemented during

src/main/kotlin/xyz/jpenilla/runtask/RunPlugin.kt

@@ -28,6 +28,7 @@ import org.gradle.api.tasks.bundling.AbstractArchiveTask
 import org.gradle.kotlin.dsl.named
 import org.gradle.kotlin.dsl.withType
 import xyz.jpenilla.runtask.task.AbstractRun
+import xyz.jpenilla.runtask.task.RunWithPlugins
 import xyz.jpenilla.runtask.util.Constants
 import xyz.jpenilla.runtask.util.findJavaLauncher
 import xyz.jpenilla.runtask.util.maybeRegister
@@ -50,7 +51,7 @@ public abstract class RunPlugin : Plugin<Project> {
     }
   }
 
-  protected fun TaskProvider<out AbstractRun>.setupPluginJarDetection(
+  protected fun TaskProvider<out RunWithPlugins>.setupPluginJarDetection(
     project: Project,
     extension: RunExtension
   ) {

src/main/kotlin/xyz/jpenilla/runtask/task/AbstractRun.kt

@@ -27,7 +27,6 @@ import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.Internal
 import org.gradle.api.tasks.JavaExec
 import org.gradle.api.tasks.Optional
-import xyz.jpenilla.runtask.RunExtension
 import xyz.jpenilla.runtask.service.DownloadsAPIService
 import xyz.jpenilla.runtask.util.path
 import java.io.File
@@ -86,14 +85,6 @@ public abstract class AbstractRun : JavaExec() {
   @get:Internal
   public abstract val runDirectory: DirectoryProperty
 
-  /**
-   * The collection of plugin jars to load.
-   *
-   * @see [RunExtension.detectPluginJar]
-   */
-  @get:Classpath
-  public abstract val pluginJars: ConfigurableFileCollection
-
   @get:Inject
   protected abstract val layout: ProjectLayout
 
@@ -201,22 +192,4 @@ public abstract class AbstractRun : JavaExec() {
   public fun runDirectory(directory: File) {
     runDirectory.set(directory)
   }
-
-  /**
-   * Convenience method for easily adding jars to [pluginJars].
-   *
-   * @param jars jars to add
-   */
-  public fun pluginJars(vararg jars: File) {
-    pluginJars.from(jars)
-  }
-
-  /**
-   * Convenience method for easily adding jars to [pluginJars].
-   *
-   * @param jars jars to add
-   */
-  public fun pluginJars(vararg jars: Provider<RegularFile>) {
-    pluginJars.from(jars)
-  }
 }

src/main/kotlin/xyz/jpenilla/runtask/task/RunWithPlugins.kt

@@ -0,0 +1,60 @@
+/*
+ * Run Task Gradle Plugins
+ * Copyright (c) 2021-2022 Jason Penilla
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package xyz.jpenilla.runtask.task
+
+import org.gradle.api.file.ConfigurableFileCollection
+import org.gradle.api.file.RegularFile
+import org.gradle.api.provider.Provider
+import org.gradle.api.tasks.Classpath
+import xyz.jpenilla.runtask.RunExtension
+import java.io.File
+
+/**
+ * Base task for runs which load a collection of plugin jars.
+ *
+ * Note that this class does not actually do anything to load
+ * the plugins in [pluginJars], it's expected that subclasses
+ * will implement this behavior in [preExec].
+ */
+public abstract class RunWithPlugins : AbstractRun() {
+
+  /**
+   * The collection of plugin jars to load.
+   *
+   * @see [RunExtension.detectPluginJar]
+   */
+  @get:Classpath
+  public abstract val pluginJars: ConfigurableFileCollection
+
+  /**
+   * Convenience method for easily adding jars to [pluginJars].
+   *
+   * @param jars jars to add
+   */
+  public fun pluginJars(vararg jars: File) {
+    pluginJars.from(jars)
+  }
+
+  /**
+   * Convenience method for easily adding jars to [pluginJars].
+   *
+   * @param jars jars to add
+   */
+  public fun pluginJars(vararg jars: Provider<RegularFile>) {
+    pluginJars.from(jars)
+  }
+}

src/main/kotlin/xyz/jpenilla/runvelocity/task/RunVelocity.kt

@@ -17,14 +17,14 @@
 package xyz.jpenilla.runvelocity.task
 
 import xyz.jpenilla.runtask.service.DownloadsAPIService
-import xyz.jpenilla.runtask.task.AbstractRun
+import xyz.jpenilla.runtask.task.RunWithPlugins
 import xyz.jpenilla.runtask.util.FileCopyingPluginHandler
 import java.nio.file.Path
 
 /**
  * Task to download and run a Velocity server along with plugins.
  */
-public abstract class RunVelocity : AbstractRun() {
+public abstract class RunVelocity : RunWithPlugins() {
   override fun init() {
     downloadsApiService.convention(DownloadsAPIService.velocity(project))
     displayName.convention("Velocity")

src/main/kotlin/xyz/jpenilla/runwaterfall/task/RunWaterfall.kt

@@ -17,14 +17,14 @@
 package xyz.jpenilla.runwaterfall.task
 
 import xyz.jpenilla.runtask.service.DownloadsAPIService
-import xyz.jpenilla.runtask.task.AbstractRun
+import xyz.jpenilla.runtask.task.RunWithPlugins
 import xyz.jpenilla.runtask.util.FileCopyingPluginHandler
 import java.nio.file.Path
 
 /**
  * Task to download and run a Waterfall server along with plugins.
  */
-public abstract class RunWaterfall : AbstractRun() {
+public abstract class RunWaterfall : RunWithPlugins() {
   override fun init() {
     downloadsApiService.convention(DownloadsAPIService.waterfall(project))
     displayName.convention("Waterfall")