Add StringOrDefault type support in various constraints and config (#360)

twisti-dev · web-flow · commit 33f998f98cd6 · 2026-05-27T21:23:04.000+02:00
diff --git a/gradle.properties b/gradle.properties
@@ -7,6 +7,6 @@ org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
 javaVersion=25
 mcVersion=26.1.2
 group=dev.slne.surf.api
-version=3.16.0
+version=3.17.0
 relocationPrefix=dev.slne.surf.api.libs
 snapshot=false
diff --git a/surf-api-core/surf-api-core/api/surf-api-core.api b/surf-api-core/surf-api-core/api/surf-api-core.api
@@ -578,6 +578,22 @@ public final class dev/slne/surf/api/core/config/type/DurationOrDisabled {
 public final class dev/slne/surf/api/core/config/type/DurationOrDisabled$Companion {
 }
 
+public final class dev/slne/surf/api/core/config/type/StringOrDefault {
+	public static final field Companion Ldev/slne/surf/api/core/config/type/StringOrDefault$Companion;
+	public synthetic fun <init> (Ljava/lang/String;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public final fun component1 ()Ljava/lang/String;
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getValue ()Ljava/lang/String;
+	public fun hashCode ()I
+	public final fun or (Ljava/lang/String;)Ljava/lang/String;
+	public fun toString ()Ljava/lang/String;
+}
+
+public final class dev/slne/surf/api/core/config/type/StringOrDefault$Companion {
+	public final fun getUSE_DEFAULT ()Ldev/slne/surf/api/core/config/type/StringOrDefault;
+	public final fun of (Ljava/lang/String;)Ldev/slne/surf/api/core/config/type/StringOrDefault;
+}
+
 public abstract interface annotation class dev/slne/surf/api/core/config/type/number/BelowZeroToEmpty : java/lang/annotation/Annotation {
 }
 
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/CollectionConstraintUtils.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/CollectionConstraintUtils.kt
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/Contains.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/Contains.kt
@@ -1,5 +1,6 @@
 package dev.slne.surf.api.core.config.constraints
 
+import dev.slne.surf.api.core.config.type.StringOrDefault
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.lang.reflect.Type
@@ -23,5 +24,14 @@ annotation class Contains(val value: String) {
                 }
             }
         }
+
+        internal object FactoryStringOrDefault : Constraint.Factory<Contains, StringOrDefault?> {
+            override fun make(data: Contains, type: Type): Constraint<StringOrDefault?> = { valueOrDefault ->
+                val value = valueOrDefault?.value
+                if (value != null && !value.contains(data.value)) {
+                    throw SerializationException("String must contain '${data.value}'")
+                }
+            }
+        }
     }
 }
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/EndsWith.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/EndsWith.kt
@@ -1,5 +1,6 @@
 package dev.slne.surf.api.core.config.constraints
 
+import dev.slne.surf.api.core.config.type.StringOrDefault
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.lang.reflect.Type
@@ -23,5 +24,14 @@ annotation class EndsWith(val suffix: String) {
                 }
             }
         }
+
+        internal object FactoryStringOrDefault : Constraint.Factory<EndsWith, StringOrDefault?> {
+            override fun make(data: EndsWith, type: Type): Constraint<StringOrDefault?> = { stringOrDefault ->
+                val value = stringOrDefault?.value
+                if (value != null && !value.endsWith(data.suffix)) {
+                    throw SerializationException("String must end with '${data.suffix}'")
+                }
+            }
+        }
     }
 }
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/ExistingFile.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/ExistingFile.kt
@@ -1,5 +1,6 @@
 package dev.slne.surf.api.core.config.constraints
 
+import dev.slne.surf.api.core.config.type.StringOrDefault
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.io.File
@@ -41,12 +42,13 @@ annotation class ExistingFile {
     }
 }
 
-internal fun Any?.asPathOrNull(): Path? {
+internal tailrec fun Any?.asPathOrNull(): Path? {
     return when (this) {
         null -> null
         is Path -> this
         is File -> toPath()
         is String -> runCatching { Path.of(this) }.getOrNull()
+        is StringOrDefault -> value?.asPathOrNull()
         else -> null
     }
 }
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MaxDuration.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MaxDuration.kt
@@ -1,6 +1,7 @@
 package dev.slne.surf.api.core.config.constraints
 
 import dev.slne.surf.api.core.config.type.ConfigDuration
+import dev.slne.surf.api.core.config.type.DurationOrDisabled
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.lang.reflect.Type
@@ -25,5 +26,15 @@ annotation class MaxDuration(val seconds: Long) {
                 }
             }
         }
+
+        internal object FactoryDurationOrDisabled : Constraint.Factory<MaxDuration, DurationOrDisabled?> {
+            override fun make(data: MaxDuration, type: Type): Constraint<DurationOrDisabled?> = { durationOrDisabled ->
+                val value = durationOrDisabled?.value
+
+                if (value != null && value.inWholeSeconds > data.seconds) {
+                    throw SerializationException("Duration is too long: ${value}, expected <= ${data.seconds}s")
+                }
+            }
+        }
     }
 }
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MaxLength.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MaxLength.kt
@@ -1,5 +1,6 @@
 package dev.slne.surf.api.core.config.constraints
 
+import dev.slne.surf.api.core.config.type.StringOrDefault
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.lang.reflect.Type
@@ -24,5 +25,14 @@ annotation class MaxLength(val max: Int) {
                 }
             }
         }
+
+        internal object FactoryStringOrDefault : Constraint.Factory<MaxLength, StringOrDefault?> {
+            override fun make(data: MaxLength, type: Type): Constraint<StringOrDefault?> = { stringOrDefault ->
+                val value = stringOrDefault?.value
+                if (value != null && value.length > data.max) {
+                    throw SerializationException("String is too long: ${value.length}, expected <= ${data.max}")
+                }
+            }
+        }
     }
 }
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MaxNumber.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MaxNumber.kt
@@ -1,5 +1,7 @@
 package dev.slne.surf.api.core.config.constraints
 
+import dev.slne.surf.api.core.config.type.number.DoubleOr
+import dev.slne.surf.api.core.config.type.number.IntOr
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.lang.reflect.Type
@@ -35,5 +37,25 @@ annotation class MaxNumber(val max: Double) {
                 }
             }
         }
+
+        internal object FactoryIntOr : Constraint.Factory<MaxNumber, IntOr?> {
+            override fun make(data: MaxNumber, type: Type): Constraint<IntOr?> = { intOr ->
+                val number = intOr?.value
+
+                if (number != null && number > data.max) {
+                    throw SerializationException(type, "Number is too big: $number, expected <= ${data.max}")
+                }
+            }
+        }
+
+        internal object FactoryDoubleOr : Constraint.Factory<MaxNumber, DoubleOr?> {
+            override fun make(data: MaxNumber, type: Type): Constraint<DoubleOr?> = { doubleOr ->
+                val number = doubleOr?.value
+
+                if (number != null && number > data.max) {
+                    throw SerializationException(type, "Number is too big: $number, expected <= ${data.max}")
+                }
+            }
+        }
     }
 }
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MinDuration.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MinDuration.kt
@@ -1,6 +1,7 @@
 package dev.slne.surf.api.core.config.constraints
 
 import dev.slne.surf.api.core.config.type.ConfigDuration
+import dev.slne.surf.api.core.config.type.DurationOrDisabled
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.lang.reflect.Type
@@ -25,5 +26,15 @@ annotation class MinDuration(val seconds: Long) {
                 }
             }
         }
+
+        internal object FactoryDurationOrDisabled : Constraint.Factory<MinDuration, DurationOrDisabled?> {
+            override fun make(data: MinDuration, type: Type): Constraint<DurationOrDisabled?> = { durationOrDisabled ->
+                val value = durationOrDisabled?.value
+
+                if (value != null && value.inWholeSeconds < data.seconds) {
+                    throw SerializationException("Duration is too short: ${value}, expected >= ${data.seconds}s")
+                }
+            }
+        }
     }
 }
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MinLength.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MinLength.kt
@@ -1,5 +1,6 @@
 package dev.slne.surf.api.core.config.constraints
 
+import dev.slne.surf.api.core.config.type.StringOrDefault
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.lang.reflect.Type
@@ -23,5 +24,15 @@ annotation class MinLength(val min: Int) {
                 }
             }
         }
+
+        internal object FactoryStringOrDefault : Constraint.Factory<MinLength, StringOrDefault?> {
+            override fun make(data: MinLength, type: Type): Constraint<StringOrDefault?> = { stringOrDefault ->
+                val value = stringOrDefault?.value
+
+                if (value != null && value.length < data.min) {
+                    throw SerializationException("String is too short: ${value.length}, expected >= ${data.min}")
+                }
+            }
+        }
     }
 }
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MinNumber.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/MinNumber.kt
@@ -1,5 +1,7 @@
 package dev.slne.surf.api.core.config.constraints
 
+import dev.slne.surf.api.core.config.type.number.DoubleOr
+import dev.slne.surf.api.core.config.type.number.IntOr
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.lang.reflect.Type
@@ -35,6 +37,26 @@ annotation class MinNumber(val min: Double) {
                 }
             }
         }
+
+        internal object FactoryIntOr : Constraint.Factory<MinNumber, IntOr?> {
+            override fun make(data: MinNumber, type: Type): Constraint<IntOr?> = { intOr ->
+                val number = intOr?.value
+
+                if (number != null && number < data.min) {
+                    throw SerializationException(type, "Number is too small: $number, expected >= ${data.min}")
+                }
+            }
+        }
+
+        internal object FactoryDoubleOr : Constraint.Factory<MinNumber, DoubleOr?> {
+            override fun make(data: MinNumber, type: Type): Constraint<DoubleOr?> = { doubleOr ->
+                val number = doubleOr?.value
+
+                if (number != null && number < data.min) {
+                    throw SerializationException(type, "Number is too small: $number, expected >= ${data.min}")
+                }
+            }
+        }
     }
 }
 
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/NegativeNumber.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/NegativeNumber.kt
@@ -1,5 +1,7 @@
 package dev.slne.surf.api.core.config.constraints
 
+import dev.slne.surf.api.core.config.type.number.DoubleOr
+import dev.slne.surf.api.core.config.type.number.IntOr
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.lang.reflect.Type
@@ -21,5 +23,25 @@ annotation class NegativeNumber {
                 }
             }
         }
+
+        internal object FactoryIntOr : Constraint.Factory<NegativeNumber, IntOr?> {
+            override fun make(data: NegativeNumber, type: Type): Constraint<IntOr?> = { intOr ->
+                val value = intOr?.value
+
+                if (value != null && value >= 0) {
+                    throw SerializationException("Number must be negative: $value, expected < 0")
+                }
+            }
+        }
+
+        internal object FactoryDoubleOr : Constraint.Factory<NegativeNumber, DoubleOr?> {
+            override fun make(data: NegativeNumber, type: Type): Constraint<DoubleOr?> = { doubleOr ->
+                val value = doubleOr?.value
+
+                if (value != null && value >= 0.0) {
+                    throw SerializationException("Number must be negative: $value, expected < 0")
+                }
+            }
+        }
     }
 }
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/PositiveNumber.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/PositiveNumber.kt
@@ -1,5 +1,7 @@
 package dev.slne.surf.api.core.config.constraints
 
+import dev.slne.surf.api.core.config.type.number.DoubleOr
+import dev.slne.surf.api.core.config.type.number.IntOr
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.lang.reflect.Type
@@ -29,7 +31,27 @@ annotation class PositiveNumber {
          */
         internal object Factory : Constraint.Factory<PositiveNumber, Number?> {
             override fun make(data: PositiveNumber, type: Type): Constraint<Number?> = { number ->
-                if (number != null && number.toDouble() <= 0) {
+                if (number != null && number.toDouble() <= 0.0) {
+                    throw SerializationException("Number is not positive: $number, expected > 0")
+                }
+            }
+        }
+
+        internal object FactoryIntOr : Constraint.Factory<PositiveNumber, IntOr?> {
+            override fun make(data: PositiveNumber, type: Type): Constraint<IntOr?> = { intOr ->
+                val number = intOr?.value
+
+                if (number != null && number <= 0) {
+                    throw SerializationException("Number is not positive: $number, expected > 0")
+                }
+            }
+        }
+
+        internal object FactoryDoubleOr : Constraint.Factory<PositiveNumber, DoubleOr?> {
+            override fun make(data: PositiveNumber, type: Type): Constraint<DoubleOr?> = { doubleOr ->
+                val number = doubleOr?.value
+
+                if (number != null && number <= 0.0) {
                     throw SerializationException("Number is not positive: $number, expected > 0")
                 }
             }
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/Range.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/Range.kt
@@ -1,5 +1,7 @@
 package dev.slne.surf.api.core.config.constraints
 
+import dev.slne.surf.api.core.config.type.number.DoubleOr
+import dev.slne.surf.api.core.config.type.number.IntOr
 import org.spongepowered.configurate.objectmapping.meta.Constraint
 import org.spongepowered.configurate.serialize.SerializationException
 import java.lang.reflect.Type
@@ -27,5 +29,30 @@ annotation class Range(val min: Double, val max: Double) {
                 }
             }
         }
+
+        internal object FactoryIntOr : Constraint.Factory<Range, IntOr?> {
+            override fun make(data: Range, type: Type): Constraint<IntOr?> = { intOr ->
+                val value = intOr?.value
+
+                if (value != null) {
+                    val double = value.toDouble()
+                    if (double < data.min || double > data.max) {
+                        throw SerializationException("Number is out of range: $value, expected ${data.min}..${data.max}")
+                    }
+                }
+            }
+        }
+
+        internal object FactoryDoubleOr : Constraint.Factory<Range, DoubleOr?> {
+            override fun make(data: Range, type: Type): Constraint<DoubleOr?> = { doubleOr ->
+                val value = doubleOr?.value
+
+                if (value != null) {
+                    if (value < data.min || value > data.max) {
+                        throw SerializationException("Number is out of range: $value, expected ${data.min}..${data.max}")
+                    }
+                }
+            }
+        }
     }
 }
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/StartsWith.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/constraints/StartsWith.kt
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/serializer/SpongeConfigSerializers.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/serializer/SpongeConfigSerializers.kt
diff --git a/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/type/StringOrDefault.kt b/surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/config/type/StringOrDefault.kt

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`package dev.slne.surf.api.core.config.constraints`
`2`	`2`
	`3`	`+import dev.slne.surf.api.core.config.type.StringOrDefault`
`3`	`4`	`import org.spongepowered.configurate.objectmapping.meta.Constraint`
`4`	`5`	`import org.spongepowered.configurate.serialize.SerializationException`
`5`	`6`	`import java.lang.reflect.Type`
`@@ -23,5 +24,14 @@ annotation class Contains(val value: String) {`
`23`	`24`	`}`
`24`	`25`	`}`
`25`	`26`	`}`
	`27`	`+`
	`28`	`+ internal object FactoryStringOrDefault : Constraint.Factory<Contains, StringOrDefault?> {`
	`29`	`+ override fun make(data: Contains, type: Type): Constraint<StringOrDefault?> = { valueOrDefault ->`
	`30`	`+ val value = valueOrDefault?.value`
	`31`	`+ if (value != null && !value.contains(data.value)) {`
	`32`	`+ throw SerializationException("String must contain '${data.value}'")`
	`33`	`+ }`
	`34`	`+ }`
	`35`	`+ }`
`26`	`36`	`}`
`27`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package dev.slne.surf.api.core.config.constraints`
`2`	`2`
`3`	`3`	`import dev.slne.surf.api.core.config.type.ConfigDuration`
	`4`	`+import dev.slne.surf.api.core.config.type.DurationOrDisabled`
`4`	`5`	`import org.spongepowered.configurate.objectmapping.meta.Constraint`
`5`	`6`	`import org.spongepowered.configurate.serialize.SerializationException`
`6`	`7`	`import java.lang.reflect.Type`
`@@ -25,5 +26,15 @@ annotation class MaxDuration(val seconds: Long) {`
`25`	`26`	`}`
`26`	`27`	`}`
`27`	`28`	`}`
	`29`	`+`
	`30`	`+ internal object FactoryDurationOrDisabled : Constraint.Factory<MaxDuration, DurationOrDisabled?> {`
	`31`	`+ override fun make(data: MaxDuration, type: Type): Constraint<DurationOrDisabled?> = { durationOrDisabled ->`
	`32`	`+ val value = durationOrDisabled?.value`
	`33`	`+`
	`34`	`+ if (value != null && value.inWholeSeconds > data.seconds) {`
	`35`	`+ throw SerializationException("Duration is too long: ${value}, expected <= ${data.seconds}s")`
	`36`	`+ }`
	`37`	`+ }`
	`38`	`+ }`
`28`	`39`	`}`
`29`	`40`	`}`