Add help command

Author: jericks

src/config/config_geom.json

@@ -17,6 +17,24 @@
     "allPublicFields": true,
     "allDeclaredFields": true
   },
+  {
+    "name": "org.geometrycommands.HelpCommand",
+    "allDeclaredConstructors": true,
+    "allPublicConstructors": true,
+    "allDeclaredMethods": true,
+    "allPublicMethods": true,
+    "allPublicFields": true,
+    "allDeclaredFields": true
+  },
+  {
+    "name": "org.geometrycommands.HelpCommand$HelpOptions",
+    "allDeclaredConstructors": true,
+    "allPublicConstructors": true,
+    "allDeclaredMethods": true,
+    "allPublicMethods": true,
+    "allPublicFields": true,
+    "allDeclaredFields": true
+  },
   {
     "name": "org.geometrycommands.VersionCommand",
     "allDeclaredConstructors": true,

src/main/java/org/geometrycommands/HelpCommand.java

@@ -0,0 +1,63 @@
+package org.geometrycommands;
+
+import org.geometrycommands.HelpCommand.HelpOptions;
+
+import java.io.Reader;
+import java.io.Writer;
+
+public class HelpCommand implements Command<HelpOptions> {
+
+    /**
+     * Get the Command's name
+     *
+     * @return The Command's name
+     */
+    @Override
+    public String getName() {
+        return "help";
+    }
+
+    /**
+     * Get the description of what the Command does
+     *
+     * @return The description of what the Command does
+     */
+    @Override
+    public String getDescription() {
+        return "Get help";
+    }
+
+    /**
+     * Get a new Options
+     *
+     * @return A new Options
+     */
+    @Override
+    public HelpOptions getOptions() {
+        return new HelpOptions();
+    }
+
+    /**
+     * Execute this Command with the given Options
+     *
+     * @param options The Options
+     * @param reader  The java.io.Reader
+     * @param writer  The java.io.Writer
+     * @throws Exception if an error occurs
+     */
+    @Override
+    public void execute(HelpOptions options, Reader reader, Writer writer) throws Exception {
+        final String newLine = System.getProperty("line.separator");
+        StringBuilder builder = new StringBuilder();
+        builder.append("Usage: geom <command> <args>").append(newLine);
+        builder.append(newLine);
+        builder.append("'geom list' lists available commands.").append(newLine);
+        builder.append(newLine);
+        builder.append("Use 'geom <command> --help' for help using a specific command.");
+        writer.write(builder.toString());
+    }
+
+    public static class HelpOptions extends Options {
+    }
+
+}

src/main/resources/META-INF/services/org.geometrycommands.Command

@@ -96,4 +96,5 @@ org.geometrycommands.TranslateCommand
 org.geometrycommands.UnionCommand
 org.geometrycommands.VoronoiDiagramCommand
 org.geometrycommands.WithinCommand
-org.geometrycommands.VersionCommand
+org.geometrycommands.VersionCommand
+org.geometrycommands.HelpCommand

src/man/geom-help.1

@@ -0,0 +1,12 @@
+.TH "geom-help" "1" "4 May 2012" "version 0.1"
+.SH NAME
+geom help
+.SH DESCRIPTION
+Get help
+.SH USAGE
+geom help
+.SH OPTIONS
+--help : Print help message
+.PP
+--web-help : Open help in a web browser
+.PP

src/shell/geom_bash_comp

@@ -5,7 +5,7 @@ _geom()
     local line=${COMP_LINE}
     COMPREPLY=()
     if [[ "$line" == *"geom " ]]; then
-        COMPREPLY=($(compgen -W 'angle arc arcpoly area asciiart boundary buffer centroid closelinestring combine contains convexHull coordinates count countpoints coveredby covers crosses delaunay densify difference dimension disjoint distance distanceline draw drawbase64 dump ellipse endpoint envelope equals fromwkb get grid hausdorffdistance interiorpoint interpolatepoint intersection intersects isccw isclosed isempty isrectangle isring issimple isvalid iswithindistance kochsnowflake linedissolve linemerge list locatepoint mincircle minclearance mindiameter minrect narrow nearestpoints node normalize octagonalenvelope overlaps placepoint pointatangle polygonize project random randomwalk rectangle reduceprecision reflect relate reverse rotate scale shear sierpinskicarpet similarity simplify sinestar slice snap split spoke squircle startpoint subline supercircle symdifference text touches towkb translate type union version voronoi within' -- $cur))
+        COMPREPLY=($(compgen -W 'angle arc arcpoly area asciiart boundary buffer centroid closelinestring combine contains convexHull coordinates count countpoints coveredby covers crosses delaunay densify difference dimension disjoint distance distanceline draw drawbase64 dump ellipse endpoint envelope equals fromwkb get grid hausdorffdistance help interiorpoint interpolatepoint intersection intersects isccw isclosed isempty isrectangle isring issimple isvalid iswithindistance kochsnowflake linedissolve linemerge list locatepoint mincircle minclearance mindiameter minrect narrow nearestpoints node normalize octagonalenvelope overlaps placepoint pointatangle polygonize project random randomwalk rectangle reduceprecision reflect relate reverse rotate scale shear sierpinskicarpet similarity simplify sinestar slice snap split spoke squircle startpoint subline supercircle symdifference text touches towkb translate type union version voronoi within' -- $cur))
     elif [[ "$line" == *"geom angle "* ]]; then
         COMPREPLY=($(compgen -W '--help --web-help -g --geometry -o --otherGeometry -t --type' -- $cur))
     elif [[ "$line" == *"geom arc "* ]]; then
@@ -78,6 +78,8 @@ _geom()
         COMPREPLY=($(compgen -W '--help --web-help -c --columns -g --geometry -r --rows' -- $cur))
     elif [[ "$line" == *"geom hausdorffdistance "* ]]; then
         COMPREPLY=($(compgen -W '--help --web-help -g --geometry -o --otherGeometry' -- $cur))
+    elif [[ "$line" == *"geom help "* ]]; then
+        COMPREPLY=($(compgen -W '--help --web-help' -- $cur))
     elif [[ "$line" == *"geom interiorpoint "* ]]; then
         COMPREPLY=($(compgen -W '--help --web-help -g --geometry' -- $cur))
     elif [[ "$line" == *"geom interpolatepoint "* ]]; then
@@ -314,6 +316,9 @@ _geom()
         if [[ "hausdorffdistance" == "$nm"* ]]; then
             COMPREPLY=("${COMPREPLY[@]}" $(compgen -W 'hausdorffdistance'))
         fi
+        if [[ "help" == "$nm"* ]]; then
+            COMPREPLY=("${COMPREPLY[@]}" $(compgen -W 'help'))
+        fi
         if [[ "interiorpoint" == "$nm"* ]]; then
             COMPREPLY=("${COMPREPLY[@]}" $(compgen -W 'interiorpoint'))
         fi

src/test/java/org/geometrycommands/HelpCommandTest.java

@@ -0,0 +1,41 @@
+package org.geometrycommands;
+
+import org.geometrycommands.HelpCommand.HelpOptions;
+import org.junit.Test;
+
+import java.io.*;
+import java.util.Properties;
+
+import static org.junit.Assert.assertEquals;
+
+public class HelpCommandTest extends BaseTest {
+
+    @Test
+    public void execute() throws Exception {
+        HelpOptions options = new HelpOptions();
+        Reader reader = new StringReader("");
+        StringWriter writer = new StringWriter();
+
+        HelpCommand command = new HelpCommand();
+        command.execute(options, reader, writer);
+        assertEquals(getExpectedHelp(), writer.getBuffer().toString());
+    }
+
+    @Test
+    public void run() throws Exception {
+        String result = runApp(new String[]{
+            "Help"
+        }, null);
+        assertEquals(getExpectedHelp(), result);
+    }
+
+    private String getExpectedHelp() throws IOException {
+        String expectedHelp = "Usage: geom <command> <args>" + NEW_LINE +
+            NEW_LINE +
+            "'geom list' lists available commands." + NEW_LINE +
+            NEW_LINE +
+            "Use 'geom <command> --help' for help using a specific command.";
+        return expectedHelp;
+    }
+
+}