release: Version 2.2.1

fix(deps): update dependency net.fabricmc.fabric-api:fabric-api to v0.86.0+1.20.1

api/build.gradle.kts

@@ -9,20 +9,14 @@ dependencies {
     compileOnly(libs.adventure.minimesssage)
     compileOnly(libs.adventure.serializer.legacy)
     compileOnly(projects.miniplaceholdersConnect)
+
     testImplementation(platform(libs.junit.bom))
     testImplementation("org.junit.jupiter:junit-jupiter")
+    testRuntimeOnly("org.junit.platform:junit-platform-launcher")
     testImplementation(libs.adventure.api)
     testImplementation(libs.adventure.minimesssage)
     testImplementation(libs.adventure.serializer.plain)
-}
-
-tasks {
-    test {
-        useJUnitPlatform()
-        testLogging {
-            events("passed", "failed")
-        }
-    }
+    testImplementation(libs.adventure.serializer.legacy)
 }
 
 jmh {
@@ -46,4 +40,13 @@ tasks {
             "https://jd.advntr.dev/text-minimessage/${libs.versions.adventure.get()}/"
         )
     }
+    compileTestJava {
+        options.encoding = Charsets.UTF_8.name()
+    }
+    test {
+        useJUnitPlatform()
+        testLogging {
+            events("passed", "failed")
+        }
+    }
 }

api/src/main/java/io/github/miniplaceholders/api/Expansion.java

@@ -35,7 +35,7 @@ import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
  * 
  * @since 1.0.0
  */
-public interface Expansion {
+public sealed interface Expansion permits ExpansionImpl {
     /**
      * Get the expansion name
      * @return the expansion name

api/src/main/java/io/github/miniplaceholders/api/ExpansionImpl.java

@@ -147,7 +147,7 @@ final class ExpansionImpl implements Expansion {
             nonNullOrEmptyString(key, "Placeholder key");
             requireNonNull(audiencePlaceholder, "the audience placeholder cannot be null");
 
-            if (this.audiencePlaceholders == null) this.audiencePlaceholders = new HashSet<>(5);
+            if (this.audiencePlaceholders == null) this.audiencePlaceholders = new HashSet<>();
 
             this.audiencePlaceholders.add(Tags.single(expansionName+key, audiencePlaceholder));
             return this;
@@ -158,7 +158,7 @@ final class ExpansionImpl implements Expansion {
             nonNullOrEmptyString(key, "Placeholder key");
             requireNonNull(relationalPlaceholder, "the relational placeholder cannot be null");
 
-            if (this.relationalPlaceholders == null) this.relationalPlaceholders = new HashSet<>(4);
+            if (this.relationalPlaceholders == null) this.relationalPlaceholders = new HashSet<>();
 
             this.relationalPlaceholders.add(Tags.relational(expansionName+"rel_"+key, relationalPlaceholder));
             return this;
@@ -169,7 +169,7 @@ final class ExpansionImpl implements Expansion {
             nonNullOrEmptyString(key, "Placeholder key");
             requireNonNull(function, "the global placeholder cannot be null");
 
-            if(this.globalPlaceholders == null) this.globalPlaceholders = TagResolver.builder();
+            if (this.globalPlaceholders == null) this.globalPlaceholders = TagResolver.builder();
 
             this.globalPlaceholders.tag(expansionName+key, function);
             return this;
@@ -180,7 +180,7 @@ final class ExpansionImpl implements Expansion {
             nonNullOrEmptyString(key, "Placeholder key");
             requireNonNull(tag, "the tag cannot be null");
 
-            if(this.globalPlaceholders == null) this.globalPlaceholders = TagResolver.builder();
+            if (this.globalPlaceholders == null) this.globalPlaceholders = TagResolver.builder();
 
             this.globalPlaceholders.tag(expansionName+key, tag);
             return this;
@@ -212,10 +212,11 @@ final class ExpansionImpl implements Expansion {
     }
 
     @Override
-    public boolean equals(Object o){
-        if (this==o) return true;
-        if (o == null || o.getClass() != ExpansionImpl.class) return false;
-        return ((ExpansionImpl)o).name.equals(this.name);
+    public boolean equals(final Object o) {
+        if (this == o) return true;
+        if (!(o instanceof Expansion that)) return false;
+
+        return that.name().equalsIgnoreCase(this.name());
     }
 
     @Override

api/src/main/java/io/github/miniplaceholders/api/MiniPlaceholders.java

@@ -1,17 +1,16 @@
 package io.github.miniplaceholders.api;
 
+import io.github.miniplaceholders.api.enums.Platform;
+import io.github.miniplaceholders.connect.InternalPlatform;
+import net.kyori.adventure.audience.Audience;
+import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
 import java.util.Objects;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 
-import io.github.miniplaceholders.api.enums.Platform;
-import org.jetbrains.annotations.NotNull;
-
-import io.github.miniplaceholders.connect.InternalPlatform;
-import net.kyori.adventure.audience.Audience;
-import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
-import org.jetbrains.annotations.Nullable;
-
 import static io.github.miniplaceholders.api.utils.Resolvers.applyIfNotEmpty;
 import static java.util.Objects.requireNonNull;
 

api/src/main/java/io/github/miniplaceholders/api/Tags.java

@@ -15,7 +15,7 @@ import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue;
 import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
 
 final class Tags {
-    private Tags(){}
+    private Tags() {}
 
     static Relational relational(@NotNull final String name, @NotNull final RelationalPlaceholder relationalPlaceholder){
         return new Tags.Relational(name, relationalPlaceholder);
@@ -35,7 +35,7 @@ final class Tags {
         }
 
         TagResolver of(@NotNull final Audience audience, @NotNull final Audience otherAudience){
-            return new TagResolver(){
+            return new TagResolver() {
                 @Override
                 public @Nullable Tag resolve(@NotNull String name, @NotNull ArgumentQueue arguments,
                         @NotNull Context ctx) throws ParsingException {
@@ -53,10 +53,10 @@ final class Tags {
         }
 
         @Override
-        public boolean equals(Object o){
-            if(o == this) return true;
-            if(!(o instanceof Relational)) return false;
-            return ((Relational)o).key.equals(this.key);
+        public boolean equals(final Object o) {
+            if (o == this) return true;
+            if (!(o instanceof final Relational that)) return false;
+            return that.key.equalsIgnoreCase(this.key);
         }
 
         @Override
@@ -93,10 +93,10 @@ final class Tags {
         }
 
         @Override
-        public boolean equals(Object o){
-            if(o == this) return true;
-            if(!(o instanceof Single)) return false;
-            return ((Single)o).key.equals(this.key);
+        public boolean equals(final Object o) {
+            if (o == this) return true;
+            if (!(o instanceof final Single that)) return false;
+            return that.key.equalsIgnoreCase(this.key);
         }
 
         @Override

api/src/main/java/io/github/miniplaceholders/api/utils/LegacyUtils.java

@@ -1,6 +1,8 @@
 package io.github.miniplaceholders.api.utils;
 
 import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.minimessage.Context;
+import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
 import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -25,20 +27,89 @@ public final class LegacyUtils {
             .build();
 
     /**
-     * Parse a string with possible legacy symbols
+     * Parse a string with possible legacy Ampersand/Section symbols
+     * <br>
+     * <p><b>
+     * This method should only be used in case a String is provided from a legacy plugin/mod
+     * or legacy source, where it is very likely to get a legacy string.
+     * It is not recommended to use this method regularly in any sense
+     * </b></p>
      *
      * @param string the string
      * @return a parsed string
      * @since 1.0.0
      */
     public static @NotNull Component parsePossibleLegacy(@Nullable String string) {
-        if (string == null || string.isBlank()) return Component.empty();
-        if (string.indexOf('&') != 0) {
-            return miniMessage().deserialize(
-                    miniMessage().serialize(LEGACY_HEX_SERIALIZER.deserialize(string))
-            );
-        } else {
+        if (string == null || string.isEmpty()) return Component.empty();
+        if (string.indexOf(LegacyComponentSerializer.SECTION_CHAR) != -1) {
+            string = string.replace(LegacyComponentSerializer.SECTION_CHAR, LegacyComponentSerializer.AMPERSAND_CHAR);
+        }
+        if (string.indexOf(LegacyComponentSerializer.AMPERSAND_CHAR) == -1) {
             return miniMessage().deserialize(string);
         }
+        return miniMessage().deserialize(
+                miniMessage().serialize(LEGACY_HEX_SERIALIZER.deserialize(string))
+                        .replace("\\<", "<")
+                        .replace("\\>", ">")
+        );
+    }
+
+    /**
+     * Parse a string with possible legacy Ampersand/Section symbols
+     * using a parsing Context
+     * <p><b>
+     * This method should only be used in case a String is provided from a legacy plugin/mod
+     * or legacy source, where it is very likely to get a legacy string.
+     * It is not recommended to use this method regularly in any sense
+     * </b></p>
+     *
+     * @param string  the string
+     * @param context the provided parsing context
+     * @return a parsed string
+     * @since 2.2.1
+     */
+    public static @NotNull Component parsePossibleLegacy(@Nullable String string, @NotNull final Context context) {
+        if (string == null || string.isEmpty()) return Component.empty();
+        if (string.indexOf(LegacyComponentSerializer.SECTION_CHAR) != -1) {
+            string = string.replace(LegacyComponentSerializer.SECTION_CHAR, LegacyComponentSerializer.AMPERSAND_CHAR);
+        }
+        if (string.indexOf(LegacyComponentSerializer.AMPERSAND_CHAR) == -1) {
+            return context.deserialize(string);
+        }
+        return context.deserialize(
+                miniMessage().serialize(LEGACY_HEX_SERIALIZER.deserialize(string))
+                        .replace("\\<", "<")
+                        .replace("\\>", ">")
+        );
+    }
+
+    /**
+     * Parse a string with possible legacy Ampersand/Section symbols
+     * using the provided resolver
+     * <p><b>
+     * This method should only be used in case a String is provided from a legacy plugin/mod
+     * or legacy source, where it is very likely to get a legacy string.
+     * It is not recommended to use this method regularly in any sense
+     * </b></p>
+     *
+     * @param string   the string
+     * @param resolver a resolver
+     * @return a parsed string
+     * @since 2.2.1
+     */
+    public static @NotNull Component parsePossibleLegacy(@Nullable String string, @NotNull final TagResolver resolver) {
+        if (string == null || string.isEmpty()) return Component.empty();
+        if (string.indexOf(LegacyComponentSerializer.SECTION_CHAR) != -1) {
+            string = string.replace(LegacyComponentSerializer.SECTION_CHAR, LegacyComponentSerializer.AMPERSAND_CHAR);
+        }
+        if (string.indexOf(LegacyComponentSerializer.AMPERSAND_CHAR) == -1) {
+            return miniMessage().deserialize(string, resolver);
+        }
+        return miniMessage().deserialize(
+                miniMessage().serialize(LEGACY_HEX_SERIALIZER.deserialize(string))
+                        .replace("\\<", "<")
+                        .replace("\\>", ">"),
+                resolver
+        );
     }
 }

api/src/main/java/module-info.java

@@ -1,11 +1,13 @@
 /** MiniPlaceholders API Module */
 open module io.github.miniplaceholders.api {
+    requires io.github.miniplaceholders.connect;
+
     requires net.kyori.adventure;
     requires net.kyori.adventure.text.minimessage;
-    requires net.kyori.examination.api;
-    requires static org.jetbrains.annotations;
-    requires io.github.miniplaceholders.connect;
     requires net.kyori.adventure.text.serializer.legacy;
+    requires net.kyori.examination.api;
+
+    requires static org.jetbrains.annotations;
 
     exports io.github.miniplaceholders.api;
     exports io.github.miniplaceholders.api.enums;

api/src/test/java/io/github/miniplaceholders/test/LegacyTest.java

@@ -0,0 +1,20 @@
+package io.github.miniplaceholders.test;
+
+import io.github.miniplaceholders.api.utils.LegacyUtils;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+class LegacyTest {
+    @Test
+    void testLegacyParsing() {
+        final String string = "<rainbow>hello... i &8hate legacy format §bso much";
+        final Component parsed = LegacyUtils.parsePossibleLegacy(string);
+        final String result = PlainTextComponentSerializer.plainText().serialize(parsed);
+        final String expected = "hello... i hate legacy format so much";
+
+        assertEquals(expected, result);
+    }
+}

build-logic/settings.gradle.kts

@@ -12,4 +12,8 @@ dependencyResolutionManagement {
             from(files("../gradle/libs.versions.toml"))
         }
     }
+}
+
+plugins {
+    id("org.gradle.toolchains.foojay-resolver-convention") version "0.6.0"
 }

build-logic/src/main/kotlin/extensions.kt

@@ -4,5 +4,4 @@ import org.gradle.configurationcache.extensions.capitalized
 val Project.capitalizeName: String
     get() = this.name.substring(17).capitalized()
 
-val Project.simpleName: String
-    get() = this.name.substring(17)
+fun Project.simpleName(): String = this.name.substring(17)

build-logic/src/main/kotlin/miniplaceholders.auto.module.gradle.kts

@@ -2,8 +2,10 @@ plugins {
     id("miniplaceholders.base")
 }
 
-tasks.jar {
-    manifest {
-        attributes("Automatic-Module-Name" to "io.github.miniplaceholders.${project.simpleName}")
+tasks {
+    jar {
+        manifest {
+            attributes("Automatic-Module-Name" to "io.github.miniplaceholders.${project.simpleName()}")
+        }
     }
 }

build-logic/src/main/kotlin/miniplaceholders.base.gradle.kts

@@ -20,4 +20,9 @@ tasks {
     }
 }
 
-java.toolchain.languageVersion.set(JavaLanguageVersion.of(17))
+java{
+    toolchain{
+        languageVersion.set(JavaLanguageVersion.of(17))
+        vendor.set(JvmVendorSpec.ADOPTIUM)
+    }
+}

build-logic/src/main/kotlin/miniplaceholders.shadow.gradle.kts

@@ -10,7 +10,7 @@ tasks {
         duplicatesStrategy = DuplicatesStrategy.EXCLUDE
         relocate("net.william278.desertwell", "io.github.miniplaceholders.libs.desertwell")
         relocate("cloud.commandframework", "io.github.miniplaceholders.libs.cloud")
-        if (project.simpleName != "sponge") {
+        if (project.simpleName() != "sponge") {
             relocate("io.leangen.geantyref", "io.github.miniplaceholders.libs.geantyref")
         }
         destinationDirectory.set(file("${project.rootDir}/jar"))

build.gradle.kts

@@ -1,5 +1,5 @@
 plugins {
-    kotlin("jvm") version "1.8.21" apply false
+    kotlin("jvm") version "1.9.0" apply false
 }
 
 tasks {

common/build.gradle.kts

@@ -16,7 +16,7 @@ dependencies {
     compileOnly(libs.adventure.minimesssage)
 }
 
-blossom{
+blossom {
     replaceToken("{version}", project.version)
     replaceTokenIn("src/main/java/io/github/miniplaceholders/common/PluginConstants.java")
 }

gradle.properties

@@ -1,5 +1,5 @@
 group = io.github.miniplaceholders
-version = 2.2.0
+version = 2.2.1
 description = MiniMessage Component-based Placeholders for Paper, Folia, Fabric, Sponge, velocity and Krypton platforms
 
 org.gradle.jvmargs=-Xmx2G

gradle/libs.versions.toml

@@ -3,27 +3,27 @@ metadata.format.version = "1.1"
 [versions]
 
 velocity = "3.2.0-SNAPSHOT"
-paper = "1.19.4-R0.1-SNAPSHOT"
-krypton = "cbfaff4aa4"
-minecraft = "1.19.4"
+paper = "1.20.1-R0.1-SNAPSHOT"
+krypton = "7796647145"
+minecraft = "1.20.1"
 
 runtask = "2.1.0"
-pluginyml = "0.5.3"
+pluginyml = "0.6.0"
 userdev = "1.5.5"
 blossom = "1.3.1"
-indra = "3.0.1"
+indra = "3.1.2"
 shadow = "8.1.1"
 jmh = "0.7.1"
-dokka = "1.8.10"
+dokka = "1.8.20"
 
 cloud = "1.8.3"
-adventure = "4.13.1"
-adventurefabric = "5.8.0"
+adventure = "4.14.0"
+adventurefabric = "5.9.0"
 brigadier = "1.0.500"
-kotlin="1.8.21"
+kotlin="1.9.0"
 
-fabric-api = "0.80.1+1.20"
-fabric-loader = "0.14.19"
+fabric-api = "0.86.0+1.20.1"
+fabric-loader = "0.14.21"
 
 desertwell = "2.0.4"
 
@@ -60,7 +60,7 @@ plugin-shadow = { group = "com.github.johnrengelman", name = "shadow", version.r
 plugin-kotlin =  { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 plugin-indra-common = { module = "net.kyori:indra-common", version.ref = "indra" }
 plugin-indra-spotless = { module = "net.kyori:indra-licenser-spotless", version.ref = "indra" }
-plugin-dokka = "org.jetbrains.dokka:dokka-gradle-plugin:1.8.10"
+plugin-dokka = "org.jetbrains.dokka:dokka-gradle-plugin:1.8.20"
 
 desertwell = { group = "net.william278", name = "DesertWell", version.ref = "desertwell" }
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
 networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -130,10 +130,13 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.

paper/build.gradle.kts

@@ -14,7 +14,7 @@ dependencies {
 
 tasks {
     runServer {
-        minecraftVersion("1.19.4")
+        minecraftVersion("1.20.1")
     }
     processResources {
         filesMatching("paper-plugin.yml") {

settings.gradle.kts

@@ -30,9 +30,9 @@ dependencyResolutionManagement {
 }
 
 plugins {
-    id("fabric-loom") version "1.2.6"
+    id("fabric-loom") version "1.3.8"
     id("org.spongepowered.gradle.plugin") version "2.1.1"
-    id("org.gradle.toolchains.foojay-resolver-convention") version "0.5.0"
+    id("org.gradle.toolchains.foojay-resolver-convention") version "0.6.0"
 }
 
 arrayOf(