Merge pull request #94 from CSC207-2022F-UofT/search-presenter

Search Presenter

Author: jerryzhu509

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

@@ -29,6 +29,7 @@
 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.display.presenters.SearchPresenter;
 import org.hydev.mcpm.client.local.LocalPluginTracker;
 import org.hydev.mcpm.client.updater.CheckForUpdatesInteractor;
 import org.hydev.mcpm.client.list.ListAllInteractor;
@@ -86,7 +87,7 @@ public static List<CommandParser> baseParsers(boolean isMinecraft) {
         // Controllers
         var exportPluginsController = new ExportPluginsController(new ExportInteractor(superTracker));
         var listController = new ListController(new ListAllInteractor(superTracker), updateChecker);
-        var searchController = new SearchPackagesController(searcher, pager);
+        var searchController = new SearchPackagesController(searcher);
         var mirrorController = new MirrorController(mirror);
         var infoController = new InfoController(superTracker);
 
@@ -95,6 +96,8 @@ public static List<CommandParser> baseParsers(boolean isMinecraft) {
         var updateController = new UpdateController(updater);
         var refreshController = new RefreshController(fetcher, listener, mirror);
 
+        var searchPresenter = new SearchPresenter(pager);
+
         /*
          * Add general parsers to this list!
          * All versions of MCPM will have access to these parsers.
@@ -103,7 +106,7 @@ public static List<CommandParser> baseParsers(boolean isMinecraft) {
         return List.of(
             new ExportPluginsParser(exportPluginsController),
             new ListParser(listController),
-            new SearchParser(searchController),
+            new SearchParser(searchController, searchPresenter),
             new MirrorParser(mirrorController),
             new InfoParser(infoController),
             new InstallParser(installController),

src/main/java/org/hydev/mcpm/client/arguments/parsers/SearchParser.java

@@ -4,6 +4,8 @@
 import net.sourceforge.argparse4j.inf.Namespace;
 import net.sourceforge.argparse4j.inf.Subparser;
 import org.hydev.mcpm.client.commands.controllers.SearchPackagesController;
+import org.hydev.mcpm.client.commands.presenters.SearchResultPresenter;
+import org.hydev.mcpm.client.display.presenters.SearchPresenter;
 
 import java.util.List;
 import java.util.function.Consumer;
@@ -13,7 +15,8 @@
  * When the user runs the search command, the program prompts the user to specify the type of
  * search and the search text.
  */
-public record SearchParser(SearchPackagesController controller) implements CommandParser {
+public record SearchParser(SearchPackagesController controller,
+                           SearchResultPresenter presenter) implements CommandParser {
     @Override
     public String name() {
         return "search";
@@ -51,6 +54,8 @@ public void run(Namespace details, Consumer<String> log) {
 
         // Call searchPackages
         List<String> t = details.getList("text");
-        controller.searchPackages(type, String.join(" ", t), !details.getBoolean("noCache"), log);
+        var result = controller.searchPackages(type,
+                String.join(" ", t), !details.getBoolean("noCache"));
+        presenter.displayResult(result, log);
     }
 }

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

@@ -4,6 +4,7 @@
 import org.hydev.mcpm.client.models.PluginModel;
 import org.hydev.mcpm.client.search.SearchPackagesBoundary;
 import org.hydev.mcpm.client.search.SearchPackagesInput;
+import org.hydev.mcpm.client.search.SearchPackagesResult;
 import org.hydev.mcpm.client.search.SearchPackagesType;
 
 import javax.annotation.Nullable;
@@ -14,43 +15,23 @@
 /**
  * Handles the user input for a search.
  *
- * @author Jerry
  */
-public record SearchPackagesController(SearchPackagesBoundary searcher, @Nullable PageBoundary pageController) {
+public record SearchPackagesController(SearchPackagesBoundary searcher) {
 
     /**
      * Load plugins and output status to log.
      *
      * @param type String that specifies the type of search.
      * @param text String that specifies the search text.
      * @param noCache Specifies whether to use local cache or not.
-     * @param log Callback for status for log events.
+     *
+     * @return The search result.
      */
-    public void searchPackages(String type, String text, boolean noCache, Consumer<String> log) {
+    public SearchPackagesResult searchPackages(String type, String text, boolean noCache) {
         SearchPackagesInput inp = new SearchPackagesInput(
                 SearchPackagesType.valueOf("BY_" + type.toUpperCase()),
                 text,
                 noCache);
-        var result = searcher.search(inp);
-        log.accept("Search State: " + result.state().toString());
-
-        // Print the plugins found
-        var list = result.plugins().stream()
-            .map(PluginModel::getLatestPluginVersion)
-            .filter(Optional::isPresent)
-            .map(it -> it.get().meta())
-            .toList();
-
-        var table = new Table(List.of(":Name", "Author", "Version:"),
-                list.stream().map(p -> List.of("&a" + p.name(), "&e" + p.getFirstAuthor(), p.version())).toList());
-
-        // Pagination
-        if (pageController != null) {
-            pageController.store(table);
-            log.accept(pageController.formatPage(1));
-        }
-        else {
-            log.accept(table.toString());
-        }
+        return searcher.search(inp);
     }
 }

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

@@ -0,0 +1,19 @@
+package org.hydev.mcpm.client.commands.presenters;
+
+import org.hydev.mcpm.client.search.SearchPackagesResult;
+
+import java.util.function.Consumer;
+
+/**
+ * Interface for presenting the search result.
+ *
+ */
+public interface SearchResultPresenter {
+    /**
+     * Display the string to the console.
+     *
+     * @param searchResult results of the search.
+     * @param log log Callback for status for log events.
+     */
+    void displayResult(SearchPackagesResult searchResult, Consumer<String> log);
+}

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

@@ -0,0 +1,53 @@
+package org.hydev.mcpm.client.display.presenters;
+
+import org.hydev.mcpm.client.commands.controllers.PageBoundary;
+import org.hydev.mcpm.client.commands.presenters.SearchResultPresenter;
+import org.hydev.mcpm.client.models.PluginModel;
+import org.hydev.mcpm.client.search.SearchPackagesResult;
+
+import javax.annotation.Nullable;
+import java.util.List;
+import java.util.Optional;
+import java.util.function.Consumer;
+
+/**
+ * Implementation to the SearchResultPresenter interface, displaying the result of the search command.
+ */
+public class SearchPresenter implements SearchResultPresenter {
+    @Nullable
+    PageBoundary pageController;
+
+    /**
+     * Instantiate Install Presenter
+     *
+     * @param pageController controller for pagination.
+     */
+
+    public SearchPresenter(@org.jetbrains.annotations.Nullable PageBoundary pageController) {
+        this.pageController = pageController;
+    }
+
+    @Override
+    public void displayResult(SearchPackagesResult result, Consumer<String> log) {
+        log.accept("Search State: " + result.state().toString());
+
+        // Print the plugins found
+        var list = result.plugins().stream()
+                .map(PluginModel::getLatestPluginVersion)
+                .filter(Optional::isPresent)
+                .map(it -> it.get().meta())
+                .toList();
+
+        var table = new Table(List.of(":Name", "Author", "Version:"),
+                list.stream().map(p -> List.of("&a" + p.name(), "&e" + p.getFirstAuthor(), p.version())).toList());
+
+        // Pagination
+        if (pageController != null) {
+            pageController.store(table);
+            log.accept(pageController.formatPage(1));
+        }
+        else {
+            log.accept(table.toString());
+        }
+    }
+}

src/main/java/org/hydev/mcpm/client/search/SearchInteractor.java

@@ -8,7 +8,6 @@
 /**
  * Handles searching within the database.
  *
- * @author Jerry Zhu (<a href="https://github.com/jerryzhu509">...</a>)
  */
 public class SearchInteractor implements SearchPackagesBoundary {
     private final DatabaseFetcher fetcher;

src/main/java/org/hydev/mcpm/client/search/SearchPackagesBoundary.java

@@ -3,7 +3,6 @@
 /**
  * Interface for searching plugins.
  *
- * @author Jerry Zhu (<a href="https://github.com/jerryzhu509">...</a>)
  */
 public interface SearchPackagesBoundary {
     /**

src/main/java/org/hydev/mcpm/client/search/SearchPackagesInput.java

@@ -7,7 +7,6 @@
  * @param searchStr String containing the name, keyword, or command to search by.
  * @param noCache If true, the ListPackagesBoundary will re-download the database before performing the request.
  *
- * @author Jerry Zhu (<a href="https://github.com/jerryzhu509">...</a>)
  */
 public record SearchPackagesInput(SearchPackagesType type, String searchStr, boolean noCache) {
 

src/main/java/org/hydev/mcpm/client/search/SearchPackagesResult.java

@@ -10,7 +10,6 @@
  * @param state The outcome of the request. Must be Success for the other values to be valid.
  * @param plugins The list of plugins corresponding to the search.
  *
- * @author Jerry Zhu (<a href="https://github.com/jerryzhu509">...</a>)
  */
 public record SearchPackagesResult(SearchPackagesResult.State state, List<PluginModel> plugins) {
     /**

src/main/java/org/hydev/mcpm/client/search/Searcher.java

@@ -8,7 +8,6 @@
 /**
  * Interface for searchers that return Maps based on the list of plugins.
  *
- * @author Jerry Zhu (<a href="https://github.com/jerryzhu509">...</a>)
  */
 public interface Searcher {
     /**