Merge pull request #5 from JesusCrie/dev

Release 2.1.0

Author: Lucas Malandrino

.idea/compiler.xml

@@ -1,5 +1,5 @@
 dependencies {
-    compile "com.jesus-crie:modularbot-core:$version"
-    compile "com.jesus-crie:modularbot-logger:$version"
-    compile "com.jesus-crie:modularbot-command:$version"
+    compile project(':modularbot-core')
+    compile project(':modularbot-logger')
+    compile project(':modularbot-command')
 }

ModularBot-Base/build.gradle

@@ -1,5 +1,5 @@
 dependencies {
     compile project(':modularbot-core')
 
-    testCompile project(':modularbot-logger')
+    testImplementation project(':modularbot-logger')
 }

ModularBot-Command/build.gradle

@@ -17,53 +17,55 @@ public class  AccessLevel {
      * Literally everyone, everywhere.
      */
     public static final AccessLevel EVERYONE = new AccessLevel(
-            EnumSet.noneOf(Permission.class), false, false, 0);
+            EnumSet.noneOf(Permission.class), false, false);
 
     /**
      * Only available in guilds.
      */
     public static final AccessLevel GUILD_ONLY = new AccessLevel(
-            EnumSet.noneOf(Permission.class), true, false, 0);
+            EnumSet.noneOf(Permission.class), true, false);
 
     /**
      * Only available in private channels.
      */
     public static final AccessLevel PRIVATE_ONLY = new AccessLevel(
-            EnumSet.noneOf(Permission.class), false, true, 0);
+            EnumSet.noneOf(Permission.class), false, true);
 
     /**
      * In guilds, peoples who can delete messages.
      */
     public static final AccessLevel GUILD_MODERATOR = new AccessLevel(
-            EnumSet.of(Permission.MESSAGE_MANAGE), true, false, 0);
+            EnumSet.of(Permission.MESSAGE_MANAGE), true, false);
 
     /**
      * In guilds, those who have all of the permissions.
      */
     public static final AccessLevel GUILD_ADMINISTRATOR = new AccessLevel(
-            EnumSet.of(Permission.ADMINISTRATOR), true, false, 0);
+            EnumSet.of(Permission.ADMINISTRATOR), true, false);
 
     /**
      * Only the creator of the bot.
      */
-    public static final AccessLevel CREATOR = new AccessLevel(EnumSet.noneOf(Permission.class), false, false, CREATOR_ID);
+    public static final AccessLevel CREATOR = new AccessLevel(EnumSet.noneOf(Permission.class), false, false) {
+        @Override
+        public boolean check(@Nonnull CommandEvent event) {
+            return event.getAuthor().getIdLong() == CREATOR_ID;
+        }
+    };
 
     private final EnumSet<Permission> requiredPermissions;
     private final boolean onlyGuild;
     private final boolean onlyPrivate;
-    private final long user;
 
     /**
      * @param requiredPermissions   The permissions required if in a guild.
      * @param onlyGuild             Flag that indicate that this can only occur in a guild.
      * @param onlyPrivate           Flag that indicate that this can only occur in a private channel.
-     * @param user                  Flag that indicate that only this user can use this, /!\ overwrite every other flag /!\.
      */
-    public AccessLevel(@Nonnull EnumSet<Permission> requiredPermissions, boolean onlyGuild, boolean onlyPrivate, long user) {
+    public AccessLevel(@Nonnull EnumSet<Permission> requiredPermissions, boolean onlyGuild, boolean onlyPrivate) {
         this.requiredPermissions = requiredPermissions;
         this.onlyGuild = onlyGuild;
         this.onlyPrivate = onlyPrivate;
-        this.user = user;
     }
 
     /**
@@ -72,10 +74,6 @@ public AccessLevel(@Nonnull EnumSet<Permission> requiredPermissions, boolean onl
      * @return
      */
     public boolean check(@Nonnull CommandEvent event) {
-        // Check user
-        if (user != 0)
-            return user == event.getAuthor().getIdLong();
-
         // If in a guild
         if (event.isFromType(ChannelType.TEXT)) {
             // Only private, eliminatory

ModularBot-Command/src/main/java/com/jesus_crie/modularbot_command/AccessLevel.java

@@ -2,10 +2,9 @@
 
 import com.jesus_crie.modularbot.ModularBotBuilder;
 import com.jesus_crie.modularbot.module.BaseModule;
-import com.jesus_crie.modularbot_command.annotations.CommandInfo;
+import com.jesus_crie.modularbot.module.ModuleManager;
 import com.jesus_crie.modularbot_command.listener.CommandListener;
 import com.jesus_crie.modularbot_command.listener.DiscordCommandListener;
-import com.jesus_crie.modularbot_command.listener.NopCommandListener;
 import com.jesus_crie.modularbot_command.processing.CommandProcessor;
 
 import javax.annotation.Nonnull;
@@ -20,7 +19,7 @@ public class CommandModule extends BaseModule {
 
     // Prefix stuff
     private String defaultPrefix = "!";
-    private Map<Long, String> customPrefix = new HashMap<>();
+    private Map<Long, String> customPrefix = Collections.emptyMap();
 
     // Command storing
     private List<Command> commandStorage = new ArrayList<>();
@@ -35,7 +34,7 @@ public CommandModule() {
     }
 
     @Override
-    public void onLoad(@Nonnull final ModularBotBuilder builder) {
+    public void onLoad(@Nonnull final ModuleManager moduleManager, @Nonnull final ModularBotBuilder builder) {
         builder.addListeners(new DiscordCommandListener(this));
     }
 
@@ -65,15 +64,45 @@ public void setCommandProcessorFlags(int... flags) {
 
     /**
      * Set the id of the owner of the bot used in {@link AccessLevel#CREATOR}.
+     * Will be automatically called if you use the config module.
      *
      * @param owner The discord id of the account of the creator.
      */
-    public void setOwnerId(final long owner) {
+    public void setCreatorId(final long owner) {
         AccessLevel.CREATOR_ID = owner;
     }
 
+    /**
+     * Register a new prefix for a guild and override the old one if present.
+     * Used by the config module.
+     * <p>
+     * You can also delete the prefix by letting the prefix {@code null}.
+     *
+     * @param guildId The id of the targeted guild.
+     * @param prefix  The prefix for this guild.
+     */
+    public void addCustomPrefixForGuild(final long guildId, @Nullable final String prefix) {
+        if (customPrefix.size() == 0)
+            customPrefix = new HashMap<>();
+
+        if (prefix == null || prefix.length() == 0 || defaultPrefix.equals(prefix))
+            customPrefix.remove(guildId);
+
+        customPrefix.put(guildId, prefix);
+    }
+
+    /**
+     * Get an unmodifiable view of the custom prefixes.
+     * Used by the config module.
+     *
+     * @return A view of the custom prefixes.
+     */
+    public Map<Long, String> getCustomPrefixes() {
+        return Collections.unmodifiableMap(customPrefix);
+    }
+
     @Nonnull
-    public String getPrefixForGuild(long guildId) {
+    public String getPrefixForGuild(final long guildId) {
         return customPrefix.getOrDefault(guildId, defaultPrefix);
     }
 

ModularBot-Command/src/main/java/com/jesus_crie/modularbot_command/CommandModule.java

@@ -1,5 +1,6 @@
 package com.jesus_crie.modularbot_command;
 
+import com.jesus_crie.modularbot.module.ModuleManager;
 import com.jesus_crie.modularbot_command.annotations.CommandInfo;
 import com.jesus_crie.modularbot_command.annotations.RegisterPattern;
 import com.jesus_crie.modularbot_command.exception.InvalidCommandPatternMethodException;
@@ -10,13 +11,7 @@
 import net.dv8tion.jda.core.entities.User;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-import org.slf4j.impl.ModularLog;
-import org.slf4j.impl.ModularLogger;
 
-import javax.annotation.Nonnull;
-import javax.annotation.RegEx;
 import java.net.URL;
 import java.util.List;
 
@@ -28,7 +23,7 @@ public class CommandTest {
 
     @BeforeAll
     static void beforeAll() {
-        new ConsoleLoggerModule().onLoad(null);
+        new ConsoleLoggerModule().onLoad(new ModuleManager(), null);
     }
 
     @Test

ModularBot-Command/src/test/java/com/jesus_crie/modularbot_command/CommandTest.java

@@ -1,6 +1,7 @@
 dependencies {
     compile 'net.dv8tion:JDA:3.6.0_375'
 
-    testCompile project(':modularbot-command')
-    testCompile project(':modularbot-logger')
+    testImplementation project(':modularbot-command')
+    testImplementation project(':modularbot-logger')
+    testImplementation project(':modularbot-night-config-wrapper')
 }

ModularBot-Core/build.gradle

@@ -5,6 +5,8 @@
 import com.jesus_crie.modularbot.utils.IStateProvider;
 import net.dv8tion.jda.core.JDA;
 import net.dv8tion.jda.core.audio.factory.IAudioSendFactory;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import javax.annotation.Nonnull;
 import java.util.ArrayList;
@@ -13,6 +15,8 @@
 
 public class ModularBotBuilder {
 
+    private static final Logger LOG = LoggerFactory.getLogger("ModularBotBuilder");
+
     protected final String token;
     protected int shards = -1;
     protected IStateProvider stateProvider = null;
@@ -171,15 +175,23 @@ public ModularBotBuilder autoLoadBaseModules() {
             Class<? extends BaseModule> loggerModule = (Class<? extends BaseModule>) Class.forName("com.jesus_crie.modularbot_logger.ConsoleLoggerModule");
             moduleManager.registerModules(this, loggerModule);
         } catch (ClassNotFoundException e) {
-            System.out.println("[Warn] Failed to autoload logger module.");
+            LOG.debug("Failed to autoload logger module.");
         }
 
         // Try command module
         try {
             Class<? extends BaseModule> commandModule = (Class<? extends BaseModule>) Class.forName("com.jesus_crie.modularbot_command.CommandModule");
             moduleManager.registerModules(this, commandModule);
         } catch (ClassNotFoundException e) {
-            System.out.println("[Warn] Failed to autoload command module.");
+            LOG.debug("Failed to autoload command module.");
+        }
+
+        // Try night config module
+        try {
+            Class<? extends BaseModule> nightConfigModule = (Class<? extends BaseModule>) Class.forName("com.jesus_crie.modularbot_nightconfigwrapper.NightConfigWrapperModule");
+            moduleManager.registerModules(this, nightConfigModule);
+        } catch (ClassNotFoundException e) {
+            LOG.debug("Failed to autoload night config module.");
         }
 
         // TODO 16/06/18 renember to complete with new modules

ModularBot-Core/src/main/java/com/jesus_crie/modularbot/ModularBotBuilder.java

@@ -11,9 +11,10 @@ public interface Lifecycle {
     /**
      * Called when the module is loaded in the first place, occurs when the module is registered.
      *
-     * @param builder The {@link ModularBotBuilder ModularBotBuilder} which is associated.
+     * @param moduleManager The current {@link ModuleManager ModuleManager}
+     * @param builder       The {@link ModularBotBuilder ModularBotBuilder} which is associated.
      */
-    default void onLoad(@Nonnull final ModularBotBuilder builder) {}
+    default void onLoad(@Nonnull final ModuleManager moduleManager, @Nonnull final ModularBotBuilder builder) {}
 
     /**
      * Called when the instance of {@link ModularBot ModularBot} is almost created and the {@link ModuleManager ModuleManager}
@@ -41,7 +42,7 @@ default void onShardsCreated() {}
      * Called right after all of the shards have received the {@link net.dv8tion.jda.core.events.ReadyEvent ReadyEvent}.
      * If you need to do things the the bot come online, put it here.
      *
-     * This method MUST call the {@link super}.
+     * This method MUST call the {@code super}.
      *
      * @param bot The associated instance of {@link ModularBot ModularBot}.
      */

ModularBot-Core/src/main/java/com/jesus_crie/modularbot/module/Lifecycle.java

@@ -27,7 +27,7 @@ public void registerModule(@Nonnull final ModularBotBuilder builder, @Nonnull fi
             throw new ModuleAlreadyLoadedException("Found another module " + m.getClass() + " !");
 
         modules.put(module.getClass(), module);
-        module.onLoad(builder);
+        module.onLoad(this, builder);
         module.state = Lifecycle.State.LOADED;
     }