Skip to content

Commit

Permalink
Better logging, DI, dependency updates (#67)
Browse files Browse the repository at this point in the history 
* Feat: Allow defaults for DI observers

Feat: Scoped DI

This is pretty much multi-context support but every context is tied to the root DI so clearing is still easy!

Feat: Integrate logging with DI system, tries to create reasonable defaults when a logger isn't registered, deprecate old logging functions.

Deps: Kotlin 1.9.23, compose 1.6.1

* revert: Undo renaming Logging -> IdoLogging to remain backwards compatible with old logging package
bump: Use develop publish action

* tests: Add tests for DefaultingModuleObserver and Scoped DI contexts
feat: Add multiplatform testing convention

* fix: Missing [plugin] prefix when writing ComponentLike
fix: Missing space in console for success/error prefix

* tweak: Color iSuccess and iFail plugin prefixes

* feat: Use logger in ActionScope
feat: Add plugin parameter to FeatureManager to be able to use its logger on load/enable

* fix: FeatureManager error with non-lazy commandExecutor

* chore: Automate dependency updates with version-catalog-update plugin!

* feat!: add onLoad option to configs, fires on any load
feat: Add Plugin.dataPath extension
  • Loading branch information
@0ffz
0ffz committed Mar 16, 2024
1 parent 5628e5a commit 2c2117b
Show file tree
Hide file tree
Showing 28 changed files with 535 additions and 278 deletions.
6 changes: 4 additions & 2 deletions .github/workflows/publish.yml
View file
Expand Up @@ -12,9 +12,11 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0

- uses: MineInAbyss/publish-action@master
- uses: MineInAbyss/publish-action@develop
with:
maven-metadata-url: https://repo.mineinabyss.com/releases/com/mineinabyss/idofront-util/maven-metadata.xml
maven-snapshot-metadata-url: https://repo.mineinabyss.com/snapshots/com/mineinabyss/idofront-util/maven-metadata.xml
Expand Down
27 changes: 27 additions & 0 deletions build.gradle.kts
View file
Expand Up @@ -5,6 +5,7 @@ plugins {
alias(libs.plugins.kotlin.jvm) apply false
id("com.mineinabyss.conventions.autoversion")
alias(libs.plugins.dependencyversions)
alias(libs.plugins.version.catalog.update)
}

subprojects {
Expand Down Expand Up @@ -50,3 +51,29 @@ tasks {
dependsOn(gradle.includedBuilds.map { it.task(":build") })
}
}

fun isNonStable(version: String): Boolean {
val unstableKeywords = listOf(
"-beta",
"-rc",
"-alpha",
)

return unstableKeywords.any { version.contains(it, ignoreCase = true) }
}

versionCatalogUpdate {
keep {
keepUnusedPlugins = true
keepUnusedVersions = true
keepUnusedLibraries = true
}
}

tasks {
dependencyUpdates {
rejectVersionIf {
isNonStable(candidate.version)
}
}
}
2 changes: 1 addition & 1 deletion gradle.properties
View file
@@ -1,2 +1,2 @@
group=com.mineinabyss
version=0.22
version=0.23
220 changes: 104 additions & 116 deletions gradle/libs.versions.toml
View file
@@ -1,172 +1,160 @@
[versions]
minecraft = "1.20.4-R0.1-SNAPSHOT"
kotlin = "1.9.20"
jvm = "17"

anvilgui = "1.9.2-SNAPSHOT"
coroutines = "1.7.3"
compose = "1.5.11"
exposed = "0.46.0"
compose = "1.6.1"
coroutines = "1.8.0"
creative = "1.7.0"
dependencyversions = "0.51.0"
dokka = "1.9.0"
exposed = "0.48.0"
fastutil = "8.2.2"
fawe = "2.8.4"
junit = "5.10.0"
itemsadder = "3.6.1"
junit = "5.10.2"
jvm = "17"
kaml = "0.57.0"
kmongo = "4.8.0" #Deprecated due to MongoDB including Kotlin
kotest = "5.8.0"
kmongo = "4.11.0"
kotest = "5.8.1"
# @pin
kotlin = "1.9.23"
kt-statistics = "1.2.1"
ktor = "2.3.6"
logback = "1.4.11"
mccoroutine = "2.14.0"
mockbukkit = "3.65.0"
mockk = "1.13.8"
ktor = "2.3.9"
logback = "1.5.3"
mccoroutine = "2.15.0"
# @pin
minecraft = "1.20.4-R0.1-SNAPSHOT"
mockbukkit = "3.78.0"
mockk = "1.13.10"
modelengine = "R4.0.4"
mythic-dist = "5.6.0"
mythiccrucible = "2.0.0-SNAPSHOT"
oraxen = "1.170.0"
protocollib = "5.1.0"
reflections = "0.10.2"
serialization = "1.6.3"
sqlite-jdbc = "3.43.0.0"
vault = "1.7"
worldguard = "7.1.0-SNAPSHOT"
creative = "1.7.0"

mythic-dist = "5.6.0"
mythiccrucible = "2.0.0-SNAPSHOT"
oraxen = "1.170.0-SNAPSHOT"
itemsadder = "3.5.0b"


# Gradle deps
dokka = "1.9.0"
shadowjar = "8.1.1"
dependencyversions = "0.48.0"
sqlite-jdbc = "3.45.2.0"
userdev = "1.5.11"
vault = "1.7"
version-catalog-update = "0.8.4"
worldguard = "7.1.0-SNAPSHOT"

[libraries]
minecraft-papermc = { module = "io.papermc.paper:paper-api", version.ref = "minecraft" }
minecraft-headlib-api = "com.github.DRE2N.HeadLib:headlib-core:877e80d3b3"
minecraft-headlib-core = "de.erethon:headlib:3.0.10"
minecraft-mccoroutine = { module = "com.github.shynixn.mccoroutine:mccoroutine-bukkit-api", version.ref = "mccoroutine" }
minecraft-mccoroutine-core = { module = "com.github.shynixn.mccoroutine:mccoroutine-bukkit-core", version.ref = "mccoroutine" }
minecraft-anvilgui = { module = "net.wesjd:anvilgui", version.ref = "anvilgui" }
minecraft-mockbukkit = { module = "com.github.seeseemelk:MockBukkit-v1.20", version.ref = "mockbukkit" }

minecraft-plugin-modelengine = { module = "com.ticxo.modelengine:ModelEngine", version.ref = "modelengine" }
minecraft-plugin-protocollib = { module = "com.comphenix.protocol:ProtocolLib", version.ref = "protocollib" }
minecraft-plugin-mythic-dist = { module = "io.lumine:Mythic-Dist", version.ref = "mythic-dist" }
minecraft-plugin-mythic-crucible = { module = "io.lumine:MythicCrucible", version.ref = "mythiccrucible" }
minecraft-plugin-oraxen = { module = "io.th0rgal:oraxen", version.ref = "oraxen" }
minecraft-plugin-itemsadder = { module = "com.github.LoneDev6:api-itemsadder", version.ref = "itemsadder" }

minecraft-plugin-fawe-core = { module = "com.fastasyncworldedit:FastAsyncWorldEdit-Core", version.ref = "fawe" }
minecraft-plugin-fawe-bukkit = { module = "com.fastasyncworldedit:FastAsyncWorldEdit-Bukkit", version.ref = "fawe" }

minecraft-plugin-vault = { module = "com.github.MilkBowl:VaultAPI", version.ref = "vault" }

minecraft-plugin-worldguard = { module = "com.sk89q.worldguard:worldguard-bukkit", version.ref = "worldguard" }

creative-api = { module = "team.unnamed:creative-api", version.ref = "creative" }
creative-serializer-minecraft = { module = "team.unnamed:creative-serializer-minecraft", version.ref = "creative" }
creative-server = { module = "team.unnamed:creative-server", version.ref = "creative" }

fastutil = { module = "it.unimi.dsi:fastutil", version.ref = "fastutil" }

reflections = { module = "org.reflections:reflections", version.ref = "reflections" }

exposed-core = { module = "org.jetbrains.exposed:exposed-core", version.ref = "exposed" }
exposed-dao = { module = "org.jetbrains.exposed:exposed-dao", version.ref = "exposed" }
exposed-jdbc = { module = "org.jetbrains.exposed:exposed-jdbc", version.ref = "exposed" }
exposed-javatime = { module = "org.jetbrains.exposed:exposed-java-time", version.ref = "exposed" }

sqlite-jdbc = { module = "org.xerial:sqlite-jdbc", version.ref = "sqlite-jdbc" }

exposed-jdbc = { module = "org.jetbrains.exposed:exposed-jdbc", version.ref = "exposed" }
fastutil = { module = "it.unimi.dsi:fastutil", version.ref = "fastutil" }
gradle-dokka = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokka" }
gradle-kotlin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
gradle-shadowjar = { module = "com.github.johnrengelman:shadow", version.ref = "shadowjar" }
gradle-paperweight-userdev = { module = "io.papermc.paperweight:paperweight-userdev", version.ref = "userdev" }
kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin" }
gradle-shadowjar = { module = "com.github.johnrengelman:shadow", version.ref = "shadowjar" }
junit-bom = { module = "org.junit:junit-bom", version.ref = "junit" }
junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit" }
kermit = "co.touchlab:kermit:2.0.3"
kmongo-coroutine-serialization = { module = "org.litote.kmongo:kmongo-coroutine-serialization", version.ref = "kmongo" }
kotest-assertions = { module = "io.kotest:kotest-assertions-core", version.ref = "kotest" }
kotest-property = { module = "io.kotest:kotest-property", version.ref = "kotest" }
kotest-runner-junit5 = { module = "io.kotest:kotest-runner-junit5", version.ref = "kotest" }
kotlin-reflect = { module = "org.jetbrains.kotlin:kotlin-reflect", version.ref = "kotlin" }

kotlin-statistics = { module = "org.nield:kotlin-statistics", version.ref = "kt-statistics" }
kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin" }
kotlinx-coroutines = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutines" }
kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "coroutines" }

kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "serialization" }
kotlinx-serialization-cbor = { module = "org.jetbrains.kotlinx:kotlinx-serialization-cbor", version.ref = "serialization" }
kotlinx-serialization-hocon = { module = "org.jetbrains.kotlinx:kotlinx-serialization-hocon", version.ref = "serialization" }
kotlinx-serialization-protobuf = { module = "org.jetbrains.kotlinx:kotlinx-serialization-protobuf", version.ref = "serialization" }
kotlinx-serialization-properties = { module = "org.jetbrains.kotlinx:kotlinx-serialization-properties", version.ref = "serialization" }
kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "serialization" }
kotlinx-serialization-kaml = { module = "com.charleskorn.kaml:kaml", version.ref = "kaml" }

kotlin-statistics = { module = "org.nield:kotlin-statistics", version.ref = "kt-statistics" }

ktor-serialization = { module = "io.ktor:ktor-serialization", version.ref = "ktor" }
ktor-serialization-json = { module = "io.ktor:ktor-serialization-kotlinx-json", version.ref = "ktor" }
ktor-server-core = { module = "io.ktor:ktor-server-core", version.ref = "ktor" }
ktor-server-netty = { module = "io.ktor:ktor-server-netty", version.ref = "ktor" }

kotlinx-serialization-properties = { module = "org.jetbrains.kotlinx:kotlinx-serialization-properties", version.ref = "serialization" }
kotlinx-serialization-protobuf = { module = "org.jetbrains.kotlinx:kotlinx-serialization-protobuf", version.ref = "serialization" }
ktor-client-cio = { module = "io.ktor:ktor-client-cio", version.ref = "ktor" }
ktor-client-content-negotiation = { module = "io.ktor:ktor-client-content-negotiation", version.ref = "ktor" }
ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }
ktor-client-js = { module = "io.ktor:ktor-client-js", version.ref = "ktor" }
ktor-client-json = { module = "io.ktor:ktor-client-json", version.ref = "ktor" }
ktor-client-serialization = { module = "io.ktor:ktor-client-serialization", version.ref = "ktor" }
ktor-client-cio = { module = "io.ktor:ktor-client-cio", version.ref = "ktor" }
ktor-client-content-negotiation = { module = "io.ktor:ktor-client-content-negotiation", version.ref = "ktor" }
ktor-client-logging = { module = "io.ktor:ktor-client-logging", version.ref = "ktor" }

kermit = "co.touchlab:kermit:1.2.2"

ktor-client-serialization = { module = "io.ktor:ktor-client-serialization", version.ref = "ktor" }
ktor-serialization = { module = "io.ktor:ktor-serialization", version.ref = "ktor" }
ktor-serialization-json = { module = "io.ktor:ktor-serialization-kotlinx-json", version.ref = "ktor" }
ktor-server-core = { module = "io.ktor:ktor-server-core", version.ref = "ktor" }
ktor-server-netty = { module = "io.ktor:ktor-server-netty", version.ref = "ktor" }
logback-classic = { module = "ch.qos.logback:logback-classic", version.ref = "logback" }
kmongo-coroutine-serialization = { module = "org.litote.kmongo:kmongo-coroutine-serialization", version.ref = "kmongo" }

minecraft-anvilgui = { module = "net.wesjd:anvilgui", version.ref = "anvilgui" }
minecraft-headlib-api = "com.github.DRE2N.HeadLib:headlib-core:877e80d3b3"
minecraft-headlib-core = "de.erethon:headlib:3.0.10"
minecraft-mccoroutine = { module = "com.github.shynixn.mccoroutine:mccoroutine-bukkit-api", version.ref = "mccoroutine" }
minecraft-mccoroutine-core = { module = "com.github.shynixn.mccoroutine:mccoroutine-bukkit-core", version.ref = "mccoroutine" }
minecraft-mockbukkit = { module = "com.github.seeseemelk:MockBukkit-v1.20", version.ref = "mockbukkit" }
minecraft-papermc = { module = "io.papermc.paper:paper-api", version.ref = "minecraft" }
minecraft-plugin-fawe-bukkit = { module = "com.fastasyncworldedit:FastAsyncWorldEdit-Bukkit", version.ref = "fawe" }
minecraft-plugin-fawe-core = { module = "com.fastasyncworldedit:FastAsyncWorldEdit-Core", version.ref = "fawe" }
minecraft-plugin-itemsadder = { module = "com.github.LoneDev6:api-itemsadder", version.ref = "itemsadder" }
minecraft-plugin-modelengine = { module = "com.ticxo.modelengine:ModelEngine", version.ref = "modelengine" }
minecraft-plugin-mythic-crucible = { module = "io.lumine:MythicCrucible", version.ref = "mythiccrucible" }
minecraft-plugin-mythic-dist = { module = "io.lumine:Mythic-Dist", version.ref = "mythic-dist" }
minecraft-plugin-oraxen = { module = "io.th0rgal:oraxen", version.ref = "oraxen" }
minecraft-plugin-protocollib = { module = "com.comphenix.protocol:ProtocolLib", version.ref = "protocollib" }
minecraft-plugin-vault = { module = "com.github.MilkBowl:VaultAPI", version.ref = "vault" }
minecraft-plugin-worldguard = { module = "com.sk89q.worldguard:worldguard-bukkit", version.ref = "worldguard" }
mockk = { module = "io.mockk:mockk", version.ref = "mockk" }

kotest-runner-junit5 = { module = "io.kotest:kotest-runner-junit5", version.ref = "kotest" }
kotest-property = { module = "io.kotest:kotest-property", version.ref = "kotest" }
kotest-assertions = { module = "io.kotest:kotest-assertions-core", version.ref = "kotest" }

junit-bom = { module = "org.junit:junit-bom", version.ref = "junit" }
junit-jupiter = { module = "org.junit.jupiter:junit-jupiter", version.ref = "junit" }
reflections = { module = "org.reflections:reflections", version.ref = "reflections" }
sqlite-jdbc = { module = "org.xerial:sqlite-jdbc", version.ref = "sqlite-jdbc" }

[bundles]
minecraft = ["minecraft-headlib-api", "minecraft-mccoroutine", "minecraft-anvilgui"]
exposed = ["exposed-core", "exposed-dao", "exposed-jdbc", "exposed-javatime", "sqlite-jdbc"]
platform = [
"minecraft-headlib-core",
"minecraft-mccoroutine-core",
"minecraft-anvilgui",
"reflections",
exposed = [
"exposed-core",
"exposed-dao",
"exposed-jdbc",
"exposed-javatime",
"exposed-jdbc",
"sqlite-jdbc",
"kotlin-stdlib",
]
minecraft = [
"minecraft-anvilgui",
"minecraft-headlib-api",
"minecraft-mccoroutine",
]
platform = [
"creative-api",
"creative-serializer-minecraft",
"creative-server",
"exposed-core",
"exposed-dao",
"exposed-javatime",
"exposed-jdbc",
"kermit",
"kmongo-coroutine-serialization",
"kotlin-reflect",
"kotlin-statistics",
"kotlin-stdlib",
"kotlinx-coroutines",
"kotlinx-serialization-json",
"kotlinx-serialization-cbor",
"kotlinx-serialization-hocon",
"kotlinx-serialization-protobuf",
"kotlinx-serialization-properties",
"kotlinx-serialization-json",
"kotlinx-serialization-kaml",
"kotlin-statistics",
"ktor-serialization",
"ktor-serialization-json",
"ktor-client-core",
"kotlinx-serialization-properties",
"kotlinx-serialization-protobuf",
"ktor-client-cio",
"ktor-client-logging",
"ktor-client-content-negotiation",
"ktor-client-core",
"ktor-client-logging",
"ktor-serialization",
"ktor-serialization-json",
"logback-classic",
"kmongo-coroutine-serialization",
"creative-api",
"creative-serializer-minecraft",
"creative-server",
"minecraft-anvilgui",
"minecraft-headlib-core",
"minecraft-mccoroutine-core",
"reflections",
"sqlite-jdbc",
]



[plugins]
compose = { id = "org.jetbrains.compose", version.ref = "compose" }
dependencyversions = { id = "com.github.ben-manes.versions", version.ref = "dependencyversions" }
dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
kotlinx-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
shadowjar = { id = "com.github.johnrengelman.shadow", version.ref = "shadowjar" }
compose = { id = "org.jetbrains.compose", version.ref = "compose" }
dependencyversions = { id = "com.github.ben-manes.versions", version.ref = "dependencyversions" }
version-catalog-update = { id = "nl.littlerobots.version-catalog-update", version.ref = "version-catalog-update" }
6 changes: 3 additions & 3 deletions idofront-config/src/main/kotlin/com/mineinabyss/idofront/config/Config.kt
View file
Expand Up @@ -2,7 +2,6 @@ package com.mineinabyss.idofront.config

import kotlinx.serialization.KSerializer
import java.nio.file.Path
import java.nio.file.attribute.FileAttribute
import kotlin.io.path.*
import kotlin.properties.ReadWriteProperty
import kotlin.reflect.KProperty
Expand All @@ -19,6 +18,7 @@ class Config<T>(
val lazyLoad: Boolean,
val onFirstLoad: (T) -> Unit = {},
val onReload: (T) -> Unit = {},
val onLoad: (T) -> Unit = {},
) : ReadWriteProperty<Any?, T> {
private var loaded: T? = null
private val fileFormat = checkFormat()
Expand All @@ -38,11 +38,11 @@ class Config<T>(

fun getOrLoad(): T {
loaded?.let { return it }
return load().also(onFirstLoad)
return load().also(onFirstLoad).also(onLoad)
}

fun reload(): T {
return load().also(onReload)
return load().also(onReload).also(onLoad)
}

private fun load(): T {
Expand Down
3 changes: 2 additions & 1 deletion idofront-config/src/main/kotlin/com/mineinabyss/idofront/config/Helpers.kt
View file
@@ -1,7 +1,6 @@
package com.mineinabyss.idofront.config

import kotlinx.serialization.serializer
import org.bukkit.plugin.Plugin
import java.nio.file.Path

typealias IdofrontConfig<T> = Config<T>
Expand All @@ -16,6 +15,7 @@ inline fun <reified T> config(
mergeUpdates: Boolean = true,
preferredFormat: String = "yml",
lazyLoad: Boolean = false,
noinline onLoad: (T) -> Unit = {},
noinline onFirstLoad: (T) -> Unit = {},
noinline onReload: (T) -> Unit = {},
): Config<T> {
Expand All @@ -29,6 +29,7 @@ inline fun <reified T> config(
formats = formats,
mergeUpdates = mergeUpdates,
lazyLoad = lazyLoad,
onLoad = onLoad,
onFirstLoad = onFirstLoad,
onReload = onReload,
)
Expand Down
1 change: 1 addition & 0 deletions idofront-di/build.gradle.kts
View file
@@ -1,6 +1,7 @@
plugins {
id("com.mineinabyss.conventions.kotlin.multiplatform")
id("com.mineinabyss.conventions.publication")
id("com.mineinabyss.conventions.multiplatform.testing")
}

kotlin {
Expand Down

0 comments on commit 2c2117b

Please sign in to comment.