[PR] Merge pull request #58 from CSC207-2022F-UofT/Clean_Architec_Search

Implemented SearchByCommand & Small Changes

Author: hykilpikonna

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

@@ -0,0 +1,37 @@
+package org.hydev.mcpm.client.commands.entries;
+
+import org.apache.commons.lang3.NotImplementedException;
+import org.hydev.mcpm.client.database.boundary.SearchPackagesBoundary;
+import org.hydev.mcpm.client.injector.LoadBoundary;
+import org.hydev.mcpm.client.injector.PluginNotFoundException;
+
+import java.util.List;
+import java.util.function.Consumer;
+
+/**
+ * Handles the user input for a search.
+ */
+
+public class SearchPackagesController {
+    private final SearchPackagesBoundary searcher;
+
+    /**
+     * Creates a LoadCommand object with this specified LoadBoundary to use when dispatched.
+     *
+     * @param searcher The load boundary to use in Command operation.
+     */
+    public SearchPackagesController(SearchPackagesBoundary searcher) {
+        this.searcher = searcher;
+    }
+
+
+    /**
+     * Load plugins and output status to log.
+     *
+     * @param pluginNames A list of all plugin names to be loaded.
+     * @param log Callback for status for log events.
+     */
+    public void searchPackages(List<String> pluginNames, Consumer<String> log) {
+        throw new NotImplementedException();
+    }
+}

src/main/java/org/hydev/mcpm/client/database/DatabaseInteractor.java

@@ -2,19 +2,19 @@
 
 import org.hydev.mcpm.client.database.boundary.CheckForUpdatesBoundary;
 import org.hydev.mcpm.client.database.boundary.ListPackagesBoundary;
-import org.hydev.mcpm.client.database.boundary.SearchPackagesBoundary;
 import org.hydev.mcpm.client.database.boundary.MatchPluginsBoundary;
 import org.hydev.mcpm.client.database.fetcher.DatabaseFetcher;
 import org.hydev.mcpm.client.database.fetcher.DatabaseFetcherListener;
 import org.hydev.mcpm.client.database.fetcher.LocalDatabaseFetcher;
 import org.hydev.mcpm.client.database.fetcher.ProgressBarFetcherListener;
-import org.hydev.mcpm.client.database.inputs.*;
+import org.hydev.mcpm.client.database.inputs.CheckForUpdatesInput;
+import org.hydev.mcpm.client.database.inputs.CheckForUpdatesResult;
+import org.hydev.mcpm.client.database.inputs.ListPackagesInput;
 import org.hydev.mcpm.client.database.results.ListPackagesResult;
-import org.hydev.mcpm.client.database.results.SearchPackagesResult;
-import org.hydev.mcpm.client.database.searchusecase.SearcherFactory;
 
 import java.net.URI;
-
+import org.hydev.mcpm.client.database.inputs.MatchPluginsInput;
+import org.hydev.mcpm.client.database.inputs.MatchPluginsResult;
 import org.hydev.mcpm.client.database.model.PluginModelId;
 import org.hydev.mcpm.client.database.model.PluginVersionState;
 import org.hydev.mcpm.client.models.PluginModel;
@@ -35,7 +35,7 @@
  * @author Jerry Zhu (<a href="https://github.com/jerryzhu509">...</a>)
  */
 public class DatabaseInteractor
-    implements ListPackagesBoundary, SearchPackagesBoundary, MatchPluginsBoundary, CheckForUpdatesBoundary {
+    implements ListPackagesBoundary, MatchPluginsBoundary, CheckForUpdatesBoundary {
     private final DatabaseFetcher fetcher;
     private final DatabaseFetcherListener listener;
 
@@ -107,31 +107,6 @@ public ListPackagesResult list(ListPackagesInput input) {
         );
     }
 
-    /**
-     * Searches for plugins based on the provided name, keyword, or command.
-     * The input contains the type of search.
-     *
-     * @param input Record of inputs as provided in SearchPackagesInput. See it for more info.
-     * @return Packages result. See the SearchPackagesResult record for more info.
-     */
-    @Override
-    public SearchPackagesResult search(SearchPackagesInput input) {
-        var database = fetcher.fetchDatabase(!input.noCache(), listener);
-
-        if (database == null) {
-            return SearchPackagesResult.by(SearchPackagesResult.State.FAILED_TO_FETCH_DATABASE);
-        }
-
-        var searchStr = input.searchStr().toLowerCase();
-        if (searchStr.isEmpty())
-            return SearchPackagesResult.by(SearchPackagesResult.State.INVALID_INPUT);
-
-        var plugins = database.plugins();
-
-        return new SearchPackagesResult(SearchPackagesResult.State.SUCCESS,
-            SearcherFactory.createSearcher(input).getSearchList(searchStr, plugins));
-    }
-
     /**
      * Checks for plugin updates.
      *
@@ -262,16 +237,6 @@ public static void main(String[] args) {
         System.out.println("Result (" + result.pageNumber() + " for " + result.plugins().size() + " plugins):");
         System.out.println(formatPluginNames(result.plugins()));
 
-        var searchInput = new SearchPackagesInput(SearchPackagesType.BY_NAME, "SkinsRestorer", true);
-        var result1 = database.search(searchInput);
-
-        System.out.println(formatPluginNames(result1.plugins()) + "\n");
-
-        var result3 = database.search(new SearchPackagesInput(
-                SearchPackagesType.BY_KEYWORD, "offline online", true));
-
-        System.out.println(formatPluginNames(result3.plugins()));
-
         var matchInput = new MatchPluginsInput(List.of(
             PluginModelId.byId(100429),
             PluginModelId.byMain("com.gestankbratwurst.smilecore.SmileCore"),

src/main/java/org/hydev/mcpm/client/database/inputs/SearchPackagesInput.java

@@ -3,8 +3,7 @@
 /**
  * Input for the SearchPackagesBoundary.
  *
- * @param type An int that specifies the type of search.
- *             1 if the search is by name, 2 if the search is by command. Else the search is by keyword.
+ * @param type Specifies the type of search.
  * @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.
  *

src/main/java/org/hydev/mcpm/client/database/results/SearchPackagesResult.java

@@ -14,6 +14,8 @@
 public record SearchPackagesResult(SearchPackagesResult.State state, List<PluginModel> plugins) {
     /**
      * The outcome of the SearchPackagesResult.
+     *
+     * For INVALID_INPUT, check that your string is non-empty.
      */
     public enum State {
         SUCCESS,

src/main/java/org/hydev/mcpm/client/database/searchusecase/SearchInteractor.java

@@ -0,0 +1,66 @@
+package org.hydev.mcpm.client.database.searchusecase;
+
+import org.hydev.mcpm.client.database.boundary.SearchPackagesBoundary;
+import org.hydev.mcpm.client.database.fetcher.DatabaseFetcher;
+import org.hydev.mcpm.client.database.fetcher.DatabaseFetcherListener;
+import org.hydev.mcpm.client.database.fetcher.ProgressBarFetcherListener;
+import org.hydev.mcpm.client.database.inputs.SearchPackagesInput;
+import org.hydev.mcpm.client.database.results.SearchPackagesResult;
+
+
+/**
+ * Handles searching within the database.
+ *
+ * @author Jerry Zhu (<a href="https://github.com/jerryzhu509">...</a>)
+ */
+public class SearchInteractor implements SearchPackagesBoundary {
+    private final DatabaseFetcher fetcher;
+    private final DatabaseFetcherListener listener;
+
+
+    /**
+     * Creates a new database with the provided database fetcher.
+     * Consider passing LocalDatabaseFetcher. Defaults to the ProgressBarFetcherListener.
+     *
+     * @param fetcher The fetcher that will be used to request the database object in boundary calls.
+     */
+    public SearchInteractor(DatabaseFetcher fetcher) {
+        this(fetcher, new ProgressBarFetcherListener());
+    }
+
+    /**
+     * Creates a new database with the provided fetcher and upload listener.
+     *
+     * @param fetcher The fetcher that will be used to request the database object in boundary calls.
+     * @param listener The listener that will receive updates if the database is downloaded from the internet.
+     */
+    public SearchInteractor(DatabaseFetcher fetcher, DatabaseFetcherListener listener) {
+        this.fetcher = fetcher;
+        this.listener = listener;
+    }
+
+    /**
+     * Searches for plugins based on the provided name, keyword, or command.
+     * The input contains the type of search.
+     *
+     * @param input Record of inputs as provided in SearchPackagesInput. See it for more info.
+     * @return Packages result. See the SearchPackagesResult record for more info.
+     */
+    @Override
+    public SearchPackagesResult search(SearchPackagesInput input) {
+        var database = fetcher.fetchDatabase(!input.noCache(), listener);
+
+        if (database == null) {
+            return SearchPackagesResult.by(SearchPackagesResult.State.FAILED_TO_FETCH_DATABASE);
+        }
+
+        var searchStr = input.searchStr().toLowerCase();
+        if (searchStr.isEmpty())
+            return SearchPackagesResult.by(SearchPackagesResult.State.INVALID_INPUT);
+
+        var plugins = database.plugins();
+
+        return new SearchPackagesResult(SearchPackagesResult.State.SUCCESS,
+                SearcherFactory.createSearcher(input).getSearchList(searchStr, plugins));
+    }
+}

src/main/java/org/hydev/mcpm/client/database/searchusecase/Searcher.java

@@ -13,19 +13,20 @@
 public interface Searcher {
 
     /**
-     * Constructs a dictionary associating a string feature of the plugins to the matching plugins.
+     * Constructs a dictionary associating a feature (e.g. name, keyword, command)
+     * of the plugins to the matching plugins.
      *
      * @param plugins A list of all plugins in the database.
-     * @return A dictionary associating a string feature of the plugins to the matching plugins.
+     * @return A dictionary associating a feature of the plugins to the matching plugins.
      */
     Map<String, List<PluginModel>> constructSearchMaps(List<PluginModel> plugins);
 
     /**
      * Searches for plugins based on the provided user input.
      *
-     * @param inp User input for the search.
+     * @param inp User input for the search, as a string.
      * @param plugins A list of all plugins in the database.
-     * @return A dictionary associating a string feature of the plugins to the matching plugins.
+     * @return A list of plugins based on inp.
      */
-    List<PluginModel> getSearchList(Object inp, List<PluginModel> plugins);
+    List<PluginModel> getSearchList(String inp, List<PluginModel> plugins);
 }

src/main/java/org/hydev/mcpm/client/database/searchusecase/SearcherByCommand.java

@@ -1,9 +1,11 @@
 package org.hydev.mcpm.client.database.searchusecase;
 
-import org.apache.commons.lang3.NotImplementedException;
 import org.hydev.mcpm.client.models.PluginModel;
 
-import java.util.*;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 /**
  * Searcher that returns a map based on commands.
@@ -19,21 +21,41 @@ public class SearcherByCommand implements Searcher {
      *
      * @param plugins A list of all plugins in the database.
      * @return A dictionary associating the command to the matching plugins.
+     *         Returns null if inp is not a string.
      */
     @Override
     public Map<String, List<PluginModel>> constructSearchMaps(List<PluginModel> plugins) {
-        throw new NotImplementedException();
+        Map<String, List<PluginModel>> models = new HashMap<>();
+        for (PluginModel plugin : plugins) {
+            // Get latest version
+            var v = plugin.getLatestPluginVersion();
+            if (v.isPresent() && v.get().meta() != null && v.get().meta().commands() != null) {
+                List<String> aliases = v.get().meta()
+                        .commands().keySet().stream()
+                        .map(String::toLowerCase).toList();
+                for (String alias : aliases) {
+                    if (!models.containsKey(alias.toLowerCase()))
+                        models.put(alias.toLowerCase(), new ArrayList<>());
+                    models.get(alias.toLowerCase()).add(plugin);
+                }
+            }
+        }
+        return models;
     }
 
     /**
-     * Searches for plugins based on the provided user input.
+     * Searches for plugins based on the command the user provides.
      *
      * @param inp User input for the search. Should be a name as a string here.
      * @param plugins A list of all plugins in the database.
-     * @return A dictionary associating a string feature of the plugins to the matching plugins.
+     * @return A list of plugins based on inp.
      */
     @Override
-    public List<PluginModel> getSearchList(Object inp, List<PluginModel> plugins) {
-        throw new NotImplementedException();
+    public List<PluginModel> getSearchList(String inp, List<PluginModel> plugins) {
+        // Instantiate if null
+        if (SearcherByCommand.commandMap == null) {
+            SearcherByCommand.commandMap = constructSearchMaps(plugins);
+        }
+        return SearcherByCommand.commandMap.get(inp.toLowerCase());
     }
 }

src/main/java/org/hydev/mcpm/client/database/searchusecase/SearcherByKeyword.java

@@ -2,7 +2,12 @@
 
 import org.hydev.mcpm.client.models.PluginModel;
 
-import java.util.*;
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.HashSet;
 
 /**
  * Searcher that returns a map based on keywords.
@@ -45,23 +50,20 @@ public Map<String, List<PluginModel>> constructSearchMaps(List<PluginModel> plug
     }
 
     /**
-     * Searches for plugins based on the provided user input.
+     * Searches for plugins based on the keywords the user provides.
      *
      * @param inp User input for the search. Should be a name as a non-empty string here.
      * @param plugins A list of all plugins in the database.
-     * @return A dictionary associating a string feature of the plugins to the matching plugins.
-     *         Returns null if inp is not a string.
+     * @return A list of plugins associated to inp.
      */
     @Override
-    public List<PluginModel> getSearchList(Object inp, List<PluginModel> plugins) {
+    public List<PluginModel> getSearchList(String inp, List<PluginModel> plugins) {
 
         // Instantiate if null
         if (SearcherByKeyword.keywordMap == null) {
             SearcherByKeyword.keywordMap = constructSearchMaps(plugins);
         }
-        if (!(inp instanceof String input))
-            return null;
-        String [] keywords = input.toLowerCase().split(" "); // Should be a string
+        String [] keywords = inp.toLowerCase().split(" "); // Should be a string
         Set<PluginModel> res = new HashSet<>(SearcherByKeyword.keywordMap.get(keywords[0]));
         for (int i = 1; i < keywords.length; i++) {
             List<PluginModel> pl = SearcherByKeyword.keywordMap.get(keywords[i]);

src/main/java/org/hydev/mcpm/client/database/searchusecase/SearcherByName.java

@@ -47,13 +47,11 @@ public Map<String, List<PluginModel>> constructSearchMaps(List<PluginModel> plug
      *         Returns null if inp is not a string.
      */
     @Override
-    public List<PluginModel> getSearchList(Object inp, List<PluginModel> plugins) {
+    public List<PluginModel> getSearchList(String inp, List<PluginModel> plugins) {
         // Instantiate if null
         if (SearcherByName.nameMap == null) {
             SearcherByName.nameMap = constructSearchMaps(plugins);
         }
-        if (!(inp instanceof String name))
-            return null;
-        return SearcherByName.nameMap.get(name);
+        return SearcherByName.nameMap.get(inp.toLowerCase());
     }
 }