finished cli: added doc + set command + dynamic version discover

Author: jknack

docs/asciidoc/getting-started.adoc

@@ -1,6 +1,7 @@
 == Getting Started
 
-[id="getting-started-java"]
+Jooby comes with couple of options for getting started: manual, maven archetype and command line tool.
+
 === Java
 
 1) Add the dependency:
@@ -97,25 +98,143 @@ Alternative you can specify all these parameters inline:
 mvn archetype:generate -B -DgroupId=mypackage -DartifactId=my-app -Dversion=1.0.0 -DarchetypeArtifactId=jooby-archetype -DarchetypeGroupId=io.jooby -DarchetypeVersion={joobyVersion}
 ----
 
-=== Code Snippets
+=== CLI
+
+The command line tool provides a dynamic way of generating Jooby applications.
+
+**Features**
+
+- Maven or Gradle build
+- Java or Kotlin language
+- Script or MVC routes
+- Choose server: Jetty, Netty or Undertow
+- Uber/Fat jar or https://github.com/fizzed/stork[Stork native launcher]
+- Dockerfile
 
-For simplicity and brevity we are going to skip the `runApp` function and extending `Jooby`.
-A code example will looks like:
+**Install**
+
+- Download https://repo1.maven.org/maven2/io/jooby/jooby-cli/{joobyVersion}/jooby-cli-{joobyVersion}.zip[jooby-cli.zip]
+- Unzip `jooby-cli.zip` in your user home directory (or any other directory you prefer to)
+- Find the native launchers in the `bin` directory
+
+[NOTE]
+====
+To simplify documentation we use `jooby` as command. Windows users must use `jooby.bat`  
+====
 
-.Snippet
-[source, java, role = "primary"]
+.Setting workspace:
+[source, bash]
 ----
-{
-  get("/", ctx -> "Snippet");
-}
+jooby set -w ~/Source
 ----
 
-.Kotlin
-[source, kotlin, role = "secondary"]
+All code will be placed inside the `~/Source` directory.
+
+[TIP]
+====
+You might want to add the native launcher `bin/jooby` or `bin/jooby.bat` to system path variable.
+So its globally accessible from any location.
+====
+
+Workspace directory is ready! Let's generate some code!! This time just run the `jooby` command.
+After prompt type `help create`:
+
+.jooby
+[source, bash]
 ----
-{
-  get("/") { "Snippet" }
-}
+jooby> help create
+----
+
+Output:
+
+[source, bash]
+----
+jooby> help create
+Missing required parameter: <name>
+Usage: jooby create [-dgikms] [--server=<server>] <name>
+Creates a new application
+      <name>              Application name or coordinates (groupId:artifactId:
+                            version)
+  -d, --docker            Generates a Dockerfile
+  -g, --gradle            Generates a Gradle project
+  -i                      Start interactive mode
+  -k, --kotlin            Generates a Kotlin application
+  -m, --mvc               Generates a MVC application
+  -s, --stork             Add Stork Maven plugin to build (Maven only)
+      --server=<server>   Choose one of the available servers: jetty, netty or
+                            undertow
+jooby> 
+----
+
+The `create` command generates a Jooby application. Some examples:
+
+.Creates `myapp` as Java Maven project:
+[source, bash]
+----
+jooby> create myapp
+----
+
+.Creates `myapp` as Kotlin Maven project:
+[source, bash]
+----
+jooby> create myapp -k
+----
+
+.Creates `myapp` as Java Gradle project:
+[source, bash]
+----
+jooby> create myapp -g
+----
+
+.Creates `myapp` as Kotlin Gradle project:
+[source, bash]
+----
+jooby> create myapp -gk
+----
+
+Maven and Java are the default options but you can easily override those with `-g -k` or `-gk` (order doesn't matter).
+Along with the build and language the `create` command adds two test classes: `UnitTest` and `IntegrationTest`.
+
+Passing the `-m` or `--mvc` generates a MVC application:
+
+.Creates `myapp` as MVC application:
+[source, bash]
+----
+jooby> create myapp -m
+----
+
+The `--server` option, allow you to choose between: (J)etty, (N)etty or (U)ndertow:
+
+.Creates `myapp` as MVC application:
+[source, bash]
+----
+jooby> create myapp --server undertow
+----
+
+Maven/Gradle configuration generates an `uber/fat` jar at package time. Maven builds supports 
+generation of https://github.com/fizzed/stork[Stork launchers].
+
+.Creates `myapp` and generates stork launchers:
+[source, bash]
+----
+jooby> create myapp --stork
+----
+
+There is a `-d` or `--docker` option which generates a `Dockerfile`
+
+.Creates `myapp` with docker:
+[source, bash]
+----
+jooby> create myapp --docker
+----
+
+The default package in all these examples is set to `app`, to get fully control of groupId, package, version, etc... Use the interactive mode:
+
+.Fully customize `myapp`:
+[source, bash]
+----
+jooby> create myapp -i
 ----
 
-The use of `runApp` will be included only when is strictly necessary.
+The jooby cli application is a small program that simplifies creation of project and provides options
+to fully customize your application.

docs/asciidoc/index.adoc

@@ -206,7 +206,28 @@ fun main(args: Array<String>) {
 
 More about MVC and JAX-RS support in the <<mvc-api, MVC API>> chapter.
 
-include::support.adoc[]
+=== Code Snippets
+
+For simplicity and brevity we are going to skip the `runApp` function and extending `Jooby`.
+A code example will looks like:
+
+.Snippet
+[source, java, role = "primary"]
+----
+{
+  get("/", ctx -> "Snippet");
+}
+----
+
+.Kotlin
+[source, kotlin, role = "secondary"]
+----
+{
+  get("/") { "Snippet" }
+}
+----
+
+The use of `application class` or `runApp function` will be included when is strictly necessary.
 
 include::getting-started.adoc[]
 

docs/asciidoc/static-files.adoc

@@ -127,7 +127,7 @@ SPAs mode never generates a `NOT FOUND (404)` response, unresolved assets fallba
 
 === Options
 
-The javadoc:AssetHandler[] automatically handle `E-Tag` and `Las-Modified` headers. You can turn
+The javadoc:AssetHandler[] automatically handles `E-Tag` and `Las-Modified` headers. You can turn
 control these headers programmatically:
 
 .Asset handler options:

modules/jooby-cli/pom.xml

@@ -45,6 +45,13 @@
       <version>3.12.1</version>
     </dependency>
 
+    <!-- https://mvnrepository.com/artifact/org.json/json -->
+    <dependency>
+      <groupId>org.json</groupId>
+      <artifactId>json</artifactId>
+      <version>20190722</version>
+    </dependency>
+
     <dependency>
       <groupId>org.junit.jupiter</groupId>
       <artifactId>junit-jupiter-engine</artifactId>

modules/jooby-cli/src/main/java/io/jooby/cli/Cli.java

@@ -16,12 +16,20 @@
 import org.jline.reader.impl.DefaultParser;
 import org.jline.terminal.Terminal;
 import org.jline.terminal.TerminalBuilder;
+import org.json.JSONArray;
+import org.json.JSONObject;
+import org.json.JSONTokener;
 import picocli.CommandLine;
 
 import javax.annotation.Nonnull;
 import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+import java.net.URL;
+import java.net.URLConnection;
 import java.util.List;
 import java.util.Objects;
+import java.util.Optional;
 import java.util.stream.Collectors;
 
 /**
@@ -46,14 +54,16 @@
     mixinStandardHelpOptions = true,
     version = "Print version information"
 )
-public class Cli extends Command {
+public class Cli extends Cmd {
+  public static String version;
+
   /** Command line specification.  */
   private @CommandLine.Spec CommandLine.Model.CommandSpec spec;
 
   /** Unmatched command line arguments. */
   private @CommandLine.Unmatched List<String> args;
 
-  @Override public void run(@Nonnull CommandContext ctx) {
+  @Override public void run(@Nonnull Context ctx) {
     List<String> args = this.args.stream()
         .filter(Objects::nonNull)
         .map(String::trim)
@@ -64,7 +74,7 @@ public class Cli extends Command {
       if ("-h".equals(arg) || "--help".equals(arg)) {
         ctx.println(spec.commandLine().getUsageMessage());
       } else if ("-V".equalsIgnoreCase(arg) || "--version".equals(arg)) {
-        ctx.println(VersionProvider.version());
+        ctx.println(ctx.getVersion());
       } else {
         ctx.println("Unknown command or option(s): " + args.stream().collect(Collectors.joining(" ")));
       }
@@ -78,11 +88,13 @@ public class Cli extends Command {
    * @throws IOException If something goes wrong.
    */
   public static void main(String[] args) throws IOException {
+    version = checkVersion();
     // set up the completion
     Cli jooby = new Cli();
     CommandLine cmd = new CommandLine(jooby)
-        .addSubcommand(new CreateApp())
-        .addSubcommand(new Exit());
+        .addSubcommand(new CreateCmd())
+        .addSubcommand(new ExitCmd())
+        .addSubcommand(new SetCmd());
 
     Terminal terminal = TerminalBuilder.builder().build();
     LineReader reader = LineReaderBuilder.builder()
@@ -91,12 +103,12 @@ public static void main(String[] args) throws IOException {
         .parser(new DefaultParser())
         .build();
 
-    CommandContextImpl context = new CommandContextImpl(reader);
+    CommandContextImpl context = new CommandContextImpl(reader, version);
     jooby.setContext(context);
     cmd.getSubcommands().values().stream()
         .map(CommandLine::getCommand)
-        .filter(Command.class::isInstance)
-        .map(Command.class::cast)
+        .filter(Cmd.class::isInstance)
+        .map(Cmd.class::cast)
         .forEach(command -> command.setContext(context));
 
     if (args.length > 0) {
@@ -119,4 +131,25 @@ public static void main(String[] args) throws IOException {
       }
     }
   }
+
+  private static String checkVersion() {
+    try {
+      URL url = URI
+          .create("http://search.maven.org/solrsearch/select?q=+g:io.jooby+a:jooby&start=0&rows=1")
+          .toURL();
+      URLConnection connection = url.openConnection();
+      try(InputStream in = connection.getInputStream()) {
+        JSONObject json = new JSONObject(new JSONTokener(in));
+        JSONObject response = json.getJSONObject("response");
+        JSONArray docs = response.getJSONArray("docs");
+        JSONObject jooby = docs.getJSONObject(0);
+        return jooby.getString("latestVersion");
+      }
+    } catch (Exception x) {
+      return Optional.ofNullable(VersionProvider.class.getPackage())
+          .map(Package::getImplementationVersion)
+          .filter(Objects::nonNull)
+          .orElse("2.0.5");
+    }
+  }
 }

…/src/main/java/io/jooby/cli/Command.java …-cli/src/main/java/io/jooby/cli/Cmd.javamodules/jooby-cli/src/main/java/io/jooby/cli/Command.java renamed to modules/jooby-cli/src/main/java/io/jooby/cli/Cmd.java modules/jooby-cli/src/main/java/io/jooby/cli/Command.java renamed to modules/jooby-cli/src/main/java/io/jooby/cli/Cmd.java

@@ -12,8 +12,8 @@
  *
  * @since 2.0.5
  */
-public abstract class Command implements Runnable {
-  private CommandContext context;
+public abstract class Cmd implements Runnable {
+  private Context context;
 
   @Override public void run() {
     try {
@@ -29,14 +29,14 @@ public abstract class Command implements Runnable {
    * @param context Command context.
    * @throws Exception If something goes wrong.
    */
-  public abstract void run(@Nonnull CommandContext context) throws Exception;
+  public abstract void run(@Nonnull Context context) throws Exception;
 
   /**
    * Set command context.
    *
    * @param context Command context.
    */
-  public void setContext(@Nonnull CommandContext context) {
+  public void setContext(@Nonnull Context context) {
     this.context = context;
   }
 

…in/java/io/jooby/cli/CommandContext.java …/src/main/java/io/jooby/cli/Context.javamodules/jooby-cli/src/main/java/io/jooby/cli/CommandContext.java renamed to modules/jooby-cli/src/main/java/io/jooby/cli/Context.java modules/jooby-cli/src/main/java/io/jooby/cli/CommandContext.java renamed to modules/jooby-cli/src/main/java/io/jooby/cli/Context.java

@@ -6,6 +6,7 @@
 package io.jooby.cli;
 
 import javax.annotation.Nonnull;
+import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.nio.file.Path;
 import java.nio.file.attribute.PosixFilePermission;
@@ -17,7 +18,7 @@
  *
  * @since 2.0.6
  */
-public interface CommandContext {
+public interface Context {
   /**
    * Exit application.
    *
@@ -70,4 +71,25 @@ void copyResource(@Nonnull String source, @Nonnull Path dest,
    * @param message Message.
    */
   void println(@Nonnull String message);
+
+  /**
+   * Jooby version to use.
+   *
+   * @return Jooby version to use.
+   */
+  @Nonnull String getVersion();
+
+  /**
+   * Working directory (where the projects are created).
+   *
+   * @return Working directory (where the projects are created).
+   */
+  @Nonnull Path getWorkspace();
+
+  /**
+   * Set workspace/working directory.
+   *
+   * @param workspace Workspace/working directory.
+   */
+  void setWorkspace(@Nonnull Path workspace) throws IOException;
 }