Initial refactoring

Author: jabrena

.gitignore

@@ -1,32 +1,4 @@
-# Compiled class file
-*.class
-**/target
-**/out
-
-# Build
-/build
+build/
 .gradle/
-
-# Log file
-*.log
-
-# BlueJ files
-*.ctxt
-
-# Mobile Tools for Java (J2ME)
-.mtj.tmp/
-
-# Package Files #
-*.jar
-*.war
-*.nar
-*.ear
-*.zip
-*.tar.gz
-*.rar
-
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
-hs_err_pid*
-
-# IntelliJ
-/.idea
+.cursor/
+.DS_Store

README.md

@@ -90,6 +90,8 @@ If you want to contribute to this project you can create a fork and a pull reque
 
 ```bash
 ./gradlew clean build
+./gradlew clean build snapshot
+java -jar build/libs/context-mapper-cli-0.1.0-SNAPSHOT.jar
 ```
 
 ## Contributing
@@ -100,4 +102,3 @@ Contribution is always welcome! Here are some ways how you can contribute:
 
 ## Licence
 ContextMapper is released under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
-

build.gradle

@@ -17,8 +17,8 @@ repositories {
 }
 
 dependencies {
-    implementation "commons-cli:commons-cli:${commonsCliVersion}"
     implementation "org.contextmapper:context-mapper-dsl:${cmlVersion}"
+    implementation "info.picocli:picocli:${picocliVersion}"
 
     testImplementation "org.junit.jupiter:junit-jupiter-api:${jUnitVersion}"
     testImplementation "org.junit.jupiter:junit-jupiter-params:${jUnitVersion}"
@@ -43,6 +43,12 @@ jar {
                 'Main-Class': 'org.contextmapper.cli.ContextMapperCLI'
         )
     }
+    from {
+        configurations.runtimeClasspath.collect { it.isDirectory() ? it : zipTree(it) }
+    }
+    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+    exclude('META-INF/LICENSE.txt', 'META-INF/NOTICE.txt', 'META-INF/DEPENDENCIES')
+    exclude('META-INF/*.SF', 'META-INF/*.DSA', 'META-INF/*.RSA', 'META-INF/services/**')
 }
 
 if (!project.hasProperty('signing.secretKeyRingFile')) {

context_mapper_cli.feature

@@ -0,0 +1,65 @@
+Feature: Context Mapper CLI Usage
+  As a user of the Context Mapper CLI
+  I want to be able to validate CML files and generate various outputs
+  So that I can effectively use the tool for my Domain-Driven Design modeling.
+
+  Background:
+    Given the Context Mapper CLI is installed
+
+  Scenario: Display help for the validate command
+    When I run the command `./cm validate -h`
+    Then the output should contain:
+      """
+      Context Mapper CLI
+      usage: cm validate
+       -h,--help          Prints this message.
+       -i,--input <arg>   Path to the CML file which you want to validate.
+      """
+
+  Scenario: Validate a CML file
+    Given a CML file named "DDD-Sample.cml" exists
+    When I run the command `./cm validate -i DDD-Sample.cml`
+    Then the CLI should validate "DDD-Sample.cml" successfully
+
+  Scenario: Display help for the generate command
+    When I run the command `./cm generate -h`
+    Then the output should contain:
+      """
+      Context Mapper CLI
+      usage: cm generate
+       -f,--outputFile <arg>   The name of the file that shall be generated
+                               (only used by Freemarker generator, as we cannot
+                               know the file extension).
+       -g,--generator <arg>    The generator you want to call. Use one of the
+                               following values: context-map (Graphical DDD
+                               Context Map), plantuml (PlantUML class-,
+                               component-, and state diagrams.), generic
+                               (Generate generic text with Freemarker template)
+       -h,--help               Prints this message.
+       -i,--input <arg>        Path to the CML file for which you want to
+                               generate output.
+       -o,--outputDir <arg>    Path to the directory into which you want to
+                               generate.
+       -t,--template <arg>     Path to the Freemarker template you want to use.
+                               This parameter is only used if you pass 'generic'
+                               to the 'generator' (-g) parameter.
+      """
+
+  Scenario: Generate PlantUML output
+    Given a CML file named "DDD-Sample.cml" exists
+    And an output directory named "output-directory"
+    When I run the command `./cm generate -i DDD-Sample.cml -g plantuml -o ./output-directory`
+    Then PlantUML diagrams should be generated in "./output-directory" from "DDD-Sample.cml"
+
+  Scenario: Generate Context Map output
+    Given a CML file named "DDD-Sample.cml" exists
+    And an output directory named "output-directory"
+    When I run the command `./cm generate -i DDD-Sample.cml -g context-map -o ./output-directory`
+    Then a Context Map should be generated in "./output-directory" from "DDD-Sample.cml"
+
+  Scenario: Generate arbitrary text file with Freemarker template
+    Given a CML file named "DDD-Sample.cml" exists
+    And an output directory named "output-directory"
+    And a Freemarker template file named "template.md.ftl"
+    When I run the command `./cm generate -i DDD-Sample.cml -g generic -o ./output-directory -t template.md.ftl -f glossary.md`
+    Then a file named "glossary.md" should be generated in "./output-directory" using "template.md.ftl" and "DDD-Sample.cml" 

gradle.properties

@@ -4,9 +4,8 @@ ossReleaseStagingRepository=https://oss.sonatype.org/service/local/staging/deplo
 
 # dependency versions
 jUnitVersion=5.9.1
-assertJVersion=3.19.0
+assertJVersion=3.27.3
 mockitoVersion=3.9.0
 
-commonsCliVersion=1.4
 cmlVersion=6.12.0
-
+picocliVersion=4.7.7

src/main/java/org/contextmapper/cli/ContextMapperCLI.java

@@ -15,61 +15,44 @@
  */
 package org.contextmapper.cli;
 
-import org.contextmapper.cli.commands.CliCommand;
 import org.contextmapper.cli.commands.GenerateCommand;
 import org.contextmapper.cli.commands.ValidateCommand;
+import picocli.CommandLine;
+import picocli.CommandLine.Command;
 
-import java.util.Arrays;
-import java.util.Collections;
-import java.util.List;
-
-public class ContextMapperCLI {
+@Command(name = "cm", mixinStandardHelpOptions = true, versionProvider = VersionProvider.class,
+        description = "Context Mapper CLI",
+        subcommands = {
+                ValidateCommand.class,
+                GenerateCommand.class
+        })
+public class ContextMapperCLI implements Runnable {
 
     private static final int REQUIRED_JAVA_VERSION = 11;
-    private static final String VALIDATE_COMMAND = "validate";
-    private static final String GENERATE_COMMAND = "generate";
-
-    private CliCommand generateCommand;
-    private CliCommand validateCommand;
-
-    public ContextMapperCLI() {
-        this.generateCommand = new GenerateCommand();
-        this.validateCommand = new ValidateCommand();
-    }
 
     public static void main(String[] args) {
-        int javaVersion = Runtime.version().feature();
-
-        if (Runtime.version().feature() >= REQUIRED_JAVA_VERSION) {
-            new ContextMapperCLI().run(args);
-        } else {
-            System.out.printf("Invalid Java version '%s' (>=%s is required).", javaVersion, REQUIRED_JAVA_VERSION);
+        if (Runtime.version().feature() < REQUIRED_JAVA_VERSION) {
+            System.err.printf("Invalid Java version '%s' (>=%s is required).%n", Runtime.version().feature(), REQUIRED_JAVA_VERSION);
             System.exit(1);
         }
+        int exitCode = new CommandLine(new ContextMapperCLI()).execute(args);
+        System.exit(exitCode);
     }
 
-    protected void run(String[] args) {
-        System.out.println("Context Mapper CLI " + getVersion());
-
-        if (args == null || args.length == 0) {
-            printUsages();
-        } else if (VALIDATE_COMMAND.equalsIgnoreCase(args[0])) {
-            validateCommand.run(Arrays.copyOfRange(args, 1, args.length));
-        } else if (GENERATE_COMMAND.equalsIgnoreCase(args[0])) {
-            generateCommand.run(Arrays.copyOfRange(args, 1, args.length));
-        } else {
-            System.out.println("Invalid input");
-            System.exit(127);
-        }
+    @Override
+    public void run() {
+        // This is executed if no subcommand is specified.
+        // Picocli will show the help message by default if mixinStandardHelpOptions = true and no subcommand is given.
+        // We can add a custom message here if needed, or rely on Picocli's default behavior.
+        System.out.println("Context Mapper CLI. Use 'cm --help' for usage information.");
     }
 
-    private void printUsages() {
-        System.out.println("Usage: cm " + VALIDATE_COMMAND + "|" + GENERATE_COMMAND + " [options]");
-    }
+}
 
-    private String getVersion() {
+class VersionProvider implements CommandLine.IVersionProvider {
+    @Override
+    public String[] getVersion() throws Exception {
         String implVersion = ContextMapperCLI.class.getPackage().getImplementationVersion();
-        return implVersion != null ? "v" + implVersion : "DEVELOPMENT VERSION";
+        return new String[]{"Context Mapper CLI " + (implVersion != null ? "v" + implVersion : "DEVELOPMENT VERSION")};
     }
-
 }

src/main/java/org/contextmapper/cli/commands/AbstractCliCommand.java

@@ -5,6 +5,9 @@
 import org.contextmapper.dsl.generator.PlantUMLGenerator;
 import org.eclipse.xtext.generator.IGenerator2;
 
+import java.util.Arrays;
+import java.util.stream.Collectors;
+
 public enum ContextMapperGenerator {
 
     CONTEXT_MAP("context-map", "Graphical DDD Context Map"),
@@ -27,28 +30,36 @@ public String getDescription() {
         return description;
     }
 
+    public String getDisplayName() {
+        return this.name + " (" + this.description + ")";
+    }
+
     @Override
     public String toString() {
-        return this.name + " (" + this.description + ")";
+        // Picocli uses toString() for default value display and for completion candidates if no specific provider is set.
+        // Returning only the name makes it cleaner for command-line usage.
+        return this.name;
     }
 
     public static ContextMapperGenerator byName(String name) {
         if (name == null || "".equals(name))
             throw new IllegalArgumentException("Please provide a name for the generator.");
 
         for (ContextMapperGenerator generator : values()) {
-            if (generator.getName().equals(name))
+            if (generator.getName().equalsIgnoreCase(name)) // Make it case-insensitive for user-friendliness
                 return generator;
         }
 
-        throw new IllegalArgumentException("No generator found for the name '" + name + "'.");
+        throw new IllegalArgumentException("No generator found for the name '" + name + "'. Valid values are: " +
+                Arrays.stream(values()).map(ContextMapperGenerator::getName).collect(Collectors.joining(", ")));
     }
 
     public IGenerator2 getGenerator() {
         if (this == CONTEXT_MAP)
             return new ContextMapGenerator();
         if (this == PLANT_UML)
             return new PlantUMLGenerator();
+        // Assumes GENERIC is the only other case based on current enum values
         return new GenericContentGenerator();
     }