improve styling/formatting of launcher help text.

Author: Robin Duda

core/main/java/com/codingchili/core/configuration/CoreStrings.java

@@ -27,7 +27,7 @@ public abstract class CoreStrings {
     // Author.
     public static String VERSION;
     public static final String GITHUB = "https://github.com/codingchili";
-    public static final String AUTHOR = "Robin Duda \u00a9 2019";
+    public static final String AUTHOR = "Robin Duda \u00a9 2020";
 
     static {
         VERSION = CoreStrings.class.getPackage().getImplementationVersion();
@@ -196,7 +196,7 @@ public abstract class CoreStrings {
     public static final String ERROR_CONFIGURATION_MISMATCH = "configuration mismatches with currently loaded.";
     public static final String ERROR_ALREADY_INITIALIZED = "Error already initialized.";
     public static final String ERROR_STORAGE_EXCEPTION = "Failed to perform a storage operation.";
-    public static final String CONFIGURED_BLOCKS = "Configured deployment blocks";
+    public static final String CONFIGURED_BLOCKS = "Configured deployment blocks and remotes available";
     public static final String ERROR_PATCH_RELOADED = "The patch version changed during patch session.";
     public static final String[] BENCHMARK_CONSOLE_REPORT_COLUMNS =
             {"[GROUP]", "[IMPLEMENTATION]", "[BENCHMARK]", "[OP/s]", "[TIME]"};
@@ -491,10 +491,6 @@ public static String getCommandExecutorHelpDescription() {
         return "prints this help text.";
     }
 
-    public static String getRemotesAvailable() {
-        return "remotes available";
-    }
-
     public static String getBenchmarkDescription() {
         return "Executes benchmarks. [--iterations ?, --html]";
     }
@@ -541,14 +537,6 @@ public static String formatAsPercent(Double value) {
         return new DecimalFormat("#.00").format(value);
     }
 
-    public static List<String> getCommandExecutorText() {
-        List<String> list = new ArrayList<>();
-        list.add("================================ HELP ================================");
-        list.add("\t\t<block-name>\t\t\tdeploys the services configured in the given block.");
-        list.add("\t\t<remote-name>\t\t\tdeploys configured blocks on a remote host.");
-        return list;
-    }
-
     public static String getMissingEntity(String key) {
         return "Error: could not get '" + key + "' in storage.";
     }
@@ -649,5 +637,18 @@ public static String getKeystoreTooManyEntries(String path) {
         return String.format("Keystore at '%s' contains too many entries, only one entry supported.", path);
     }
 
+    public static String pad(String text, int spaces) {
+        int padding = spaces - text.length();
+        if (padding > 0) {
+            return text + String.join("", Collections.nCopies(padding, " "));
+        } else {
+            return text;
+        }
+    }
+
+    public static String leftPad(String text, int spaces) {
+        return pad("", spaces) + text;
+    }
+
     private enum IPVersion {IP4, IP6;}
 }

core/main/java/com/codingchili/core/context/LauncherCommandExecutor.java

@@ -1,14 +1,14 @@
 package com.codingchili.core.context;
 
 import io.vertx.core.Future;
+import org.fusesource.jansi.Ansi;
 
 import java.util.*;
 import java.util.function.Function;
 
 import com.codingchili.core.benchmarking.CoreBenchmarkSuite;
-import com.codingchili.core.configuration.CoreStrings;
 import com.codingchili.core.files.Configurations;
-import com.codingchili.core.logging.*;
+import com.codingchili.core.logging.Logger;
 import com.codingchili.core.security.AuthenticationGenerator;
 
 import static com.codingchili.core.configuration.CoreStrings.*;
@@ -17,6 +17,7 @@
  * Command executor that registers launch commands to a CommandExecutor.
  */
 public class LauncherCommandExecutor extends DefaultCommandExecutor {
+    private Ansi ansi = Ansi.ansi();
 
     /**
      * constructs an instance with the default logger
@@ -74,25 +75,45 @@ public Optional<String> getCommand() {
         }
     }
 
+    private void printCommand(String text, String description, int align) {
+        ansi.fgBright(Ansi.Color.CYAN)
+                .a(String.format("\t%s", pad(text, align)))
+                .reset()
+                .a(description)
+                .newline();
+    }
+
+    private void printExecutorHelpText(int align) {
+        ansi.fgBright(Ansi.Color.GREEN)
+                .a(" HELP ")
+                .newline()
+                .reset();
+
+        printCommand("<block-name>", "deploys the services configured in the given block.", align);
+        printCommand("<remote-name>", "deploys configured blocks on a remote host.", align);
+    }
+
     private void help() {
-        int align = 24;
+        final int DEFAULT_SPACING = 18;
+        final int COMMAND_PADDING = 4;
 
-        for (String line : getCommandExecutorText()) {
-            logger.log(line, Level.STARTUP);
-        }
+        // find the longest command and add some padding to it.
+        int align = commands.values().stream()
+                .map(command -> command.getName().length() + COMMAND_PADDING)
+                .reduce(Math::max)
+                .orElse(DEFAULT_SPACING);
 
-        for (Command command : commands.values()) {
-            int space = align - command.getName().length();
+        printExecutorHelpText(align);
 
+        for (Command command : commands.values()) {
             if (command.isVisible()) {
-                logger.log("\t\t" + command.getName() +
-                        String.join("", Collections.nCopies(space, " ")) +
-                        command.getDescription(), Level.STARTUP);
+                printCommand(command.getName(), command.getDescription(), align);
             }
         }
 
         List<BlockRow> blocks = new ArrayList<>();
-        logger.log("\n\t\t" + CoreStrings.CONFIGURED_BLOCKS + "\t\t" + getRemotesAvailable(), Level.WARNING);
+        ansi.a(String.format("\n\t%s\n\n", CONFIGURED_BLOCKS));
+
         settings.getBlocks().keySet()
                 .forEach(block -> {
                     BlockRow row = new BlockRow(block);
@@ -102,7 +123,8 @@ private void help() {
                             .forEach(row.remotes::add);
                     blocks.add(row);
                 });
-        blocks.forEach(block -> logger.log(block.toString(), Level.SPECIAL));
+        blocks.forEach(block -> block.toAnsi(ansi, align));
+        logger.log(ansi.toString());
     }
 
     private class BlockRow {
@@ -113,25 +135,25 @@ private class BlockRow {
             this.block = block;
         }
 
-        @Override
-        public String toString() {
-            int align = 36;
-            String string = "\t\t" + block + String.join("",
-                    Collections.nCopies(align - block.length(), " "));
+        public void toAnsi(Ansi ansi, int align) {
+            ansi.fgBright(Ansi.Color.CYAN)
+                    .a(pad("\t" + block, align))
+                    .reset();
 
             for (int i = 0; i < remotes.size(); i++) {
                 if (i == 0)
-                    string += "[";
+                    ansi.a("[");
 
-                string += remotes.get(i);
+                ansi.fgBright(Ansi.Color.CYAN)
+                        .a(remotes.get(i))
+                        .reset();
 
                 if (i < remotes.size() - 1)
-                    string += ", ";
+                    ansi.a(", ");
                 if (i == remotes.size() - 1)
-                    string += "]";
+                    ansi.a("]");
             }
-
-            return string;
+            ansi.newline();
         }
     }
 }

core/main/java/com/codingchili/core/logging/ConsoleLogger.java

@@ -9,7 +9,6 @@
 import java.util.concurrent.*;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.function.Consumer;
-import java.util.stream.Collectors;
 
 import com.codingchili.core.context.CoreContext;
 
@@ -111,6 +110,7 @@ private void write(String line) {
         //AnsiConsole.out.flush();
     }
 
+    private static final int SPACES = 15;
     protected String parseJsonLog(JsonObject data, String event) {
         LogLevel level = consumeLevel(data);
         String message = consume(data, LOG_MESSAGE);
@@ -125,11 +125,11 @@ protected String parseJsonLog(JsonObject data, String event) {
                 .a(consumeTimestamp(data))
                 .reset()
                 .a("] ")
-                .a((hasValue(event)) ? pad(event, 15) : "")
+                .a((hasValue(event)) ? pad(event, SPACES) : "")
                 .a(" [");
 
         level.apply(ansi)
-                .a(pad(consume(data, LOG_SOURCE), 15))
+                .a(pad(consume(data, LOG_SOURCE), SPACES))
                 .reset()
                 .a("]");
 
@@ -199,15 +199,6 @@ private String consumeTimestamp(JsonObject data) {
         }
     }
 
-    private String pad(String text, int spaces) {
-        int padding = spaces - text.length();
-        if (padding > 0) {
-            return text + Collections.nCopies(padding, " ").stream().collect(Collectors.joining());
-        } else {
-            return text;
-        }
-    }
-
     private String compactPath(String path) {
         StringBuilder text = new StringBuilder();