Generate Maven Archetype

Author: ihostage

.travis.yml

@@ -25,8 +25,10 @@ install:
 script:
   # Test with the defaults
   - sbt new file://$(pwd) --name=hello && pushd hello && sbt test && popd
-    # Test with custom name/organization to ensure templating is done correctly
-  - sbt new file://$(pwd) --name=smello --organization=org.eggsample && cd smello && sbt test
+  # Test with custom name/organization to ensure templating is done correctly
+  - sbt new file://$(pwd) --name=smello --organization=org.eggsample && pushd smello && sbt test && popd
+  # Test Maven Archetype
+  - ./test-archetype.sh
 
 cache:
   directories:

src/main/g8/.sbtopts renamed to src/main/g8/$if(!mavenArchetype.truthy)$.sbtopts$endif$

@@ -0,0 +1,42 @@
+<archetype-descriptor xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                      xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0 http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd"
+                      name="lagom-maven-java">
+
+    <requiredProperties>
+        <requiredProperty key="serviceName">
+            <defaultValue>hello</defaultValue>
+        </requiredProperty>
+        <requiredProperty key="serviceClassName">
+            <defaultValue>Hello</defaultValue>
+        </requiredProperty>
+        <!-- These properties must be valid Velocity identifiers, so cannot contain dots. -->
+        <requiredProperty key="scala-binary-version">
+            <defaultValue>2.12</defaultValue>
+            <validationRegex>\d+\.\d+</validationRegex>
+        </requiredProperty>
+    </requiredProperties>
+
+    <!-- If you read up on the documentation and various blog posts and question/answers out on the internet, you'll
+      see that the archetype descriptor actually has a nifty feature where it can be aware of different modules, and
+      name packages for you, and all sorts of wonderful things. The problem is, we want the names of the modules to be
+      dynamically selected using the above properties (eg, service1Name), but the Maven archetype plugin treats module
+      directories different to all other directories, where other directories can substitute any property they want
+      using __myPropertyName__ syntax, the module directory is hard coded to only substitute __rootArtifactId__.  This
+      issue has been raised here: https://issues.apache.org/jira/browse/ARCHETYPE-455, a patch has existed for 3 years,
+      but no response or review from the maintainers.  So, consequently, we can't use modules in the archetype
+      descriptor. -->
+
+    <fileSets>
+        <fileSet filtered="true" encoding="UTF-8">
+            <directory></directory>
+            <includes>
+                <include>**/*</include>
+            </includes>
+            <excludes>
+                <exclude>pom.xml</exclude>
+                <exclude>LICENSE</exclude>
+            </excludes>
+        </fileSet>
+    </fileSets>
+
+</archetype-descriptor>

src/main/g8/README.md renamed to src/main/g8/$if(!mavenArchetype.truthy)$README.md$endif$

@@ -1,4 +1,4 @@
-package $package$.api;
+package $if(mavenArchetype.truthy)$\${package}.\${serviceName}$else$$package$$endif$.api;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonSubTypes;
@@ -8,13 +8,13 @@
 
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, property = "type")
 @JsonSubTypes({
-        @JsonSubTypes.Type(value = $name;format="Camel"$Event.GreetingMessageChanged.class, name = "greeting-message-changed")
+        @JsonSubTypes.Type(value = $if(mavenArchetype.truthy)$\${serviceClassName}$else$$name;format="Camel"$$endif$Event.GreetingMessageChanged.class, name = "greeting-message-changed")
 })
-public interface $name;format="Camel"$Event {
+public interface $if(mavenArchetype.truthy)$\${serviceClassName}$else$$name;format="Camel"$$endif$Event {
     String getName();
 
     @Value
-    final class GreetingMessageChanged implements $name;format="Camel"$Event {
+    final class GreetingMessageChanged implements $if(mavenArchetype.truthy)$\${serviceClassName}$else$$name;format="Camel"$$endif$Event {
         public final String name;
         public final String message;
 

src/main/g8/build.sbt renamed to src/main/g8/$if(!mavenArchetype.truthy)$build.sbt$endif$

@@ -1,4 +1,4 @@
-package $package$.api;
+package $if(mavenArchetype.truthy)$\${package}.\${serviceName}$else$$package$$endif$.api;
 
 import akka.Done;
 import akka.NotUsed;
@@ -11,12 +11,12 @@
 import static com.lightbend.lagom.javadsl.api.Service.*;
 
 /**
- * The $name;format="camel"$ service interface.
+ * The $if(mavenArchetype.truthy)$\${serviceClassName}$else$$name;format="Camel"$$endif$ service interface.
  * <p>
  * This describes everything that Lagom needs to know about how to serve and
- * consume the $name;format="Camel"$Service.
+ * consume the $if(mavenArchetype.truthy)$\${serviceClassName}$else$$name;format="Camel"$$endif$Service.
  */
-public interface $name;format="Camel"$Service extends Service {
+public interface $if(mavenArchetype.truthy)$\${serviceClassName}$else$$name;format="Camel"$$endif$Service extends Service {
     /**
      * Example:
      * curl http://localhost:9000/api/hello/Alice
@@ -32,11 +32,11 @@ public interface $name;format="Camel"$Service extends Service {
     /**
      * This gets published to Kafka.
      */
-    Topic<$name;format="Camel"$Event> helloEvents();
+    Topic<$if(mavenArchetype.truthy)$\${serviceClassName}$else$$name;format="Camel"$$endif$Event> helloEvents();
 
     @Override
     default Descriptor descriptor() {
-        return named("$name;format="camel"$")
+        return named("$if(mavenArchetype.truthy)$\${serviceClassName}$else$$name;format="Camel"$$endif$")
                 .withCalls(
                         pathCall("/api/hello/:id", this::hello),
                         pathCall("/api/hello/:id", this::useGreeting)
@@ -48,7 +48,7 @@ default Descriptor descriptor() {
                                 // go to the same partition (and hence are delivered in order with respect
                                 // to that user), we configure a partition key strategy that extracts the
                                 // name as the partition key.
-                                .withProperty(KafkaProperties.partitionKeyStrategy(), $name;format="Camel"$Event::getName)
+                                .withProperty(KafkaProperties.partitionKeyStrategy(), $if(mavenArchetype.truthy)$\${serviceClassName}$else$$name;format="Camel"$$endif$Event::getName)
                 )
                 .withAutoAcl(true);
     }

src/main/g8/project/build.properties renamed to src/main/g8/$if(!mavenArchetype.truthy)$project$endif$/$if(!mavenArchetype.truthy)$build.properties$endif$

@@ -1,4 +1,4 @@
-package $package$.api;
+package $if(mavenArchetype.truthy)$\${package}.\${serviceName}$else$$package$$endif$.api;
 
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.databind.annotation.JsonDeserialize;