[PR] Merge pull request #81 from CSC207-2022F-UofT/patch-search

hykilpikonna · web-flow · commit 1f7f9909bf87 · 2022-11-28T12:45:17.000-05:00
Patch search
diff --git a/src/main/java/org/hydev/mcpm/client/arguments/parsers/SearchParser.java b/src/main/java/org/hydev/mcpm/client/arguments/parsers/SearchParser.java
@@ -4,20 +4,18 @@
 import net.sourceforge.argparse4j.inf.Namespace;
 import net.sourceforge.argparse4j.inf.Subparser;
 import org.hydev.mcpm.client.commands.entries.SearchPackagesController;
+
+import java.util.List;
 import java.util.function.Consumer;
 
 /**
  * SearchParser has two arguments: "type" and "text."
  * When the user runs the search command, the program prompts the user to specify the type of
  * search and the search text.
+ *
+ * @author Jerry Zhu (https://github.com/jerryzhu509)
  */
-public class SearchParser implements CommandParser {
-    private final SearchPackagesController controller;
-
-    public SearchParser(SearchPackagesController controller) {
-        this.controller = controller;
-    }
-
+public record SearchParser(SearchPackagesController controller) implements CommandParser {
     @Override
     public String name() {
         return "search";
@@ -30,20 +28,31 @@ public String description() {
 
     @Override
     public void configure(Subparser parser) {
-        parser.addArgument("by").choices("name", "keyword", "command")
-                .setDefault("name").dest("type")
-                .help("Specifies the Type of Search");
+        // Default search by name, if -k is specified then search by keyword
+        var type = parser.addMutuallyExclusiveGroup();
+        type.addArgument("-k", "--keyword").action(Arguments.storeTrue()).dest("byKeyword")
+            .help("Search by keyword in descriptions");
+        type.addArgument("-c", "--command").action(Arguments.storeTrue()).dest("byCommand")
+            .help("Search by command");
+
+        // Content of the search
         parser.addArgument("text").dest("text").nargs("+")
-                .help("Specifies the search text.");
+            .help("Specifies the search text.");
         parser.addArgument("-n", "--no-cache").action(Arguments.storeTrue()).dest("noCache")
-                .help("Specifies whether to use local cache or not.");
+            .help("Specifies whether to use local cache or not.");
     }
 
     @Override
     public void run(Namespace details, Consumer<String> log) {
-        var t = details.getList("text");
-        controller.searchPackages(details.getString("type"),
-                String.join(" ", details.getList("text")),
-                !details.getBoolean("noCache"), log);
+        // Convert type
+        var type = "name";
+        if (details.getBoolean("byKeyword"))
+            type = "keyword";
+        if (details.getBoolean("byCommand"))
+            type = "command";
+
+        // Call searchPackages
+        List<String> t = details.getList("text");
+        controller.searchPackages(type, String.join(" ", t), !details.getBoolean("noCache"), log);
     }
 }
diff --git a/src/main/java/org/hydev/mcpm/client/commands/entries/SearchPackagesController.java b/src/main/java/org/hydev/mcpm/client/commands/entries/SearchPackagesController.java
@@ -30,7 +30,7 @@ public SearchPackagesController(SearchPackagesBoundary searcher) {
      * Load plugins and output status to log.
      *
      * @param type String that specifies the type of search.
-     * @param text String that secifies the search text.
+     * @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.
      */
diff --git a/src/main/java/org/hydev/mcpm/client/database/results/SearchPackagesResult.java b/src/main/java/org/hydev/mcpm/client/database/results/SearchPackagesResult.java
@@ -14,7 +14,6 @@
 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 {
diff --git a/src/main/java/org/hydev/mcpm/client/database/searchusecase/SearcherByCommand.java b/src/main/java/org/hydev/mcpm/client/database/searchusecase/SearcherByCommand.java
@@ -56,6 +56,6 @@ public List<PluginModel> getSearchList(String inp, List<PluginModel> plugins) {
         if (SearcherByCommand.commandMap == null) {
             SearcherByCommand.commandMap = constructSearchMaps(plugins);
         }
-        return SearcherByCommand.commandMap.get(inp.toLowerCase());
+        return SearcherByCommand.commandMap.getOrDefault(inp, List.of());
     }
 }
diff --git a/src/main/java/org/hydev/mcpm/client/database/searchusecase/SearcherByKeyword.java b/src/main/java/org/hydev/mcpm/client/database/searchusecase/SearcherByKeyword.java
@@ -39,7 +39,7 @@ public Map<String, List<PluginModel>> constructSearchMaps(List<PluginModel> plug
                     v.get().meta().description() != null && !v.get().meta().description().equals("")) {
                 String[] keywords = v.get().meta().description()
                         .replaceAll("[^a-zA-Z ]", "").toLowerCase().split("\\s+");
-                for (String keyword : keywords) {
+                for (String keyword : new HashSet<>(List.of(keywords))) {
                     if (!models.containsKey(keyword))
                         models.put(keyword, new ArrayList<>());
                     models.get(keyword).add(plugin);
@@ -63,11 +63,13 @@ public List<PluginModel> getSearchList(String inp, List<PluginModel> plugins) {
         if (SearcherByKeyword.keywordMap == null) {
             SearcherByKeyword.keywordMap = constructSearchMaps(plugins);
         }
-        String [] keywords = inp.toLowerCase().split(" "); // Should be a string
-        Set<PluginModel> res = new HashSet<>(SearcherByKeyword.keywordMap.get(keywords[0]));
+        String [] keywords = inp.split(" "); // Should be a string
+        Set<PluginModel> res = new HashSet<>(SearcherByKeyword.keywordMap.getOrDefault(keywords[0], List.of()));
         for (int i = 1; i < keywords.length; i++) {
-            List<PluginModel> pl = SearcherByKeyword.keywordMap.get(keywords[i]);
+            List<PluginModel> pl = SearcherByKeyword.keywordMap.getOrDefault(keywords[i], List.of());
             res.retainAll(pl);
+            if (res.isEmpty())
+                return List.of();
         }
         return new ArrayList<>(res);
     }
diff --git a/src/main/java/org/hydev/mcpm/client/database/searchusecase/SearcherByName.java b/src/main/java/org/hydev/mcpm/client/database/searchusecase/SearcherByName.java
@@ -43,15 +43,14 @@ public Map<String, List<PluginModel>> constructSearchMaps(List<PluginModel> plug
      *
      * @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.
-     *         Returns null if inp is not a string.
+     * @return A list of plugins associated to inp.
      */
     @Override
     public List<PluginModel> getSearchList(String inp, List<PluginModel> plugins) {
         // Instantiate if null
         if (SearcherByName.nameMap == null) {
             SearcherByName.nameMap = constructSearchMaps(plugins);
         }
-        return SearcherByName.nameMap.get(inp.toLowerCase());
+        return SearcherByName.nameMap.getOrDefault(inp, List.of());
     }
 }
diff --git a/src/test/java/org/hydev/mcpm/client/database/DatabaseInteractorUpdateTest.java b/src/test/java/org/hydev/mcpm/client/database/DatabaseInteractorUpdateTest.java
@@ -45,9 +45,9 @@ public static void setup() {
 
         smallInteractor = interactor(List.of(
             PluginMockFactory.model(1),
-            PluginMockFactory.model(2, "name", List.of("ver.1", "ver.2")),
-            PluginMockFactory.model(3, "test", List.of("update", "update update")),
-            PluginMockFactory.model(4, "test", List.of("1.0", "2.0", "3.0"))
+            PluginMockFactory.model(2, "name", null, List.of("ver.1", "ver.2"), null),
+            PluginMockFactory.model(3, "test", null, List.of("update", "update update"), null),
+            PluginMockFactory.model(4, "test", null, List.of("1.0", "2.0", "3.0"), null)
         ));
     }
 
diff --git a/src/test/java/org/hydev/mcpm/client/database/PluginMockFactory.java b/src/test/java/org/hydev/mcpm/client/database/PluginMockFactory.java
@@ -2,45 +2,70 @@
 
 import org.hydev.mcpm.client.database.fetcher.BriefFetcherListener;
 import org.hydev.mcpm.client.database.fetcher.ConstantFetcher;
+import org.hydev.mcpm.client.models.PluginCommand;
 import org.hydev.mcpm.client.models.PluginModel;
 import org.hydev.mcpm.client.models.PluginVersion;
 import org.hydev.mcpm.client.models.PluginYml;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Unmodifiable;
 
-import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
+import java.util.Map;
 import java.util.stream.IntStream;
 
 /**
- * Mock factory for testing search functionality
+ * This class creates Plugins mainly for testing purposes.
+ *
+ * @author Taylor Whatley
+ * @author Jerry Zhu (<a href="https://github.com/jerryzhu509">...</a>)
  */
 public class PluginMockFactory {
     private PluginMockFactory() { }
 
+    /**
+     * Creates a mock PluginCommand object.
+     *
+     * @param description Description
+     * @param aliases Other names
+     * @return A Map<String, PluginCommand> object.
+     */
+    public static @NotNull Map<String, PluginCommand> createCommand(String description, List<String> aliases) {
+        var map = new HashMap<String, PluginCommand>();
+        var pc = new PluginCommand(description, aliases, null, null);
+        for (String alias : aliases) {
+            map.put(alias, pc);
+        }
+        return map;
+    }
+
     /**
      * Creates a mock PluginYml object.
      *
      * @param name The name of the plugin.
      * @param version The version string for the plugin.
      * @param description The description for the plugin.
+     * @param commands Commands for the plugin.
      * @return A PluginYml object.
      */
-    public static PluginYml meta(String name, String version, String description) {
+    public static PluginYml meta(String name, String version, String description,
+                                 Map<String, PluginCommand> commands) {
         return new PluginYml(
-            "org." + name,
-            name,
-            version,
-            description,
-            null,
-            null,
-            null,
-            null,
-            null,
-            null,
-            null,
-            null,
-            null,
-            null,
-            null
+                "org." + name,
+                name,
+                version,
+                description,
+                null,
+                null,
+                null,
+                null,
+                null,
+                null,
+                null,
+                null,
+                null,
+                null,
+                commands
         );
     }
 
@@ -53,7 +78,22 @@ public static PluginYml meta(String name, String version, String description) {
      * @return A PluginVersion object.
      */
     public static PluginVersion version(long id, String name, String string) {
-        return new PluginVersion(id, 0, "", meta(name, string, null));
+        return new PluginVersion(id, 0, "", meta(name, string, null, null));
+    }
+
+    /**
+     * Creates a mock PluginVersion object.
+     *
+     * @param id The version id.
+     * @param name The plugin name (for meta).
+     * @param string The version string (for meta).
+     * @param description The plugin description.
+     * @param commands The commands in the plugin.
+     * @return A PluginVersion object.
+     */
+    public static PluginVersion version(long id, String name, String string, String description,
+                                        Map<String, PluginCommand> commands) {
+        return new PluginVersion(id, 0, "", meta(name, string, description, commands));
     }
 
 
@@ -77,8 +117,8 @@ public static PluginModel model(long id) {
      */
     public static PluginModel model(long id, String name) {
         return new PluginModel(
-            id,
-            List.of(version(id, name, "ver." + name)) // NOT SEMVER
+                id,
+                List.of(version(id, name, "ver." + name)) // NOT SEMVER
         );
     }
 
@@ -88,24 +128,63 @@ public static PluginModel model(long id, String name) {
      *
      * @param id The plugin id.
      * @param name The plugin name.
+     * @param description The plugin description.
      * @param versionNames The individual version strings for each version.
+     * @param commands Commands for the plugin.
      * @return A PluginModel object.
      */
-    public static PluginModel model(long id, String name, List<String> versionNames) {
+    public static PluginModel model(long id, String name, String description, List<String> versionNames,
+                                    Map<String, PluginCommand> commands) {
         return new PluginModel(
-            id,
-            IntStream.range(0, versionNames.size())
-                .mapToObj(i -> version(i, name, versionNames.get(i)))
-                .toList()
+                id,
+                IntStream.range(0, versionNames.size())
+                        .mapToObj(i -> version(i, name, versionNames.get(i), description, commands))
+                        .toList()
         );
     }
 
-    public static List<PluginModel> generatePlugins() {
-        List<PluginModel> plugins = new ArrayList<>();
-        String[] names = {"WorldGuard"};
-        String [] descriptions = {"Protect your server!\n" +
-                "WorldGuard lets you and players guard areas of land against griefers and undesirables\n" +
-                "as well as tweak and disable various gameplay features of Minecraft."};
-        return plugins;
+    /**
+     * Creates a mock DatabaseInteractor object with the provided plugin list.
+     *
+     * @param plugins A list of plugins that the DatabaseInteractor will have access to.
+     * @return A DatabaseInteractor object.
+     */
+    public static DatabaseInteractor interactor(List<PluginModel> plugins) {
+        var fetcher = new ConstantFetcher(plugins);
+        var listener = new BriefFetcherListener(true);
+
+        return new DatabaseInteractor(fetcher, listener);
+    }
+
+
+    /**
+     * Generates a sample list of plugins used for testing, containing the name, description, and commands.
+     *
+     * @return List of plugins for testing.
+     */
+    public static @Unmodifiable List<PluginModel> generateTestPlugins() {
+        String[] descriptions = {"WorldGuard lets you and players guard areas " +
+                "of land against griefers and undesirables as well " +
+                "as tweak and disable various gameplay features of Minecraft.",
+                "Multiverse was created at the dawn of Bukkit multiworld support. " +
+                        "It has since then grown into a complete world management " +
+                        "solution including special treatment of your nether worlds with " +
+                        "Multiverse NetherPortals.",
+                "Create futuristic holograms to display text and items to players!"
+        };
+
+        return List.of(
+                PluginMockFactory.model(1),
+                PluginMockFactory.model(2, "WorldGuard",
+                        descriptions[0],
+                        List.of("1.18.2", "1.18.1"),
+                        createCommand(descriptions[0], List.of("/god", "/ungod"))),
+                PluginMockFactory.model(3, "Multiverse-Core", descriptions[1],
+                        List.of("1.19.2", "1.19.1"),
+                        createCommand(descriptions[1],List.of("/mvlist", "/mvl"))),
+                PluginMockFactory.model(4, "Holographic Displays", descriptions[2],
+                        List.of("1.19.2", "1.19.1", "1.19"),
+                        createCommand(descriptions[2], List.of("/hd", "/ungod")))
+        );
     }
 }
diff --git a/src/test/java/org/hydev/mcpm/client/database/SearchInteractorTest.java b/src/test/java/org/hydev/mcpm/client/database/SearchInteractorTest.java

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public SearchPackagesController(SearchPackagesBoundary searcher) {`
`30`	`30`	`* Load plugins and output status to log.`
`31`	`31`	`*`
`32`	`32`	`* @param type String that specifies the type of search.`
`33`		`- * @param text String that secifies the search text.`
	`33`	`+ * @param text String that specifies the search text.`
`34`	`34`	`* @param noCache Specifies whether to use local cache or not.`
`35`	`35`	`* @param log Callback for status for log events.`
`36`	`36`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,6 @@ public List<PluginModel> getSearchList(String inp, List<PluginModel> plugins) {`
`56`	`56`	`if (SearcherByCommand.commandMap == null) {`
`57`	`57`	`SearcherByCommand.commandMap = constructSearchMaps(plugins);`
`58`	`58`	`}`
`59`		`- return SearcherByCommand.commandMap.get(inp.toLowerCase());`
	`59`	`+ return SearcherByCommand.commandMap.getOrDefault(inp, List.of());`
`60`	`60`	`}`
`61`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,15 +43,14 @@ public Map<String, List<PluginModel>> constructSearchMaps(List<PluginModel> plug`
`43`	`43`	`*`
`44`	`44`	`* @param inp User input for the search. Should be a name as a string here.`
`45`	`45`	`* @param plugins A list of all plugins in the database.`
`46`		`- * @return A dictionary associating a string feature of the plugins to the matching plugins.`
`47`		`- * Returns null if inp is not a string.`
	`46`	`+ * @return A list of plugins associated to inp.`
`48`	`47`	`*/`
`49`	`48`	`@Override`
`50`	`49`	`public List<PluginModel> getSearchList(String inp, List<PluginModel> plugins) {`
`51`	`50`	`// Instantiate if null`
`52`	`51`	`if (SearcherByName.nameMap == null) {`
`53`	`52`	`SearcherByName.nameMap = constructSearchMaps(plugins);`
`54`	`53`	`}`
`55`		`- return SearcherByName.nameMap.get(inp.toLowerCase());`
	`54`	`+ return SearcherByName.nameMap.getOrDefault(inp, List.of());`
`56`	`55`	`}`
`57`	`56`	`}`