Created Presenter for the ListAll usecase

Instead of logging directly in the Controller, the implementation of the presenter allows for logging to take place in the ListPresenter instead (as it should).

Implementation Details: ListController now instantiates a new ListPresenter based on the log parameter, which performs the logging task with error codes, etc.

ListResult is a record class storing the result of a call to ListAll in the controller.

ListResultPresenter offers an interface for the ListPresenter's displayResult method, as pursuant to the Dependency Inversion Principle.

Author: kchprog

src/main/java/org/hydev/mcpm/client/commands/controllers/ListController.java

@@ -1,8 +1,12 @@
 package org.hydev.mcpm.client.commands.controllers;
 
+import org.hydev.mcpm.client.display.presenters.ListPresenter;
 import org.hydev.mcpm.client.list.ListAllBoundary;
+import org.hydev.mcpm.client.models.PluginYml;
 import org.hydev.mcpm.client.updater.CheckForUpdatesBoundary;
 import org.hydev.mcpm.client.list.ListType;
+import org.hydev.mcpm.client.list.ListResult;
+import org.hydev.mcpm.client.commands.presenters.ListResultPresenter;
 
 import java.util.List;
 import java.util.function.Consumer;
@@ -18,6 +22,7 @@ public class ListController {
     private final ListAllBoundary listAllBoundary;
     private final CheckForUpdatesBoundary checkForUpdatesBoundary;
 
+
     /**
      * Constructor for ListAllController.
      *
@@ -26,16 +31,16 @@ public class ListController {
     public ListController(ListAllBoundary listAllBoundary, CheckForUpdatesBoundary checkForUpdatesBoundary) {
         this.listAllBoundary = listAllBoundary;
         this.checkForUpdatesBoundary = checkForUpdatesBoundary;
+
     }
 
     /**
      * Executes the ListAll use case.
      *
      * @param parameter The parameter for the ListAll use case.
-     * @param log       Logger
      */
     public void listAll(String parameter, Consumer<String> log) {
-
+        ListPresenter listPresenter = new ListPresenter(log);
         ListType listType;
         switch (parameter.toLowerCase()) {
             case "all":
@@ -51,17 +56,19 @@ public void listAll(String parameter, Consumer<String> log) {
                 listType = ListType.OUTDATED;
                 break;
             default:
-                log.accept("Invalid parameter. Please use 'all', 'manual', 'automatic', or 'outdated'.");
+                ListResult queryResult = new ListResult(null, ListResult.Type.SEARCH_INVALID_INPUT);
+                listPresenter.displayResult(queryResult);
                 return;
         }
 
-        var list = listAllBoundary.listAll(listType);
-
-        // Tabulate result
-        var table = tabulate(
-                list.stream().map(p -> List.of("&a" + p.name(), "&e" + p.getFirstAuthor(), p.version())).toList(),
-                List.of(":Name", "Author", "Version:"));
+        try {
+            var list = listAllBoundary.listAll(listType);
+            ListResult queryResult = new ListResult(list, ListResult.Type.SUCCESS_RETRIEVING_LOCAL_AND_UPDATABLE);
+            listPresenter.displayResult(queryResult);
+        } catch (Exception e) {
+            ListResult queryResult = new ListResult(null, ListResult.Type.SEARCH_FAILED_TO_FETCH_INSTALLED);
+            listPresenter.displayResult(queryResult);
+        }
 
-        log.accept(table);
     }
 }

src/main/java/org/hydev/mcpm/client/commands/presenters/ListResultPresenter.java

@@ -0,0 +1,13 @@
+package org.hydev.mcpm.client.commands.presenters;
+
+import org.hydev.mcpm.client.installer.InstallResult;
+import org.hydev.mcpm.client.list.ListResult;
+
+public interface ListResultPresenter {
+    /**
+     * Display the associated output to the console
+     *
+     * @param listResult result of the list command
+     */
+    void displayResult(ListResult listResult);
+}

src/main/java/org/hydev/mcpm/client/display/presenters/ListPresenter.java

@@ -0,0 +1,39 @@
+package org.hydev.mcpm.client.display.presenters;
+
+import org.hydev.mcpm.client.commands.presenters.ListResultPresenter;
+import org.hydev.mcpm.client.list.ListResult;
+
+import java.util.List;
+import java.util.function.Consumer;
+
+import static org.hydev.mcpm.client.display.presenters.Table.tabulate;
+
+public class ListPresenter implements ListResultPresenter {
+    private final Consumer<String> log;
+
+    /**
+     * Instantiate Install Presenter
+     *
+     * @param log log string to the console
+     */
+
+    public ListPresenter(Consumer<String> log) {
+        this.log = log;
+    }
+
+    @Override
+    public void displayResult(ListResult listResult) {
+        var list = listResult.queryResult();
+        if (listResult.type() == ListResult.Type.SEARCH_INVALID_INPUT) {
+            log.accept(listResult.type().reason() + "\n" + "Invalid input. Please enter one of the following: " +
+                    "all, manual, automatic, outdated");
+        } else if (listResult.type() == ListResult.Type.SEARCH_FAILED_TO_FETCH_INSTALLED) {
+            log.accept(listResult.type().reason() + "\n" + "Unable to fetch result.");
+        } else {
+            var table = tabulate(
+                list.stream().map(p -> List.of("&a" + p.name(), "&e" + p.getFirstAuthor(), p.version())).toList(),
+                List.of(":Name", "Author", "Version:"));
+            this.log.accept(listResult.type().reason() + "\n" + table);
+        }
+    }
+}

src/main/java/org/hydev/mcpm/client/list/ListAllInteractor.java

@@ -7,17 +7,15 @@
 import java.util.List;
 
 /**
- * Implementation to the ListAll functionality
- *
- * @author Kevin (https://github.com/kchprog)
- * @since 2022-11-20
+ * Implementation for the ListAll functionality
  */
 public record ListAllInteractor(PluginTracker pluginTracker, CheckForUpdatesBoundary checkForUpdatesBoundary) implements ListAllBoundary {
     /**
      * listAllInteractor interacts with the LocalPluginTracker to get the list of
      * plugins, according to a specified
      * parameter
      *
+     *
      * @param parameter The parameter for the ListAll use case. 'All' denotes a
      *                  request to list all manually
      *                  installed plugins, 'manual' denotes a request to list all
@@ -40,8 +38,8 @@ public List<PluginYml> listAll(ListType parameter) {
                 return installed.stream().filter(it -> !manual.contains(it.name())).toList();
 
             case OUTDATED:
-                ListUpdateableBoundary listUpdateableBoundary = new ListUpdateableHelper();
-                var outdated = listUpdateableBoundary.listUpdateable(pluginTracker, checkForUpdatesBoundary);
+                ListUpdatableBoundary listUpdatableBoundary = new ListUpdatableHelper();
+                var outdated = listUpdatableBoundary.listUpdatable(pluginTracker, checkForUpdatesBoundary);
                 return installed.stream().filter(it -> outdated.contains(it.name())).toList();
 
             default:

src/main/java/org/hydev/mcpm/client/list/ListResult.java

@@ -0,0 +1,33 @@
+package org.hydev.mcpm.client.list;
+
+
+import org.hydev.mcpm.client.models.PluginYml;
+
+import java.util.List;
+
+
+/**
+ * Exception during installation of a plugin
+ */
+public record ListResult(List<PluginYml> queryResult, Type type) {
+    /**
+     * Type of list failure
+     */
+    public enum Type {
+        SEARCH_INVALID_INPUT("Invalid search input"),
+        SEARCH_FAILED_TO_FETCH_INSTALLED("Failed to fetch the local files"),
+        SUCCESS_RETRIEVING_LOCAL_BUT_FAIL_UPDATABLE("Successfully retrieved local files," +
+                " but failed to retrieve updatable files"),
+        SUCCESS_RETRIEVING_LOCAL_AND_UPDATABLE("Successfully retrieved local files");
+
+        private final String reason;
+
+        Type(String reason) {
+            this.reason = reason;
+        }
+
+        public String reason() {
+            return reason;
+        }
+    }
+}

src/main/java/org/hydev/mcpm/client/list/ListUpdateableBoundary.java renamed to src/main/java/org/hydev/mcpm/client/list/ListUpdatableBoundary.java

@@ -7,7 +7,7 @@
 /**
  * Defines an interface for obtaining a list of plugin names that may be updated
  */
-public interface ListUpdateableBoundary {
-    ArrayList<String> listUpdateable(PluginTracker superPluginTracker,
-                                     CheckForUpdatesBoundary checkForUpdatesBoundary);
+public interface ListUpdatableBoundary {
+    ArrayList<String> listUpdatable(PluginTracker superPluginTracker,
+                                    CheckForUpdatesBoundary checkForUpdatesBoundary);
 }

src/main/java/org/hydev/mcpm/client/list/ListUpdateableHelper.java renamed to src/main/java/org/hydev/mcpm/client/list/ListUpdatableHelper.java

@@ -18,9 +18,9 @@
 import java.util.OptionalLong;
 
 /**
- * A helper class for ListUpdateableBoundary.
+ * A helper class for ListUpdatableBoundary.
  */
-public class ListUpdateableHelper implements ListUpdateableBoundary {
+public class ListUpdatableHelper implements ListUpdatableBoundary {
 
     /**
      * Returns a list of plugins names that belong to outdated plugins
@@ -29,7 +29,7 @@ public class ListUpdateableHelper implements ListUpdateableBoundary {
      * @param checkForUpdatesBoundary The boundary to check for updates
      * @return A list of plugins that are outdated.
      */
-    public ArrayList<String> listUpdateable(
+    public ArrayList<String> listUpdatable(
         PluginTracker localPluginTracker, CheckForUpdatesBoundary checkForUpdatesBoundary) {
 
         ArrayList<PluginVersionState> temp = new ArrayList<>();
@@ -56,7 +56,7 @@ public ArrayList<String> listUpdateable(
 
         // Read the list of installedModels and create a CheckForUpdatesInput object
         // with state equal
-        // to the list of PluginTrackerModels's version
+        // to the list of PluginTrackerModels' version
 
         if (rawResult.state() == CheckForUpdatesResult.State.SUCCESS) {