Implement the command categories.

Author: Aleksi Salmela

src/main/java/fi/helsinki/cs/tmc/cli/Application.java

@@ -13,6 +13,7 @@
 
 import org.apache.commons.cli.CommandLine;
 import org.apache.commons.cli.GnuParser;
+import org.apache.commons.cli.OptionBuilder;
 import org.apache.commons.cli.Options;
 import org.apache.commons.cli.ParseException;
 import org.slf4j.Logger;
@@ -23,6 +24,8 @@
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
+import org.apache.commons.cli.Option;
 
 /**
  * The application class for the program.
@@ -49,11 +52,26 @@ public Application(CliContext context) {
         this.context = context;
         this.io = context.getIo();
 
-        options.addOption("h", "help", false, "Display help information about tmc-cli");
+        options.addOption(
+                OptionBuilder.withLongOpt("help-all")
+                        .withDescription("Display all help information of tmc-cli")
+                        .create());
+        options.addOption("h", "help", false, "Display help information");
         options.addOption("v", "version", false, "Give the version of the tmc-cli");
         options.addOption("u", "force-update", false, "Force the auto-update");
         options.addOption("d", "no-update", false, "Disable temporarily the auto-update");
 
+        Set<String> helpCategories = CommandFactory.getCommandCategories();
+        for (String category : helpCategories) {
+            if (category.equals("") || category.equals("hidden")) {
+                continue;
+            }
+            options.addOption(
+                    OptionBuilder.withLongOpt("help-" + category)
+                            .withDescription("Display " + category + " help information")
+                            .create());
+        }
+
         //TODO implement the inTests as context.property
         if (!context.inTests()) {
             shutdownHandler = new ShutdownHandler(context.getIo());
@@ -103,6 +121,17 @@ private String[] parseArgs(String[] args) {
             return null;
         }
 
+        // handle help flags
+        for (Option opt : line.getOptions()) {
+            String helpPrefix = "help-";
+            if (!opt.getLongOpt().startsWith(helpPrefix)) {
+                continue;
+            }
+
+            String helpCategory = opt.getLongOpt().substring(helpPrefix.length());
+            runCommand("help", new String[] {helpCategory});
+            return null;
+        }
         if (showHelp) {
             // don't run the help sub-command with -h switch
             if (commandName.equals("help")) {

src/main/java/fi/helsinki/cs/tmc/cli/command/HelpCommand.java

@@ -42,9 +42,7 @@ public void run(CliContext context, CommandLine args) {
 
     private List<String> getCommandStrings() {
         List<String> strings = new ArrayList<>();
-        Set<Class<Command>> commands = CommandFactory.getCommands();
-        commands.remove(castToCommandClass(ShellHelperCommand.class));
-        commands.remove(castToCommandClass(DocumentCommand.class));
+        List<Class<Command>> commands = CommandFactory.getCommands();
 
         longestNameLength = longestName(commands);
         for (Class<Command> commandClass : commands) {
@@ -69,7 +67,7 @@ private String createCommandString(Command command) {
         return builder.toString();
     }
 
-    private int longestName(Set<Class<Command>> commandList) {
+    private int longestName(List<Class<Command>> commandList) {
         int longest = 0;
         for (Class<Command> commandClass : commandList) {
             Command command = CommandFactory.getCommand(commandClass);

src/main/java/fi/helsinki/cs/tmc/cli/core/CommandAnnotationProcessor.java

@@ -28,8 +28,10 @@ public class CommandAnnotationProcessor extends AbstractProcessor {
 
     private static final String CLASS_NAME = "CommandList";
     private static final String PACKAGE_NAME = "fi.helsinki.cs.tmc.cli.core";
+    private static final String COMMAND_PACKAGE_NAME = "fi.helsinki.cs.tmc.cli.command";
     private static final String TAB = "    ";
 
+    //TODO reorder
     private void generateSourceFile(Map<String, String> map) throws IOException {
         JavaFileObject jfo =
                 processingEnv.getFiler().createSourceFile(PACKAGE_NAME + "." + CLASS_NAME);
@@ -43,25 +45,41 @@ private void generateSourceFile(Map<String, String> map) throws IOException {
             for (Entry<String, String> entry : map.entrySet()) {
                 bwriter.append("import ").append(entry.getValue()).append(";\n");
             }
-            bwriter.append("//CHECKSTYLE:ON\n");
 
             bwriter.append("\npublic class " + CLASS_NAME + " {\n");
             bwriter.append(TAB + "static {\n");
             for (Entry<String, String> entry : map.entrySet()) {
-                String[] parts = entry.getValue().split("\\.");
-                if (parts.length == 0) {
+                String classPath = entry.getValue();
+                String[] parts = classPath.split("\\.");
+                if (parts.length < 2) {
                     continue;
                 }
-                // print out the lines that add the commands to the command factory.
+
                 String className = parts[parts.length - 1];
+                String packageName = "?";
+                if (classPath.startsWith(COMMAND_PACKAGE_NAME)) {
+                    //remove class name and dot
+                    packageName = classPath.substring(
+                            0,
+                            classPath.length() - className.length() - 1);
+                    //remove prefix
+                    packageName = packageName.substring(COMMAND_PACKAGE_NAME.length());
+                    //remove the first dot
+                    if(packageName.startsWith(".")) {
+                        packageName = packageName.substring(1);
+                    }
+                }
                 bwriter.append(TAB + TAB + "CommandFactory.addCommand(\"")
                         .append(entry.getKey())
+                        .append("\", \"")
+                        .append(packageName)
                         .append("\", ")
                         .append(className)
                         .append(".class);\n");
             }
             bwriter.append(TAB + "}\n");
             bwriter.append("}\n");
+            bwriter.append("//CHECKSTYLE:ON\n");
             bwriter.flush();
         }
     }

src/main/java/fi/helsinki/cs/tmc/cli/core/CommandFactory.java

@@ -3,8 +3,10 @@
 import org.slf4j.LoggerFactory;
 
 import java.lang.annotation.Annotation;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
@@ -15,6 +17,7 @@ public class CommandFactory {
 
     private static final org.slf4j.Logger logger = LoggerFactory.getLogger(CommandFactory.class);
     private static final Map<String, Class<Command>> commands = new HashMap<>();
+    private static final Map<String, List<Class<Command>>> packages = new HashMap<>();
 
     static {
         /* Force load the CommandList so that it's static initialization block is executed.
@@ -33,11 +36,19 @@ public class CommandFactory {
      * This method is used for generating the commands list from the annotations.
      *
      * @param name the name visible to the user
+     * @param packageName the package name that is used to categorize the commands
      * @param commandClass the class of the command objects
      */
-    public static void addCommand(String name, Class commandClass) {
+    public static void addCommand(String name, String packageName, Class commandClass) {
         Class<Command> klass = castToCommandClass(commandClass);
         CommandFactory.commands.put(name, klass);
+
+        List<Class<Command>> list = CommandFactory.packages.get(packageName);
+        if (list == null) {
+            list = new ArrayList<>();
+            CommandFactory.packages.put(packageName, list);
+        }
+        list.add(klass);
     }
 
     /**
@@ -94,8 +105,16 @@ public static Command getCommand(Class<Command> commandClass) {
      *
      * @return Set of commands.
      */
-    public static Set<Class<Command>> getCommands() {
-        return new HashSet<>(CommandFactory.commands.values());
+    public static List<Class<Command>> getCommands() {
+        return new ArrayList<>(CommandFactory.commands.values());
+    }
+
+    public static Set<String> getCommandCategories() {
+        return packages.keySet();
+    }
+
+    public static List<Class<Command>> getCategoryCommands(String category) {
+        return packages.get(category);
     }
 
     @SuppressWarnings("unchecked")

src/test/java/fi/helsinki/cs/tmc/cli/core/CommandAnnotationProcessorTest.java

@@ -191,7 +191,7 @@ public void generateCorrectCodeWithTwoCommands() {
 
         Set<TypeElement> annotations = new HashSet<>();
         assertTrue(processor.process(annotations, roundEnv));
-        assertThat("" + stringWriter, containsString("(\"commmand1\", TestTest1.class)"));
-        assertThat("" + stringWriter, containsString("(\"commmand2\", TestTest2.class)"));
+        assertThat("" + stringWriter, containsString("(\"commmand1\", \"?\", TestTest1.class)"));
+        assertThat("" + stringWriter, containsString("(\"commmand2\", \"?\", TestTest2.class)"));
     }
 }