Break Commons's functions down into modules

Commons/src/main/java/cl/bgmp/commons/Commons.java

@@ -2,7 +2,10 @@
 
 import cl.bgmp.commons.Chat.ChatFormatter;
 import cl.bgmp.commons.Commands.ChatFormatterCommand;
-import cl.bgmp.commons.Navigator.Navigator;
+import cl.bgmp.commons.Modules.Module;
+import cl.bgmp.commons.Modules.ModuleManager;
+import cl.bgmp.commons.Modules.NavigatorModule;
+import cl.bgmp.commons.Modules.JoinToolsModule;
 import cl.bgmp.utilsbukkit.Channels;
 import cl.bgmp.utilsbukkit.Chat;
 import com.sk89q.bukkit.util.BukkitCommandsManager;
@@ -22,21 +25,22 @@
 import org.bukkit.plugin.java.JavaPlugin;
 import org.jetbrains.annotations.NotNull;
 
-public final class Commons extends JavaPlugin {
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
+
+public final class Commons extends JavaPlugin implements ModuleManager {
   private static Commons commons;
-  private Navigator navigator;
   private ChatFormatter chatFormatter;
   private CommandsManager commands;
   private CommandsManagerRegistration commandRegistry;
 
+  private Set<Module> modules = new HashSet<>();
+
   public static Commons get() {
     return commons;
   }
 
-  public Navigator getNavigator() {
-    return navigator;
-  }
-
   public ChatFormatter getChatFormatter() {
     return chatFormatter;
   }
@@ -77,14 +81,16 @@ public void onEnable() {
 
     Channels.registerBungeeToPlugin(this);
 
-    navigator = new Navigator();
     chatFormatter = new ChatFormatter(getLogger());
 
     commands = new BukkitCommandsManager();
     commandRegistry = new CommandsManagerRegistration(this, this.commands);
 
-    registerCommands();
+    registerModules(new NavigatorModule(), new JoinToolsModule());
+    loadModules();
+
     registerEvents();
+    registerCommands();
   }
 
   @Override
@@ -100,8 +106,23 @@ public void registerEvents(Listener... listeners) {
     for (Listener listener : listeners) pluginManager.registerEvents(listener, this);
   }
 
-  public void loadConfiguration() {
+  private void loadConfiguration() {
     getConfig().options().copyDefaults(true);
     saveConfig();
   }
+
+  @Override
+  public void registerModules(Module... modules) {
+    this.modules.addAll(Arrays.asList(modules));
+  }
+
+  @Override
+  public void loadModules() {
+    this.modules.forEach(Module::load);
+  }
+
+  @Override
+  public Module getModule(String id) {
+    return this.modules.stream().filter(module -> module.getId().equals(id)).findFirst().orElse(null);
+  }
 }

Commons/src/main/java/cl/bgmp/commons/Config.java

@@ -26,6 +26,17 @@ private static Configuration getConfig() {
     else return new YamlConfiguration();
   }
 
+  public static class Tools {
+    private static final String onJoinToolsPath = "onjoin-tools";
+
+    private static final boolean defaultOnJoinToolsState = false;
+
+    public static boolean areEnabled() {
+      if (!Validate.pathsAreValid(getConfig().getConfigurationSection(onJoinToolsPath))) return defaultOnJoinToolsState;
+      else return getConfig().getBoolean(onJoinToolsPath);
+    }
+  }
+
   public static class Navigator {
     private static final String navigatorPath = "navigator";
     private static final String navigatorEnabledPath = navigatorPath + ".enabled";

Commons/src/main/java/cl/bgmp/commons/Modules/JoinToolsModule.java

@@ -0,0 +1,54 @@
+package cl.bgmp.commons.Modules;
+
+import cl.bgmp.commons.Commons;
+import cl.bgmp.commons.Config;
+import cl.bgmp.utilsbukkit.Chat;
+import cl.bgmp.utilsbukkit.Items.Items;
+import org.bukkit.Material;
+import org.bukkit.entity.Player;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
+import org.bukkit.event.player.PlayerJoinEvent;
+import org.bukkit.inventory.ItemStack;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class JoinToolsModule extends Module {
+    public static final String id = "join-module";
+
+    private static List<ItemStack> onJoinTools = new ArrayList<ItemStack>() {{
+        add(Items.titledItemStackWithLore(Material.COMPASS, Chat.colourify("&9&lTeleport Tool&r"), new String[]{Chat.colourify("&7Click to teleport!&r")}));
+        add(Items.titledItemStack(Material.RABBIT_FOOT, Chat.colourify("&5&lEdit Wand")));
+    }};
+
+    public JoinToolsModule() {
+        super(id);
+    }
+
+    @EventHandler(priority = EventPriority.LOWEST)
+    public void onPlayerJoin(final PlayerJoinEvent event) {
+        final Player player = event.getPlayer();
+        player.getInventory().clear();
+
+        final Module module = Commons.get().getModule(NavigatorModule.id);
+        if (module != null) {
+            final NavigatorModule navigatorModule = (NavigatorModule) module;
+            if (navigatorModule.isEnabled()) player.getInventory().setItem(4, navigatorModule.getNavigator().getItem());
+        }
+
+        if (!player.hasPermission("commons.tools")) return;
+        player.getInventory().setItem(0, onJoinTools.get(0));
+        player.getInventory().setItem(1, onJoinTools.get(1));
+    }
+
+    @Override
+    public void load() {
+        this.enabled = Config.Tools.areEnabled();
+        if (enabled) Commons.get().registerEvents(this);
+    }
+
+    @Override
+    public void unload() {
+    }
+}

Commons/src/main/java/cl/bgmp/commons/Modules/Module.java

@@ -0,0 +1,24 @@
+package cl.bgmp.commons.Modules;
+
+import org.bukkit.event.Listener;
+
+public abstract class Module implements Listener {
+    protected String id;
+    protected boolean enabled;
+
+    public Module(String id) {
+        this.id = id;
+    }
+
+    public String getId() {
+        return id;
+    }
+
+    public boolean isEnabled() {
+        return enabled;
+    }
+
+    public abstract void load();
+
+    public abstract void unload();
+}

Commons/src/main/java/cl/bgmp/commons/Modules/ModuleManager.java

@@ -0,0 +1,10 @@
+package cl.bgmp.commons.Modules;
+
+public interface ModuleManager {
+
+    void registerModules(Module... modules);
+
+    void loadModules();
+
+    Module getModule(String id);
+}

Commons/src/main/java/cl/bgmp/commons/Modules/NavigatorModule.java

@@ -0,0 +1,54 @@
+package cl.bgmp.commons.Modules;
+
+import cl.bgmp.commons.Commons;
+import cl.bgmp.commons.Config;
+import cl.bgmp.commons.Navigator.Navigator;
+import cl.bgmp.commons.Navigator.NavigatorGUI;
+import org.bukkit.Material;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.player.PlayerInteractEvent;
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.inventory.meta.SkullMeta;
+
+public class NavigatorModule extends Module {
+    public static final String id = "navigator-module";
+    private Navigator navigator = new Navigator();
+
+    public NavigatorModule() {
+        super(id);
+    }
+
+    public Navigator getNavigator() {
+        return navigator;
+    }
+
+    @EventHandler
+    public void onPlayerInteract(PlayerInteractEvent event) {
+        final ItemStack itemInHand = event.getItem();
+        if (itemInHand == null || itemInHand.getType() == Material.AIR) return;
+
+        final ItemStack navigatorItem = navigator.getItem();
+        boolean itemInHandIsNavigator = false;
+
+        if (navigatorItem.getItemMeta() instanceof SkullMeta) {
+            if (!itemInHand.hasItemMeta()
+                    || !itemInHand.getItemMeta().hasLore()
+                    || !navigatorItem.getItemMeta().hasLore()
+            ) return;
+
+            if (itemInHand.getLore().equals(navigatorItem.getLore())) itemInHandIsNavigator = true;
+        } else if (itemInHand.equals(navigator)) itemInHandIsNavigator = true;
+
+        if (itemInHandIsNavigator) event.getPlayer().openInventory(new NavigatorGUI().getInventory());
+    }
+
+    @Override
+    public void load() {
+        this.enabled = Config.Navigator.isEnabled();
+        if (enabled) Commons.get().registerEvents(this);
+    }
+
+    @Override
+    public void unload() {
+    }
+}

Commons/src/main/java/cl/bgmp/commons/Navigator/Navigator.java

@@ -1,70 +1,20 @@
 package cl.bgmp.commons.Navigator;
 
-import cl.bgmp.commons.Commons;
-import cl.bgmp.commons.Config;
 import cl.bgmp.utilsbukkit.Chat;
-import cl.bgmp.utilsbukkit.Items.Items;
 import cl.bgmp.utilsbukkit.Items.PlayerHeads;
-import org.bukkit.Material;
-import org.bukkit.entity.Player;
-import org.bukkit.event.EventHandler;
-import org.bukkit.event.EventPriority;
-import org.bukkit.event.Listener;
-import org.bukkit.event.player.PlayerInteractEvent;
-import org.bukkit.event.player.PlayerJoinEvent;
 import org.bukkit.inventory.ItemStack;
-import org.bukkit.inventory.meta.SkullMeta;
-
-import java.util.ArrayList;
-import java.util.HashMap;
-import java.util.List;
 
 /** The server navigator players are given when joining */
-public class Navigator implements Listener {
+public class Navigator {
   private String title = Chat.colourify("&9&lNavigator&r");
   private String[] lore = new String[] {Chat.colourify("&7Right-Click to pick a Server!&r")};
-
-  // Note: if navigator happens to be a player head, it must contain a lore for validation matters!
   private ItemStack navigator = PlayerHeads.titledPlayerHeadWithLore("Skyron_Varn", title, lore);
 
+  // Note: if navigator's item happens to be a player head, it must contain a lore for validation matters!
   public Navigator() {
-    if (Config.Navigator.isEnabled()) {
-      Commons.get().registerEvents(this);
-    }
-  }
-
-  // TODO: Move this out of here and come up with an idea to modularise it
-  private static List<ItemStack> onJoinItems = new ArrayList<ItemStack>() {{
-      add(Items.titledItemStackWithLore(Material.COMPASS, Chat.colourify("&9&lTeleport Tool&r"), new String[]{Chat.colourify("&7Click to teleport!&r")}));
-      add(Items.titledItemStack(Material.RABBIT_FOOT, Chat.colourify("&5&lEdit Wand")));
-  }};
-
-  @EventHandler
-  public void onPlayerJoin(PlayerJoinEvent event) {
-    final Player player = event.getPlayer();
-    player.getInventory().clear();
-    player.getInventory().setItem(4, navigator);
-
-    if (player.hasPermission("commons.items.compass")) player.getInventory().addItem(onJoinItems.get(0));
-    if (player.hasPermission("commons.items.rabbit_foot")) player.getInventory().addItem(onJoinItems.get(1));
   }
 
-  @EventHandler
-  public void onPlayerInteract(PlayerInteractEvent event) {
-    final ItemStack itemInHand = event.getItem();
-    if (itemInHand == null || itemInHand.getType() == Material.AIR) return;
-
-    boolean itemInHandIsNavigator = false;
-
-    if (navigator.getItemMeta() instanceof SkullMeta) {
-      if (!itemInHand.hasItemMeta()
-              || !itemInHand.getItemMeta().hasLore()
-              || !navigator.getItemMeta().hasLore()
-      ) return;
-
-      if (itemInHand.getLore().equals(navigator.getLore())) itemInHandIsNavigator = true;
-    } else if (itemInHand.equals(navigator)) itemInHandIsNavigator = true;
-
-    if (itemInHandIsNavigator) event.getPlayer().openInventory(new NavigatorGUI().getInventory());
+  public ItemStack getItem() {
+    return navigator;
   }
 }

Commons/src/main/resources/config.yml

@@ -1,3 +1,4 @@
+onjoin-tools: true
 navigator:
   enabled: true
   title: "&b&lAvailable Servers"