Release 7.x.x (#34)

* GH-33 Use kyori adventure's components whenever it's possible

* Rebrand from dev.peri to org.mythicprojects

* Set default GlobalAdventureSerializer if MiniMessage or legacy serializer is available

* Simplify GlobalAdventureSerializer code

* Move MessageDispatcher to interface

* Utilize new MessageDispatcher API

* Add more javadocs

* add VelocityMessageDispatcher#all

* Mark #all #allPlayers and #console as deprecated in VelocityMessageDispatcher

* Convert ComponentTransformer to ComponentSerializer to allow serialzation of any Component type

* Create StringReplaceable to different from standard Replaceable and prevent using wrong placeholder type

* Don't unnecessarily change package

* Update package in example

* Fix ActionBarHolderSerializer

* Fix title serialization, revert old actionbar serialization

* Make compilable, bump dependencies, force Java 21

* Drop deprecated API, hopes everything works

Author: P3ridot

README.md

@@ -1,8 +1,8 @@
 YetAnotherMessagesLibrary (YAML)
 ===========
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-![Version](https://repo.titanvale.net/api/badge/latest/releases/dev/peri/yetanothermessageslibrary/core?color=42c611&name=Releases&prefix=v)
-![Version](https://repo.titanvale.net/api/badge/latest/snapshots/dev/peri/yetanothermessageslibrary/core?color=d45f48&name=Snapshots&prefix=v)
+![Version](https://repo.mythicprojects.org/api/badge/latest/releases/org/mythicprojects/yetanothermessageslibrary/core?color=42c611&name=Releases&prefix=v)
+![Version](https://repo.mythicprojects.org/api/badge/latest/snapshots/org/mythicprojects/yetanothermessageslibrary/core?color=d45f48&name=Snapshots&prefix=v)
 ![GitHub repo size](https://img.shields.io/github/repo-size/P3ridot/YetAnotherMessagesLibrary)
 
 Lightweight and modular *Minecraft Messages Library* based on [adventure](https://github.com/KyoriPowered/adventure).
@@ -21,8 +21,8 @@ Implementations of values/messages suppliers or utilities class to easily add su
 
 ### Replaceable
 Implementations of `Replaceable` interface to easily replace placeholders in messages
-- [okaeri-placeholders](https://github.com/OkaeriPoland/okaeri-placeholders)
 - [PlaceholderAPI](https://github.com/PlaceholderAPI/PlaceholderAPI)
+- [okaeri-placeholders **\[EXPERIMENTAL\]**](https://github.com/OkaeriPoland/okaeri-placeholders)
 
 
 ## Maven/Gradle
@@ -31,13 +31,13 @@ Implementations of `Replaceable` interface to easily replace placeholders in mes
 ```xml
 <!-- Releases -->
 <repository>
-    <id>titanvale-releases</id>
-    <url>https://repo.titanvale.net/releases</url>
+    <id>mythic-releases</id>
+    <url>https://repo.mythicprojects.org/releases</url>
 </repository>
 <!-- Snapshots -->
 <repository>
-    <id>titanvale-snapshots</id>
-    <url>https://repo.titanvale.net/snapshots</url>
+    <id>mythic-snapshots</id>
+    <url>https://repo.mythicprojects.org/snapshots</url>
 </repository>
 ```
 
@@ -55,13 +55,13 @@ Implementations of `Replaceable` interface to easily replace placeholders in mes
 repositories {
     // Releases
     maven {
-        name = "titanvale-releases"
-        url = "https://repo.titanvale.net/releases"
+        name = "mythic-releases"
+        url = "https://repo.mythicprojects.org/releases"
     }
     // Snapshots
     maven {
-        name = "titanvale-snapshots"
-        url = "https://repo.titanvale.net/snapshots"
+        name = "mythic-snapshots"
+        url = "https://repo.mythicprojects.org/snapshots"
     }
 }
 ```

build.gradle

@@ -5,26 +5,25 @@ plugins {
 
 allprojects {
     group 'dev.peri.yetanothermessageslibrary'
-    version '6.8.0-SNAPSHOT'
+    version '7.0.0-SNAPSHOT'
 
     apply plugin: 'java-library'
     apply plugin: 'maven-publish'
     apply plugin: 'com.github.johnrengelman.shadow'
 
-    sourceCompatibility = JavaVersion.VERSION_1_8
-    targetCompatibility = JavaVersion.VERSION_1_8
+    sourceCompatibility = JavaVersion.VERSION_21
+    targetCompatibility = JavaVersion.VERSION_21
 
     compileJava.options.encoding = 'UTF-8'
 }
 
 subprojects {
     repositories {
-        mavenCentral()
+        maven { url "https://repo.titanvale.net/releases" }
+        maven { url "https://repo.titanvale.net/snapshots" }
 
         maven { url "https://hub.spigotmc.org/nexus/content/repositories/snapshots/" }
         maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots/" }
-        maven { url "https://repo.papermc.io/repository/maven-public/" }
-        maven { url "https://storehouse.okaeri.eu/repository/maven-public/" }
         maven { url "https://repo.extendedclip.com/content/repositories/placeholderapi/" }
     }
 
@@ -43,13 +42,12 @@ subprojects {
         publications {
             libraries(MavenPublication) {
                 artifactId = project.name.toLowerCase()
-
                 from components.java
 
                 pom {
-                    url = "https://github.com/P3ridot/YetAnotherMessagesLibrary"
+                    url = "https://github.com/Mythic-Projects/YetAnotherMessagesLibrary"
                     name = project.name
-                    description = "YetAnotherMessagesLibrary is simple Miecraft Messages Library based on `adventure`. It allows to easily send messages to players with built-in support for localization and placeholders."
+                    description = "YetAnotherMessagesLibrary is simple Minecraft Messages Library based on `adventure`. It allows to easily send messages to players with built-in support for localization and placeholders."
 
                     developers {
                         developer {
@@ -60,9 +58,9 @@ subprojects {
                     }
 
                     scm {
-                        url = "https://github.com/P3ridot/YetAnotherMessagesLibrary.git"
-                        connection = "git@github.com:P3ridot/YetAnotherMessagesLibrary.git"
-                        developerConnection = "git@github.com:P3ridot/YetAnotherMessagesLibrary.git"
+                        url = "https://github.com/Mythic-Projects/YetAnotherMessagesLibrary.git"
+                        connection = "git@github.com:Mythic-Projects/YetAnotherMessagesLibrary.git"
+                        developerConnection = "git@github.com:Mythic-Projects/YetAnotherMessagesLibrary.git"
                     }
 
                     licenses {
@@ -93,8 +91,8 @@ subprojects {
 
         repositories {
             maven {
-                name "titanvale-repo"
-                url "https://repo.titanvale.net/${version.toString().endsWith('SNAPSHOT') ? 'snapshots' : 'releases'}"
+                name "mythic"
+                url "https://repo.mythicprojects.org/${version.toString().endsWith('SNAPSHOT') ? 'snapshots' : 'releases'}"
 
                 credentials {
                     username = System.getenv("MAVEN_NAME")
@@ -103,4 +101,4 @@ subprojects {
             }
         }
     }
-}
+}

core/build.gradle

@@ -1,5 +1,3 @@
 dependencies {
-    compileOnlyApi adventure.api
-    compileOnlyApi adventure.minimessage
-    compileOnlyApi adventure.serializer.legacy
+    api project(':tools')
 }

core/src/main/java/dev/peri/yetanothermessageslibrary/MessageService.java

@@ -1,17 +1,20 @@
 package dev.peri.yetanothermessageslibrary;
 
 import dev.peri.yetanothermessageslibrary.locale.LocaleProvider;
+import dev.peri.yetanothermessageslibrary.replace.ComponentReplacer;
 import dev.peri.yetanothermessageslibrary.replace.Replaceable;
+import dev.peri.yetanothermessageslibrary.replace.StringReplaceable;
 import dev.peri.yetanothermessageslibrary.replace.StringReplacer;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 import java.util.function.Function;
+import net.kyori.adventure.text.Component;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.Unmodifiable;
 
-public interface MessageService<C extends MessageRepository> {
+public interface MessageService<REPOSITORY extends MessageRepository> {
 
     /**
      * Get message from repository
@@ -23,7 +26,7 @@ public interface MessageService<C extends MessageRepository> {
      * @param <T>           type of message
      * @return message
      */
-    default <T> T get(@Nullable Object entity, @NotNull Function<@NotNull C, @Nullable T> valueSupplier) {
+    default <T> T get(@Nullable Object entity, @NotNull Function<@NotNull REPOSITORY, @Nullable T> valueSupplier) {
         Locale locale = this.getLocale(entity);
         return valueSupplier.apply(this.getRepository(locale));
     }
@@ -36,7 +39,7 @@ default <T> T get(@Nullable Object entity, @NotNull Function<@NotNull C, @Nullab
      * @param <T>           type of message
      * @return message
      */
-    default <T> T get(@NotNull Function<@NotNull C, @Nullable T> valueSupplier) {
+    default <T> T get(@NotNull Function<@NotNull REPOSITORY, @Nullable T> valueSupplier) {
         return this.get(null, valueSupplier);
     }
 
@@ -50,7 +53,7 @@ default <T> T get(@NotNull Function<@NotNull C, @Nullable T> valueSupplier) {
      * @param replacements   replacements to replace in message
      * @return message with replaced placeholders
      */
-    default String get(@Nullable Object entity, @NotNull Function<@NotNull C, @Nullable String> stringSupplier, @NotNull Replaceable... replacements) {
+    default String getString(@Nullable Object entity, @NotNull Function<@NotNull REPOSITORY, @Nullable String> stringSupplier, @NotNull StringReplaceable... replacements) {
         String string = this.get(entity, stringSupplier);
         if (string == null) {
             return null;
@@ -59,6 +62,25 @@ default String get(@Nullable Object entity, @NotNull Function<@NotNull C, @Nulla
         return StringReplacer.replace(locale, string, replacements);
     }
 
+    /**
+     * Get message from repository and replace placeholders
+     *
+     * @param entity         entity to find locale for using registered {@link LocaleProvider}
+     *                       use default locale if entity is null or no {@link LocaleProvider} is registered
+     *                       can be {@link Locale} if you want to use specific locale
+     * @param componentSupplier function to get message from repository
+     * @param replacements   replacements to replace in message
+     * @return message with replaced placeholders
+     */
+    default Component getComponent(@Nullable Object entity, @NotNull Function<@NotNull REPOSITORY, @Nullable Component> componentSupplier, @NotNull Replaceable... replacements) {
+        Component component = this.get(entity, componentSupplier);
+        if (component == null) {
+            return null;
+        }
+        Locale locale = this.getLocale(entity);
+        return ComponentReplacer.replace(locale, component, replacements);
+    }
+
     /**
      * Get message from repository with default locale and replace placeholders
      *
@@ -69,7 +91,7 @@ default String get(@Nullable Object entity, @NotNull Function<@NotNull C, @Nulla
      * @param replacements replacements to replace in message
      * @return message with replaced placeholders
      */
-    default List<String> getList(@Nullable Object entity, @NotNull Function<@NotNull C, @Nullable List<String>> listSupplier, @NotNull Replaceable... replacements) {
+    default List<String> getStringList(@Nullable Object entity, @NotNull Function<@NotNull REPOSITORY, @Nullable List<String>> listSupplier, @NotNull StringReplaceable... replacements) {
         List<String> stringList = this.get(entity, listSupplier);
         if (stringList == null || stringList.isEmpty()) {
             return stringList;
@@ -78,6 +100,25 @@ default List<String> getList(@Nullable Object entity, @NotNull Function<@NotNull
         return StringReplacer.replace(locale, stringList, replacements);
     }
 
+    /**
+     * Get message from repository with default locale and replace placeholders
+     *
+     * @param entity       entity to find locale for using registered {@link LocaleProvider}
+     *                     use default locale if entity is null or no {@link LocaleProvider} is registered
+     *                     can be {@link Locale} if you want to use specific locale
+     * @param listSupplier function to get message from repository
+     * @param replacements replacements to replace in message
+     * @return message with replaced placeholders
+     */
+    default List<Component> getComponentList(@Nullable Object entity, @NotNull Function<@NotNull REPOSITORY, @Nullable List<Component>> listSupplier, @NotNull Replaceable... replacements) {
+        List<Component> componentList = this.get(entity, listSupplier);
+        if (componentList == null || componentList.isEmpty()) {
+            return componentList;
+        }
+        Locale locale = this.getLocale(entity);
+        return ComponentReplacer.replace(locale, componentList, replacements);
+    }
+
     /**
      * Set default locale that will be used if:
      * <ul>
@@ -148,31 +189,31 @@ default List<String> getList(@Nullable Object entity, @NotNull Function<@NotNull
      *
      * @return message repositories
      */
-    @NotNull @Unmodifiable Map<Locale, C> getMessageRepositories();
+    @NotNull @Unmodifiable Map<Locale, REPOSITORY> getMessageRepositories();
 
     /**
      * Get message repository for locale
      *
      * @param locale locale
      * @return message repository
      */
-    @NotNull C getRepository(@NotNull Locale locale);
+    @NotNull REPOSITORY getRepository(@NotNull Locale locale);
 
     /**
      * Register message repository for locale
      *
      * @param locale            locale
      * @param messageRepository message repository
      */
-    void registerRepository(@NotNull Locale locale, @NotNull C messageRepository);
+    void registerRepository(@NotNull Locale locale, @NotNull REPOSITORY messageRepository);
 
     /**
      * Register message repository for locale and set it as default
      *
      * @param defaultLocale     default locale
      * @param messageRepository message repository
      */
-    default void registerDefaultRepository(@NotNull Locale defaultLocale, @NotNull C messageRepository) {
+    default void registerDefaultRepository(@NotNull Locale defaultLocale, @NotNull REPOSITORY messageRepository) {
         this.setDefaultLocale(defaultLocale);
         this.registerRepository(defaultLocale, messageRepository);
     }

core/src/main/java/dev/peri/yetanothermessageslibrary/SendableMessageService.java

@@ -8,7 +8,8 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-public interface SendableMessageService<R, C extends MessageRepository, D extends MessageDispatcher<R, ? extends D>> extends MessageService<C> {
+public interface SendableMessageService<RECEIVER, REPOSITORY extends MessageRepository, DISPATCHER extends MessageDispatcher<RECEIVER, ? extends DISPATCHER>>
+        extends MessageService<REPOSITORY> {
 
     /**
      * Wrap message in {@link MessageDispatcher} to easily send it
@@ -17,12 +18,12 @@ public interface SendableMessageService<R, C extends MessageRepository, D extend
      * @return MessageDispatcher
      */
     @SuppressWarnings("unchecked")
-    default D getMessage(@NotNull Function<@NotNull C, @Nullable Sendable> messageSupplier) {
+    default DISPATCHER getMessage(@NotNull Function<@NotNull REPOSITORY, @Nullable Sendable> messageSupplier) {
         return this.getDispatcherFactory().prepareDispatcher(this.getViewerService(), this::getLocale, (entity) -> this.get(entity, messageSupplier));
     }
 
-    @NotNull ViewerService<R> getViewerService();
+    @NotNull ViewerService<RECEIVER> getViewerService();
 
-    @NotNull MessageDispatcherFactory<R, ? extends D> getDispatcherFactory();
+    @NotNull MessageDispatcherFactory<RECEIVER, ? extends DISPATCHER> getDispatcherFactory();
 
 }

core/src/main/java/dev/peri/yetanothermessageslibrary/SimpleMessageService.java

@@ -12,11 +12,11 @@
 import org.jetbrains.annotations.Nullable;
 import org.jetbrains.annotations.Unmodifiable;
 
-public abstract class SimpleMessageService<C extends MessageRepository> implements MessageService<C> {
+public abstract class SimpleMessageService<REPOSITORY extends MessageRepository> implements MessageService<REPOSITORY> {
 
     private Locale defaultLocale = Locale.getDefault();
     private final Collection<LocaleProvider<?>> localeProviders = new LinkedHashSet<>();
-    private final Map<Locale, C> messageRepositories = new LinkedHashMap<>();
+    private final Map<Locale, REPOSITORY> messageRepositories = new LinkedHashMap<>();
 
     @Override
     public @NotNull Locale getDefaultLocale() {
@@ -45,13 +45,13 @@ public void registerLocaleProvider(@NotNull LocaleProvider<?> localeProvider) {
     }
 
     @Override
-    public @NotNull @Unmodifiable Map<Locale, C> getMessageRepositories() {
+    public @NotNull @Unmodifiable Map<Locale, REPOSITORY> getMessageRepositories() {
         return Collections.unmodifiableMap(this.messageRepositories);
     }
 
     @Override
-    public @NotNull C getRepository(@NotNull Locale locale) {
-        C messageRepository = this.messageRepositories.get(locale);
+    public @NotNull REPOSITORY getRepository(@NotNull Locale locale) {
+        REPOSITORY messageRepository = this.messageRepositories.get(locale);
         if (messageRepository == null) {
             // If we can't find message repository for language wariant (for e.g. en_GB) we will try to find message repository for language (for e.g. en)
             messageRepository = this.messageRepositories.get(Locale.forLanguageTag(locale.getLanguage()));
@@ -69,7 +69,7 @@ public void registerLocaleProvider(@NotNull LocaleProvider<?> localeProvider) {
     }
 
     @Override
-    public void registerRepository(@NotNull Locale locale, @NotNull C messageRepository) {
+    public void registerRepository(@NotNull Locale locale, @NotNull REPOSITORY messageRepository) {
         Validate.notNull(locale, "Locale cannot be null");
         Validate.notNull(messageRepository, "Message repository cannot be null");
         this.messageRepositories.put(locale, messageRepository);