Prepare release of version v1.9.0 (#22)

* Add test for the new provider

* Fix tests

* Move TestMapProvider class

* Update dependency gradle to v8.14.1

* Update dependency gradle to v8.14.2 (#16)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Add builder pattern to create a BaseMap reference (#17)

* Move provider part into a dedicated package

* Update import

* Add builder pattern for the BaseMap class

* Add static method to access the new builder

* Add modern variant of the FileHandler (#15)

* Deprecate FileHandler and GsonFileHandler; introduce ModernFileHandler and ModernGsonFileHandler

* Update ModernFileHandler and ModernGsonFileHandler to remove unused parameters and increment version to 1.9.0; add unit tests for ModernFileHandler

* Update version to 1.9.0 in build.gradle.kts

* Cleanup empty lines

---------

Co-authored-by: theEvilReaper <steffenwx@gmail.com>

* Update readme content

* Update dependency gradle to v8.14.3 (#18)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

* Remove refresh method (#21)

* Deprecate static methods (#20)

* Add 1.21.5 support (#19)

* Switch to a 1.21.5 snapshot

* Deprecate a constant value

* Rework inventory click handling to work with the latest version of Minestom

* Remove logger usage

* Improve switch expression usage

* Remove instance field

* Use existing event node and remove own definition

* Improve exception handling

* Fix ItemStackGsonTypeAdapter

* Update exception test case

* Update component import and usage

* Remove title variable in the update method and cleanup code

* Remove unused import

* Cleanup imports

* Update minestom to the latest 1.21.5 release

* Update RegistryKey usage

* Update minestom version

* Disable test which runs to long

* Update bom and migrate Minestom usage

* Fix documentation

* Update since content in the Deprecated annotation

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Phillipp Glanz <6745190+TheMeinerLP@users.noreply.github.com>

Author: 3 people

README.md

@@ -34,7 +34,7 @@ Add the following dependency to your `build.gradle.kts` file:
 
 ```kotlin
 dependencies {
-    implementation("net.theevilreaper.aves:aves:<version>")
+    implementation("net.theevilreaper:aves:<version>")
 }
 ```
 

build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
 }
 
 group = "net.theevilreaper"
-version = "1.8.0"
+version = "1.9.0"
 description = "Aves"
 
 java {

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-all.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

settings.gradle.kts

@@ -26,11 +26,10 @@ dependencyResolutionManagement {
     }
     versionCatalogs {
         create("libs") {
-            version("bom", "1.2.3")
+            version("bom", "1.3.0")
             version("publishdata", "1.4.0")
-
             library("mycelium.bom", "net.onelitefeather", "mycelium-bom").versionRef("bom")
-            library("minestom","net.minestom", "minestom-snapshots").withoutVersion()
+            library("minestom","net.minestom", "minestom").withoutVersion()
             library("adventure", "net.kyori", "adventure-text-minimessage").withoutVersion()
             library("cyano", "net.onelitefeather", "cyano").withoutVersion()
             library("junit-jupiter", "org.junit.jupiter", "junit-jupiter").withoutVersion()

src/main/java/net/theevilreaper/aves/file/FileHandler.java

@@ -14,7 +14,9 @@
  * @author theEvilReaper
  * @version 1.0.0
  * @since 1.0.0
+ * * @deprecated This interface is deprecated since version 1.9.0 and will be removed in a future release. Use {@link ModernFileHandler} instead.
  **/
+@Deprecated(since = "1.9.0", forRemoval = true)
 public interface FileHandler {
 
     Logger LOGGER = LoggerFactory.getLogger(FileHandler.class);

src/main/java/net/theevilreaper/aves/file/GsonFileHandler.java

@@ -15,7 +15,9 @@
  * @author theEvilReaper
  * @version 1.0.0
  * @since 1.1.0
+ * @deprecated This class is deprecated since version 1.9.0 and will be removed in a future release. Use {@link ModernGsonFileHandler} instead.
  **/
+@Deprecated(since = "1.9.0", forRemoval = true)
 public final class GsonFileHandler implements FileHandler {
 
     private final Gson gson;

src/main/java/net/theevilreaper/aves/file/ModernFileHandler.java

@@ -0,0 +1,42 @@
+package net.theevilreaper.aves.file;
+
+import com.google.gson.reflect.TypeToken;
+import org.jetbrains.annotations.NotNull;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Path;
+import java.util.Optional;
+
+/**
+ * The class represents the base logic to load or save json files.
+ * @author theEvilReaper
+ * @version 1.0.0
+ * @since 1.9.0
+ **/
+public interface ModernFileHandler {
+
+    Logger LOGGER = LoggerFactory.getLogger(ModernFileHandler.class);
+
+    Charset UTF_8 = StandardCharsets.UTF_8;
+
+    /**
+     * Saves a given object into a file.
+     * @param path The path where the file is located
+     * @param object The object to save
+     * @param typeToken the type token to serialize the object
+     * @param <T> A generic type for the object value
+     */
+    <T> void save(@NotNull Path path, @NotNull T object, @NotNull TypeToken<T> typeToken);
+
+    /**
+     * Load a given file and parse to the give class.
+     * @param path is the where the file is located
+     * @param typeToken the type token to deserialize the object
+     * @param <T> is generic type for the object value
+     * @return a {@link Optional} with the object instance
+     */
+    <T> Optional<T> load(@NotNull Path path, @NotNull TypeToken<T> typeToken);
+}

src/main/java/net/theevilreaper/aves/file/ModernGsonFileHandler.java

@@ -0,0 +1,79 @@
+package net.theevilreaper.aves.file;
+
+import com.google.gson.Gson;
+import com.google.gson.reflect.TypeToken;
+import net.minestom.server.utils.validate.Check;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Optional;
+
+/**
+ * The class represents the implementation of the {@link ModernFileHandler} for the {@link com.google.gson.Gson} library.
+ * @author TheMeinerLP
+ * @version 1.0.0
+ * @since 1.9.0
+ */
+public class ModernGsonFileHandler implements ModernFileHandler {
+
+    private final Gson gson;
+
+    /**
+     * Creates a new instance from the file handler.
+     */
+    public ModernGsonFileHandler() {
+        this.gson = new Gson();
+    }
+
+    /**
+     * Creates a new instance from the file handler.
+     * @param gson the gson instance to deserialize or serialize data
+     */
+    public ModernGsonFileHandler(@NotNull Gson gson) {
+        this.gson = gson;
+    }
+
+    /**
+     * Saves a given object into a file.
+     * @param path The path where the file is located
+     * @param object The object to save
+     * @param <T> A generic type for the object value
+     */
+    @Override
+    public <T> void save(@NotNull Path path, @NotNull T object, @NotNull TypeToken<T> typeToken) {
+        Check.argCondition(Files.isDirectory(path), "Unable to save a directory. Please check the used path");
+        try (var outputStream = Files.newBufferedWriter(path, UTF_8)) {
+            if (!Files.exists(path)) {
+                var file = Files.createFile(path).getFileName();
+                LOGGER.info("Created new file: {}", file);
+            }
+            gson.toJson(object, typeToken.getRawType(), outputStream);
+        } catch (IOException exception) {
+            LOGGER.warn("Unable to save file", exception);
+        }
+    }
+
+    /**
+     * Load a given file and parse to the give class.
+     * @param path is the where the file is located
+     * @param typeToken the type token to deserialize the object
+     * @param <T> is generic type for the object value
+     * @return a {@link Optional} with the object instance
+     */
+    @Override
+    public <T> Optional<T> load(@NotNull Path path, @NotNull TypeToken<T> typeToken) {
+        Check.argCondition(Files.isDirectory(path), "Unable to load a directory. Please check the used path");
+        if (!Files.exists(path)) {
+            return Optional.empty();
+        }
+
+        try (var reader = Files.newBufferedReader(path, UTF_8)) {
+            return Optional.ofNullable(gson.fromJson(reader, typeToken));
+        } catch (IOException exception) {
+            LOGGER.warn("Unable to load file", exception);
+        }
+        return Optional.empty();
+    }
+}

src/main/java/net/theevilreaper/aves/file/gson/ItemStackGsonTypeAdapter.java

@@ -9,10 +9,11 @@
 import com.google.gson.JsonSerializationContext;
 import com.google.gson.JsonSerializer;
 import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
-import net.minestom.server.item.ItemComponent;
+import net.minestom.server.component.DataComponents;
 import net.minestom.server.item.ItemStack;
 import net.minestom.server.item.Material;
 import net.minestom.server.item.component.CustomModelData;
+import net.minestom.server.item.component.TooltipDisplay;
 import org.jetbrains.annotations.NotNull;
 
 import java.lang.reflect.Type;
@@ -38,16 +39,17 @@ public JsonElement serialize(@NotNull ItemStack itemStack, Type type, JsonSerial
         serializeCustomName(itemStack, metaObject);
         serializeLore(itemStack, metaObject);
 
-        if (itemStack.has(ItemComponent.HIDE_TOOLTIP)) {
-            metaObject.addProperty("hideTooltip", "true");
-        }
 
-        if (itemStack.has(ItemComponent.HIDE_ADDITIONAL_TOOLTIP)) {
-            metaObject.addProperty("hideAdditionalTooltip", "true");
+        if (itemStack.has(DataComponents.TOOLTIP_DISPLAY)) {
+            TooltipDisplay tooltipDisplay = itemStack.get(DataComponents.TOOLTIP_DISPLAY);
+            if (tooltipDisplay.hideTooltip()) {
+                metaObject.addProperty("hideTooltip", true);
+            }
         }
 
-        if (itemStack.has(ItemComponent.CUSTOM_MODEL_DATA)) {
-            CustomModelData modelData = itemStack.get(ItemComponent.CUSTOM_MODEL_DATA);
+
+        if (itemStack.has(DataComponents.CUSTOM_MODEL_DATA)) {
+            CustomModelData modelData = itemStack.get(DataComponents.CUSTOM_MODEL_DATA);
             JsonElement customData = context.serialize(modelData);
             metaObject.add(CUSTOM_MODEL_DATA, customData);
         }
@@ -86,17 +88,13 @@ public ItemStack deserialize(@NotNull JsonElement jsonElement, Type type, JsonDe
         itemBuilder = deserializeLore(itemBuilder, metaObject);
 
         if (metaObject.has("hideTooltip")) {
-            itemBuilder.set(ItemComponent.HIDE_TOOLTIP);
-        }
-
-        if (metaObject.has("hideAdditionalTooltip")) {
-            itemBuilder.set(ItemComponent.HIDE_ADDITIONAL_TOOLTIP);
+            itemBuilder.set(DataComponents.TOOLTIP_DISPLAY, new TooltipDisplay(true, null));
         }
 
         if (metaObject.has(CUSTOM_MODEL_DATA)) {
             JsonElement customModelElement = metaObject.get(CUSTOM_MODEL_DATA);
             CustomModelData customModelData = context.deserialize(customModelElement, CustomModelData.class);
-            itemBuilder.set(ItemComponent.CUSTOM_MODEL_DATA, customModelData);
+            itemBuilder.set(DataComponents.CUSTOM_MODEL_DATA, customModelData);
         }
 
         itemBuilder = deserializeEnchantments(itemBuilder, metaObject);

src/main/java/net/theevilreaper/aves/file/gson/ItemStackSerializerHelper.java

@@ -7,11 +7,12 @@
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
 import net.minestom.server.MinecraftServer;
-import net.minestom.server.item.ItemComponent;
+import net.minestom.server.component.DataComponents;
 import net.minestom.server.item.ItemStack;
 import net.minestom.server.item.component.EnchantmentList;
 import net.minestom.server.item.enchant.Enchantment;
 import net.minestom.server.registry.DynamicRegistry;
+import net.minestom.server.registry.RegistryKey;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.ArrayList;
@@ -42,8 +43,8 @@ sealed interface ItemStackSerializerHelper permits ItemStackGsonTypeAdapter {
      * @param object the object to serialize the data
      */
     default void serializeCustomName(@NotNull ItemStack stack, @NotNull JsonObject object) {
-        if (!stack.has(ItemComponent.CUSTOM_NAME)) return;
-        final Component itemName = stack.get(ItemComponent.CUSTOM_NAME, Component.empty());
+        if (!stack.has(DataComponents.CUSTOM_NAME)) return;
+        final Component itemName = stack.get(DataComponents.CUSTOM_NAME, Component.empty());
         final String displayName = plainText().serialize(itemName);
         object.addProperty(DISPLAY_NAME, displayName);
     }
@@ -55,8 +56,8 @@ default void serializeCustomName(@NotNull ItemStack stack, @NotNull JsonObject o
      * @param jsonObject the object to deserialize the data
      */
     default void serializeLore(@NotNull ItemStack stack, @NotNull JsonObject jsonObject) {
-        if (!stack.has(ItemComponent.LORE)) return;
-        final List<Component> loreLines = stack.get(ItemComponent.LORE);
+        if (!stack.has(DataComponents.LORE)) return;
+        final List<Component> loreLines = stack.get(DataComponents.LORE);
 
         if (loreLines != null && !loreLines.isEmpty()) {
             JsonArray loreArray = new JsonArray();
@@ -92,12 +93,12 @@ default void serializeLore(@NotNull ItemStack stack, @NotNull JsonObject jsonObj
      * @param object the object to serialize the data
      */
     default void serializeEnchantments(@NotNull ItemStack stack, @NotNull JsonObject object) {
-        if (!stack.has(ItemComponent.ENCHANTMENTS)) return;
+        if (!stack.has(DataComponents.ENCHANTMENTS)) return;
         JsonArray enchantsArray = new JsonArray();
-        final EnchantmentList enchantmentList = stack.get(ItemComponent.ENCHANTMENTS);
+        final EnchantmentList enchantmentList = stack.get(DataComponents.ENCHANTMENTS);
         if (enchantmentList != null && !enchantmentList.enchantments().isEmpty()) {
-            Set<Map.Entry<DynamicRegistry.Key<Enchantment>, Integer>> entries = enchantmentList.enchantments().entrySet();
-            for (Map.Entry<DynamicRegistry.Key<Enchantment>, Integer> entry : entries) {
+            Set<Map.Entry<RegistryKey<Enchantment>, Integer>> entries = enchantmentList.enchantments().entrySet();
+            for (Map.Entry<RegistryKey<Enchantment>, Integer> entry : entries) {
                 JsonObject enchantmentObject = new JsonObject();
                 enchantmentObject.addProperty("enchantment", entry.getKey().name());
                 enchantmentObject.addProperty("level", entry.getValue());
@@ -117,18 +118,18 @@ default void serializeEnchantments(@NotNull ItemStack stack, @NotNull JsonObject
     default @NotNull ItemStack.Builder deserializeEnchantments(@NotNull ItemStack.Builder builder, @NotNull JsonObject object) {
         if (!object.has(ENCHANTMENTS)) return builder;
         JsonArray enchantsArray = object.getAsJsonArray(ENCHANTMENTS);
-        Map<DynamicRegistry.Key<Enchantment>, Integer> enchantments = new HashMap<>();
+        Map<RegistryKey<Enchantment>, Integer> enchantments = new HashMap<>();
         for (JsonElement enchantElement : enchantsArray) {
             final JsonObject enchantObject = (JsonObject) enchantElement;
             String nameSpace = enchantObject.get("enchantment").getAsString();
             var level = enchantObject.get("level").getAsInt();
             DynamicRegistry<Enchantment> enchantmentRegistry = MinecraftServer.getEnchantmentRegistry();
             Enchantment rawEnchantment = enchantmentRegistry.get(Key.key(nameSpace));
             if (rawEnchantment == null) continue;
-            DynamicRegistry.Key<Enchantment> enchantment = enchantmentRegistry.getKey(rawEnchantment);
+            RegistryKey<Enchantment> enchantment = enchantmentRegistry.getKey(rawEnchantment);
             enchantments.putIfAbsent(enchantment, level);
         }
         EnchantmentList enchantmentList = new EnchantmentList(enchantments);
-        return builder.set(ItemComponent.ENCHANTMENTS, enchantmentList);
+        return builder.set(DataComponents.ENCHANTMENTS, enchantmentList);
     }
 }