GH-56 Simplify configuration file names and some code cleanup.

imDMK · web-flow · commit 3b514f5c268c · 2025-07-04T12:50:27.000+02:00
diff --git a/src/main/java/com/github/imdmk/automessage/AutoMessage.java b/src/main/java/com/github/imdmk/automessage/AutoMessage.java
@@ -2,19 +2,19 @@
 
 import com.eternalcode.multification.notice.Notice;
 import com.github.imdmk.automessage.configuration.ConfigurationManager;
-import com.github.imdmk.automessage.configuration.implementation.PluginConfiguration;
-import com.github.imdmk.automessage.feature.command.builder.configuration.CommandConfiguration;
+import com.github.imdmk.automessage.configuration.PluginConfig;
+import com.github.imdmk.automessage.feature.command.builder.configuration.CommandConfig;
 import com.github.imdmk.automessage.feature.command.builder.configuration.CommandEditor;
 import com.github.imdmk.automessage.feature.command.builder.handler.MissingPermissionHandler;
 import com.github.imdmk.automessage.feature.command.builder.handler.UsageHandler;
 import com.github.imdmk.automessage.feature.command.builder.player.PlayerArgument;
 import com.github.imdmk.automessage.feature.command.builder.player.PlayerContextual;
 import com.github.imdmk.automessage.feature.command.implementation.DelayCommand;
 import com.github.imdmk.automessage.feature.command.implementation.ReloadCommand;
-import com.github.imdmk.automessage.feature.message.MessageConfiguration;
+import com.github.imdmk.automessage.feature.message.MessageConfig;
 import com.github.imdmk.automessage.feature.message.MessageResultHandler;
 import com.github.imdmk.automessage.feature.message.MessageService;
-import com.github.imdmk.automessage.feature.message.auto.AutoMessageConfiguration;
+import com.github.imdmk.automessage.feature.message.auto.AutoMessageConfig;
 import com.github.imdmk.automessage.feature.message.auto.dispatcher.AutoMessageDispatcher;
 import com.github.imdmk.automessage.feature.message.auto.eligibility.AutoMessageEligibilityEvaluator;
 import com.github.imdmk.automessage.feature.message.auto.eligibility.DefaultEligibilityEvaluator;
@@ -32,7 +32,9 @@
 import org.bukkit.command.CommandSender;
 import org.bukkit.entity.Player;
 import org.bukkit.plugin.Plugin;
+import org.jetbrains.annotations.NotNull;
 
+import java.util.Objects;
 import java.util.concurrent.TimeUnit;
 import java.util.logging.Logger;
 import java.util.stream.Stream;
@@ -47,16 +49,14 @@ class AutoMessage {
     private final Logger logger;
 
     private final ConfigurationManager configurationManager;
-
     private final MessageService messageService;
-
     private final TaskScheduler taskScheduler;
 
     private final LiteCommands<CommandSender> liteCommands;
-
     private final Metrics metrics;
 
-    AutoMessage(Plugin plugin) {
+    AutoMessage(@NotNull Plugin plugin) {
+        Objects.requireNonNull(plugin, "plugin cannot be null.");
         Stopwatch stopwatch = Stopwatch.createStarted();
 
         this.server = plugin.getServer();
@@ -65,32 +65,32 @@ class AutoMessage {
         /* Configuration */
         this.configurationManager = new ConfigurationManager(this.logger, plugin.getDataFolder());
 
-        PluginConfiguration pluginConfiguration = this.configurationManager.create(PluginConfiguration.class);
-        MessageConfiguration messageConfiguration = this.configurationManager.create(MessageConfiguration.class);
-        AutoMessageConfiguration autoMessageConfiguration = this.configurationManager.create(AutoMessageConfiguration.class);
-        CommandConfiguration commandConfiguration = this.configurationManager.create(CommandConfiguration.class);
+        PluginConfig pluginConfig = this.configurationManager.create(PluginConfig.class);
+        MessageConfig messageConfig = this.configurationManager.create(MessageConfig.class);
+        AutoMessageConfig autoMessageConfig = this.configurationManager.create(AutoMessageConfig.class);
+        CommandConfig commandConfig = this.configurationManager.create(CommandConfig.class);
 
         /* Services */
-        this.messageService = new MessageService(messageConfiguration, BukkitAudiences.create(plugin), MiniMessage.miniMessage());
-        UpdateService updateService = new UpdateService(pluginConfiguration, plugin.getDescription());
+        this.messageService = new MessageService(messageConfig, BukkitAudiences.create(plugin), MiniMessage.miniMessage());
+        UpdateService updateService = new UpdateService(pluginConfig, plugin.getDescription());
 
         /* Scheduler */
         this.taskScheduler = new BukkitTaskScheduler(plugin, this.server);
 
         /* Dispatcher */
         AutoMessageEligibilityEvaluator eligibilityEvaluator = new DefaultEligibilityEvaluator();
 
-        AutoMessageDispatcher autoMessageDispatcher = new AutoMessageDispatcher(this.server, this.configurationManager, autoMessageConfiguration, this.messageService, this.taskScheduler, eligibilityEvaluator);
+        AutoMessageDispatcher autoMessageDispatcher = new AutoMessageDispatcher(this.server, this.configurationManager, autoMessageConfig, this.messageService, this.taskScheduler, eligibilityEvaluator);
         autoMessageDispatcher.schedule();
 
         /* Controllers */
         Stream.of(
-                new UpdateController(this.logger, pluginConfiguration, this.messageService, updateService, this.taskScheduler)
+                new UpdateController(this.logger, pluginConfig, this.messageService, updateService, this.taskScheduler)
         ).forEach(listener -> this.server.getPluginManager().registerEvents(listener, plugin));
 
         /* LiteCommands */
         this.liteCommands = LiteBukkitFactory.builder("AutoMessage", plugin, this.server)
-                .argument(Player.class, new PlayerArgument(this.server, messageConfiguration))
+                .argument(Player.class, new PlayerArgument(this.server, messageConfig))
 
                 .context(Player.class, new PlayerContextual())
                 .result(Notice.class, new MessageResultHandler(this.messageService))
@@ -103,7 +103,7 @@ class AutoMessage {
                         new ReloadCommand(this.logger, this.configurationManager, this.messageService)
                 )
 
-                .editorGlobal(new CommandEditor(this.logger, commandConfiguration))
+                .editorGlobal(new CommandEditor(this.logger, commandConfig))
 
                 .build();
 
diff --git a/src/main/java/com/github/imdmk/automessage/configuration/PluginConfig.java b/src/main/java/com/github/imdmk/automessage/configuration/PluginConfig.java
@@ -1,14 +1,13 @@
-package com.github.imdmk.automessage.configuration.implementation;
+package com.github.imdmk.automessage.configuration;
 
-import com.github.imdmk.automessage.configuration.ConfigSection;
 import eu.okaeri.configs.annotation.Comment;
 import eu.okaeri.configs.serdes.OkaeriSerdesPack;
 import eu.okaeri.configs.serdes.commons.SerdesCommons;
 import org.jetbrains.annotations.NotNull;
 
 import java.time.Duration;
 
-public class PluginConfiguration extends ConfigSection {
+public class PluginConfig extends ConfigSection {
 
     @Comment("# Check for plugin update and send notification after administrator join to server?")
     public boolean checkUpdate = true;
@@ -25,6 +24,6 @@ public class PluginConfiguration extends ConfigSection {
 
     @Override
     public @NotNull String getFileName() {
-        return "pluginConfiguration.yml";
+        return "pluginConfig.yml";
     }
 }
diff --git a/src/main/java/com/github/imdmk/automessage/feature/command/builder/configuration/CommandConfig.java b/src/main/java/com/github/imdmk/automessage/feature/command/builder/configuration/CommandConfig.java
@@ -15,7 +15,7 @@
         "# This file allows you to configure commands.",
         "#"
 })
-public class CommandConfiguration extends ConfigSection {
+public class CommandConfig extends ConfigSection {
 
     @Comment("# Specifies to enable command editor feature.")
     public boolean enabled = false;
@@ -63,6 +63,6 @@ public Optional<Command> getCommand(String name) {
 
     @Override
     public @NotNull String getFileName() {
-        return "commandConfiguration.yml";
+        return "commandConfig.yml";
     }
 }
diff --git a/src/main/java/com/github/imdmk/automessage/feature/command/builder/configuration/CommandEditor.java b/src/main/java/com/github/imdmk/automessage/feature/command/builder/configuration/CommandEditor.java
@@ -12,9 +12,9 @@
 public class CommandEditor implements Editor<CommandSender> {
 
     private final Logger logger;
-    private final CommandConfiguration configuration;
+    private final CommandConfig configuration;
 
-    public CommandEditor(@NotNull Logger logger, @NotNull CommandConfiguration configuration) {
+    public CommandEditor(@NotNull Logger logger, @NotNull CommandConfig configuration) {
         this.logger = logger;
         this.configuration = configuration;
     }
diff --git a/src/main/java/com/github/imdmk/automessage/feature/command/builder/player/PlayerArgument.java b/src/main/java/com/github/imdmk/automessage/feature/command/builder/player/PlayerArgument.java
@@ -1,6 +1,6 @@
 package com.github.imdmk.automessage.feature.command.builder.player;
 
-import com.github.imdmk.automessage.feature.message.MessageConfiguration;
+import com.github.imdmk.automessage.feature.message.MessageConfig;
 import dev.rollczi.litecommands.argument.Argument;
 import dev.rollczi.litecommands.argument.parser.ParseResult;
 import dev.rollczi.litecommands.argument.resolver.ArgumentResolver;
@@ -18,18 +18,18 @@
 public class PlayerArgument extends ArgumentResolver<CommandSender, Player> {
 
     private final Server server;
-    private final MessageConfiguration messageConfiguration;
+    private final MessageConfig messageConfig;
 
-    public PlayerArgument(@NotNull Server server, @NotNull MessageConfiguration messageConfiguration) {
+    public PlayerArgument(@NotNull Server server, @NotNull MessageConfig messageConfig) {
         this.server = Objects.requireNonNull(server, "server cannot be null");
-        this.messageConfiguration = Objects.requireNonNull(messageConfiguration, "messageConfiguration cannot be null");
+        this.messageConfig = Objects.requireNonNull(messageConfig, "messageConfiguration cannot be null");
     }
 
     @Override
     protected ParseResult<Player> parse(Invocation<CommandSender> invocation, Argument<Player> context, String argument) {
         return Optional.ofNullable(this.server.getPlayer(argument))
                 .map(ParseResult::success)
-                .orElseGet(() -> ParseResult.failure(this.messageConfiguration.playerNotFound));
+                .orElseGet(() -> ParseResult.failure(this.messageConfig.playerNotFound));
     }
 
     @Override
diff --git a/src/main/java/com/github/imdmk/automessage/feature/message/MessageConfig.java b/src/main/java/com/github/imdmk/automessage/feature/message/MessageConfig.java
@@ -8,7 +8,7 @@
 import eu.okaeri.configs.serdes.OkaeriSerdesPack;
 import org.jetbrains.annotations.NotNull;
 
-public class MessageConfiguration extends ConfigSection {
+public class MessageConfig extends ConfigSection {
 
     @Comment({
             "# Sent when the automatic message delay is changed",
@@ -61,6 +61,6 @@ public class MessageConfiguration extends ConfigSection {
 
     @Override
     public @NotNull String getFileName() {
-        return "messageConfiguration.yml";
+        return "messageConfig.yml";
     }
 }
diff --git a/src/main/java/com/github/imdmk/automessage/feature/message/MessageService.java b/src/main/java/com/github/imdmk/automessage/feature/message/MessageService.java
@@ -14,25 +14,25 @@
 
 import java.util.Objects;
 
-public final class MessageService extends BukkitMultification<MessageConfiguration> {
+public final class MessageService extends BukkitMultification<MessageConfig> {
 
-    private final MessageConfiguration messageConfiguration;
+    private final MessageConfig messageConfig;
     private final AudienceProvider audienceProvider;
     private final MiniMessage miniMessage;
 
     public MessageService(
-            @NotNull MessageConfiguration messageConfiguration,
+            @NotNull MessageConfig messageConfig,
             @NotNull AudienceProvider audienceProvider,
             @NotNull MiniMessage miniMessage
     ) {
-        this.messageConfiguration = Objects.requireNonNull(messageConfiguration, "messageConfiguration cannot be null");
+        this.messageConfig = Objects.requireNonNull(messageConfig, "messageConfiguration cannot be null");
         this.audienceProvider = Objects.requireNonNull(audienceProvider, "audienceProvider cannot be null");
         this.miniMessage = Objects.requireNonNull(miniMessage, "miniMessage cannot be null");
     }
 
     @Override
-    protected @NotNull TranslationProvider<MessageConfiguration> translationProvider() {
-        return locale -> this.messageConfiguration;
+    protected @NotNull TranslationProvider<MessageConfig> translationProvider() {
+        return locale -> this.messageConfig;
     }
 
     @Override
@@ -51,7 +51,7 @@ public MessageService(
         };
     }
 
-    public void send(@NotNull CommandSender sender, @NotNull NoticeProvider<MessageConfiguration> notice) {
+    public void send(@NotNull CommandSender sender, @NotNull NoticeProvider<MessageConfig> notice) {
         this.create().viewer(sender).notice(notice).send();
     }
 
diff --git a/src/main/java/com/github/imdmk/automessage/feature/message/auto/AutoMessageConfig.java b/src/main/java/com/github/imdmk/automessage/feature/message/auto/AutoMessageConfig.java
@@ -4,6 +4,7 @@
 import com.eternalcode.multification.notice.resolver.NoticeResolverDefaults;
 import com.eternalcode.multification.okaeri.MultificationSerdesPack;
 import com.github.imdmk.automessage.configuration.ConfigSection;
+import com.github.imdmk.automessage.feature.message.auto.selector.AutoMessageSelectorMode;
 import eu.okaeri.configs.annotation.Comment;
 import eu.okaeri.configs.serdes.OkaeriSerdesPack;
 import eu.okaeri.configs.serdes.commons.SerdesCommons;
@@ -14,7 +15,7 @@
 import java.util.Arrays;
 import java.util.List;
 
-public class AutoMessageConfiguration extends ConfigSection {
+public class AutoMessageConfig extends ConfigSection {
 
     @Comment("# How often should automatic messages be sent?")
     public Duration delay = Duration.ofSeconds(10);
@@ -24,7 +25,7 @@ public class AutoMessageConfiguration extends ConfigSection {
             "# RANDOM - messages are chosen randomly.",
             "# SEQUENTIAL - messages are sent in order."
     })
-    public AutoMessageMode mode = AutoMessageMode.SEQUENTIAL;
+    public AutoMessageSelectorMode mode = AutoMessageSelectorMode.SEQUENTIAL;
 
     @Comment({
             "# List of automatic messages to be dispatched.",
@@ -69,7 +70,7 @@ public class AutoMessageConfiguration extends ConfigSection {
 
     @Override
     public @NotNull String getFileName() {
-        return "autoMessageConfiguration.yml";
+        return "autoMessageConfig.yml";
     }
 
     public void setDelay(@NotNull Duration delay) {
diff --git a/src/main/java/com/github/imdmk/automessage/feature/message/auto/dispatcher/AutoMessageDispatcher.java b/src/main/java/com/github/imdmk/automessage/feature/message/auto/dispatcher/AutoMessageDispatcher.java
@@ -2,7 +2,7 @@
 
 import com.github.imdmk.automessage.configuration.ConfigurationManager;
 import com.github.imdmk.automessage.feature.message.MessageService;
-import com.github.imdmk.automessage.feature.message.auto.AutoMessageConfiguration;
+import com.github.imdmk.automessage.feature.message.auto.AutoMessageConfig;
 import com.github.imdmk.automessage.feature.message.auto.AutoMessageNotice;
 import com.github.imdmk.automessage.feature.message.auto.eligibility.AutoMessageEligibilityEvaluator;
 import com.github.imdmk.automessage.feature.message.auto.selector.AutoMessageSelector;
@@ -34,7 +34,7 @@ public final class AutoMessageDispatcher {
 
     private final Server server;
     private final ConfigurationManager configurationManager;
-    private final AutoMessageConfiguration configuration;
+    private final AutoMessageConfig configuration;
     private final MessageService messageService;
     private final TaskScheduler taskScheduler;
 
@@ -46,7 +46,7 @@ public final class AutoMessageDispatcher {
     public AutoMessageDispatcher(
             @NotNull Server server,
             @NotNull ConfigurationManager configurationManager,
-            @NotNull AutoMessageConfiguration configuration,
+            @NotNull AutoMessageConfig configuration,
             @NotNull MessageService messageService,
             @NotNull TaskScheduler taskScheduler,
             @NotNull AutoMessageEligibilityEvaluator eligibilityEvaluator
diff --git a/src/main/java/com/github/imdmk/automessage/feature/message/auto/selector/AutoMessageSelectorFactory.java b/src/main/java/com/github/imdmk/automessage/feature/message/auto/selector/AutoMessageSelectorFactory.java
@@ -1,6 +1,5 @@
 package com.github.imdmk.automessage.feature.message.auto.selector;
 
-import com.github.imdmk.automessage.feature.message.auto.AutoMessageMode;
 import com.github.imdmk.automessage.feature.message.auto.eligibility.AutoMessageEligibilityEvaluator;
 import org.jetbrains.annotations.NotNull;
 
@@ -14,14 +13,14 @@ private AutoMessageSelectorFactory() {
     }
 
     /**
-     * Creates an {@link AutoMessageSelector} according to the given {@link AutoMessageMode}.
+     * Creates an {@link AutoMessageSelector} according to the given {@link AutoMessageSelectorMode}.
      *
      * @param mode      the selection mode, must not be {@code null}
      * @param evaluator the eligibility evaluator used by the selector, must not be {@code null}
      * @return a new instance of {@link AutoMessageSelector} matching the specified mode
      */
     public static AutoMessageSelector create(
-            @NotNull AutoMessageMode mode,
+            @NotNull AutoMessageSelectorMode mode,
             @NotNull AutoMessageEligibilityEvaluator evaluator
     ) {
         return switch (mode) {
diff --git a/src/main/java/com/github/imdmk/automessage/feature/message/auto/selector/AutoMessageSelectorMode.java b/src/main/java/com/github/imdmk/automessage/feature/message/auto/selector/AutoMessageSelectorMode.java
@@ -1,11 +1,11 @@
-package com.github.imdmk.automessage.feature.message.auto;
+package com.github.imdmk.automessage.feature.message.auto.selector;
 
 /**
  * Represents the strategy used for selecting and dispatching automatic messages.
  * <p>
  * This enum defines how messages should be selected from the configured list.
  */
-public enum AutoMessageMode {
+public enum AutoMessageSelectorMode {
 
     /**
      * Messages are selected randomly from the configured list.
diff --git a/src/main/java/com/github/imdmk/automessage/feature/update/UpdateController.java b/src/main/java/com/github/imdmk/automessage/feature/update/UpdateController.java
@@ -3,7 +3,7 @@
 import com.eternalcode.gitcheck.GitCheckResult;
 import com.eternalcode.gitcheck.git.GitException;
 import com.eternalcode.multification.notice.Notice;
-import com.github.imdmk.automessage.configuration.implementation.PluginConfiguration;
+import com.github.imdmk.automessage.configuration.PluginConfig;
 import com.github.imdmk.automessage.feature.message.MessageService;
 import com.github.imdmk.automessage.scheduler.TaskScheduler;
 import com.github.imdmk.automessage.util.DurationUtil;
@@ -34,28 +34,28 @@ public class UpdateController implements Listener {
     );
 
     private final Logger logger;
-    private final PluginConfiguration pluginConfiguration;
+    private final PluginConfig pluginConfig;
     private final MessageService messageService;
     private final UpdateService updateService;
     private final TaskScheduler taskScheduler;
 
     public UpdateController(
             @NotNull Logger logger,
-            @NotNull PluginConfiguration pluginConfiguration,
+            @NotNull PluginConfig pluginConfig,
             @NotNull MessageService messageService,
             @NotNull UpdateService updateService,
             @NotNull TaskScheduler taskScheduler
     ) {
         this.logger = Objects.requireNonNull(logger, "logger cannot be null");
-        this.pluginConfiguration = Objects.requireNonNull(pluginConfiguration, "pluginConfiguration cannot be null");
+        this.pluginConfig = Objects.requireNonNull(pluginConfig, "pluginConfiguration cannot be null");
         this.messageService = Objects.requireNonNull(messageService, "messageService cannot be null");
         this.updateService = Objects.requireNonNull(updateService, "updateService cannot be null");
         this.taskScheduler = Objects.requireNonNull(taskScheduler, "taskScheduler cannot be null");
     }
 
     @EventHandler(priority = EventPriority.HIGHEST)
     void onPlayerJoin(final PlayerJoinEvent event) {
-        if (!this.pluginConfiguration.checkUpdate) {
+        if (!this.pluginConfig.checkUpdate) {
             return;
         }
 
@@ -88,7 +88,7 @@ private void checkForUpdate(@NotNull Player player) {
     private void sendNotice(@NotNull Player player, @NotNull Notice notice) {
         this.messageService.create()
                 .notice(notice)
-                .placeholder("{UPDATE_CHECK_INTERVAL}", DurationUtil.format(this.pluginConfiguration.updateInterval))
+                .placeholder("{UPDATE_CHECK_INTERVAL}", DurationUtil.format(this.pluginConfig.updateInterval))
                 .viewer(player)
                 .send();
     }
diff --git a/src/main/java/com/github/imdmk/automessage/feature/update/UpdateService.java b/src/main/java/com/github/imdmk/automessage/feature/update/UpdateService.java
diff --git a/src/main/java/com/github/imdmk/automessage/util/CollectionUtil.java b/src/main/java/com/github/imdmk/automessage/util/CollectionUtil.java
diff --git a/src/main/java/com/github/imdmk/automessage/util/ComponentUtil.java b/src/main/java/com/github/imdmk/automessage/util/ComponentUtil.java

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`"# This file allows you to configure commands.",`
`16`	`16`	`"#"`
`17`	`17`	`})`
`18`		`-public class CommandConfiguration extends ConfigSection {`
	`18`	`+public class CommandConfig extends ConfigSection {`
`19`	`19`
`20`	`20`	`@Comment("# Specifies to enable command editor feature.")`
`21`	`21`	`public boolean enabled = false;`
`@@ -63,6 +63,6 @@ public Optional<Command> getCommand(String name) {`
`63`	`63`
`64`	`64`	`@Override`
`65`	`65`	`public @NotNull String getFileName() {`
`66`		`- return "commandConfiguration.yml";`
	`66`	`+ return "commandConfig.yml";`
`67`	`67`	`}`
`68`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`import eu.okaeri.configs.serdes.OkaeriSerdesPack;`
`9`	`9`	`import org.jetbrains.annotations.NotNull;`
`10`	`10`
`11`		`-public class MessageConfiguration extends ConfigSection {`
	`11`	`+public class MessageConfig extends ConfigSection {`
`12`	`12`
`13`	`13`	`@Comment({`
`14`	`14`	`"# Sent when the automatic message delay is changed",`
`@@ -61,6 +61,6 @@ public class MessageConfiguration extends ConfigSection {`
`61`	`61`
`62`	`62`	`@Override`
`63`	`63`	`public @NotNull String getFileName() {`
`64`		`- return "messageConfiguration.yml";`
	`64`	`+ return "messageConfig.yml";`
`65`	`65`	`}`
`66`	`66`	`}`