feat: add support for <skipHtml> paramenter in <markdownProcessor> co…

…nfiguration #284
bsorrentino · Mar 1, 2023 · 39392f4 · 39392f4
1 parent 332658c
commit 39392f4
Show file tree

Hide file tree

Showing 7 changed files with 61 additions and 14 deletions.
diff --git a/core/src/main/java/org/bsc/confluence/model/SiteProcessor.java b/core/src/main/java/org/bsc/confluence/model/SiteProcessor.java
@@ -291,6 +291,11 @@ public static  String processMarkdown(
             final Optional<String> pagePrefixToApply) throws IOException {
 
         return MarkdownProcessor.shared.processMarkdown(new MarkdownParserContext() {
+            @Override
+            public boolean isSkipHtml() {
+                return MarkdownProcessor.shared.isSkipHtml();
+            }
+
             @Override
             public Optional<Site> getSite() {
                 return Optional.of(site);

diff --git a/core/src/main/java/org/bsc/markdown/MarkdownParserContext.java b/core/src/main/java/org/bsc/markdown/MarkdownParserContext.java
@@ -11,6 +11,13 @@
  */
 public interface MarkdownParserContext {
 
+    /**
+     * skip html tag parsing
+     *
+     * @return true|false
+     */
+    boolean isSkipHtml();
+
     /**
      * The Site Model Object
      *

diff --git a/core/src/main/java/org/bsc/markdown/MarkdownProcessor.java b/core/src/main/java/org/bsc/markdown/MarkdownProcessor.java
@@ -30,18 +30,6 @@ public interface MarkdownProcessor {
      */
     String processMarkdown( MarkdownParserContext context, String content ) throws IOException;
 
-    /**
-     * default method
-     *
-     * @param content
-     * @return
-     * @throws IOException
-     */
-    default String processMarkdown( String content ) throws IOException {
-        return processMarkdown(new MarkdownParserContext() {
-        }, content);
-    }
-
     /**
      * factory method
      *
@@ -63,6 +51,21 @@ class Shared implements MarkdownProcessor {
         private String name = "commonmark";
         private MarkdownProcessor processor;
 
+        private boolean skipHtml = false;
+
+        public boolean isSkipHtml() {
+            return skipHtml;
+        }
+
+        /**
+         * set skip html tag processing
+         *
+         * @return true|false
+         */
+        public void setSkipHtml(boolean skipHtml) {
+            this.skipHtml = skipHtml;
+        }
+
         @Override
         public String getName() {
             return ofNullable(shared.name)
@@ -76,6 +79,15 @@ public String processMarkdown(MarkdownParserContext context, String content) thr
                     .processMarkdown( context, content);
         }
 
+        public String processMarkdown(String content) throws IOException {
+            return ofNullable(processor)
+                .orElseThrow( () -> new IllegalStateException( "processor has not been initialized yet!" ))
+                .processMarkdown( new MarkdownParserContext() {
+                    @Override
+                    public boolean isSkipHtml() { return isSkipHtml(); }
+                }, content);
+        }
+
         public void setName(String value) {
             name = ofNullable(value)
                     .orElseThrow( () -> new IllegalArgumentException( "processor's name cannot be null!" ));
@@ -92,6 +104,8 @@ public MarkdownProcessor init( ) {
             }
             return processor;
         }
+
+
     }
 
     Shared shared = new Shared();

diff --git a/plugin-reporting/src/main/java/org/bsc/mojo/configuration/MarkdownProcessorInfo.java b/plugin-reporting/src/main/java/org/bsc/mojo/configuration/MarkdownProcessorInfo.java
@@ -7,8 +7,19 @@
  */
 public class MarkdownProcessorInfo {
 
-    public String getName() {
+    public boolean isSkipHtml() {
+        return MarkdownProcessor.shared.isSkipHtml();
+    }
 
+    /**
+     * set skip html tags parsing
+     * @param skipHtml
+     */
+    public void setSkipHtml(boolean skipHtml) {
+        MarkdownProcessor.shared.setSkipHtml( skipHtml );
+    }
+
+    public String getName() {
         return MarkdownProcessor.shared.getName();
     }
 

diff --git a/...commonmark/src/main/java/org/bsc/markdown/commonmark/CommonmarkConfluenceWikiVisitor.java b/...commonmark/src/main/java/org/bsc/markdown/commonmark/CommonmarkConfluenceWikiVisitor.java
@@ -323,6 +323,9 @@ public void visit( TableCell node ) {
 
     @Override
     public void visit(HtmlBlock node) {
+        // GUARD
+        if( parseContext.isSkipHtml() ) return;
+
         final String literal = node.getLiteral();
 
         final Matcher m = parseHTMLComment(literal);
@@ -342,6 +345,9 @@ public void visit(HtmlBlock node) {
 
     @Override
     public void visit(HtmlInline node) {
+        // GUARD
+        if( parseContext.isSkipHtml() ) return;
+
         processChildren(node)
                 //.pre("<<HTMI>>").post("<</HTMI>>")
                 .process().nl();

diff --git a/processor-commonmark/src/test/kotlin/org/bsc/makdown/commonmark/ParseHelpers.kt b/processor-commonmark/src/test/kotlin/org/bsc/makdown/commonmark/ParseHelpers.kt
@@ -4,7 +4,6 @@ import org.apache.commons.io.IOUtils
 import org.bsc.confluence.model.Site
 import org.bsc.markdown.MarkdownParserContext
 import org.bsc.markdown.commonmark.CommonmarkConfluenceWikiVisitor
-import org.junit.jupiter.api.Assertions.fail
 import org.junit.jupiter.api.fail
 import java.nio.charset.Charset
 import java.util.*
@@ -15,6 +14,7 @@ fun parseContent(site: Site, content: String, linkPrefixEnabled: Boolean = true)
         val root = CommonmarkConfluenceWikiVisitor.parser().parse(content)
 
         val visitor = CommonmarkConfluenceWikiVisitor(object : MarkdownParserContext {
+                override fun isSkipHtml() = false
 
                 override fun getSite() = Optional.of(site)
 

diff --git a/test-publishing/pom.xml b/test-publishing/pom.xml
@@ -442,6 +442,10 @@
                             <encoding>UTF-8</encoding>
                             <failOnError>true</failOnError>
                             <siteDescriptor>${basedir}/src/site/confluence/issue284/site.yml</siteDescriptor>
+                            <markdownProcessor>
+                                <skipHtml>true</skipHtml>
+                            </markdownProcessor>
+
                         </configuration>
                     </execution>