Add Config tests, improve ConfigManager, add Javadocs.

Author: imDMK

automessage-core/src/main/java/com/github/imdmk/automessage/AutoMessagePlugin.java

@@ -12,11 +12,11 @@
 import com.github.imdmk.automessage.platform.logger.PluginLogger;
 import com.github.imdmk.automessage.platform.scheduler.BukkitTaskScheduler;
 import com.github.imdmk.automessage.platform.scheduler.TaskScheduler;
-import com.github.imdmk.automessage.scheduled.ScheduledMessageConfig;
+import com.github.imdmk.automessage.scheduled.ScheduledMessagesConfig;
 import com.github.imdmk.automessage.scheduled.audience.filter.AudienceFilter;
 import com.github.imdmk.automessage.scheduled.dispatcher.MessageDispatcher;
-import com.github.imdmk.automessage.scheduled.dispatcher.MessageDispatcherConfig;
 import com.github.imdmk.automessage.scheduled.dispatcher.MessageDispatcherTask;
+import com.github.imdmk.automessage.scheduled.dispatcher.MessagesDispatcherConfig;
 import com.github.imdmk.automessage.scheduled.selector.MessageSelector;
 import com.github.imdmk.automessage.scheduled.selector.MessageSelectorFactory;
 import com.github.imdmk.automessage.shared.message.MessageConfig;
@@ -72,20 +72,20 @@ void enable(@NotNull PluginSettings settings) {
         messageService = new MessageService(configManager.require(MessageConfig.class), bukkitAudiences);
         taskScheduler = new BukkitTaskScheduler(plugin, server.getScheduler());
 
-        final MessageDispatcherConfig messageDispatcherConfig = configManager.require(MessageDispatcherConfig.class);
-        final ScheduledMessageConfig scheduledMessageConfig = configManager.require(ScheduledMessageConfig.class);
+        final MessagesDispatcherConfig messagesDispatcherConfig = configManager.require(MessagesDispatcherConfig.class);
+        final ScheduledMessagesConfig scheduledMessagesConfig = configManager.require(ScheduledMessagesConfig.class);
 
         final AudienceFilter audienceFilter = AudienceFilter.createDefault();
-        final MessageSelector messageSelector = MessageSelectorFactory.create(messageDispatcherConfig.selector);
+        final MessageSelector messageSelector = MessageSelectorFactory.create(messagesDispatcherConfig.selector);
 
         final MessageDispatcher messageDispatcher = new MessageDispatcher(
                 messageService,
                 messageSelector,
                 audienceFilter,
-                () -> scheduledMessageConfig.messages
+                () -> scheduledMessagesConfig.messages
         );
 
-        MessageDispatcherTask messageDispatcherTask = new MessageDispatcherTask(server, messageDispatcherConfig, messageDispatcher);
+        MessageDispatcherTask messageDispatcherTask = new MessageDispatcherTask(server, messagesDispatcherConfig, messageDispatcher);
         taskScheduler.runTimerAsync(messageDispatcherTask);
 
         liteCommands = LiteBukkitFactory.builder(PLUGIN_PREFIX, plugin, server)
@@ -94,8 +94,8 @@ void enable(@NotNull PluginSettings settings) {
                 .result(Notice.class, new NoticeResultHandlerImpl(messageService))
 
                 .commands(
-                        new DisableCommand(messageDispatcherConfig, messageService),
-                        new EnableCommand(messageDispatcherConfig, messageService),
+                        new DisableCommand(messagesDispatcherConfig, messageService),
+                        new EnableCommand(messagesDispatcherConfig, messageService),
                         new ReloadCommand(logger, configManager, taskScheduler, messageService)
                 )
 
@@ -107,7 +107,10 @@ void enable(@NotNull PluginSettings settings) {
     }
 
     void disable() {
-        Validator.ifNotNull(configManager, ConfigManager::saveAll);
+//        Validator.ifNotNull(configManager, manager -> {
+//            manager.saveAll();
+//            manager.clearAll();
+//        });
         Validator.ifNotNull(bukkitAudiences, BukkitAudiences::close);
         Validator.ifNotNull(taskScheduler, TaskScheduler::shutdown);
         Validator.ifNotNull(liteCommands, LiteCommands::unregister);

automessage-core/src/main/java/com/github/imdmk/automessage/command/dispatcher/DisableCommand.java

@@ -1,6 +1,6 @@
 package com.github.imdmk.automessage.command.dispatcher;
 
-import com.github.imdmk.automessage.scheduled.dispatcher.MessageDispatcherConfig;
+import com.github.imdmk.automessage.scheduled.dispatcher.MessagesDispatcherConfig;
 import com.github.imdmk.automessage.shared.message.MessageService;
 import com.github.imdmk.automessage.shared.validate.Validator;
 import dev.rollczi.litecommands.annotations.command.Command;
@@ -14,11 +14,11 @@
 @Permission("command.automessage.disable")
 public final class DisableCommand {
 
-    private final MessageDispatcherConfig dispatcherConfig;
+    private final MessagesDispatcherConfig dispatcherConfig;
     private final MessageService messageService;
 
     public DisableCommand(
-            @NotNull MessageDispatcherConfig dispatcherConfig,
+            @NotNull MessagesDispatcherConfig dispatcherConfig,
             @NotNull MessageService messageService
     ) {
         this.dispatcherConfig = Validator.notNull(dispatcherConfig, "dispatcherConfig");

automessage-core/src/main/java/com/github/imdmk/automessage/command/dispatcher/EnableCommand.java

@@ -1,6 +1,6 @@
 package com.github.imdmk.automessage.command.dispatcher;
 
-import com.github.imdmk.automessage.scheduled.dispatcher.MessageDispatcherConfig;
+import com.github.imdmk.automessage.scheduled.dispatcher.MessagesDispatcherConfig;
 import com.github.imdmk.automessage.shared.message.MessageService;
 import com.github.imdmk.automessage.shared.validate.Validator;
 import dev.rollczi.litecommands.annotations.command.Command;
@@ -14,11 +14,11 @@
 @Permission("command.automessage.enable")
 public final class EnableCommand {
 
-    private final MessageDispatcherConfig dispatcherConfig;
+    private final MessagesDispatcherConfig dispatcherConfig;
     private final MessageService messageService;
 
     public EnableCommand(
-            @NotNull MessageDispatcherConfig dispatcherConfig,
+            @NotNull MessagesDispatcherConfig dispatcherConfig,
             @NotNull MessageService messageService
     ) {
         this.dispatcherConfig = Validator.notNull(dispatcherConfig, "dispatcherConfig");

automessage-core/src/main/java/com/github/imdmk/automessage/command/dispatcher/messages/DispatcherMessagesImpl.java

@@ -4,7 +4,9 @@
 import eu.okaeri.configs.OkaeriConfig;
 import eu.okaeri.configs.annotation.Comment;
 
-public final class DispatcherMessagesImpl extends OkaeriConfig implements DispatcherMessages {
+public final class DispatcherMessagesImpl
+        extends OkaeriConfig
+        implements DispatcherMessages {
 
     @Comment({"#", "# Sent when automatic message dispatching is successfully enabled.", "#"})
     Notice dispatcherEnabled = Notice.chat(

automessage-core/src/main/java/com/github/imdmk/automessage/command/reload/messages/ReloadMessagesImpl.java

@@ -4,7 +4,9 @@
 import eu.okaeri.configs.OkaeriConfig;
 import eu.okaeri.configs.annotation.Comment;
 
-public final class ReloadMessagesImpl extends OkaeriConfig implements ReloadMessages {
+public final class ReloadMessagesImpl
+        extends OkaeriConfig
+        implements ReloadMessages {
 
     @Comment({"#", "# Message shown when all configuration files are successfully reloaded.", "#"})
     Notice configReloadedSuccess = Notice.chat(

automessage-core/src/main/java/com/github/imdmk/automessage/config/ConfigAccessException.java

@@ -0,0 +1,17 @@
+package com.github.imdmk.automessage.config;
+
+public class ConfigAccessException extends RuntimeException {
+
+    public ConfigAccessException(String message) {
+        super(message);
+    }
+
+    public ConfigAccessException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+    public ConfigAccessException(Throwable cause) {
+        super(cause);
+    }
+}
+

automessage-core/src/main/java/com/github/imdmk/automessage/config/ConfigBinder.java

@@ -0,0 +1,27 @@
+package com.github.imdmk.automessage.config;
+
+import com.github.imdmk.automessage.shared.validate.Validator;
+import eu.okaeri.configs.serdes.OkaeriSerdesPack;
+import eu.okaeri.configs.serdes.commons.SerdesCommons;
+import eu.okaeri.configs.yaml.snakeyaml.YamlSnakeYamlConfigurer;
+import org.jetbrains.annotations.NotNull;
+
+import java.io.File;
+
+final class ConfigBinder {
+
+    void bind(@NotNull ConfigSection config, @NotNull File file) {
+        Validator.notNull(config, "config");
+        Validator.notNull(file, "file");
+
+        final OkaeriSerdesPack serdesPack = config.getSerdesPack();
+        final YamlSnakeYamlConfigurer yamlConfigurer = YamlConfigurerFactory.create();
+
+        config.withConfigurer(yamlConfigurer)
+                .withSerdesPack(serdesPack)
+                .withSerdesPack(new SerdesCommons())
+                .withBindFile(file)
+                .withRemoveOrphans(true);
+    }
+}
+

automessage-core/src/main/java/com/github/imdmk/automessage/config/ConfigFactory.java

@@ -0,0 +1,22 @@
+package com.github.imdmk.automessage.config;
+
+import com.github.imdmk.automessage.shared.validate.Validator;
+import eu.okaeri.configs.ConfigManager;
+import eu.okaeri.configs.exception.OkaeriException;
+import org.jetbrains.annotations.NotNull;
+
+final class ConfigFactory {
+
+    <T extends ConfigSection> @NotNull T instantiate(@NotNull Class<T> type) {
+        Validator.notNull(type, "type");
+
+        try {
+            return ConfigManager.create(type);
+        } catch (OkaeriException e) {
+            throw new IllegalStateException(
+                    "Failed to instantiate config: " + type.getName(), e
+            );
+        }
+    }
+}
+

automessage-core/src/main/java/com/github/imdmk/automessage/config/ConfigLifecycle.java

@@ -0,0 +1,39 @@
+package com.github.imdmk.automessage.config;
+
+import com.github.imdmk.automessage.platform.logger.PluginLogger;
+import com.github.imdmk.automessage.shared.validate.Validator;
+import eu.okaeri.configs.exception.OkaeriException;
+import org.jetbrains.annotations.NotNull;
+
+final class ConfigLifecycle {
+
+    private final PluginLogger logger;
+
+    ConfigLifecycle(@NotNull PluginLogger logger) {
+        this.logger = Validator.notNull(logger, "logger");
+    }
+
+    void initialize(@NotNull ConfigSection config) {
+        config.saveDefaults();
+        load(config);
+    }
+
+    void load(@NotNull ConfigSection config) {
+        try {
+            config.load(true);
+        } catch (OkaeriException e) {
+            logger.error(e, "Failed to load config %s", config.getClass().getSimpleName());
+            throw new ConfigAccessException(e);
+        }
+    }
+
+    void save(@NotNull ConfigSection config) {
+        try {
+            config.save();
+        } catch (Exception e) {
+            logger.error(e, "Failed to save config %s", config.getClass().getSimpleName());
+            throw new ConfigAccessException(e);
+        }
+    }
+}
+