apt: update cli with apt support + some docs

jknack · jknack · commit 97c98a1d52cf · 2019-08-30T23:54:46.000-03:00
diff --git a/docs/asciidoc/mvc-api.adoc b/docs/asciidoc/mvc-api.adoc
@@ -3,7 +3,11 @@
 MVC API is an alternative way to define routes in Jooby. It uses annotations and byte code generation
 to define and execute routes.
 
-The package `io.jooby.annotations` contains the annotations available for MVC routes.
+The package `io.jooby.annotations` contains all the annotations available for MVC routes.
+
+Since 2.1.0, Jooby uses an annotation processing tool to convert MVC routes to script/lambda routes
+at compilation time. The tool reduces application startup time and eliminates the use of dynamic
+class loading.
 
 .MVC API:
 [source,java,role="primary"]
@@ -22,7 +26,7 @@ public class MyController {
 public class App extends Jooby {
 
   {
-    use(new MyController());   // <3>
+    mvc(new MyController());   // <3>
   }
 
   public static void main(String[] args) {
@@ -49,7 +53,7 @@ class MyController {
 
 fun main(args: Array<String>) {
   runApp(args) {
-    use(MyController())        // <3>
+    mvc(MyController())        // <3>
   }
 }
 
@@ -59,6 +63,13 @@ fun main(args: Array<String>) {
 <2> Add a HTTP method
 <3> Register/install the controller in the main application
 
+The next section describes how to configure the annotation processing tool, but keep in mind all these
+can be done using the <<getting-started-cli, jooby console>>.
+
+=== APT
+
+==== Maven
+
 === Parameters
 
 HTTP parameter provision is available via `*Param` annotations.
diff --git a/docs/asciidoc/usage/usage.adoc b/docs/asciidoc/usage/usage.adoc
@@ -0,0 +1,18 @@
+= Help/Usage section
+
+This section describes usage error and how to fix them.
+
+== Annotation Processing Tool
+
+=== MVC route missing
+
+----
+Mvc route not found: `examples.PlainText`. Make sure Jooby annotation processor is configured properly.
+----
+
+The cause of this error is generated when you try to use a MVC route and (usually) the annotation
+processing tool is not configured properly.
+
+*Solution*
+
+Configure the `jooby-apt` as part of your build. 
diff --git a/docs/pom.xml b/docs/pom.xml
@@ -30,6 +30,11 @@
       <artifactId>asm-util</artifactId>
     </dependency>
 
+    <dependency>
+      <groupId>org.unbescape</groupId>
+      <artifactId>unbescape</artifactId>
+    </dependency>
+
     <dependency>
       <groupId>org.asciidoctor</groupId>
       <artifactId>asciidoctorj</artifactId>
diff --git a/docs/src/main/java/io/jooby/adoc/DocGenerator.java b/docs/src/main/java/io/jooby/adoc/DocGenerator.java
@@ -37,6 +37,7 @@
 import java.util.Set;
 import java.util.UUID;
 import java.util.stream.Collectors;
+import java.util.stream.Stream;
 
 public class DocGenerator {
   public static void main(String[] args) throws Exception {
@@ -69,11 +70,13 @@ public static void generate(Path basedir, boolean publish, boolean v1) throws Ex
 
     asciidoctor.convertFile(asciidoc.resolve("index.adoc").toFile(),
         createOptions(asciidoc, outdir, version, null));
-    Path modules = outdir.resolve("modules");
-    Files.createDirectories(modules);
-    Files.walk(asciidoc.resolve("modules")).filter(Files::isRegularFile).forEach(module -> {
-      processModule(asciidoctor, asciidoc, module, outdir, version);
-    });
+    Stream.of("usage", "modules").forEach(SneakyThrows.throwingConsumer(name -> {
+      Path modules = outdir.resolve(name);
+      Files.createDirectories(modules);
+      Files.walk(asciidoc.resolve(name)).filter(Files::isRegularFile).forEach(module -> {
+        processModule(asciidoctor, asciidoc, module, outdir, name, version);
+      });
+    }));
 
     // post process
     Files.walk(outdir).filter(it -> it.getFileName().toString().endsWith("index.html"))
@@ -142,18 +145,24 @@ private static void v1doc(Path basedir, Path output) throws Exception {
   }
 
   private static void processModule(Asciidoctor asciidoctor, Path basedir, Path module, Path outdir,
-      String version) {
+      String name, String version) {
     try {
       String moduleName = module.getFileName().toString().replace(".adoc", "");
 
-      Options options = createOptions(basedir, outdir, version,
-          moduleName.replace("-", " ") + " module");
+      String title = moduleName.replace("-", " ");
+      if (name.equals("modules")) {
+        title += " module";
+      }
+      Options options = createOptions(basedir, outdir, version, title);
 
       asciidoctor.convertFile(module.toFile(), options);
 
       Path output = outdir.resolve(moduleName + ".html").toAbsolutePath();
-      Path indexlike = output.getParent().resolve("modules").resolve(moduleName)
-          .resolve("index.html");
+      Path indexlike = output.getParent().resolve(name);
+      if (name.equals("modules")) {
+        indexlike = indexlike.resolve(moduleName);
+      }
+      indexlike = indexlike.resolve("index.html");
       Files.createDirectories(indexlike.getParent());
       Files.move(output, indexlike);
       String content = new String(Files.readAllBytes(indexlike), StandardCharsets.UTF_8)
diff --git a/jooby/src/main/java/io/jooby/Usage.java b/jooby/src/main/java/io/jooby/Usage.java
@@ -30,7 +30,11 @@ public Usage(@Nonnull String message, @Nonnull String id) {
    * @return Usage exception.
    */
   public static @Nonnull Usage mvcRouteMissing(@Nonnull Class mvcRoute) {
-    return new Usage("Mvc route not found: `" + mvcRoute.getName()
-        + "`. Make sure Jooby annotation processor is configured properly.", "mvc-route-apt");
+    return apt("Mvc route not found: `" + mvcRoute.getName()
+        + "`. Make sure Jooby annotation processor is configured properly.", "mvc-route-missing");
+  }
+
+  private static Usage apt(String message, String id) {
+    return new Usage(message, "annotation-processing-tool-" + id);
   }
 }
diff --git a/modules/jooby-bom/pom.xml b/modules/jooby-bom/pom.xml
@@ -16,7 +16,7 @@
   <!-- THIS FILE IS AUTO GENERATED. DON'T EDIT -->
 
   <properties>
-  <jooby.version>2.0.6</jooby.version>
+  <jooby.version>2.0.7-SNAPSHOT</jooby.version>
   <HikariCP.version>3.3.1</HikariCP.version>
   <apt-maven-plugin.version>1.1.3</apt-maven-plugin.version>
   <archetype-packaging.version>2.2</archetype-packaging.version>
@@ -55,8 +55,8 @@
   <jdbi.version>3.9.1</jdbi.version>
   <jetty.version>9.4.20.v20190813</jetty.version>
   <jfiglet.version>0.0.8</jfiglet.version>
-  <jooby-maven-plugin.version>2.0.6</jooby-maven-plugin.version>
-  <jooby.version>2.0.6</jooby.version>
+  <jooby-maven-plugin.version>2.0.7-SNAPSHOT</jooby-maven-plugin.version>
+  <jooby.version>2.0.7-SNAPSHOT</jooby.version>
   <jsr305.version>3.0.2</jsr305.version>
   <junit.version>5.5.1</junit.version>
   <kotlin.version>1.3.50</kotlin.version>
diff --git a/modules/jooby-cli/src/main/java/io/jooby/cli/CreateCmd.java b/modules/jooby-cli/src/main/java/io/jooby/cli/CreateCmd.java
@@ -171,6 +171,8 @@ public class CreateCmd extends Cmd {
     model.put("maven", !gradle);
     model.put("docker", docker);
     model.put("mvc", mvc);
+    model.put("kapt", mvc && kotlin);
+    model.put("apt", mvc && !kotlin);
     model.put("finalArtifactId", finalArtifactId);
 
     ctx.writeTemplate(templateName, model, projectDir.resolve(buildFileName));
diff --git a/modules/jooby-cli/src/main/resources/cli/build.gradle.hbs b/modules/jooby-cli/src/main/resources/cli/build.gradle.hbs
@@ -11,18 +11,23 @@ buildscript {
   }
 
   dependencies {
+  {{#kapt}}
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"
+  {{/kapt}}
     classpath "com.google.gradle:osdetector-gradle-plugin:1.4.0"
     classpath "io.spring.gradle:dependency-management-plugin:1.0.8.RELEASE"
     {{#if kotlin}}classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion"{{/if}}
     classpath "io.jooby:jooby-gradle-plugin:$joobyVersion"
     classpath "com.github.jengelman.gradle.plugins:shadow:5.1.0"
   }
 }
-
 apply plugin: "io.spring.dependency-management"
 apply plugin: "com.google.osdetector"
 apply plugin: "com.github.johnrengelman.shadow"
 apply plugin: "application"
+{{#kapt}}
+  apply plugin: "org.jetbrains.kotlin.kapt"
+{{/kapt}}
 {{#if kotlin}}apply plugin: "kotlin"{{/if}}
 apply plugin: "jooby"
 
@@ -44,6 +49,11 @@ dependencyManagement {
 }
 
 dependencies {
+{{#if kapt}}
+  kapt "io.jooby:jooby-apt"
+{{else if apt}}
+  annotationProcessor "io.jooby:jooby-apt"
+{{/if}}
 {{#each dependencies}}
   compile "{{this}}"
 {{/each}}
diff --git a/modules/jooby-cli/src/main/resources/cli/pom.xml.hbs b/modules/jooby-cli/src/main/resources/cli/pom.xml.hbs
@@ -64,6 +64,26 @@
           <jvmTarget>${maven.compiler.target}</jvmTarget>
         </configuration>
         <executions>
+        {{#if kapt}}
+          <execution>
+            <id>kapt</id>
+            <goals>
+              <goal>kapt</goal>
+            </goals>
+            <configuration>
+              <sourceDirs>
+                <sourceDir>src/main/kotlin</sourceDir>
+              </sourceDirs>
+              <annotationProcessorPaths>
+                <annotationProcessorPath>
+                  <groupId>io.jooby</groupId>
+                  <artifactId>jooby-apt</artifactId>
+                  <version>${jooby.version}</version>
+                </annotationProcessorPath>
+              </annotationProcessorPaths>
+            </configuration>
+          </execution>
+        {{/if}}
           <execution>
             <id>compile</id>
             <goals>
@@ -82,6 +102,17 @@
       <plugin>
         <artifactId>maven-compiler-plugin</artifactId>
         <version>3.6.2</version>
+      {{#if apt}}
+        <configuration>
+          <annotationProcessorPaths>
+            <path>
+              <groupId>io.jooby</groupId>
+              <artifactId>jooby-apt</artifactId>
+              <version>${jooby.version}</version>
+            </path>
+          </annotationProcessorPaths>
+        </configuration>
+      {{/if}}
       </plugin>
     {{/if}}
       <plugin>
diff --git a/pom.xml b/pom.xml
@@ -310,6 +310,24 @@
         <version>${jooby.version}</version>
       </dependency>
 
+      <dependency>
+        <groupId>io.jooby</groupId>
+        <artifactId>jooby-cli</artifactId>
+        <version>${jooby.version}</version>
+      </dependency>
+
+      <dependency>
+        <groupId>io.jooby</groupId>
+        <artifactId>jooby-apt</artifactId>
+        <version>${jooby.version}</version>
+      </dependency>
+
+      <dependency>
+        <groupId>io.jooby</groupId>
+        <artifactId>jooby-maven-plugin</artifactId>
+        <version>${jooby.version}</version>
+      </dependency>
+
       <dependency>
         <groupId>io.jooby</groupId>
         <artifactId>jooby-gradle-plugin</artifactId>

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,11 @@ public Usage(@Nonnull String message, @Nonnull String id) {`
`30`	`30`	`* @return Usage exception.`
`31`	`31`	`*/`
`32`	`32`	`public static @Nonnull Usage mvcRouteMissing(@Nonnull Class mvcRoute) {`
`33`		- return new Usage("Mvc route not found: `" + mvcRoute.getName()
`34`		- + "`. Make sure Jooby annotation processor is configured properly.", "mvc-route-apt");
	`33`	+ return apt("Mvc route not found: `" + mvcRoute.getName()
	`34`	+ + "`. Make sure Jooby annotation processor is configured properly.", "mvc-route-missing");
	`35`	`+ }`
	`36`	`+`
	`37`	`+ private static Usage apt(String message, String id) {`
	`38`	`+ return new Usage(message, "annotation-processing-tool-" + id);`
`35`	`39`	`}`
`36`	`40`	`}`