Fixed DSL guide generation to handle HTML comments in Javadoc comments.

gradle · Mar 17, 2014 · f6ac6b4 · f6ac6b4
1 parent ec13220
commit f6ac6b4
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 0 deletions.
diff --git a/buildSrc/src/main/groovy/org/gradle/build/docs/dsl/docbook/BasicJavadocLexer.java b/buildSrc/src/main/groovy/org/gradle/build/docs/dsl/docbook/BasicJavadocLexer.java
@@ -34,6 +34,8 @@ class BasicJavadocLexer implements JavadocLexer {
     private static final Pattern TAG = Pattern.compile("(?s)\\{@.+?\\}");
     private static final Pattern END_TAG_NAME = Pattern.compile("(?s)\\s|}");
     private static final Pattern WHITESPACE_WITH_EOL = Pattern.compile("(?s)\\s+");
+    private static final String START_HTML_COMMENT = "<!--";
+    private static final String END_HTML_COMMENT = "-->";
     private static final Map<String, String> ENTITIES = new HashMap<String, String>();
 
     static {
@@ -56,6 +58,10 @@ public void pushText(String rawCommentText) {
 
     public void visit(TokenVisitor visitor) {
         while (!scanner.isEmpty()) {
+            if (scanner.lookingAt(START_HTML_COMMENT)) {
+                skipComment();
+                continue;
+            }
             if (scanner.lookingAt(HTML_ELEMENT)) {
                 parseStartElement(visitor);
                 continue;
@@ -67,6 +73,10 @@ public void visit(TokenVisitor visitor) {
 
             StringBuilder text = new StringBuilder();
             while (!scanner.isEmpty()) {
+                if (scanner.lookingAt(START_HTML_COMMENT)) {
+                    skipComment();
+                    continue;
+                }
                 if (scanner.lookingAt(HTML_ELEMENT)) {
                     break;
                 }
@@ -88,6 +98,16 @@ public void visit(TokenVisitor visitor) {
         visitor.onEnd();
     }
 
+    private void skipComment() {
+        scanner.next(4);
+        while (!scanner.isEmpty() && !scanner.lookingAt(END_HTML_COMMENT)) {
+            scanner.next();
+        }
+        if (!scanner.isEmpty()) {
+            scanner.next(3);
+        }
+    }
+
     private void parseHtmlEntity(StringBuilder buffer) {
         scanner.next();
         scanner.mark();

diff --git a/buildSrc/src/test/groovy/org/gradle/build/docs/dsl/docbook/BasicJavadocLexerTest.groovy b/buildSrc/src/test/groovy/org/gradle/build/docs/dsl/docbook/BasicJavadocLexerTest.groovy
@@ -100,6 +100,32 @@ class BasicJavadocLexerTest extends Specification {
         0 * visitor._
     }
 
+    def discardsHtmlComments() {
+        when:
+        lexer.pushText("<p><!-- ignore me --></p>text <!-- -->2")
+        lexer.visit(visitor)
+
+        then:
+        1 * visitor.onStartHtmlElement('p')
+        1 * visitor.onStartHtmlElementComplete('p')
+        1 * visitor.onEndHtmlElement('p')
+        1 * visitor.onText("text 2")
+        1 * visitor.onEnd()
+        0 * visitor._
+    }
+
+    def handlesMissingEndOfComment() {
+        when:
+        lexer.pushText("<p><!-- ignore me ")
+        lexer.visit(visitor)
+
+        then:
+        1 * visitor.onStartHtmlElement('p')
+        1 * visitor.onStartHtmlElementComplete('p')
+        1 * visitor.onEnd()
+        0 * visitor._
+    }
+
     def parsesJavadocTags() {
         when:
         lexer.pushText("{@tag some value}")

diff --git a/buildSrc/src/test/groovy/org/gradle/build/docs/dsl/docbook/JavadocConverterTest.groovy b/buildSrc/src/test/groovy/org/gradle/build/docs/dsl/docbook/JavadocConverterTest.groovy
@@ -100,6 +100,16 @@ line 2</para>'''
         format(result.docbook) == '''<para>&lt;&gt;&amp; /&gt;</para>'''
     }
 
+    def ignoresHtmlComments() {
+        _ * classMetaData.rawCommentText >> '<!-- <p>ignore me</p> --><p>para 1'
+
+        when:
+        def result = parser.parse(classMetaData, listener)
+
+        then:
+        format(result.docbook) == '''<para>para 1</para>'''
+    }
+
     def convertsPElementsToParaElements() {
         _ * classMetaData.rawCommentText >> '<p>para 1</p><P>para 2</P>'