Refactor/refactor (#220)

Author: twisti-dev

gradle.properties

@@ -7,6 +7,6 @@ org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
 javaVersion=25
 mcVersion=1.21.11
 group=dev.slne.surf
-version=1.21.11-2.58.0
+version=1.21.11-2.59.0
 relocationPrefix=dev.slne.surf.surfapi.libs
 snapshot=false

gradle/libs.versions.toml

@@ -45,6 +45,7 @@ gson = "2.13.2"
 commons-lang3 = "3.20.0"
 commons-text = "1.15.0"
 commons-math4-core = "4.0-beta1"
+commons-math3 = "3.6.1"
 plugin-yml-paper = "0.8.0"
 spongepowered-math = "2.0.1"
 fastutil = "8.5.18"
@@ -139,6 +140,7 @@ gson = { module = "com.google.code.gson:gson", version.ref = "gson" }
 commons-lang3 = { module = "org.apache.commons:commons-lang3", version.ref = "commons-lang3" }
 commons-text = { module = "org.apache.commons:commons-text", version.ref = "commons-text" }
 commons-math4-core = { module = "org.apache.commons:commons-math4-core", version.ref = "commons-math4-core" }
+commons-math3 = { module = "org.apache.commons:commons-math3", version.ref = "commons-math3" }
 spongepowered-math = { module = "org.spongepowered:math", version.ref = "spongepowered-math" }
 fastutil = { module = "it.unimi.dsi:fastutil", version.ref = "fastutil" }
 okhttp = { module = "com.squareup.okhttp3:okhttp", version.ref = "okhttp" }

surf-api-bukkit/surf-api-bukkit-server/build.gradle.kts

@@ -44,6 +44,7 @@ dependencies {
     paperLibrary(libs.flogger)
     paperLibrary(libs.flogger.slf4j.backend)
     paperLibrary(libs.commons.math4.core)
+    paperLibrary(libs.commons.math3)
     paperLibrary(libs.aide.reflection)
     api(libs.mccoroutine.folia.api)
     api(libs.mccoroutine.folia.core)

surf-api-core/surf-api-core-api/api/surf-api-core-api.api

@@ -19,6 +19,7 @@ dependencies {
     api(libs.configurate.kotlin)
     compileOnlyApi(libs.flogger)
     compileOnlyApi(libs.commons.math4.core)
+    compileOnlyApi(libs.commons.math3)
     compileOnlyApi(libs.aide.reflection)
     api(libs.glm)
 

surf-api-core/surf-api-core-api/build.gradle.kts

@@ -21,17 +21,17 @@ interface SurfCoreApi {
      */
     fun getPlayer(playerUuid: UUID): Any?
 
-    companion object {
+    companion object : SurfCoreApi by surfCoreApi {
 
         /**
          * The instance of the SurfCoreApi.
          */
         @JvmStatic
-        val instance = requiredService<SurfCoreApi>()
+        val instance = surfCoreApi
     }
 }
 
 /**
  * The instance of the SurfCoreApi.
  */
-val surfCoreApi get() = SurfCoreApi.instance
+val surfCoreApi = requiredService<SurfCoreApi>()

surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/SurfCoreApi.kt

@@ -1,5 +1,6 @@
 package dev.slne.surf.surfapi.core.api.config
 
+import dev.slne.surf.surfapi.core.api.config.manager.DazzlConfDeprecationMessageHolder
 import dev.slne.surf.surfapi.core.api.config.manager.PreferUsingSpongeConfigOverDazzlConf
 import dev.slne.surf.surfapi.core.api.config.manager.SpongeConfigManager
 import dev.slne.surf.surfapi.core.api.util.requiredService
@@ -21,6 +22,7 @@ interface SurfConfigApi {
      * @return An instance of the configuration class [C].
      */
     @PreferUsingSpongeConfigOverDazzlConf
+    @Deprecated(message = DazzlConfDeprecationMessageHolder.MESSAGE, level = DeprecationLevel.ERROR)
     fun <C> createDazzlConfig(
         configClass: Class<C>,
         configFolder: Path,
@@ -35,6 +37,7 @@ interface SurfConfigApi {
      * @return An instance of the configuration class [C].
      */
     @PreferUsingSpongeConfigOverDazzlConf
+    @Deprecated(message = DazzlConfDeprecationMessageHolder.MESSAGE, level = DeprecationLevel.ERROR)
     fun <C> getDazzlConfig(configClass: Class<C>): C
 
     /**
@@ -45,6 +48,7 @@ interface SurfConfigApi {
      * @return The reloaded instance of the configuration class [C].
      */
     @PreferUsingSpongeConfigOverDazzlConf
+    @Deprecated(message = DazzlConfDeprecationMessageHolder.MESSAGE, level = DeprecationLevel.ERROR)
     fun <C> reloadDazzlConfig(configClass: Class<C>): C
 
     /**
@@ -134,18 +138,18 @@ interface SurfConfigApi {
      */
     fun <C> getSpongeConfigManagerForConfig(configClass: Class<C>): SpongeConfigManager<C>
 
-    companion object {
+    companion object: SurfConfigApi by surfConfigApi {
         /**
          * Retrieves the singleton instance of [SurfConfigApi].
          */
-        val instance = requiredService<SurfConfigApi>()
+        val instance = surfConfigApi
     }
 }
 
 /**
  * Retrieves the singleton instance of [SurfConfigApi].
  */
-val surfConfigApi get() = SurfConfigApi.instance
+val surfConfigApi = requiredService<SurfConfigApi>()
 
 /**
  * Creates a DazzlConf configuration using a reified type.
@@ -156,6 +160,8 @@ val surfConfigApi get() = SurfConfigApi.instance
  * @return An instance of the configuration class [C].
  */
 @PreferUsingSpongeConfigOverDazzlConf
+@Deprecated(message = DazzlConfDeprecationMessageHolder.MESSAGE, level = DeprecationLevel.ERROR)
+@Suppress("DEPRECATION_ERROR")
 inline fun <reified C> SurfConfigApi.createDazzlConfig(
     configFolder: Path,
     configFileName: @YamlConfigFileNamePattern String,
@@ -168,6 +174,8 @@ inline fun <reified C> SurfConfigApi.createDazzlConfig(
  * @return An instance of the configuration class [C].
  */
 @PreferUsingSpongeConfigOverDazzlConf
+@Deprecated(message = DazzlConfDeprecationMessageHolder.MESSAGE, level = DeprecationLevel.ERROR)
+@Suppress("DEPRECATION_ERROR")
 inline fun <reified C> SurfConfigApi.getDazzlConfig() = getDazzlConfig(C::class.java)
 
 /**
@@ -177,6 +185,8 @@ inline fun <reified C> SurfConfigApi.getDazzlConfig() = getDazzlConfig(C::class.
  * @return The reloaded instance of the configuration class [C].
  */
 @PreferUsingSpongeConfigOverDazzlConf
+@Deprecated(message = DazzlConfDeprecationMessageHolder.MESSAGE, level = DeprecationLevel.ERROR)
+@Suppress("DEPRECATION_ERROR")
 inline fun <reified C> SurfConfigApi.reloadDazzlConfig() = reloadDazzlConfig(C::class.java)
 
 /**

surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/config/SurfConfigApi.kt

@@ -3,6 +3,7 @@ package dev.slne.surf.surfapi.core.api.config.manager
 import dev.slne.surf.surfapi.core.api.config.YamlConfigFileNamePattern
 import dev.slne.surf.surfapi.core.api.config.serializer.DefaultDazzlConfSerializers
 import dev.slne.surf.surfapi.core.api.util.logger
+import dev.slne.surf.surfapi.shared.api.util.InternalSurfApi
 import space.arim.dazzleconf.ConfigurationOptions
 import space.arim.dazzleconf.error.ConfigFormatSyntaxException
 import space.arim.dazzleconf.error.InvalidConfigException
@@ -16,12 +17,19 @@ import java.nio.file.Path
 import java.util.concurrent.TimeUnit
 
 @RequiresOptIn(
-    level = RequiresOptIn.Level.WARNING,
-    message = "Prefer using Sponge's Configurate library over DazzlConf"
+    level = RequiresOptIn.Level.ERROR,
+    message = DazzlConfDeprecationMessageHolder.MESSAGE
 )
 @Retention(AnnotationRetention.BINARY)
 @Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION)
-annotation class PreferUsingSpongeConfigOverDazzlConf
+annotation class PreferUsingSpongeConfigOverDazzlConf {
+}
+
+@InternalSurfApi
+object DazzlConfDeprecationMessageHolder {
+    const val MESSAGE =
+        "Prefer using Sponge's Configurate library over DazzlConf. DazzlConf will be removed in a future release. If you need to use DazzlConf, please contact the developers to discuss your use case."
+}
 
 /**
  * Manages configurations using the DazzlConf library, including loading, saving, and reloading configurations.
@@ -31,6 +39,7 @@ annotation class PreferUsingSpongeConfigOverDazzlConf
  * @property config The current configuration instance, or `null` if not yet loaded.
  */
 @PreferUsingSpongeConfigOverDazzlConf
+@Deprecated(message = DazzlConfDeprecationMessageHolder.MESSAGE, level = DeprecationLevel.ERROR)
 class DazzlConfConfigManager<C> private constructor(private val helper: ConfigurationHelper<C>) {
     @Volatile
     var config: C? = null
@@ -102,6 +111,9 @@ class DazzlConfConfigManager<C> private constructor(private val helper: Configur
          * @return A new instance of [DazzlConfConfigManager].
          */
         @JvmStatic
+        @Deprecated(message = DazzlConfDeprecationMessageHolder.MESSAGE, level = DeprecationLevel.ERROR)
+        @PreferUsingSpongeConfigOverDazzlConf
+        @Suppress("DEPRECATION_ERROR")
         fun <C> create(
             configClass: Class<C>,
             configFolder: Path,

surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/config/manager/DazzlConfConfigManager.kt

@@ -4,7 +4,6 @@ import dev.slne.surf.surfapi.core.api.config.JsonConfigFileNamePattern
 import dev.slne.surf.surfapi.core.api.config.YamlConfigFileNamePattern
 import dev.slne.surf.surfapi.core.api.config.serializer.SpongeConfigSerializers
 import dev.slne.surf.surfapi.core.api.util.logger
-import org.jetbrains.annotations.Contract
 import org.spongepowered.configurate.ConfigurateException
 import org.spongepowered.configurate.ConfigurationNode
 import org.spongepowered.configurate.ScopedConfigurationNode
@@ -15,6 +14,7 @@ import org.spongepowered.configurate.serialize.SerializationException
 import org.spongepowered.configurate.yaml.NodeStyle
 import org.spongepowered.configurate.yaml.YamlConfigurationLoader
 import java.io.Serial
+import java.io.UncheckedIOException
 import java.nio.file.Path
 
 /**
@@ -24,7 +24,7 @@ import java.nio.file.Path
  * @param C The type of the configuration class.
  * @property config The current configuration instance.
  */
-class SpongeConfigManager<C> @Contract(pure = true) private constructor(
+class SpongeConfigManager<C> private constructor(
     private val configClass: Class<C>,
     @JvmField @field:Volatile var config: C,
     private val loader: ConfigurationLoader<out ConfigurationNode>,
@@ -34,8 +34,9 @@ class SpongeConfigManager<C> @Contract(pure = true) private constructor(
     /**
      * Saves the current configuration to the file.
      *
-     * @throws RuntimeException if an I/O error or serialization error occurs.
+     * @throws UncheckedIOException if an I/O error or serialization error occurs.
      */
+    @Throws(UncheckedIOException::class)
     fun save() {
         try {
             node.set(configClass, config)
@@ -44,15 +45,15 @@ class SpongeConfigManager<C> @Contract(pure = true) private constructor(
             log.atSevere()
                 .withCause(e)
                 .log("Failed to save config")
-            throw RuntimeException(e)
+            throw UncheckedIOException(e)
         }
     }
 
     /**
      * Reloads the configuration from the file. If loading fails, the current configuration remains unchanged.
      *
      * @return The reloaded configuration instance.
-     * @throws RuntimeException if a critical error occurs during reload.
+     * @throws UncheckedIOException if an I/O error occurs during reload.
      */
     fun reloadFromFile(): C {
         try {
@@ -74,7 +75,7 @@ class SpongeConfigManager<C> @Contract(pure = true) private constructor(
             log.atSevere()
                 .withCause(e)
                 .log("Failed to reload config")
-            throw RuntimeException(e)
+            throw UncheckedIOException(e)
         }
     }
 

surf-api-core/surf-api-core-api/src/main/kotlin/dev/slne/surf/surfapi/core/api/config/manager/SpongeConfigManager.kt

@@ -1,15 +1,14 @@
 package dev.slne.surf.surfapi.core.api.config.serializer
 
 import dev.slne.surf.surfapi.core.api.config.manager.PreferUsingSpongeConfigOverDazzlConf
-import dev.slne.surf.surfapi.core.api.messages.Colors
+import dev.slne.surf.surfapi.core.api.minimessage.SurfMiniMessageHolder
 import net.kyori.adventure.text.Component
-import net.kyori.adventure.text.format.TextColor
 import net.kyori.adventure.text.minimessage.MiniMessage
 import net.kyori.adventure.text.minimessage.ParsingException
-import net.kyori.adventure.text.minimessage.tag.Tag
 import space.arim.dazzleconf.serialiser.Decomposer
 import space.arim.dazzleconf.serialiser.FlexibleType
 import space.arim.dazzleconf.serialiser.ValueSerialiser
+import java.util.concurrent.CopyOnWriteArrayList
 
 /**
  * Default serializers for DazzlConf configuration files. Provides support for custom types such as Adventure [Component].
@@ -20,7 +19,11 @@ object DefaultDazzlConfSerializers {
     /**
      * The default list of serializers used in DazzlConf configurations.
      */
-    val DEFAULTS = mutableListOf<ValueSerialiser<*>>(ComponentSerializer())
+    val DEFAULTS = CopyOnWriteArrayList<ValueSerialiser<*>>()
+
+    init {
+        DEFAULTS.add(ComponentSerializer())
+    }
 
     /**
      * Serializer for [Component] objects in DazzlConf configurations.
@@ -29,7 +32,7 @@ object DefaultDazzlConfSerializers {
         override fun getTargetClass() = Component::class.java
         override fun deserialise(flexibleType: FlexibleType): Component {
             try {
-                return miniMessage.deserialize(flexibleType.string)
+                return SurfMiniMessageHolder.miniMessage().deserialize(flexibleType.string)
             } catch (e: ParsingException) {
                 throw flexibleType.badValueExceptionBuilder()
                     .message(
@@ -45,48 +48,24 @@ object DefaultDazzlConfSerializers {
         }
 
         override fun serialise(value: Component, decomposer: Decomposer?) =
-            miniMessage.serialize(value)
+            SurfMiniMessageHolder.miniMessage().serialize(value)
 
         companion object {
-            private val builder = MiniMessage.builder()
-                .editTags {
-                    val tags = mapOf(
-                        "primary" to Colors.PRIMARY,
-                        "secondary" to Colors.SECONDARY,
-                        "info" to Colors.INFO,
-                        "success" to Colors.SUCCESS,
-                        "warning" to Colors.WARNING,
-                        "error" to Colors.ERROR,
-                        "variable_key" to Colors.VARIABLE_KEY,
-                        "variable_value" to Colors.VARIABLE_VALUE,
-                        "spacer" to Colors.SPACER,
-                        "dark_spacer" to Colors.DARK_SPACER,
-                        "prefix_color" to Colors.PREFIX_COLOR
-                    )
-
-                    tags.forEach { (tag, color) ->
-                        it.tag(tag) { _, _ -> colorTag(color) }
-                    }
-                }
-
             @JvmStatic
-            var miniMessage: MiniMessage = builder.build()
-                get() {
-                    if (modified) {
-                        field = builder.build()
-                        modified = false
-                    }
-
-                    return field
-                }
-                private set
-            private var modified = false
-
-            private fun colorTag(color: TextColor) = Tag.styling { it.color(color) }
+            @Deprecated(
+                message = "Configs now use the MiniMessage instance supplied by the SurfMiniMessageHolder",
+                replaceWith = ReplaceWith(
+                    "SurfMiniMessageHolder.miniMessage()",
+                    "dev.slne.surf.surfapi.core.api.minimessage.SurfMiniMessageHolder"
+                )
+            )
+            val miniMessage: MiniMessage = SurfMiniMessageHolder.miniMessage()
 
+            @Deprecated(
+                message = "Cannot customize MiniMessage anymore. If you need custom tags, use your own MiniMessage instance instead and use a String in the config, then parse it manually (Consider caching the parsed value in a lazy value though).",
+                level = DeprecationLevel.ERROR
+            )
             fun customizeMiniMessage(modifier: (MiniMessage.Builder) -> Unit) {
-                modifier(builder)
-                modified = true
             }
         }
     }