Merge pull request #20 from simplecloudapp/feat/pretty-name-placeholder

feat: pretty name placeholder

Author: niklasnieberler

build.gradle.kts

@@ -28,7 +28,8 @@ subprojects {
     apply(plugin = "net.thebugmc.gradle.sonatype-central-portal-publisher")
 
     dependencies {
-        compileOnly(rootProject.libs.kotlinJvm)
+        testImplementation(rootProject.libs.kotlin.test)
+        compileOnly(rootProject.libs.kotlin.jvm)
         compileOnly(rootProject.libs.bundles.simpleCloudController)
         compileOnly(rootProject.libs.bundles.adventure)
     }

gradle/libs.versions.toml

@@ -1,11 +1,12 @@
 [versions]
-kotlin = "2.0.0"
+kotlin = "2.0.20"
 simpleCloudController = "0.0.30-dev.e3e27fc"
 sonatype-central-portal-publisher = "1.2.3"
 adventure = "4.18.0"
 
 [libraries]
-kotlinJvm = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin" }
+kotlin-jvm = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin" }
+kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
 
 simpleCloudControllerApi = { module = "app.simplecloud.controller:controller-api", version.ref = "simpleCloudController" }
 simpleCloudControllerShared = { module = "app.simplecloud.controller:controller-shared", version.ref = "simpleCloudController" }

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/pattern/ServerPatternIdentifier.kt

@@ -3,6 +3,7 @@ package app.simplecloud.plugin.api.shared.pattern
 import app.simplecloud.controller.api.ControllerApi
 import app.simplecloud.controller.shared.group.Group
 import app.simplecloud.controller.shared.server.Server
+import app.simplecloud.plugin.api.shared.pretty.StringPrettifier
 
 /**
  * @author Niklas Nieberler
@@ -42,6 +43,7 @@ class ServerPatternIdentifier(
     fun parseServerToPattern(server: Server): String {
         return this.pattern
             .replace("<group_name>", server.group)
+            .replace("<group_pretty_name>", server.properties["pretty-name"] ?: StringPrettifier.prettify(server.group))
             .replace("<id>", server.uniqueId)
             .replace("<unique_id>", server.uniqueId)
             .replace("<numerical_id>", server.numericalId.toString())

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/placeholder/single/SingleServerPlaceholderExecutor.kt

@@ -3,6 +3,7 @@ package app.simplecloud.plugin.api.shared.placeholder.single
 import app.simplecloud.controller.api.ControllerApi
 import app.simplecloud.controller.shared.server.Server
 import app.simplecloud.plugin.api.shared.placeholder.async.AsyncPlaceholder
+import app.simplecloud.plugin.api.shared.pretty.StringPrettifier
 
 /**
  * @author Niklas Nieberler
@@ -14,6 +15,9 @@ class SingleServerPlaceholderExecutor : SinglePlaceholderExecutor<Server> {
         AsyncPlaceholder("id") { it.uniqueId },
         AsyncPlaceholder("numerical_id") { it.numericalId },
         AsyncPlaceholder("group_name") { it.group },
+        AsyncPlaceholder("group_pretty_name") {
+            it.properties["pretty-name"] ?: StringPrettifier.prettify(it.group)
+        },
         AsyncPlaceholder("type") { it.type },
         AsyncPlaceholder("state") { it.state },
         AsyncPlaceholder("ip") { it.ip },

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/pretty/PrettifyCase.kt

@@ -0,0 +1,10 @@
+package app.simplecloud.plugin.api.shared.pretty
+
+enum class PrettifyCase {
+    TITLE,
+    CAMEL,
+    PASCAL,
+    SENTENCE,
+    KEBAB,
+    SNAKE
+}

plugin-shared/src/main/kotlin/app/simplecloud/plugin/api/shared/pretty/StringPrettifier.kt

@@ -0,0 +1,64 @@
+package app.simplecloud.plugin.api.shared.pretty
+
+object StringPrettifier {
+
+    /**
+     * Converts various string formats to different cases
+     */
+    fun prettify(input: String, case: PrettifyCase = PrettifyCase.TITLE): String {
+        return when (case) {
+            PrettifyCase.TITLE -> toTitleCase(input)
+            PrettifyCase.CAMEL -> toCamelCase(input)
+            PrettifyCase.PASCAL -> toPascalCase(input)
+            PrettifyCase.SENTENCE -> toSentenceCase(input)
+            PrettifyCase.KEBAB -> toKebabCase(input)
+            PrettifyCase.SNAKE -> toSnakeCase(input)
+        }
+    }
+
+    private fun toTitleCase(input: String): String {
+        return input.split(Regex("[\\s_-]"))
+            .filter { it.isNotEmpty() }
+            .joinToString(" ") { word ->
+                word.lowercase().replaceFirstChar { it.uppercase() }
+            }
+    }
+
+    private fun toCamelCase(input: String): String {
+        return input.split(Regex("[\\s_-]"))
+            .filter { it.isNotEmpty() }
+            .mapIndexed { index, word ->
+                if (index == 0) word.lowercase()
+                else word.lowercase().replaceFirstChar { it.uppercase() }
+            }
+            .joinToString("")
+    }
+
+    private fun toPascalCase(input: String): String {
+        return input.split(Regex("[\\s_-]"))
+            .filter { it.isNotEmpty() }
+            .joinToString("") { word ->
+                word.lowercase().replaceFirstChar { it.uppercase() }
+            }
+    }
+
+    private fun toSentenceCase(input: String): String {
+        return input.split(Regex("[\\s_-]"))
+            .filter { it.isNotEmpty() }
+            .joinToString(" ") { it.lowercase() }
+            .replaceFirstChar { it.uppercase() }
+    }
+
+    private fun toKebabCase(input: String): String {
+        return input.split(Regex("[\\s_]"))
+            .filter { it.isNotEmpty() }
+            .joinToString("-") { it.lowercase() }
+    }
+
+    private fun toSnakeCase(input: String): String {
+        return input.split(Regex("[\\s-]"))
+            .filter { it.isNotEmpty() }
+            .joinToString("_") { it.lowercase() }
+    }
+
+}

plugin-shared/src/test/kotlin/app/simplecloud/plugin/api/shared/pretty/StringPrettifierTest.kt

@@ -0,0 +1,65 @@
+package app.simplecloud.plugin.api.shared.pretty
+
+import kotlin.test.*
+
+class StringPrettifierTest {
+
+    @Test
+    fun testTitleCaseConversion() {
+        assertEquals("Hello World", StringPrettifier.prettify("hello-world"))
+        assertEquals("Hello World", StringPrettifier.prettify("hello_world"))
+        assertEquals("Hello World", StringPrettifier.prettify("hello world"))
+        assertEquals("Hello Beautiful World", StringPrettifier.prettify("hello-beautiful_world"))
+    }
+
+    @Test
+    fun testCamelCaseConversion() {
+        assertEquals("helloWorld", StringPrettifier.prettify("hello-world", PrettifyCase.CAMEL))
+        assertEquals("helloWorld", StringPrettifier.prettify("hello_world", PrettifyCase.CAMEL))
+        assertEquals("helloBeautifulWorld", StringPrettifier.prettify("hello beautiful world", PrettifyCase.CAMEL))
+        assertEquals("myVariableName", StringPrettifier.prettify("my-variable-name", PrettifyCase.CAMEL))
+    }
+
+    @Test
+    fun testPascalCaseConversion() {
+        assertEquals("HelloWorld", StringPrettifier.prettify("hello-world", PrettifyCase.PASCAL))
+        assertEquals("HelloWorld", StringPrettifier.prettify("hello_world", PrettifyCase.PASCAL))
+        assertEquals("HelloBeautifulWorld", StringPrettifier.prettify("hello beautiful world", PrettifyCase.PASCAL))
+        assertEquals("MyVariableName", StringPrettifier.prettify("my-variable-name", PrettifyCase.PASCAL))
+    }
+
+    @Test
+    fun testSentenceCaseConversion() {
+        assertEquals("Hello world", StringPrettifier.prettify("hello-world", PrettifyCase.SENTENCE))
+        assertEquals("Hello beautiful world", StringPrettifier.prettify("hello_beautiful_world", PrettifyCase.SENTENCE))
+        assertEquals("My variable name", StringPrettifier.prettify("my-variable-name", PrettifyCase.SENTENCE))
+    }
+
+    @Test
+    fun testKebabCaseConversion() {
+        assertEquals("hello-world", StringPrettifier.prettify("hello world", PrettifyCase.KEBAB))
+        assertEquals("hello-beautiful-world", StringPrettifier.prettify("hello_beautiful_world", PrettifyCase.KEBAB))
+        assertEquals("my-variable-name", StringPrettifier.prettify("my variable name", PrettifyCase.KEBAB))
+    }
+
+    @Test
+    fun testSnakeCaseConversion() {
+        assertEquals("hello_world", StringPrettifier.prettify("hello-world", PrettifyCase.SNAKE))
+        assertEquals("hello_beautiful_world", StringPrettifier.prettify("hello beautiful world", PrettifyCase.SNAKE))
+        assertEquals("my_variable_name", StringPrettifier.prettify("my-variable-name", PrettifyCase.SNAKE))
+    }
+
+    @Test
+    fun testEmptyStringHandling() {
+        assertEquals("", StringPrettifier.prettify(""))
+        assertEquals("", StringPrettifier.prettify("", PrettifyCase.CAMEL))
+        assertEquals("", StringPrettifier.prettify("", PrettifyCase.PASCAL))
+    }
+
+    @Test
+    fun testMultipleDelimiterHandling() {
+        assertEquals("Hello Beautiful World", StringPrettifier.prettify("hello-beautiful_world"))
+        assertEquals("helloBeautifulWorld", StringPrettifier.prettify("hello-beautiful_world", PrettifyCase.CAMEL))
+        assertEquals("HelloBeautifulWorld", StringPrettifier.prettify("hello-beautiful_world", PrettifyCase.PASCAL))
+    }
+}