From 1abc1a3164fbd939243983cc0a4d41e189577405 Mon Sep 17 00:00:00 2001
From: Johan Maasing <johan@zoom.nu>
Date: Sat, 12 Apr 2025 19:59:44 +0200
Subject: [PATCH] Fix packaging

---
 README.md                                     | 35 ++++++++++++++
 assembly/pom.xml                              | 23 ----------
 endgen-dist/pom.xml                           | 46 +++++++++++++++++++
 endgen-dist/src/assembly/src.xml              | 44 ++++++++++++++++++
 endgen-dist/src/main/resources/run.sh         |  4 ++
 parser/pom.xml                                | 13 ++++++
 .../java/nu/zoom/dsl/cli/EndpointsCLI.java    |  2 +-
 pom.xml                                       |  2 +-
 8 files changed, 144 insertions(+), 25 deletions(-)
 delete mode 100644 assembly/pom.xml
 create mode 100644 endgen-dist/pom.xml
 create mode 100644 endgen-dist/src/assembly/src.xml
 create mode 100755 endgen-dist/src/main/resources/run.sh

diff --git a/README.md b/README.md
index ee46c4d..c647419 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,41 @@ separate files (for endpoint-definitions, circe serializer support etc).
 So I wrote a [DSL](https://en.wikipedia.org/wiki/Domain-specific_language) parsed by an [ANTLR4](https://www.antlr.org) 
 parser and a code generator using [freemarker](https://freemarker.apache.org).
 
+```
+                                 | Endgen |
+                  -------------------------------------------------
+-----------       ||--------|      |-----------|     |------------||
+| endpoint |      || Parser |      | In-Memory |     | Freemarker ||     ---------------
+| file     | -->  ||        | -->  | AST       | --> | engine     || --> | Output file |
+\__________\      ||--------|      |-----------|     |------------||     \_____________\
+                  ------------------------------------------------- -
+                                                           ^
+                                                           |
+                                                    ----------------
+                                                    | Template.ftl |
+                                                    \_______________\
+``` 
+## How to Run
+
+You need a Java 24 runtime and java in the path. A very convenient way to install a java runtime is [SdkMan](https://sdkman.io).
+
+Unpack the archive, run the provided shellscript file.
+
+### Usage
+```
+Usage: EndpointsCLI [-hvV] [-o=<outputDir>] [-t=<templateDir>] <file>
+Generate source code from an endpoints specification file.
+      <file>                 The source endpoints DSL file.
+  -h, --help                 Show this help message and exit.
+  -o, --output=<outputDir>   The directory to write the generated code to.
+                               Default is ~/endpoints-output
+  -t, --template=<templateDir>
+                             The template directory. Default is
+                               ~/endpoints-templates
+  -v, --verbose              Print verbose debug messages.
+  -V, --version              Print version information and exit.
+```
+
 ## DSL example
 
 In the simplest form the DSL looks like this
diff --git a/assembly/pom.xml b/assembly/pom.xml
deleted file mode 100644
index e8c323f..0000000
--- a/assembly/pom.xml
+++ /dev/null
@@ -1,23 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-    <modelVersion>4.0.0</modelVersion>
-
-    <parent>
-        <groupId>nu.zoom.dsl</groupId>
-        <artifactId>endgen</artifactId>
-        <version>1.0-SNAPSHOT</version>
-    </parent>
-
-    <artifactId>assembly</artifactId>
-
-    <dependencies>
-        <dependency>
-            <groupId>nu.zoom.dsl</groupId>
-            <artifactId>parser</artifactId>
-            <version>${project.parent.version}</version>
-        </dependency>
-    </dependencies>
-
-</project>
\ No newline at end of file
diff --git a/endgen-dist/pom.xml b/endgen-dist/pom.xml
new file mode 100644
index 0000000..9d2a59c
--- /dev/null
+++ b/endgen-dist/pom.xml
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>nu.zoom.dsl</groupId>
+        <artifactId>endgen</artifactId>
+        <version>1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>endgen-dist</artifactId>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-assembly-plugin</artifactId>
+                <version>3.6.0</version>
+                <configuration>
+                    <descriptors>
+                        <descriptor>src/assembly/src.xml</descriptor>
+                    </descriptors>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>make-assembly</id> <!-- this is used for inheritance merges -->
+                        <phase>package</phase> <!-- bind to the packaging phase -->
+                        <goals>
+                            <goal>single</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+    <dependencies>
+        <dependency>
+            <groupId>nu.zoom.dsl</groupId>
+            <artifactId>parser</artifactId>
+            <version>${project.parent.version}</version>
+        </dependency>
+    </dependencies>
+
+</project>
\ No newline at end of file
diff --git a/endgen-dist/src/assembly/src.xml b/endgen-dist/src/assembly/src.xml
new file mode 100644
index 0000000..118ca91
--- /dev/null
+++ b/endgen-dist/src/assembly/src.xml
@@ -0,0 +1,44 @@
+<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.2.0"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.2.0 http://maven.apache.org/xsd/assembly-2.2.0.xsd">
+    <id>bin</id>
+    <includeBaseDirectory>false</includeBaseDirectory>
+    <baseDirectory>endgen-${project.version}</baseDirectory>
+    <formats>
+        <format>dir</format>
+        <format>zip</format>
+    </formats>
+    <files>
+        <file>
+            <source>src/main/resources/run.sh</source>
+            <outputDirectory></outputDirectory>
+            <filtered>true</filtered>
+        </file>
+    </files>
+    <dependencySets>
+        <dependencySet>
+            <outputDirectory>libs</outputDirectory>
+            <excludes>
+                <exclude>nu.zoom.dsl:parser:*</exclude>
+            </excludes>
+            <useStrictFiltering>true</useStrictFiltering>
+            <outputFileNameMapping>${artifact.artifactId}-${artifact.baseVersion}.${artifact.extension}</outputFileNameMapping>
+            <useTransitiveDependencies>true</useTransitiveDependencies>
+            <unpack>false</unpack>
+            <scope>runtime</scope>
+            <useProjectArtifact>false</useProjectArtifact>
+        </dependencySet>
+        <dependencySet>
+            <outputDirectory></outputDirectory>
+            <includes>
+                <include>nu.zoom.dsl:parser:*</include>
+            </includes>
+            <useStrictFiltering>true</useStrictFiltering>
+            <outputFileNameMapping>${artifact.artifactId}-${artifact.baseVersion}.${artifact.extension}</outputFileNameMapping>
+            <useTransitiveDependencies>true</useTransitiveDependencies>
+            <unpack>false</unpack>
+            <scope>runtime</scope>
+            <useProjectArtifact>false</useProjectArtifact>
+        </dependencySet>
+    </dependencySets>
+</assembly>
\ No newline at end of file
diff --git a/endgen-dist/src/main/resources/run.sh b/endgen-dist/src/main/resources/run.sh
new file mode 100755
index 0000000..720ffe7
--- /dev/null
+++ b/endgen-dist/src/main/resources/run.sh
@@ -0,0 +1,4 @@
+#! /bin/sh
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+cd "${SCRIPT_DIR}"
+java -jar parser-${artifact.baseVersion}.jar
\ No newline at end of file
diff --git a/parser/pom.xml b/parser/pom.xml
index 1bd7d29..5e312e1 100644
--- a/parser/pom.xml
+++ b/parser/pom.xml
@@ -56,6 +56,19 @@
                     <target>24</target>
                 </configuration>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-jar-plugin</artifactId>
+                <configuration>
+                    <archive>
+                        <manifest>
+                            <classpathPrefix>libs/</classpathPrefix>
+                            <addClasspath>true</addClasspath>
+                            <mainClass>nu.zoom.dsl.cli.EndpointsCLI</mainClass>
+                        </manifest>
+                    </archive>
+                </configuration>
+            </plugin>
             <!-- Plugin to compile the g4 files ahead of the java files
                  See https://github.com/antlr/antlr4/blob/master/antlr4-maven-plugin/src/site/apt/examples/simple.apt.vm
                  Except that the grammar does not need to contain the package declaration as stated in the documentation (I do not know why)
diff --git a/parser/src/main/java/nu/zoom/dsl/cli/EndpointsCLI.java b/parser/src/main/java/nu/zoom/dsl/cli/EndpointsCLI.java
index 1e3cee5..57bf2bc 100644
--- a/parser/src/main/java/nu/zoom/dsl/cli/EndpointsCLI.java
+++ b/parser/src/main/java/nu/zoom/dsl/cli/EndpointsCLI.java
@@ -29,7 +29,7 @@ import java.util.List;
 import java.util.concurrent.Callable;
 
 @Command(
-	name = "EndpointsCLI",
+	name = "run.sh",
 	mixinStandardHelpOptions = true,
 	description = "Generate source code from an endpoints specification file."
 )
diff --git a/pom.xml b/pom.xml
index 85d9e3d..36177d4 100644
--- a/pom.xml
+++ b/pom.xml
@@ -32,7 +32,7 @@
 
     <modules>
         <module>parser</module>
-        <module>assembly</module>
+        <module>endgen-dist</module>
     </modules>
 
 </project>
\ No newline at end of file