Introduce AsciidoctorJ

Co-authored-by: jtama<[email protected]>
quarkiverse · Dec 19, 2024 · 4e68aa3 · 4e68aa3
1 parent 711c7b1
commit 4e68aa3
Show file tree

Hide file tree

Showing 40 changed files with 969 additions and 58 deletions.
diff --git a/.gitignore b/.gitignore
@@ -62,3 +62,7 @@ pom.xml.tag
 pom.xml.releaseBackup
 pom.xml.versionsBackup
 release.properties
+
+
+# Asciidoctor
+.asciidoctor
diff --git a/asciidoc/asciidoc-light/deployment/pom.xml b/asciidoc/asciidoc-light/deployment/pom.xml
@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>io.quarkiverse.qute.web</groupId>
+        <artifactId>quarkus-qute-web-asciidoc-light-parent</artifactId>
+        <version>999-SNAPSHOT</version>
+    </parent>
+    <artifactId>quarkus-qute-web-asciidoc-light-deployment</artifactId>
+    <name>Quarkus Qute Web - Asciidoc - Light - Deployment</name>
+
+    <dependencies>
+        <dependency>
+            <groupId>io.quarkiverse.qute.web</groupId>
+            <artifactId>quarkus-qute-web-asciidoc-light</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-junit5-internal</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-qute-deployment</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>${assertj.version}</version>
+            <scope>test</scope>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <annotationProcessorPaths>
+                        <path>
+                            <groupId>io.quarkus</groupId>
+                            <artifactId>quarkus-extension-processor</artifactId>
+                            <version>${quarkus.version}</version>
+                        </path>
+                    </annotationProcessorPaths>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/.../deployment/QuteWebAsciidocProcessor.java → .../deployment/QuteWebAsciidocProcessor.java b/.../deployment/QuteWebAsciidocProcessor.java → .../deployment/QuteWebAsciidocProcessor.java
@@ -1,9 +1,9 @@
-package io.quarkiverse.qute.web.asciidoc.deployment;
+package io.quarkiverse.qute.web.asciidoclight.deployment;
 
 import java.util.ArrayList;
 import java.util.List;
 
-import io.quarkiverse.qute.web.asciidoc.runtime.AsciidocSectionHelperFactory;
+import io.quarkiverse.qute.web.asciidoclight.runtime.AsciidocLightSectionHelperFactory;
 import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
 import io.quarkus.deployment.annotations.BuildProducer;
 import io.quarkus.deployment.annotations.BuildStep;
@@ -13,7 +13,7 @@
 
 class QuteWebAsciidocProcessor {
 
-    private static final String FEATURE = "qute-web-asciidoc";
+    private static final String FEATURE = "qute-web-asciidoc-light";
 
     @BuildStep
     FeatureBuildItem feature() {
@@ -22,7 +22,7 @@ FeatureBuildItem feature() {
 
     @BuildStep
     void process(BuildProducer<AdditionalBeanBuildItem> additionalBeans) {
-        additionalBeans.produce(new AdditionalBeanBuildItem(AsciidocSectionHelperFactory.class));
+        additionalBeans.produce(new AdditionalBeanBuildItem(AsciidocLightSectionHelperFactory.class));
     }
 
     @BuildStep

diff --git a/...eb/asciidoc/test/QuarkusAsciidocTest.java → ...clight/test/QuarkusAsciidocLightTest.java b/...eb/asciidoc/test/QuarkusAsciidocTest.java → ...clight/test/QuarkusAsciidocLightTest.java
@@ -1,4 +1,4 @@
-package io.quarkiverse.qute.web.asciidoc.test;
+package io.quarkiverse.qute.web.asciidoclight.test;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
@@ -7,15 +7,15 @@
 import org.assertj.core.api.SoftAssertions;
 import org.junit.jupiter.api.Test;
 
-import io.quarkiverse.qute.web.asciidoc.runtime.AsciidocSectionHelperFactory;
+import io.quarkiverse.qute.web.asciidoclight.runtime.AsciidocLightSectionHelperFactory;
 import io.quarkus.qute.Engine;
 
-public class QuarkusAsciidocTest {
+public class QuarkusAsciidocLightTest {
 
     @Test
     public void shouldConvertUsingAsciiTag() {
         Engine engine = Engine.builder().addDefaults()
-                .addSectionHelper(new AsciidocSectionHelperFactory()).build();
+                .addSectionHelper(new AsciidocLightSectionHelperFactory()).build();
 
         String result = engine.parse("{#ascii}...{/ascii}").render();
 
@@ -29,7 +29,7 @@ public void shouldConvertUsingAsciiTag() {
     @Test
     public void shouldConvertUsingAsciidocTag() {
         Engine engine = Engine.builder().addDefaults()
-                .addSectionHelper(new AsciidocSectionHelperFactory()).build();
+                .addSectionHelper(new AsciidocLightSectionHelperFactory()).build();
 
         String result = engine.parse("{#asciidoc}...{/asciidoc}").render();
 
@@ -43,7 +43,7 @@ public void shouldConvertUsingAsciidocTag() {
     @Test
     public void testH1() {
         Engine engine = Engine.builder().addDefaults()
-                .addSectionHelper(new AsciidocSectionHelperFactory()).build();
+                .addSectionHelper(new AsciidocLightSectionHelperFactory()).build();
 
         String result = engine.parse("{#ascii}= Quarkus and Roq{/ascii}").render();
 
@@ -54,7 +54,7 @@ public void testH1() {
     void shouldConvertWithForTagInsideAsciiTag() {
 
         Engine engine = Engine.builder().addDefaults()
-                .addSectionHelper(new AsciidocSectionHelperFactory()).build();
+                .addSectionHelper(new AsciidocLightSectionHelperFactory()).build();
 
         String result = engine.parse("""
                 <h1>Quarkus and Qute</h1>

diff --git a/...c/test/QuteAsciidocSectionHelperTest.java → ...t/test/QuteAsciidocSectionHelperTest.java b/...c/test/QuteAsciidocSectionHelperTest.java → ...t/test/QuteAsciidocSectionHelperTest.java
@@ -1,4 +1,4 @@
-package io.quarkiverse.qute.web.asciidoc.test;
+package io.quarkiverse.qute.web.asciidoclight.test;
 
 import static org.assertj.core.api.Assertions.assertThat;
 

diff --git a/...eAsciidocSectionWithInnerSectionTest.java → ...eAsciidocSectionWithInnerSectionTest.java b/...eAsciidocSectionWithInnerSectionTest.java → ...eAsciidocSectionWithInnerSectionTest.java
@@ -1,4 +1,4 @@
-package io.quarkiverse.qute.web.asciidoc.test;
+package io.quarkiverse.qute.web.asciidoclight.test;
 
 import static org.assertj.core.api.AssertionsForClassTypes.assertThat;
 

diff --git a/...c/test/QuteWebAsciidocExtensionsTest.java → ...t/test/QuteWebAsciidocExtensionsTest.java b/...c/test/QuteWebAsciidocExtensionsTest.java → ...t/test/QuteWebAsciidocExtensionsTest.java
@@ -1,4 +1,4 @@
-package io.quarkiverse.qute.web.asciidoc.test;
+package io.quarkiverse.qute.web.asciidoclight.test;
 
 import jakarta.inject.Inject;
 

diff --git a/asciidoc/integration-tests/pom.xml → .../asciidoc-light/integration-tests/pom.xml b/asciidoc/integration-tests/pom.xml → .../asciidoc-light/integration-tests/pom.xml
@@ -3,11 +3,11 @@
   <modelVersion>4.0.0</modelVersion>
   <parent>
     <groupId>io.quarkiverse.qute.web</groupId>
-    <artifactId>quarkus-qute-web-asciidoc-parent</artifactId>
+    <artifactId>quarkus-qute-web-asciidoc-light-parent</artifactId>
     <version>999-SNAPSHOT</version>
   </parent>
-  <artifactId>quarkus-qute-web-asciidoc-integration-tests</artifactId>
-  <name>Quarkus Qute Web - AsciiDoc - Integration Tests</name>
+  <artifactId>quarkus-qute-web-asciidoc-light-integration-tests</artifactId>
+  <name>Quarkus Qute Web - AsciiDoc - Light - Integration Tests</name>
   <properties>
     <skipITs>true</skipITs>
   </properties>
@@ -19,7 +19,7 @@
     </dependency>
     <dependency>
       <groupId>io.quarkiverse.qute.web</groupId>
-      <artifactId>quarkus-qute-web-asciidoc</artifactId>
+      <artifactId>quarkus-qute-web-asciidoc-light</artifactId>
       <version>${project.version}</version>
     </dependency>
     <dependency>

diff --git a/...va/io/quarkiverse/qute/web/it/MyBean.java → ...va/io/quarkiverse/qute/web/it/MyBean.java b/...va/io/quarkiverse/qute/web/it/MyBean.java → ...va/io/quarkiverse/qute/web/it/MyBean.java
diff --git a/...src/main/resources/application.properties → ...src/main/resources/application.properties b/...src/main/resources/application.properties → ...src/main/resources/application.properties
diff --git a/...c/main/resources/templates/pub/hello.html → ...c/main/resources/templates/pub/hello.html b/...c/main/resources/templates/pub/hello.html → ...c/main/resources/templates/pub/hello.html
diff --git a/...ht/integration-tests/src/test/java/io/quarkiverse/qute/web/it/QuteWebAsciidocLightIT.java b/...ht/integration-tests/src/test/java/io/quarkiverse/qute/web/it/QuteWebAsciidocLightIT.java
@@ -0,0 +1,7 @@
+package io.quarkiverse.qute.web.it;
+
+import io.quarkus.test.junit.QuarkusIntegrationTest;
+
+@QuarkusIntegrationTest
+public class QuteWebAsciidocLightIT extends QuteWebAsciidocLightTest {
+}
diff --git a/...erse/qute/web/it/QuteWebAsciiDocTest.java → ...qute/web/it/QuteWebAsciidocLightTest.java b/...erse/qute/web/it/QuteWebAsciiDocTest.java → ...qute/web/it/QuteWebAsciidocLightTest.java
@@ -10,7 +10,7 @@
 import io.quarkus.test.junit.QuarkusTest;
 
 @QuarkusTest
-public class QuteWebAsciiDocTest {
+public class QuteWebAsciidocLightTest {
 
     @Test
     public void testTemplates() {

diff --git a/asciidoc/asciidoc-light/pom.xml b/asciidoc/asciidoc-light/pom.xml
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>io.quarkiverse.qute.web</groupId>
+        <artifactId>quarkus-qute-web-asciidoc-parent</artifactId>
+        <version>999-SNAPSHOT</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+    <artifactId>quarkus-qute-web-asciidoc-light-parent</artifactId>
+    <version>999-SNAPSHOT</version>
+    <packaging>pom</packaging>
+    <name>Quarkus Qute Web - Asciidoc - Light - Parent</name>
+
+    <modules>
+        <module>deployment</module>
+        <module>runtime</module>
+    </modules>
+    <profiles>
+        <profile>
+            <id>it</id>
+            <activation>
+                <property>
+                    <name>performRelease</name>
+                    <value>!true</value>
+                </property>
+            </activation>
+            <modules>
+                <module>integration-tests</module>
+            </modules>
+        </profile>
+    </profiles>
+
+</project>
diff --git a/asciidoc/runtime/pom.xml → asciidoc/asciidoc-light/runtime/pom.xml b/asciidoc/runtime/pom.xml → asciidoc/asciidoc-light/runtime/pom.xml
@@ -4,11 +4,11 @@
 
     <parent>
         <groupId>io.quarkiverse.qute.web</groupId>
-        <artifactId>quarkus-qute-web-asciidoc-parent</artifactId>
+        <artifactId>quarkus-qute-web-asciidoc-light-parent</artifactId>
         <version>999-SNAPSHOT</version>
     </parent>
-    <artifactId>quarkus-qute-web-asciidoc</artifactId>
-    <name>Quarkus Qute - Asciidoc - Runtime</name>
+    <artifactId>quarkus-qute-web-asciidoc-light</artifactId>
+    <name>Quarkus Qute - Asciidoc - Light - Runtime</name>
 
     <dependencies>
         <dependency>
@@ -18,12 +18,12 @@
         <dependency>
             <groupId>io.yupiik.maven</groupId>
             <artifactId>asciidoc-java</artifactId>
-            <version>${asciidoc.java.version}</version>
+            <version>${asciidoc.light.version}</version>
         </dependency>
         <dependency>
             <groupId>io.yupiik.maven</groupId>
             <artifactId>ascii2svg</artifactId>
-            <version>${asciidoc.java.version}</version>
+            <version>${asciidoc.light.version}</version>
         </dependency>
     </dependencies>
 

diff --git a/...b/asciidoc/runtime/AsciidocConverter.java → ...light/runtime/AsciidocLightConverter.java b/...b/asciidoc/runtime/AsciidocConverter.java → ...light/runtime/AsciidocLightConverter.java
@@ -1,4 +1,4 @@
-package io.quarkiverse.qute.web.asciidoc.runtime;
+package io.quarkiverse.qute.web.asciidoclight.runtime;
 
 import java.nio.file.Path;
 import java.util.Map;
@@ -8,7 +8,7 @@
 import io.yupiik.asciidoc.parser.resolver.ContentResolver;
 import io.yupiik.asciidoc.renderer.html.AsciidoctorLikeHtmlRenderer;
 
-public class AsciidocConverter {
+public class AsciidocLightConverter {
 
     private final Parser parser = new Parser();
     private final AsciidoctorLikeHtmlRenderer.Configuration config = new AsciidoctorLikeHtmlRenderer.Configuration()

diff --git a/...runtime/AsciidocSectionHelperFactory.java → ...me/AsciidocLightSectionHelperFactory.java b/...runtime/AsciidocSectionHelperFactory.java → ...me/AsciidocLightSectionHelperFactory.java
@@ -1,21 +1,22 @@
-package io.quarkiverse.qute.web.asciidoc.runtime;
+package io.quarkiverse.qute.web.asciidoclight.runtime;
 
 import java.util.List;
 import java.util.concurrent.CompletionStage;
 
 import io.quarkus.qute.CompletedStage;
 import io.quarkus.qute.EngineConfiguration;
+import io.quarkus.qute.RawString;
 import io.quarkus.qute.ResultNode;
 import io.quarkus.qute.SectionHelper;
 import io.quarkus.qute.SectionHelperFactory;
 import io.quarkus.qute.SingleResultNode;
 import io.quarkus.qute.TemplateExtension;
 
 @EngineConfiguration
-public class AsciidocSectionHelperFactory
-        implements SectionHelperFactory<AsciidocSectionHelperFactory.AsciidocSectionHelper> {
+public class AsciidocLightSectionHelperFactory
+        implements SectionHelperFactory<AsciidocLightSectionHelperFactory.AsciidocSectionHelper> {
 
-    private static final AsciidocConverter CONVERTER = new AsciidocConverter();
+    private static final AsciidocLightConverter CONVERTER = new AsciidocLightConverter();
     private static final AsciidocSectionHelper HELPER = new AsciidocSectionHelper();
 
     @Override
@@ -29,8 +30,8 @@ public AsciidocSectionHelper initialize(SectionInitContext context) {
     }
 
     @TemplateExtension(matchNames = { "asciidocify", "asciidocToHtml" })
-    static String convertToAsciidoc(String text, String ignoredName) {
-        return CONVERTER.apply(text);
+    static RawString convertToAsciidoc(String text, String ignoredName) {
+        return new RawString(CONVERTER.apply(text));
     }
 
     public static class AsciidocSectionHelper implements SectionHelper {

diff --git a/...resources/META-INF/quarkus-extension.yaml → ...resources/META-INF/quarkus-extension.yaml b/...resources/META-INF/quarkus-extension.yaml → ...resources/META-INF/quarkus-extension.yaml
@@ -1,5 +1,5 @@
-name: Qute Web Asciidoc
-description: A Qute Web extension designed to simplify the conversion of AsciiDoc to HTML by providing a set of AsciiDoc tags.
+name: Qute Web Asciidoc Light
+description: A Qute Web extension designed to simplify the conversion of AsciiDoc to HTML by providing a set of AsciiDoc tags using a light pure Java converter. It's faster but it is not feature complete.
 metadata:
   keywords:
     - qute-web-asciidoc

diff --git a/asciidoc/deployment/pom.xml → asciidoc/asciidoctorj/deployment/pom.xml b/asciidoc/deployment/pom.xml → asciidoc/asciidoctorj/deployment/pom.xml
@@ -4,16 +4,16 @@
 
     <parent>
         <groupId>io.quarkiverse.qute.web</groupId>
-        <artifactId>quarkus-qute-web-asciidoc-parent</artifactId>
+        <artifactId>quarkus-qute-web-asciidoctorj-parent</artifactId>
         <version>999-SNAPSHOT</version>
     </parent>
-    <artifactId>quarkus-qute-web-asciidoc-deployment</artifactId>
-    <name>Quarkus Qute Web - Asciidoc - Deployment</name>
+    <artifactId>quarkus-qute-web-asciidoctorj-deployment</artifactId>
+    <name>Quarkus Qute Web - AsciidoctorJ - Deployment</name>
 
     <dependencies>
         <dependency>
             <groupId>io.quarkiverse.qute.web</groupId>
-            <artifactId>quarkus-qute-web-asciidoc</artifactId>
+            <artifactId>quarkus-qute-web-asciidoctorj</artifactId>
             <version>${project.version}</version>
         </dependency>
         <dependency>

diff --git a/...in/java/io/quarkiverse/qute/web/asciidoctorj/deployment/QuteWebAsciidoctorJProcessor.java b/...in/java/io/quarkiverse/qute/web/asciidoctorj/deployment/QuteWebAsciidoctorJProcessor.java
@@ -0,0 +1,26 @@
+package io.quarkiverse.qute.web.asciidoctorj.deployment;
+
+import io.quarkiverse.qute.web.asciidoctorj.runtime.AsciidoctorJConfig;
+import io.quarkiverse.qute.web.asciidoctorj.runtime.AsciidoctorJConverter;
+import io.quarkiverse.qute.web.asciidoctorj.runtime.AsciidoctorJSectionHelperFactory;
+import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
+import io.quarkus.deployment.annotations.BuildProducer;
+import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.builditem.FeatureBuildItem;
+
+class QuteWebAsciidoctorJProcessor {
+
+    private static final String FEATURE = "qute-web-asciidoctorj";
+
+    @BuildStep
+    FeatureBuildItem feature() {
+        return new FeatureBuildItem(FEATURE);
+    }
+
+    @BuildStep
+    void process(BuildProducer<AdditionalBeanBuildItem> additionalBeans, AsciidoctorJConfig config) {
+        additionalBeans.produce(new AdditionalBeanBuildItem(AsciidoctorJSectionHelperFactory.class));
+        additionalBeans.produce(AdditionalBeanBuildItem.unremovableOf(AsciidoctorJConverter.class));
+    }
+
+}