MVC routes fail to show description in Swagger & RAML docs if class contains @Inject-annotated constructor declared before the route methods. fix jooby-project#1059

jknack · jknack · commit 8be6dfdc10dc · 2018-04-16T15:05:02.000-03:00
diff --git a/modules/jooby-apitool/src/main/antlr4/org/jooby/internal/apitool/javadoc/FuzzyDoc.g4 b/modules/jooby-apitool/src/main/antlr4/org/jooby/internal/apitool/javadoc/FuzzyDoc.g4
@@ -17,9 +17,9 @@ route: doc=DOC 'route' '(' pattern=STRING ')' scripts;
 
 scripts: '{' (scripts | script | .)*? '}';
 
-clazz: doc=DOC annotations+=annotation+ (isClass='class'|.)*? '{' classBody  '}';
+clazz: doc=DOC? annotations+=annotation+ (isClass='class'|.)*? classBody;
 
-classBody: (mvcRoute | .)*?;
+classBody: '{' (classBody | mvcRoute | .)*? '}';
 
 script:
         doc=DOC dot='.'? method=METHOD kotlinScriptBody
diff --git a/modules/jooby-apitool/src/main/java/org/jooby/internal/apitool/DocParser.java b/modules/jooby-apitool/src/main/java/org/jooby/internal/apitool/DocParser.java
@@ -394,17 +394,21 @@ private String summary() {
         boolean isClass = ctx.isClass != null;
         if (isClass) {
           this.prefix.addLast(normalize(pattern));
-          this.summary.addLast(cleanJavadoc(file, ctx.doc.getText()));
+          if (ctx.doc != null) {
+            this.summary.addLast(cleanJavadoc(file, ctx.doc.getText()));
+          }
         } else {
           popPrefix();
           popSummary();
           List<String> methods = methods(ctx.annotations);
-          String comment = ctx.doc.getText();
-          if (methods.size() == 0) {
-            doc.add(doc("get", normalize(pattern), file, summary(), comment));
-          } else {
-            methods.stream()
-                .forEach(it -> doc.add(doc(it, normalize(pattern), file, summary(), comment)));
+          if (ctx.doc != null) {
+            String comment = ctx.doc.getText();
+            if (methods.size() == 0) {
+              doc.add(doc("get", normalize(pattern), file, summary(), comment));
+            } else {
+              methods.stream()
+                  .forEach(it -> doc.add(doc(it, normalize(pattern), file, summary(), comment)));
+            }
           }
         }
       } else {
diff --git a/modules/jooby-apitool/src/test/java/apps/App1059.java b/modules/jooby-apitool/src/test/java/apps/App1059.java
@@ -0,0 +1,10 @@
+package apps;
+
+import org.jooby.Jooby;
+
+public class App1059 extends Jooby {
+
+  {
+    use(Controller1059.class);
+  }
+}
diff --git a/modules/jooby-apitool/src/test/java/apps/Controller1059.java b/modules/jooby-apitool/src/test/java/apps/Controller1059.java
@@ -0,0 +1,36 @@
+package apps;
+
+import org.jooby.mvc.GET;
+import org.jooby.mvc.Path;
+
+import javax.inject.Inject;
+
+/**
+ * Top level comment.
+ */
+@Path("/test")
+public class Controller1059 {
+
+  @Inject
+  public Controller1059() {
+  }
+
+  /**
+   * Say hi.
+   * @return Hi.
+   */
+  @GET
+  public String salute() {
+    return "Hi";
+  }
+
+  /**
+   * Say X.
+   * @return Hi.
+   */
+  @GET
+  @Path("/x")
+  public String salutex() {
+    return "Hi";
+  }
+}
diff --git a/modules/jooby-apitool/src/test/java/org/jooby/apitool/Issue1059.java b/modules/jooby-apitool/src/test/java/org/jooby/apitool/Issue1059.java
@@ -0,0 +1,38 @@
+package org.jooby.apitool;
+
+import apps.App1059;
+import org.junit.Test;
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+public class Issue1059 {
+
+  @Test
+  public void topLevelDescriptionShouldWorkWhenAnnotatedContructorIsPresent() throws Exception {
+    new RouteMethodAssert(new ApiParser(dir()).parseFully(new App1059()))
+        .next(r -> {
+          r.returnType(String.class);
+          r.pattern("/test");
+          r.method("GET");
+          r.description("Say hi.");
+          r.summary("Top level comment.");
+        })
+        .next(r -> {
+          r.returnType(String.class);
+          r.pattern("/test/x");
+          r.method("GET");
+          r.description("Say X.");
+          r.summary("Top level comment.");
+        })
+        .done();
+  }
+
+  private Path dir() {
+    Path userdir = Paths.get(System.getProperty("user.dir"));
+    if (!userdir.toString().endsWith("jooby-apitool")) {
+      userdir = userdir.resolve("modules").resolve("jooby-apitool");
+    }
+    return userdir;
+  }
+}
