Merge pull request #95 from CSC207-2022F-UofT/feature-controller-tests

Add controller and parser tests

Author: hykilpikonna

src/main/java/org/hydev/mcpm/SpigotEntry.java

@@ -6,7 +6,7 @@
 import org.bukkit.command.CommandSender;
 import org.bukkit.plugin.java.JavaPlugin;
 import org.hydev.mcpm.client.arguments.ArgsParser;
-import org.hydev.mcpm.client.arguments.CommandsFactory;
+import org.hydev.mcpm.client.arguments.ArgsParserFactory;
 import org.hydev.mcpm.client.arguments.parsers.CommandParser;
 import org.hydev.mcpm.utils.ColorLogger;
 import org.jetbrains.annotations.NotNull;
@@ -48,7 +48,7 @@ public void onEnable()
         log.info("Enabled!");
 
         // Initialize controller
-        parser = CommandsFactory.serverArgsParser();
+        parser = ArgsParserFactory.serverArgsParser();
 
         // Register mcpm command
         requireNonNull(this.getCommand("mcpm")).setExecutor(this);

src/main/java/org/hydev/mcpm/client/arguments/ArgsParser.java

@@ -116,7 +116,7 @@ public List<CommandParser> getRawSubparsers() {
      * @param args Arguments are ignored.
      */
     public static void main(String[] args) {
-        var parser = CommandsFactory.baseArgsParser();
+        var parser = ArgsParserFactory.baseArgsParser();
 
         try {
             parser.parse(args, ColorLogger.toStdOut());

src/main/java/org/hydev/mcpm/client/arguments/ArgsParserFactory.java

@@ -0,0 +1,35 @@
+package org.hydev.mcpm.client.arguments;
+
+/**
+ * Class that produces default implementations of the Controller and ArgsParser classes.
+ * These classes are used to handle commands.
+ * Checkout Command.java for a process on adding a new command!
+ */
+public class ArgsParserFactory {
+    // No instantiation.
+    private ArgsParserFactory() { }
+
+    /**
+     * Creates an ArgsParser object that has general parsers (works in any environment).
+     *
+     * @return An ArgsParser object. Invoke ArgsParser#parse to see more.
+     */
+    public static ArgsParser baseArgsParser() {
+        var interactors = new InteractorFactory(false);
+        var controllers = new ControllerFactory(interactors);
+
+        return new ArgsParser(ParserFactory.baseParsers(controllers));
+    }
+
+    /**
+     * Creates an ArgsParser object that has all (CLI & Server) parsers.
+     *
+     * @return An ArgsParser object. Invoke ArgsParser#parse to see more.
+     */
+    public static ArgsParser serverArgsParser() {
+        var interactors = new InteractorFactory(true);
+        var controllers = new ControllerFactory(interactors);
+
+        return new ArgsParser(ParserFactory.serverParsers(controllers));
+    }
+}

src/main/java/org/hydev/mcpm/client/arguments/CommandsFactory.java

@@ -0,0 +1,93 @@
+package org.hydev.mcpm.client.arguments;
+
+import org.hydev.mcpm.client.commands.controllers.ExportPluginsController;
+import org.hydev.mcpm.client.commands.controllers.InfoController;
+import org.hydev.mcpm.client.commands.controllers.InstallController;
+import org.hydev.mcpm.client.commands.controllers.ListController;
+import org.hydev.mcpm.client.commands.controllers.LoadController;
+import org.hydev.mcpm.client.commands.controllers.MirrorController;
+import org.hydev.mcpm.client.commands.controllers.PageBoundary;
+import org.hydev.mcpm.client.commands.controllers.RefreshController;
+import org.hydev.mcpm.client.commands.controllers.ReloadController;
+import org.hydev.mcpm.client.commands.controllers.SearchPackagesController;
+import org.hydev.mcpm.client.commands.controllers.UninstallController;
+import org.hydev.mcpm.client.commands.controllers.UnloadController;
+import org.hydev.mcpm.client.commands.controllers.UpdateController;
+import org.hydev.mcpm.client.local.PageController;
+
+/**
+ * Handles the creation of default factory classes.
+ * The required parameters to initialize these classes are acquired from the `boundary` object.
+ *
+ * @param boundary A provider to acquire the required interactors to initialize the controllers.
+ */
+public record ControllerFactory(InteractorFactoryBoundary boundary) implements ControllerFactoryBoundary {
+    @Override
+    public PageBoundary pageBoundary() {
+        return new PageController(20);
+    }
+
+    @Override
+    public ExportPluginsController exportController() {
+        return new ExportPluginsController(boundary.exportBoundary());
+    }
+
+    @Override
+    public ListController listController() {
+        return new ListController(boundary.listBoundary());
+    }
+
+    @Override
+    public SearchPackagesController searchController() {
+        return new SearchPackagesController(boundary.searchBoundary());
+    }
+
+    @Override
+    public MirrorController mirrorController() {
+        return new MirrorController(boundary.mirrorSelector());
+    }
+
+    @Override
+    public InfoController infoController() {
+        return new InfoController(boundary.pluginTracker());
+    }
+
+    @Override
+    public InstallController installController() {
+        return new InstallController(boundary.installBoundary());
+    }
+
+    @Override
+    public UninstallController uninstallController() {
+        return new UninstallController(boundary.uninstallBoundary());
+    }
+
+    @Override
+    public UpdateController updateController() {
+        return new UpdateController(boundary.updateBoundary());
+    }
+
+    @Override
+    public RefreshController refreshController() {
+        return new RefreshController(
+            boundary.databaseFetcher(),
+            boundary.fetcherListener(),
+            boundary.mirrorSelector()
+        );
+    }
+
+    @Override
+    public LoadController loadController() {
+        return new LoadController(boundary.loadBoundary());
+    }
+
+    @Override
+    public ReloadController reloadController() {
+        return new ReloadController(boundary.reloadBoundary());
+    }
+
+    @Override
+    public UnloadController unloadController() {
+        return new UnloadController(boundary.unloadBoundary());
+    }
+}