Implement support for custom concrete items.

This commit is contained in:
2023-03-16 17:35:40 -07:00
parent bb3d3cb6bc
commit 4cec9a74a9
11 changed files with 80 additions and 33 deletions

View File

@ -2,9 +2,10 @@ plugins {
id("gay.pizza.foundation.concrete-root") id("gay.pizza.foundation.concrete-root")
} }
concrete { concreteRoot {
minecraftServerPath.set("server") minecraftServerPath.set("server")
paperServerVersionGroup.set("1.19") paperServerVersionGroup.set("1.19")
paperApiVersion.set("1.19.3-R0.1-SNAPSHOT") paperApiVersion.set("1.19.3-R0.1-SNAPSHOT")
acceptServerEula.set(true) acceptServerEula.set(true)
expansiveItemInclusion.set(true)
} }

View File

@ -7,6 +7,6 @@ dependencies {
implementation(project(":bukkit-plugins:common-library")) implementation(project(":bukkit-plugins:common-library"))
} }
plugin { concreteItem {
dependency(project(":bukkit-plugins:goodbye-world")) dependency(project(":bukkit-plugins:goodbye-world"))
} }

View File

@ -1,3 +1,10 @@
plugins { plugins {
id("gay.pizza.foundation.concrete-base") id("gay.pizza.foundation.concrete-base")
} }
concreteItem {
type.set("library")
fileInclusion {
tasks.jar.get().outputs.files.associateWith { "library-jar" }
}
}

View File

@ -4,6 +4,7 @@ import org.gradle.api.JavaVersion
import org.gradle.api.Plugin import org.gradle.api.Plugin
import org.gradle.api.Project import org.gradle.api.Project
import org.gradle.api.plugins.JavaPluginExtension import org.gradle.api.plugins.JavaPluginExtension
import org.gradle.kotlin.dsl.create
import org.gradle.kotlin.dsl.getByType import org.gradle.kotlin.dsl.getByType
import org.gradle.kotlin.dsl.withType import org.gradle.kotlin.dsl.withType
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
@ -40,5 +41,7 @@ open class ConcreteBasePlugin : Plugin<Project> {
} }
} }
} }
project.extensions.create<ConcreteItemExtension>("concreteItem")
} }
} }

View File

@ -0,0 +1,21 @@
package gay.pizza.foundation.concrete
import org.gradle.api.DomainObjectSet
import org.gradle.api.Project
import org.gradle.api.provider.Property
import java.io.File
interface ConcreteItemExtension {
val type: Property<String>
val version: Property<String>
val dependencies: DomainObjectSet<Project>
val fileInclusion: Property<() -> Map<File, String>>
fun dependency(project: Project) {
dependencies.add(project)
}
fun fileInclusion(inclusion: () -> Map<File, String>) {
fileInclusion.set(inclusion)
}
}

View File

@ -1,12 +0,0 @@
package gay.pizza.foundation.concrete
import org.gradle.api.DomainObjectSet
import org.gradle.api.Project
interface ConcretePluginExtension {
val dependencies: DomainObjectSet<Project>
fun dependency(project: Project) {
dependencies.add(project)
}
}

View File

@ -1,6 +1,7 @@
package gay.pizza.foundation.concrete package gay.pizza.foundation.concrete
import org.gradle.api.Project import org.gradle.api.Project
import org.gradle.kotlin.dsl.create
import org.gradle.kotlin.dsl.get import org.gradle.kotlin.dsl.get
import org.gradle.language.jvm.tasks.ProcessResources import org.gradle.language.jvm.tasks.ProcessResources
@ -9,8 +10,6 @@ class ConcretePluginPlugin : ConcreteBaseBukkitPlugin() {
override fun apply(project: Project) { override fun apply(project: Project) {
super.apply(project) super.apply(project)
project.extensions.create("plugin", ConcretePluginExtension::class.java)
project.plugins.apply("com.github.johnrengelman.shadow") project.plugins.apply("com.github.johnrengelman.shadow")
// During IDEA project import, if this code is active, it will print warnings. // During IDEA project import, if this code is active, it will print warnings.

View File

@ -7,4 +7,5 @@ interface ConcreteRootExtension {
val paperApiVersion: Property<String> val paperApiVersion: Property<String>
val minecraftServerPath: Property<String> val minecraftServerPath: Property<String>
val acceptServerEula: Property<Boolean> val acceptServerEula: Property<Boolean>
val expansiveItemInclusion: Property<Boolean>
} }

View File

@ -9,7 +9,7 @@ import java.nio.file.Paths
class ConcreteRootPlugin : Plugin<Project> { class ConcreteRootPlugin : Plugin<Project> {
override fun apply(project: Project) { override fun apply(project: Project) {
project.apply(plugin = "base") project.apply(plugin = "base")
project.extensions.create<ConcreteRootExtension>("concrete") project.extensions.create<ConcreteRootExtension>("concreteRoot")
val setupPaperServer = project.tasks.create<SetupPaperServer>("setupPaperServer") val setupPaperServer = project.tasks.create<SetupPaperServer>("setupPaperServer")
val runPaperServer = project.tasks.create<RunPaperServer>("runPaperServer") val runPaperServer = project.tasks.create<RunPaperServer>("runPaperServer")
runPaperServer.dependsOn(setupPaperServer) runPaperServer.dependsOn(setupPaperServer)

View File

@ -5,14 +5,20 @@ import org.gradle.api.tasks.TaskAction
import java.nio.file.Files import java.nio.file.Files
import java.nio.file.Path import java.nio.file.Path
import kotlin.io.path.name import kotlin.io.path.name
import kotlin.io.path.relativeTo
open class UpdateManifestTask : DefaultTask() { open class UpdateManifestTask : DefaultTask() {
@TaskAction @TaskAction
fun update() { fun update() {
val manifestsDir = ensureManifestsDirectory() val manifestsDir = ensureManifestsDirectory()
val rootPath = project.projectDir.toPath() val rootExtension = project.concreteRootExtension
val rootPath = if (rootExtension.expansiveItemInclusion.orNull == true) {
project.rootProject.rootDir
} else {
project.rootDir
}
val legacyUpdateManifest = project.findPluginProjects().mapNotNull { project -> val legacyUpdateManifest = project.findPluginProjects().mapNotNull { project ->
val paths = project.shadowJarOutputs!!.allFilesRelativeToPath(rootPath) val paths = project.shadowJarOutputs!!.files.allFilesRelativeToPath(rootPath.toPath())
if (paths.isNotEmpty()) { if (paths.isNotEmpty()) {
project.name to mapOf( project.name to mapOf(
@ -25,24 +31,25 @@ open class UpdateManifestTask : DefaultTask() {
val legacyUpdateFile = manifestsDir.resolve("update.json") val legacyUpdateFile = manifestsDir.resolve("update.json")
Files.writeString(legacyUpdateFile, Globals.gson.toJson(legacyUpdateManifest)) Files.writeString(legacyUpdateFile, Globals.gson.toJson(legacyUpdateManifest))
val extensibleUpdateManifestItems = project.findPluginProjects().mapNotNull { project -> val extensibleUpdateManifestItems = project.findItemProjects().map { project ->
val paths = project.shadowJarOutputs!!.allFilesRelativeToPath(rootPath) val concreteItemExtension = project.concreteItemExtension!!
val pathInclusion = concreteItemExtension.fileInclusion.orNull ?: {
project.shadowJarOutputs!!.files.associateWith { "plugin-jar" }
}
val paths = pathInclusion()
val dependencies = concreteItemExtension.dependencies.map { it.name }
val dependencies = project.concretePluginExtension.dependencies.map { it.name }
ExtensibleManifestItem( ExtensibleManifestItem(
name = project.name, name = project.name,
type = "bukkit-plugin", type = concreteItemExtension.type.orNull ?: "bukkit-plugin",
version = project.version.toString(), version = concreteItemExtension.version.orNull ?: project.version.toString(),
dependencies = dependencies, dependencies = dependencies,
files = paths.map { path -> files = paths.map { (path, type) ->
var type = "unknown"
if (path.name.endsWith("-plugin.jar")) {
type = "plugin-jar"
}
ExtensibleManifestItemFile( ExtensibleManifestItemFile(
name = path.name, name = path.name,
type = type, type = type,
path = path.toUnixString() path = path.toPath().relativeTo(rootPath.toPath()).toUnixString()
) )
} }
) )

View File

@ -4,6 +4,7 @@ import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
import org.gradle.api.Project import org.gradle.api.Project
import org.gradle.api.tasks.TaskContainer import org.gradle.api.tasks.TaskContainer
import org.gradle.api.tasks.TaskOutputs import org.gradle.api.tasks.TaskOutputs
import java.io.File
import java.nio.file.FileSystems import java.nio.file.FileSystems
import java.nio.file.Path import java.nio.file.Path
@ -12,11 +13,30 @@ import java.nio.file.Path
*/ */
internal fun Project.isPluginProject() = plugins.hasPlugin(ConcretePluginPlugin::class.java) internal fun Project.isPluginProject() = plugins.hasPlugin(ConcretePluginPlugin::class.java)
/**
* Checks if the project has the [ConcreteBasePlugin] applied and is opting into item behavior.
*/
internal fun Project.isConcreteItem() =
isPluginProject() || concreteItemExtension?.type?.orNull != null
/** /**
* Finds all projects in the project's hierarchy that are plugins. * Finds all projects in the project's hierarchy that are plugins.
*/ */
internal fun Project.findPluginProjects() = allprojects.filter { project -> project.isPluginProject() } internal fun Project.findPluginProjects() = allprojects.filter { project -> project.isPluginProject() }
/**
* Finds all projects in the project's hierarchy that are items.
*/
internal fun Project.findItemProjects(): List<Project> {
val optInExpansion = concreteRootExtension.expansiveItemInclusion.orNull ?: false
val searchScope = if (optInExpansion) {
project.rootProject.allprojects
} else {
allprojects
}
return searchScope.filter { project -> project.isConcreteItem() }
}
internal fun TaskContainer.addTaskDependency(dependent: String, dependency: String) { internal fun TaskContainer.addTaskDependency(dependent: String, dependency: String) {
getByName(dependent).dependsOn(getByName(dependency)) getByName(dependent).dependsOn(getByName(dependency))
} }
@ -37,8 +57,8 @@ internal val Project.concreteRootExtension: ConcreteRootExtension
error = { "Failed to find concrete root. Did you apply the concrete root plugin?" } error = { "Failed to find concrete root. Did you apply the concrete root plugin?" }
) )
internal val Project.concretePluginExtension: ConcretePluginExtension internal val Project.concreteItemExtension: ConcreteItemExtension?
get() = extensions.getByType(ConcretePluginExtension::class.java) get() = extensions.findByType(ConcreteItemExtension::class.java)
/** /**
* Finds the concrete root project, which is the first project in the project hierarchy * Finds the concrete root project, which is the first project in the project hierarchy
@ -68,6 +88,6 @@ internal fun <T> Project.findTargetParent(valid: Project.() -> Boolean, extract:
throw RuntimeException(error()) throw RuntimeException(error())
} }
internal fun TaskOutputs.allFilesRelativeToPath(root: Path): List<Path> = files.map { root.relativize(it.toPath()) } internal fun Iterable<File>.allFilesRelativeToPath(root: Path): List<Path> = map { root.relativize(it.toPath()) }
internal fun Path.toUnixString() = toString().replace(FileSystems.getDefault().separator, "/") internal fun Path.toUnixString() = toString().replace(FileSystems.getDefault().separator, "/")