Merge pull request #572 from ancho/feature/picocli-integration

jonbullock · web-flow · commit dcc0e83d21ab · 2021-05-20T09:45:01.000+01:00
switch to picocli
diff --git a/gradle.properties b/gradle.properties
@@ -28,6 +28,8 @@ pebbleVersion               = 3.1.5
 slf4jVersion                = 1.7.30
 snakeYamlVersion            = 1.28
 thymeleafVersion            = 3.0.12.RELEASE
+picocli                     = 4.6.1
+
 
 # testing dependencies
 junit4Version               = 4.13.2
diff --git a/jbake-core/build.gradle b/jbake-core/build.gradle
@@ -30,7 +30,7 @@ dependencies {
 
     // cli specific dependencies
     implementation "org.eclipse.jetty:jetty-server:$jettyServerVersion", optional
-    implementation "args4j:args4j:$args4jVersion", optional
+    implementation "info.picocli:picocli:$picocli", optional
 }
 
 processResources {
diff --git a/jbake-core/src/main/java/org/jbake/app/ContentStore.java b/jbake-core/src/main/java/org/jbake/app/ContentStore.java
@@ -36,6 +36,7 @@
 import com.orientechnologies.orient.core.sql.OCommandSQL;
 import com.orientechnologies.orient.core.sql.executor.OResultSet;
 import com.orientechnologies.orient.core.sql.query.OSQLSynchQuery;
+import org.jbake.launcher.SystemExit;
 import org.jbake.model.DocumentAttributes;
 import org.jbake.model.DocumentTypes;
 import org.slf4j.Logger;
@@ -212,7 +213,7 @@ public ODocument mergeDocument(Map<String, ? extends Object> incomingDocMap) {
         activateOnCurrentThread();
         List<ODocument> results = db.command(new OSQLSynchQuery<ODocument>(sql)).execute(sourceUri);
         if (results.isEmpty()) {
-            throw new JBakeException("No document with sourceUri '" + sourceUri + "'.");
+            throw new JBakeException(SystemExit.ERROR, "No document with sourceUri '" + sourceUri + "'.");
         }
 
         // Update it from the given map.
diff --git a/jbake-core/src/main/java/org/jbake/app/JBakeException.java b/jbake-core/src/main/java/org/jbake/app/JBakeException.java
@@ -1,5 +1,7 @@
 package org.jbake.app;
 
+import org.jbake.launcher.SystemExit;
+
 /**
  * This runtime exception is thrown by JBake API to indicate an processing
  * error.
@@ -9,18 +11,26 @@
 public class JBakeException extends RuntimeException {
     private static final long serialVersionUID = 1L;
 
+    final private SystemExit exit;
+
     /**
+     *
      * @param message
      *            The error message.
      * @param cause
      *            The causing exception or <code>null</code> if no cause
      *            available.
      */
-    public JBakeException(final String message, final Throwable cause) {
+    public JBakeException(final SystemExit exit, final String message, final Throwable cause) {
         super(message, cause);
+        this.exit = exit;
+    }
+
+    public JBakeException(final SystemExit exit, final String message) {
+        this(exit, message, null);
     }
 
-    public JBakeException(final String message) {
-        this(message, null);
+    public int getExit() {
+        return exit.getStatus();
     }
 }
diff --git a/jbake-core/src/main/java/org/jbake/app/configuration/ConfigUtil.java b/jbake-core/src/main/java/org/jbake/app/configuration/ConfigUtil.java
@@ -5,14 +5,12 @@
 import org.apache.commons.configuration.PropertiesConfiguration;
 import org.apache.commons.configuration.SystemConfiguration;
 import org.jbake.app.JBakeException;
+import org.jbake.launcher.SystemExit;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.File;
 import java.net.URL;
-import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.nio.charset.Charset;
 
 /**
  * Provides Configuration related functions.
@@ -29,10 +27,10 @@ public class ConfigUtil {
     private CompositeConfiguration load(File source) throws ConfigurationException {
 
         if (!source.exists()) {
-            throw new JBakeException("The given source folder '" + source.getAbsolutePath() + "' does not exist.");
+            throw new JBakeException(SystemExit.CONFIGURATION_ERROR, "The given source folder '" + source.getAbsolutePath() + "' does not exist.");
         }
         if (!source.isDirectory()) {
-            throw new JBakeException("The given source folder is not a directory.");
+            throw new JBakeException(SystemExit.CONFIGURATION_ERROR,"The given source folder is not a directory.");
         }
         CompositeConfiguration config = new CompositeConfiguration();
         config.setListDelimiter(',');
diff --git a/jbake-core/src/main/java/org/jbake/app/configuration/JBakeConfigurationInspector.java b/jbake-core/src/main/java/org/jbake/app/configuration/JBakeConfigurationInspector.java
@@ -2,6 +2,7 @@
 
 import org.jbake.app.FileUtil;
 import org.jbake.app.JBakeException;
+import org.jbake.launcher.SystemExit;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -28,10 +29,10 @@ public void inspect() throws JBakeException {
     private void ensureSource() throws JBakeException {
         File source = configuration.getSourceFolder();
         if (!FileUtil.isExistingFolder(source)) {
-            throw new JBakeException("Error: Source folder must exist: " + source.getAbsolutePath());
+            throw new JBakeException(SystemExit.CONFIGURATION_ERROR, "Error: Source folder must exist: " + source.getAbsolutePath());
         }
         if (!configuration.getSourceFolder().canRead()) {
-            throw new JBakeException("Error: Source folder is not readable: " + source.getAbsolutePath());
+            throw new JBakeException(SystemExit.CONFIGURATION_ERROR, "Error: Source folder is not readable: " + source.getAbsolutePath());
         }
     }
 
@@ -51,7 +52,7 @@ private void ensureDestination() {
             destination.mkdirs();
         }
         if (!destination.canWrite()) {
-            throw new JBakeException("Error: Destination folder is not writable: " + destination.getAbsolutePath());
+            throw new JBakeException(SystemExit.CONFIGURATION_ERROR, "Error: Destination folder is not writable: " + destination.getAbsolutePath());
         }
     }
 
@@ -62,9 +63,9 @@ private void checkAssetFolder() {
         }
     }
 
-    private void checkRequiredFolderExists(String property, File path) {
+    private void checkRequiredFolderExists(String folderName, File path) {
         if (!FileUtil.isExistingFolder(path)) {
-            throw new JBakeException("Error: Required folder cannot be found! Expected to find [" + property + "] at: " + path.getAbsolutePath());
+            throw new JBakeException(SystemExit.CONFIGURATION_ERROR, "Error: Required folder cannot be found! Expected to find [" + folderName + "] at: " + path.getAbsolutePath());
         }
     }
 
diff --git a/jbake-core/src/main/java/org/jbake/launcher/Baker.java b/jbake-core/src/main/java/org/jbake/launcher/Baker.java
@@ -41,7 +41,7 @@ public void bake(final JBakeConfiguration config) {
                 msg.append(MessageFormat.format("{0}. {1}\n", errNr, error.getMessage()));
                 ++errNr;
             }
-            throw new JBakeException(msg.toString(), errors.get(0));
+            throw new JBakeException(SystemExit.ERROR ,msg.toString(), errors.get(0));
         }
     }
 }
diff --git a/jbake-core/src/main/java/org/jbake/launcher/JettyServer.java b/jbake-core/src/main/java/org/jbake/launcher/JettyServer.java
@@ -7,6 +7,7 @@
 import org.eclipse.jetty.server.handler.DefaultHandler;
 import org.eclipse.jetty.server.handler.HandlerList;
 import org.eclipse.jetty.server.handler.ResourceHandler;
+import org.jbake.app.JBakeException;
 import org.jbake.app.configuration.JBakeConfiguration;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -34,41 +35,42 @@ public void run(String resourceBase, String port) {
     public void run(String resourceBase, JBakeConfiguration configuration) {
         run(resourceBase, configuration.getServerContextPath(), configuration.getServerHostname(), configuration.getServerPort());
     }
+
     /**
      * Run Jetty web server serving out supplied path on supplied port
      *
      * @param resourceBase Base directory for resources to be served
-     * @param port Required server port
+     * @param port         Required server port
      */
     private void run(String resourceBase, String contextPath, String hostname, int port) {
-        server = new Server();
-        ServerConnector connector = new ServerConnector(server);
-        connector.setHost(hostname);
-        connector.setPort(port);
-        server.addConnector(connector);
+        try {
+            server = new Server();
+            ServerConnector connector = new ServerConnector(server);
+            connector.setHost(hostname);
+            connector.setPort(port);
+            server.addConnector(connector);
 
-        ResourceHandler resource_handler = new ResourceHandler();
-        resource_handler.setDirectoriesListed(true);
-        resource_handler.setWelcomeFiles(new String[]{"index", "index.html"});
-        resource_handler.setResourceBase(resourceBase);
+            ResourceHandler resource_handler = new ResourceHandler();
+            resource_handler.setDirectoriesListed(true);
+            resource_handler.setWelcomeFiles(new String[]{"index", "index.html"});
+            resource_handler.setResourceBase(resourceBase);
 
-        ContextHandler contextHandler = new ContextHandler();
-        contextHandler.setContextPath(contextPath);
-        contextHandler.setHandler(resource_handler);
+            ContextHandler contextHandler = new ContextHandler();
+            contextHandler.setContextPath(contextPath);
+            contextHandler.setHandler(resource_handler);
 
-        HandlerList handlers = new HandlerList();
+            HandlerList handlers = new HandlerList();
 
-        handlers.setHandlers(new Handler[]{contextHandler, new DefaultHandler()});
-        server.setHandler(handlers);
+            handlers.setHandlers(new Handler[]{contextHandler, new DefaultHandler()});
+            server.setHandler(handlers);
 
-        LOGGER.info("Serving out contents of: [{}] on http://{}:{}{}", resourceBase, hostname, port, contextHandler.getContextPath());
-        LOGGER.info("(To stop server hit CTRL-C)");
+            LOGGER.info("Serving out contents of: [{}] on http://{}:{}{}", resourceBase, hostname, port, contextHandler.getContextPath());
+            LOGGER.info("(To stop server hit CTRL-C)");
 
-        try {
             server.start();
             server.join();
         } catch (Exception e) {
-            LOGGER.error("unable to start server", e);
+            throw new JBakeException(SystemExit.SERVER_ERROR, "unable to start the server", e);
         }
     }
 
diff --git a/jbake-core/src/main/java/org/jbake/launcher/LaunchOptions.java b/jbake-core/src/main/java/org/jbake/launcher/LaunchOptions.java
@@ -1,41 +1,50 @@
 package org.jbake.launcher;
 
-import org.kohsuke.args4j.Argument;
-import org.kohsuke.args4j.Option;
+import picocli.CommandLine.ArgGroup;
+import picocli.CommandLine.Command;
+import picocli.CommandLine.Option;
+import picocli.CommandLine.Parameters;
 
 import java.io.File;
 
+@Command(
+        description = "JBake is a Java based, open source, static site/blog generator for developers & designers",
+        name = "jbake",
+        usageHelpAutoWidth = true
+)
 public class LaunchOptions {
-    @Argument(index = 0, usage = "source folder of site content (with templates and assets), if not supplied will default to current directory", metaVar = "<source>")
+    @Parameters(index = "0", description = "source folder of site content (with templates and assets), if not supplied will default to current directory", arity = "0..1")
     private String source;
 
-    @Argument(index = 1, usage = "destination folder for output, if not supplied will default to a folder called \"output\" in the current directory", metaVar = "<destination>")
+    @Parameters(index = "1", description = "destination folder for output, if not supplied will default to a folder called \"output\" in the current directory", arity = "0..1")
     private String destination;
 
-    @Option(name = "-b", aliases = {"--bake"}, usage = "performs a bake")
+    @Option(names = {"-b", "--bake"}, description = "performs a bake")
     private boolean bake;
 
-    @Option(name = "-i", aliases = {"--init"}, usage = "initialises required folder structure with default templates (defaults to current directory if <value> is not supplied)")
-    private boolean init;
+    @ArgGroup(exclusive = false, heading = "%n%nJBake initialization%n%n")
+    private InitOptions initGroup;
 
-    @Option(name = "-t", aliases = {"--template"}, usage = "use specified template engine for default templates (uses Freemarker if <value> is not supplied) ", depends = ("-i"))
-    private String template;
+    static class InitOptions {
 
-    @Option(name = "-s", aliases = {"--server"}, usage = "runs HTTP server to serve out baked site, if no <value> is supplied will default to a folder called \"output\" in the current directory")
+        @Option(names = {"-i", "--init"}, paramLabel = "<target>", description = "initialises required folder structure with default templates (defaults to current directory if <source> is not supplied)", required = true)
+        private boolean init;
+
+        @Option(names = {"-t", "--template"}, defaultValue = "freemarker", fallbackValue = "freemarker", description = "use specified template engine for default templates (uses Freemarker if <template> is not supplied) ", arity = "0..1")
+        private String template;
+    }
+
+    @Option(names = {"-s", "--server"}, description = "runs HTTP server to serve out baked site, if no <value> is supplied will default to a folder called \"output\" in the current directory")
     private boolean runServer;
 
-    @Option(name = "-h", aliases = {"--help"}, usage = "prints this message")
-    private boolean helpNeeded;
+    @Option(names = {"-h", "--help"}, description = "prints this message", usageHelp = true)
+    private boolean helpRequested;
 
-    @Option(name = "--reset", usage = "clears the local cache, enforcing rendering from scratch")
+    @Option(names = {"--reset"}, description = "clears the local cache, enforcing rendering from scratch")
     private boolean clearCache;
 
     public String getTemplate() {
-        if (template != null) {
-            return template;
-        } else {
-            return "freemarker";
-        }
+        return initGroup.template;
     }
 
     public File getSource() {
@@ -63,15 +72,15 @@ public String getDestinationValue() {
     }
 
     public boolean isHelpNeeded() {
-        return helpNeeded || !(isBake() || isRunServer() || isInit() || source != null || destination != null);
+        return helpRequested || !(isBake() || isRunServer() || isInit() || source != null || destination != null);
     }
 
     public boolean isRunServer() {
         return runServer;
     }
 
     public boolean isInit() {
-        return init;
+        return (initGroup !=null && initGroup.init);
     }
 
     public boolean isClearCache() {
diff --git a/jbake-core/src/main/java/org/jbake/launcher/Main.java b/jbake-core/src/main/java/org/jbake/launcher/Main.java
diff --git a/jbake-core/src/main/java/org/jbake/launcher/SystemExit.java b/jbake-core/src/main/java/org/jbake/launcher/SystemExit.java
diff --git a/jbake-core/src/test/java/org/jbake/launcher/LaunchOptionsTest.java b/jbake-core/src/test/java/org/jbake/launcher/LaunchOptionsTest.java
diff --git a/jbake-core/src/test/java/org/jbake/launcher/MainTest.java b/jbake-core/src/test/java/org/jbake/launcher/MainTest.java

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ dependencies {`
`30`	`30`
`31`	`31`	`// cli specific dependencies`
`32`	`32`	`implementation "org.eclipse.jetty:jetty-server:$jettyServerVersion", optional`
`33`		`- implementation "args4j:args4j:$args4jVersion", optional`
	`33`	`+ implementation "info.picocli:picocli:$picocli", optional`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`processResources {`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`import org.jbake.app.FileUtil;`
`4`	`4`	`import org.jbake.app.JBakeException;`
	`5`	`+import org.jbake.launcher.SystemExit;`
`5`	`6`	`import org.slf4j.Logger;`
`6`	`7`	`import org.slf4j.LoggerFactory;`
`7`	`8`
`@@ -28,10 +29,10 @@ public void inspect() throws JBakeException {`
`28`	`29`	`private void ensureSource() throws JBakeException {`
`29`	`30`	`File source = configuration.getSourceFolder();`
`30`	`31`	`if (!FileUtil.isExistingFolder(source)) {`
`31`		`- throw new JBakeException("Error: Source folder must exist: " + source.getAbsolutePath());`
	`32`	`+ throw new JBakeException(SystemExit.CONFIGURATION_ERROR, "Error: Source folder must exist: " + source.getAbsolutePath());`
`32`	`33`	`}`
`33`	`34`	`if (!configuration.getSourceFolder().canRead()) {`
`34`		`- throw new JBakeException("Error: Source folder is not readable: " + source.getAbsolutePath());`
	`35`	`+ throw new JBakeException(SystemExit.CONFIGURATION_ERROR, "Error: Source folder is not readable: " + source.getAbsolutePath());`
`35`	`36`	`}`
`36`	`37`	`}`
`37`	`38`
`@@ -51,7 +52,7 @@ private void ensureDestination() {`
`51`	`52`	`destination.mkdirs();`
`52`	`53`	`}`
`53`	`54`	`if (!destination.canWrite()) {`
`54`		`- throw new JBakeException("Error: Destination folder is not writable: " + destination.getAbsolutePath());`
	`55`	`+ throw new JBakeException(SystemExit.CONFIGURATION_ERROR, "Error: Destination folder is not writable: " + destination.getAbsolutePath());`
`55`	`56`	`}`
`56`	`57`	`}`
`57`	`58`
`@@ -62,9 +63,9 @@ private void checkAssetFolder() {`
`62`	`63`	`}`
`63`	`64`	`}`
`64`	`65`
`65`		`- private void checkRequiredFolderExists(String property, File path) {`
	`66`	`+ private void checkRequiredFolderExists(String folderName, File path) {`
`66`	`67`	`if (!FileUtil.isExistingFolder(path)) {`
`67`		`- throw new JBakeException("Error: Required folder cannot be found! Expected to find [" + property + "] at: " + path.getAbsolutePath());`
	`68`	`+ throw new JBakeException(SystemExit.CONFIGURATION_ERROR, "Error: Required folder cannot be found! Expected to find [" + folderName + "] at: " + path.getAbsolutePath());`
`68`	`69`	`}`
`69`	`70`	`}`
`70`	`71`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public void bake(final JBakeConfiguration config) {`
`41`	`41`	`msg.append(MessageFormat.format("{0}. {1}\n", errNr, error.getMessage()));`
`42`	`42`	`++errNr;`
`43`	`43`	`}`
`44`		`- throw new JBakeException(msg.toString(), errors.get(0));`
	`44`	`+ throw new JBakeException(SystemExit.ERROR ,msg.toString(), errors.get(0));`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`	`}`