GH-902 Rename private chat domain to msg. Add migration's for config keys. (#1100)

* privatechat -> msg

* Fix migration's.

* Update eternalcore-api-example/src/main/java/com/eternalcode/example/feature/privatechat/ApiPrivateChatListener.java

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Update eternalcore-api-example/src/main/java/com/eternalcode/example/feature/privatechat/ApiPrivateChatListener.java

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* Fix.

---------

Co-authored-by: vLuckyyy <[email protected]>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Author: 3 people

eternalcore-api-example/src/main/java/com/eternalcode/example/feature/privatechat/ApiPrivateChatListener.java

@@ -1,6 +1,6 @@
 package com.eternalcode.example.feature.privatechat;
 
-import com.eternalcode.core.feature.privatechat.PrivateChatEvent;
+import com.eternalcode.core.feature.msg.MsgEvent;
 import java.util.UUID;
 import org.bukkit.Server;
 import org.bukkit.entity.Player;
@@ -16,7 +16,7 @@ public ApiPrivateChatListener(Server server) {
     }
 
     @EventHandler
-    public void onPrivateChat(PrivateChatEvent event) {
+    public void onMsg(MsgEvent event) {
         UUID sender = event.getSender();
         UUID receiver = event.getReceiver();
         String content = event.getContent();
@@ -34,7 +34,7 @@ public void onPrivateChat(PrivateChatEvent event) {
     }
 
     @EventHandler
-    public void overridePrivateChat(PrivateChatEvent event) {
+    public void overrideMsg(MsgEvent event) {
         String content = event.getContent();
 
         if (content.contains("kurła!")) {

eternalcore-api/src/main/java/com/eternalcode/core/EternalCoreApi.java

@@ -5,7 +5,7 @@
 import com.eternalcode.core.feature.home.HomeService;
 import com.eternalcode.core.feature.jail.JailService;
 import com.eternalcode.core.feature.language.LanguageService;
-import com.eternalcode.core.feature.privatechat.PrivateChatService;
+import com.eternalcode.core.feature.msg.MsgService;
 import com.eternalcode.core.feature.ignore.IgnoreService;
 import com.eternalcode.core.feature.randomteleport.RandomTeleportService;
 import com.eternalcode.core.feature.spawn.SpawnService;
@@ -26,7 +26,7 @@ public interface EternalCoreApi {
 
     LanguageService getLanguageService();
 
-    PrivateChatService getPrivateChatService();
+    MsgService getMsgService();
 
     RandomTeleportService getRandomTeleportService();
 

eternalcore-api/src/main/java/com/eternalcode/core/feature/privatechat/PrivateChatEvent.java renamed to eternalcore-api/src/main/java/com/eternalcode/core/feature/msg/MsgEvent.java

@@ -1,4 +1,4 @@
-package com.eternalcode.core.feature.privatechat;
+package com.eternalcode.core.feature.msg;
 
 import java.util.UUID;
 import org.bukkit.event.Event;
@@ -7,15 +7,15 @@
 /**
  * Event that is called when a player sends a private message to another player.
  */
-public class PrivateChatEvent extends Event {
+public class MsgEvent extends Event {
 
     private static final HandlerList HANDLER_LIST = new HandlerList();
 
     private final UUID sender;
     private final UUID receiver;
     private String content;
 
-    public PrivateChatEvent(UUID sender, UUID receiver, String content) {
+    public MsgEvent(UUID sender, UUID receiver, String content) {
         super(true);
 
         this.sender = sender;

eternalcore-api/src/main/java/com/eternalcode/core/feature/privatechat/PrivateChatService.java renamed to eternalcore-api/src/main/java/com/eternalcode/core/feature/msg/MsgService.java

@@ -1,9 +1,9 @@
-package com.eternalcode.core.feature.privatechat;
+package com.eternalcode.core.feature.msg;
 
 import java.util.UUID;
 import org.bukkit.entity.Player;
 
-public interface PrivateChatService {
+public interface MsgService {
 
     void enableSpy(UUID uuid);
 
@@ -13,5 +13,5 @@ public interface PrivateChatService {
 
     void reply(Player sender, String message);
 
-    void privateMessage(Player sender, Player target, String message);
+    void sendMessage(Player sender, Player target, String message);
 }

eternalcore-api/src/main/java/com/eternalcode/core/feature/privatechat/toggle/PrivateChatState.java renamed to eternalcore-api/src/main/java/com/eternalcode/core/feature/msg/toggle/MsgState.java

@@ -1,22 +1,22 @@
-package com.eternalcode.core.feature.privatechat.toggle;
+package com.eternalcode.core.feature.msg.toggle;
 
 /**
  * Enum representing state of blocking incoming private messages by the player.
  */
-public enum PrivateChatState {
+public enum MsgState {
 
     /**
      * Player can receive private messages.
      */
-    ENABLE,
+    ENABLED,
 
     /**
      * Player cannot receive private messages.
      */
-    DISABLE;
+    DISABLED;
 
-    PrivateChatState invert() {
-        return this == ENABLE ? DISABLE : ENABLE;
+    MsgState invert() {
+        return this == ENABLED ? DISABLED : ENABLED;
     }
 
 }

eternalcore-api/src/main/java/com/eternalcode/core/feature/privatechat/toggle/PrivateChatStateService.java renamed to eternalcore-api/src/main/java/com/eternalcode/core/feature/msg/toggle/MsgToggleService.java

@@ -1,28 +1,28 @@
-package com.eternalcode.core.feature.privatechat.toggle;
+package com.eternalcode.core.feature.msg.toggle;
 
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
 
 /**
  * This Service manages player's receiving of private messages
  */
-public interface PrivateChatStateService {
+public interface MsgToggleService {
 
     /**
      * Checks status of player's private chat messages blocking.
      *
      * @param playerUniqueId player's UUID.
      * @return state of player's private chat messages blocking.
      */
-    CompletableFuture<PrivateChatState> getChatState(UUID playerUniqueId);
+    CompletableFuture<MsgState> getState(UUID playerUniqueId);
 
     /**
      * Sets blocking of incoming private messages.
      *
      * @param playerUniqueId player's UUID.
      * @param state desired state of player's private chat messages blocking.
      */
-    CompletableFuture<Void> setChatState(UUID playerUniqueId, PrivateChatState state);
+    CompletableFuture<Void> setState(UUID playerUniqueId, MsgState state);
 
 
     /**
@@ -31,6 +31,6 @@ public interface PrivateChatStateService {
      * @param playerUniqueId player's UUID.
      * @return new state of player's private chat messages blocking.
      */
-    CompletableFuture<PrivateChatState> toggleChatState(UUID playerUniqueId);
+    CompletableFuture<MsgState> toggleState(UUID playerUniqueId);
 
 }

eternalcore-core/src/main/java/com/eternalcode/core/EternalCoreApiImpl.java

@@ -6,7 +6,7 @@
 import com.eternalcode.core.feature.ignore.IgnoreService;
 import com.eternalcode.core.feature.jail.JailService;
 import com.eternalcode.core.feature.language.LanguageService;
-import com.eternalcode.core.feature.privatechat.PrivateChatService;
+import com.eternalcode.core.feature.msg.MsgService;
 import com.eternalcode.core.feature.randomteleport.RandomTeleportService;
 import com.eternalcode.core.feature.spawn.SpawnService;
 import com.eternalcode.core.feature.teleport.TeleportService;
@@ -52,8 +52,8 @@ public LanguageService getLanguageService() {
     }
 
     @Override
-    public PrivateChatService getPrivateChatService() {
-        return this.dependencyProvider.getDependency(PrivateChatService.class);
+    public MsgService getMsgService() {
+        return this.dependencyProvider.getDependency(MsgService.class);
     }
 
     @Override

eternalcore-core/src/main/java/com/eternalcode/core/configuration/ConfigurationManager.java

@@ -1,12 +1,14 @@
 package com.eternalcode.core.configuration;
 
+import com.eternalcode.core.configuration.migrations.Migrations;
 import com.eternalcode.core.configuration.serializer.LanguageSerializer;
 import com.eternalcode.core.configuration.transformer.PositionTransformer;
 import com.eternalcode.core.injector.annotations.Inject;
 import com.eternalcode.core.injector.annotations.component.Service;
 import com.eternalcode.core.publish.Publisher;
 import com.eternalcode.multification.notice.resolver.NoticeResolverRegistry;
 import com.eternalcode.multification.okaeri.MultificationNoticeSerializer;
+import eu.okaeri.configs.ConfigManager;
 import eu.okaeri.configs.OkaeriConfig;
 import eu.okaeri.configs.serdes.OkaeriSerdesPack;
 import eu.okaeri.configs.serdes.commons.SerdesCommons;
@@ -15,6 +17,7 @@
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
+import java.util.logging.Logger;
 import org.yaml.snakeyaml.DumperOptions;
 import org.yaml.snakeyaml.LoaderOptions;
 import org.yaml.snakeyaml.Yaml;
@@ -61,9 +64,10 @@ public <T extends OkaeriConfig & EternalConfigurationFile> T load(T config) {
         config.withConfigurer(yamlConfigurer)
             .withSerdesPack(serdesPack)
             .withBindFile(file)
-            .withRemoveOrphans(true)
             .saveDefaults()
-            .load(true);
+            .load(true)
+            .migrate(Migrations.ALL); // Remember: migration should be launched after the #load method.
+
 
         this.configs.add(config);
         return config;

eternalcore-core/src/main/java/com/eternalcode/core/configuration/migrations/Migration_0001_Rename_privateChat_to_msg.java

@@ -0,0 +1,16 @@
+package com.eternalcode.core.configuration.migrations;
+
+import static eu.okaeri.configs.migrate.ConfigMigrationDsl.move;
+import eu.okaeri.configs.migrate.builtin.NamedMigration;
+
+class Migration_0001_Rename_privateChat_to_msg extends NamedMigration {
+
+    Migration_0001_Rename_privateChat_to_msg() {
+        super("Rename privateChat to msg",
+            move("privateChat.privateMessageYouToTarget", "privateChat.msgYouToTarget"),
+            move("privateChat.privateMessageTargetToYou", "privateChat.msgTargetToYou"),
+            move("privateChat", "msg")
+        );
+    }
+
+}

eternalcore-core/src/main/java/com/eternalcode/core/configuration/migrations/Migrations.java

@@ -0,0 +1,11 @@
+package com.eternalcode.core.configuration.migrations;
+
+import eu.okaeri.configs.migrate.ConfigMigration;
+
+public class Migrations {
+
+    public static final ConfigMigration[] ALL = new ConfigMigration[] {
+        new Migration_0001_Rename_privateChat_to_msg(),
+    };
+
+}