[#1715] Add RepoSense CLI Wizard Walkthrough

build.gradle

@@ -88,6 +88,7 @@ run {
     tasks.compileJava.mustRunAfter(zipReport)
     args System.getProperty('args', '').split()
     systemProperty "version", getRepoSenseVersion()
+    standardInput = System.in
 }
 
 checkstyle {

docs/ug/cli.md

@@ -137,6 +137,19 @@ This flag overrides the `Ignore file size limit` field in the CSV config file.
 
 <!-- ------------------------------------------------------------------------------------------------------ -->
 
+### `--init`
+
+**`--init`**: Launches the RepoSense CLI set-up wizard.
+* Example: `--init`
+
+<box type="info" seamless>
+
+* The wizard will run through the basic config flags in this order: `--since`, `--until`, `--view`, `--repos`.
+* This flag overrides all other flags and thus should be used on its own.
+</box>
+
+<!-- ------------------------------------------------------------------------------------------------------ -->
+
 ### `--last-modified-date`, `-l`
 
 **`--last-modified-date`**: Specifies that the last modified date of each line of code should be added to `authorship.json`.

docs/ug/generatingReports.md

@@ -44,6 +44,9 @@ For other types of repositories, external links are disabled.
 
 **To learn how to generate a report using <tooltip content="e.g., generate a report for a different period, for specific file types, for specific authors, etc.">other settings</tooltip>**, head over to the [_**Customizing reports**_](customizingReports.html) section.
 
+**Alternatively**, you may also use the RepoSense CLI set-up wizard, which will take you through a basic configuration of RepoSense through the following command:
+  * `java -jar RepoSense.jar --init`
+
 <!-- ==================================================================================================== -->
 
 ## Generating reports remotely

src/main/java/reposense/RepoSense.java

@@ -7,6 +7,7 @@
 import java.time.format.DateTimeFormatter;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Scanner;
 import java.util.logging.Level;
 import java.util.logging.LogManager;
 import java.util.logging.Logger;
@@ -23,6 +24,7 @@
 import reposense.model.RepoLocation;
 import reposense.model.ReportConfiguration;
 import reposense.model.ViewCliArguments;
+import reposense.model.WizardCliArguments;
 import reposense.parser.ArgsParser;
 import reposense.parser.AuthorConfigCsvParser;
 import reposense.parser.GroupConfigCsvParser;
@@ -36,6 +38,8 @@
 import reposense.system.ReportServer;
 import reposense.util.FileUtil;
 import reposense.util.TimeUtil;
+import reposense.wizard.BasicWizard;
+import reposense.wizard.WizardRunner;
 
 /**
  * The main RepoSense class.
@@ -68,6 +72,11 @@ public static void main(String[] args) {
                 reportConfig = ((ConfigCliArguments) cliArguments).getReportConfiguration();
             } else if (cliArguments instanceof LocationsCliArguments) {
                 configs = getRepoConfigurations((LocationsCliArguments) cliArguments);
+            } else if (cliArguments instanceof WizardCliArguments) {
+                WizardRunner wizardRunner = new WizardRunner(new BasicWizard());
+                wizardRunner.buildInput(new Scanner(System.in));
+                wizardRunner.run();
+                return;
             } else {
                 throw new AssertionError("CliArguments's subclass type is unhandled.");
             }

src/main/java/reposense/model/WizardCliArguments.java

@@ -0,0 +1,7 @@
+package reposense.model;
+
+/**
+ * Represents command line arguments user supplied when running the program with mandatory field -init.
+ */
+public class WizardCliArguments extends CliArguments {
+}

src/main/java/reposense/parser/ArgsParser.java

@@ -31,6 +31,7 @@
 import reposense.model.LocationsCliArguments;
 import reposense.model.ReportConfiguration;
 import reposense.model.ViewCliArguments;
+import reposense.model.WizardCliArguments;
 import reposense.system.LogsManager;
 import reposense.util.TimeUtil;
 
@@ -65,6 +66,8 @@ public class ArgsParser {
     public static final String[] CLONING_THREADS_FLAG = new String[] {"--cloning-threads"};
     public static final String[] ANALYSIS_THREADS_FLAG = new String[] {"--analysis-threads"};
 
+    public static final String[] CLI_WIZARD_FLAGS = new String[] {"--init"};
+
     public static final String[] TEST_MODE_FLAG = new String[] {"--test-mode"};
     public static final String[] FRESH_CLONING_FLAG = new String[] {"--fresh-cloning"};
 
@@ -239,6 +242,11 @@ private static ArgumentParser getArgumentParser() {
                 .setDefault(DEFAULT_NUM_ANALYSIS_THREADS)
                 .help(FeatureControl.SUPPRESS);
 
+        parser.addArgument(CLI_WIZARD_FLAGS)
+                .dest(CLI_WIZARD_FLAGS[0])
+                .action(Arguments.storeTrue())
+                .help("Launches the RepoSense Command line wizard to walk through the basic setup.");
+
         // Testing flags
         argumentGroup.addArgument(TEST_MODE_FLAG)
                 .dest(TEST_MODE_FLAG[0])
@@ -283,6 +291,11 @@ public static CliArguments parse(String[] args) throws HelpScreenException, Pars
             boolean shouldIncludeLastModifiedDate = results.get(LAST_MODIFIED_DATE_FLAGS[0]);
             boolean shouldPerformShallowCloning = results.get(SHALLOW_CLONING_FLAGS[0]);
             boolean shouldFindPreviousAuthors = results.get(FIND_PREVIOUS_AUTHORS_FLAGS[0]);
+            boolean isWizardCli = results.get(CLI_WIZARD_FLAGS[0]);
+
+            if (isWizardCli) {
+                return new WizardCliArguments();
+            }
 
             // Report config is ignored if --repos is provided
             if (locations == null) {

src/main/java/reposense/wizard/BasicWizard.java

@@ -0,0 +1,22 @@
+package reposense.wizard;
+
+import reposense.wizard.prompt.OptionalSincePrompt;
+import reposense.wizard.prompt.OptionalUntilPrompt;
+import reposense.wizard.prompt.OptionalViewPrompt;
+import reposense.wizard.prompt.Prompt;
+import reposense.wizard.prompt.RepoPrompt;
+
+/**
+ * Represents a basic wizard run.
+ */
+public class BasicWizard extends Wizard {
+    private static final Prompt[] INITIAL_PROMPTS = new Prompt[] {
+            new OptionalSincePrompt(),
+            new OptionalUntilPrompt(),
+            new OptionalViewPrompt(),
+            new RepoPrompt()
+    };
+    public BasicWizard() {
+        super(INITIAL_PROMPTS);
+    }
+}