Add compatibility with maven-site-plugin v3.20.0 (asciidoctor#934)

* Bump Doxia and Doxia-sitetools to the same versions as maven-site-plugin (v2.0.x-MX) * Apply required code changes to code and test * Update site.xml in ITs to new novel (https://maven.apache.org/xsd/site-2.0.0.xsd) Fixes asciidoctor#933
abelsromero · Oct 12, 2024 · 9a528ac · 9a528ac
1 parent 25cc1e5
commit 9a528ac
Show file tree

Hide file tree

Showing 21 changed files with 137 additions and 125 deletions.
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -16,10 +16,12 @@ For a detailed view of what has changed, refer to the {uri-repo}/commits/main[co
 Bug Fixes::
 
   * Fix open IMG tags in parser-doxia-module (#930)
+  * Fix naming in Asciidoctor Converter Doxia Module pom (#934)
 
 Improvements::
 
   * Added support for AsciidoctorJ v3.0.0 (#651)
+  * Add compatibility with maven-site-plugin v3.20.0 and Doxia v2.0.0 (#933)
 
 Build / Infrastructure::
 

diff --git a/asciidoctor-converter-doxia-module/pom.xml b/asciidoctor-converter-doxia-module/pom.xml
@@ -12,8 +12,8 @@
     <artifactId>asciidoctor-converter-doxia-module</artifactId>
     <packaging>jar</packaging>
 
-    <name>Asciidoctor Converter Doxia Parser</name>
-    <description>Asciidoctor Doxia Parser based on Asciidoctor Html converter (for Maven Site integration)</description>
+    <name>Asciidoctor Converter Doxia Module</name>
+    <description>Asciidoctor Doxia Module based on Asciidoctor Html converter (for Maven Site integration)</description>
     <url>https://github.com/asciidoctor/asciidoctor-maven-plugin</url>
 
     <dependencies>
@@ -46,7 +46,7 @@
         <dependency>
             <groupId>org.apache.maven.doxia</groupId>
             <artifactId>doxia-site-renderer</artifactId>
-            <version>1.11.1</version>
+            <version>${doxia.sitetools.version}</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

diff --git a/asciidoctor-converter-doxia-module/src/it/maven-site-plugin/pom.xml b/asciidoctor-converter-doxia-module/src/it/maven-site-plugin/pom.xml
@@ -28,8 +28,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-site-plugin</artifactId>
-                <!-- v2.2.2 of the plugin require Maven Site Plugin 3.1x.0 alongside Doxia 1.11.1 -->
-                <version>3.12.1</version>
+                <version>3.20.0</version>
                 <configuration>
                     <asciidoc>
                         <baseDir>${project.basedir}/src/site/asciidoc</baseDir>
@@ -52,6 +51,7 @@
                             <toclevels>2</toclevels>
                         </attributes>
                     </asciidoc>
+                    <relativizeSiteLinks>false</relativizeSiteLinks>
                     <moduleExcludes>
                         <asciidoc>**/_*.adoc,**/_*/</asciidoc>
                     </moduleExcludes>

diff --git a/asciidoctor-converter-doxia-module/src/it/maven-site-plugin/src/site/site.xml b/asciidoctor-converter-doxia-module/src/it/maven-site-plugin/src/site/site.xml
@@ -1,4 +1,6 @@
-<project name="Maven Site Plugin IT">
+<site xmlns="http://maven.apache.org/SITE/2.0.0"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd">
     <body>
         <breadcrumbs>
             <item name="Doxia" href="https://maven.apache.org/doxia/index.html"/>
@@ -14,6 +16,6 @@
     <skin>
         <groupId>org.apache.maven.skins</groupId>
         <artifactId>maven-fluido-skin</artifactId>
-        <version>1.12.0</version>
+        <version>2.0.0-M9</version>
     </skin>
-</project>
+</site>
diff --git a/...oxia-module/src/main/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParser.java b/...oxia-module/src/main/java/org/asciidoctor/maven/site/AsciidoctorConverterDoxiaParser.java
@@ -5,7 +5,6 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.Reader;
-import java.util.logging.Logger;
 
 import org.apache.maven.doxia.parser.AbstractTextParser;
 import org.apache.maven.doxia.parser.ParseException;
@@ -26,6 +25,8 @@
 import org.codehaus.plexus.component.annotations.Component;
 import org.codehaus.plexus.util.IOUtil;
 import org.codehaus.plexus.util.xml.Xpp3Dom;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * This class is used by <a href="https://maven.apache.org/doxia/overview.html">the Doxia framework</a>
@@ -39,6 +40,8 @@
 @Component(role = Parser.class, hint = AsciidoctorConverterDoxiaParser.ROLE_HINT)
 public class AsciidoctorConverterDoxiaParser extends AbstractTextParser {
 
+    private final Logger logger = LoggerFactory.getLogger(AsciidoctorConverterDoxiaParser.class);
+
     @Inject
     protected Provider<MavenProject> mavenProjectProvider;
 
@@ -58,7 +61,7 @@ public void parse(Reader reader, Sink sink, String reference) throws ParseExcept
                 source = "";
             }
         } catch (IOException ex) {
-            getLog().error("Could not read AsciiDoc source: " + ex.getLocalizedMessage());
+            logger.error("Could not read AsciiDoc source: {}", ex.getLocalizedMessage());
             return;
         }
 
@@ -86,7 +89,7 @@ public void parse(Reader reader, Sink sink, String reference) throws ParseExcept
 
         try {
             // process log messages according to mojo configuration
-            new LogRecordsProcessors(logHandler, siteDirectory, errorMessage -> getLog().error(errorMessage))
+            new LogRecordsProcessors(logHandler, siteDirectory, errorMessage -> logger.error(errorMessage))
                 .processLogRecords(memoryLogHandler);
         } catch (Exception exception) {
             throw new ParseException(exception.getMessage(), exception);
@@ -102,10 +105,10 @@ public void parse(Reader reader, Sink sink, String reference) throws ParseExcept
     private MemoryLogHandler asciidoctorLoggingSetup(Asciidoctor asciidoctor, LogHandler logHandler, File siteDirectory) {
 
         final MemoryLogHandler memoryLogHandler = new MemoryLogHandler(logHandler.getOutputToConsole(),
-            logRecord -> getLog().info(LogRecordFormatter.format(logRecord, siteDirectory)));
+            logRecord -> logger.info(LogRecordFormatter.format(logRecord, siteDirectory)));
         asciidoctor.registerLogHandler(memoryLogHandler);
         // disable default console output of AsciidoctorJ
-        Logger.getLogger("asciidoctor").setUseParentHandlers(false);
+        java.util.logging.Logger.getLogger("asciidoctor").setUseParentHandlers(false);
         return memoryLogHandler;
     }
 
@@ -147,7 +150,7 @@ private void requireLibrary(Asciidoctor asciidoctor, String require) {
             try {
                 asciidoctor.requireLibrary(require);
             } catch (Exception ex) {
-                getLog().error(ex.getLocalizedMessage());
+                logger.error(ex.getLocalizedMessage());
             }
         }
     }

diff --git a/asciidoctor-parser-doxia-module/pom.xml b/asciidoctor-parser-doxia-module/pom.xml
@@ -46,7 +46,7 @@
         <dependency>
             <groupId>org.apache.maven.doxia</groupId>
             <artifactId>doxia-site-renderer</artifactId>
-            <version>1.11.1</version>
+            <version>${doxia.sitetools.version}</version>
             <scope>test</scope>
         </dependency>
     </dependencies>

diff --git a/asciidoctor-parser-doxia-module/src/it/maven-site-plugin/pom.xml b/asciidoctor-parser-doxia-module/src/it/maven-site-plugin/pom.xml
@@ -23,14 +23,15 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-site-plugin</artifactId>
-                <version>3.12.1</version>
+                <version>3.20.0</version>
                 <configuration>
                     <asciidoc>
                         <baseDir>${project.basedir}/src/site/asciidoc</baseDir>
                         <attributes>
                             <toclevels>2</toclevels>
                         </attributes>
                     </asciidoc>
+                    <relativizeSiteLinks>false</relativizeSiteLinks>
                     <moduleExcludes>
                         <asciidoc>**/_*.adoc,**/_*/</asciidoc>
                     </moduleExcludes>

diff --git a/asciidoctor-parser-doxia-module/src/it/maven-site-plugin/src/site/site.xml b/asciidoctor-parser-doxia-module/src/it/maven-site-plugin/src/site/site.xml
@@ -1,4 +1,6 @@
-<project name="Maven Site Plugin IT">
+<site xmlns="http://maven.apache.org/SITE/2.0.0"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:schemaLocation="http://maven.apache.org/SITE/2.0.0 https://maven.apache.org/xsd/site-2.0.0.xsd">
     <body>
         <breadcrumbs>
             <item name="Doxia" href="https://maven.apache.org/doxia/index.html"/>
@@ -7,11 +9,11 @@
         <menu name="AsciiDoc Pages">
             <item name="Sample" href="sample.html"/>
         </menu>
-        ${reports}
+        <menu ref="reports"/>
     </body>
     <skin>
         <groupId>org.apache.maven.skins</groupId>
         <artifactId>maven-fluido-skin</artifactId>
-        <version>1.12.0</version>
+        <version>2.0.0-M9</version>
     </skin>
-</project>
+</site>
diff --git a/asciidoctor-parser-doxia-module/src/it/maven-site-plugin/validate.groovy b/asciidoctor-parser-doxia-module/src/it/maven-site-plugin/validate.groovy
@@ -136,7 +136,7 @@ class HtmlAsserter {
     }
 
     void containsBreadcrumbs(String value) {
-        def found = find("<li class=\"active \">${value}</li>")
+        def found = find("<li class=\"active\">${value}</li>")
         assertFound("Breadcrumb", value, found)
     }
 
@@ -153,13 +153,13 @@ class HtmlAsserter {
     void containsSectionTitle(String value, int level) {
         def found = -1
 
-        def id = value.replaceAll(" ", "_")
+        def id = value.toLowerCase().replaceAll(" ", "_")
         if (level == 2) {
-            found = find("<h2><a name=\"$id\"></a>$value</h2>")
+            found = find("<h2><a id=\"$id\"></a>$value</h2>")
         } else if (level == 3) {
-            found = find("<h3><a name=\"$id\"></a>$value</h3>")
+            found = find("<h3><a id=\"$id\"></a>$value</h3>")
         } else if (level == 4) {
-            found = find("<h4><a name=\"$id\"></a>$value</h4>")
+            found = find("<h4><a id=\"$id\"></a>$value</h4>")
         }
         assertFound("Section Title (level:$level)", value, found)
     }
@@ -185,7 +185,7 @@ class HtmlAsserter {
     }
 
     void containsOrderedList(String... values) {
-        def found = find("<ol style=\"list-style-type: decimal\"><li>${values.join('</li><li>')}</li></ol>")
+        def found = find("<ol style=\"list-style-type: decimal;\"><li>${values.join('</li><li>')}</li></ol>")
         assertFound("Ordered list", values.join(','), found)
     }
 

diff --git a/...xia-module/src/main/java/org/asciidoctor/maven/site/parser/AsciidoctorAstDoxiaParser.java b/...xia-module/src/main/java/org/asciidoctor/maven/site/parser/AsciidoctorAstDoxiaParser.java
@@ -23,14 +23,15 @@
 import org.asciidoctor.maven.log.LogRecordFormatter;
 import org.asciidoctor.maven.log.LogRecordsProcessors;
 import org.asciidoctor.maven.log.MemoryLogHandler;
-import org.asciidoctor.maven.site.HeaderMetadata;
 import org.asciidoctor.maven.site.HeadParser;
+import org.asciidoctor.maven.site.HeaderMetadata;
 import org.asciidoctor.maven.site.SiteConversionConfiguration;
 import org.asciidoctor.maven.site.SiteConversionConfigurationParser;
 import org.asciidoctor.maven.site.SiteLogHandlerDeserializer;
 import org.codehaus.plexus.component.annotations.Component;
 import org.codehaus.plexus.util.IOUtil;
 import org.codehaus.plexus.util.xml.Xpp3Dom;
+import org.slf4j.LoggerFactory;
 
 import static org.asciidoctor.maven.commons.StringUtils.isNotBlank;
 
@@ -45,6 +46,8 @@
 @Component(role = Parser.class, hint = AsciidoctorAstDoxiaParser.ROLE_HINT)
 public class AsciidoctorAstDoxiaParser extends AbstractTextParser {
 
+    private final org.slf4j.Logger logger = LoggerFactory.getLogger(AsciidoctorAstDoxiaParser.class);
+
     @Inject
     protected Provider<MavenProject> mavenProjectProvider;
 
@@ -64,7 +67,7 @@ public void parse(Reader reader, Sink sink, String reference) throws ParseExcept
                 source = "";
             }
         } catch (IOException ex) {
-            getLog().error("Could not read AsciiDoc source: " + ex.getLocalizedMessage());
+            logger.error("Could not read AsciiDoc source: {}", ex.getLocalizedMessage());
             return;
         }
 
@@ -88,13 +91,13 @@ public void parse(Reader reader, Sink sink, String reference) throws ParseExcept
         final MemoryLogHandler memoryLogHandler = asciidoctorLoggingSetup(asciidoctor, logHandler, siteDirectory);
 
         if (isNotBlank(reference))
-            getLog().debug("Document loaded: " + reference);
+            logger.debug("Document loaded: {}", reference);
 
         Document document = asciidoctor.load(source, conversionConfig.getOptions());
 
         try {
             // process log messages according to mojo configuration
-            new LogRecordsProcessors(logHandler, siteDirectory, errorMessage -> getLog().error(errorMessage))
+            new LogRecordsProcessors(logHandler, siteDirectory, errorMessage -> logger.error(errorMessage))
                     .processLogRecords(memoryLogHandler);
 
         } catch (Exception exception) {
@@ -116,7 +119,7 @@ public void parse(Reader reader, Sink sink, String reference) throws ParseExcept
     private MemoryLogHandler asciidoctorLoggingSetup(Asciidoctor asciidoctor, LogHandler logHandler, File siteDirectory) {
 
         final MemoryLogHandler memoryLogHandler = new MemoryLogHandler(logHandler.getOutputToConsole(),
-                logRecord -> getLog().info(LogRecordFormatter.format(logRecord, siteDirectory)));
+            logRecord -> logger.info(LogRecordFormatter.format(logRecord, siteDirectory)));
         asciidoctor.registerLogHandler(memoryLogHandler);
         // disable default console output of AsciidoctorJ
         Logger.getLogger("asciidoctor").setUseParentHandlers(false);
@@ -161,7 +164,7 @@ private void requireLibrary(Asciidoctor asciidoctor, String require) {
             try {
                 asciidoctor.requireLibrary(require);
             } catch (Exception ex) {
-                getLog().error(ex.getLocalizedMessage());
+                logger.error(ex.getLocalizedMessage());
             }
         }
     }

diff --git a/...module/src/main/java/org/asciidoctor/maven/site/parser/processors/ImageNodeProcessor.java b/...module/src/main/java/org/asciidoctor/maven/site/parser/processors/ImageNodeProcessor.java
@@ -40,7 +40,9 @@ public void process(StructuralNode node) {
         final String imagesdir = (String) node.getAttribute("imagesdir");
         String imagePath = isBlank(imagesdir) ? target : formatPath(imagesdir, target);
         final SinkEventAttributeSet attributes = new SinkEventAttributeSet();
-        attributes.addAttribute(Attribute.ALT, alt);
+        if (!isBlank(alt))
+            attributes.addAttribute(Attribute.ALT, alt);
+
         getSink().figureGraphics(imagePath, attributes);
     }
 

diff --git a/...dule/src/main/java/org/asciidoctor/maven/site/parser/processors/SectionNodeProcessor.java b/...dule/src/main/java/org/asciidoctor/maven/site/parser/processors/SectionNodeProcessor.java
@@ -5,6 +5,8 @@
 import org.asciidoctor.ast.StructuralNode;
 import org.asciidoctor.jruby.ast.impl.SectionImpl;
 import org.asciidoctor.maven.site.parser.NodeProcessor;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * Section title processor.
@@ -15,6 +17,8 @@
  */
 public class SectionNodeProcessor extends AbstractSinkNodeProcessor implements NodeProcessor {
 
+    private final Logger logger = LoggerFactory.getLogger(SectionNodeProcessor.class);
+
     /**
      * Constructor.
      *
@@ -36,45 +40,32 @@ public void process(StructuralNode node) {
 
     private void sectionTitle(Sink sink, int level, String title, Section node) {
         final String formattedTitle = formatTitle(title, node);
-        switch (level) {
-            case 0:
-                // Kept for completeness, real document title is treated in
-                // DocumentNodeProcessor
-                sink.rawText("<h1>" + formattedTitle + "</h1>");
-                break;
-            case 1:
-                sink.sectionTitle1();
-                sink.text(formattedTitle);
-                sink.sectionTitle1_();
-                break;
-            case 2:
-                sink.sectionTitle2();
-                sink.text(formattedTitle);
-                sink.sectionTitle2_();
-                break;
-            case 3:
-                sink.sectionTitle3();
-                sink.text(formattedTitle);
-                sink.sectionTitle3_();
-                break;
-            case 4:
-                sink.sectionTitle4();
-                sink.text(formattedTitle);
-                sink.sectionTitle4_();
-                break;
-            case 5:
-                sink.sectionTitle5();
-                sink.text(formattedTitle);
-                sink.sectionTitle5_();
-                break;
-            case 6:
-                sink.sectionTitle6();
-                sink.text(formattedTitle);
-                sink.sectionTitle6_();
-                break;
+        if (level == 0) {
+            // Kept for completeness, real document title is treated in
+            // DocumentNodeProcessor
+            sink.sectionTitle1();
+            sink.text(formattedTitle);
+            sink.sectionTitle1_();
+        } else {
+            // Asciidoctor supports up o 6 levels, but Xhtml5BaseSink only up to 5
+            int siteLevel = level + 1;
+            if (level >= 5) {
+                // TODO generate code manually or request change
+                logger.warn("Site module does not support level 6 sections. Re-writing as 5");
+                siteLevel = 5;
+            }
+            sink.sectionTitle(siteLevel, null);
+            anchor(sink, node);
+            sink.text(formattedTitle);
+            sink.sectionTitle_(siteLevel);
         }
     }
 
+    private void anchor(Sink sink, Section node) {
+        sink.anchor(node.getId());
+        sink.anchor_();
+    }
+
     private String formatTitle(String title, Section node) {
         final Boolean numbered = node.isNumbered();
         final Long sectnumlevels = getSectnumlevels(node);