Add asciidoc converter to core (#1555)

buildSrc/build.gradle

@@ -38,6 +38,7 @@ dependencies {
     }
     implementation("com.networknt:json-schema-validator")
     implementation("io.micronaut.rss:micronaut-rss")
+    implementation("org.asciidoctor:asciidoctorj:3.0.0")
     testImplementation("org.skyscreamer:jsonassert:1.5.3")
 }
 

buildSrc/src/main/java/io/micronaut/guides/core/CalloutMacroSubstitution.java

@@ -0,0 +1,21 @@
+package io.micronaut.guides.core;
+
+import jakarta.inject.Singleton;
+
+@Singleton
+public class CalloutMacroSubstitution extends LineMacroSubstitution {
+    @Override
+    protected String getMacroName() {
+        return "callout";
+    }
+
+    @Override
+    protected String getBaseDirectory() {
+        return "{calloutsDir}";
+    }
+
+    @Override
+    protected String getPrefix() {
+        return "callout-";
+    }
+}

buildSrc/src/main/java/io/micronaut/guides/core/CommonMacroSubstitution.java

@@ -0,0 +1,22 @@
+package io.micronaut.guides.core;
+
+import jakarta.inject.Singleton;
+
+@Singleton
+public class CommonMacroSubstitution extends LineMacroSubstitution {
+
+    @Override
+    protected String getMacroName() {
+        return "common";
+    }
+
+    @Override
+    protected String getBaseDirectory() {
+        return "{commonsDir}";
+    }
+
+    @Override
+    protected String getPrefix() {
+        return "common-";
+    }
+}

buildSrc/src/main/java/io/micronaut/guides/core/ExternalMacroSubstitution.java

@@ -0,0 +1,22 @@
+package io.micronaut.guides.core;
+
+import jakarta.inject.Singleton;
+
+@Singleton
+public class ExternalMacroSubstitution extends LineMacroSubstitution {
+
+    @Override
+    protected String getMacroName() {
+        return "external";
+    }
+
+    @Override
+    protected String getBaseDirectory() {
+        return "{guidesDir}";
+    }
+
+    @Override
+    protected String getPrefix() {
+        return "";
+    }
+}

buildSrc/src/main/java/io/micronaut/guides/core/ExternalTemplateMacroSubstitution.java

@@ -0,0 +1,21 @@
+package io.micronaut.guides.core;
+
+import jakarta.inject.Singleton;
+
+@Singleton
+public class ExternalTemplateMacroSubstitution extends LineMacroSubstitution {
+    @Override
+    protected String getMacroName() {
+        return "external-template";
+    }
+
+    @Override
+    protected String getBaseDirectory() {
+        return "{guidesDir}";
+    }
+
+    @Override
+    protected String getPrefix() {
+        return "";
+    }
+}

buildSrc/src/main/java/io/micronaut/guides/core/GuideLinkMacroSubstitution.java

@@ -0,0 +1,34 @@
+package io.micronaut.guides.core;
+
+import jakarta.inject.Singleton;
+
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import static io.micronaut.guides.core.MacroUtils.findMacroInstances;
+
+@Singleton
+public class GuideLinkMacroSubstitution implements MacroSubstitution {
+    private static final Pattern GUIDE_LINK_REGEX = Pattern.compile("guideLink:(.*?)\\[(.*?)]");
+
+    private static String processGuideLink(String line) {
+        Matcher matcher = GUIDE_LINK_REGEX.matcher(line);
+        if (matcher.find()) {
+            String slug = matcher.group(1).trim();
+            String text = matcher.group(2);
+            return "link:" + slug + ".html[" + text + "]";
+        }
+        return line;
+    }
+
+    @Override
+    public String substitute(String str, Guide guide, GuidesOption option) {
+        for (String instance : findMacroInstances(str, GUIDE_LINK_REGEX)) {
+            String res = processGuideLink(instance);
+            str = str.replace(instance, res);
+        }
+
+        return str;
+    }
+
+}

buildSrc/src/main/java/io/micronaut/guides/core/LineMacroSubstitution.java

@@ -0,0 +1,45 @@
+package io.micronaut.guides.core;
+
+import io.micronaut.guides.core.asciidoc.Argument;
+import io.micronaut.guides.core.asciidoc.AsciidocMacro;
+import io.micronaut.guides.core.asciidoc.Attribute;
+import io.micronaut.guides.core.asciidoc.IncludeDirective;
+
+import java.nio.file.Path;
+import java.util.Optional;
+
+import static io.micronaut.guides.core.MacroUtils.findMacroLines;
+
+abstract class LineMacroSubstitution implements MacroSubstitution {
+    protected abstract String getMacroName();
+
+    protected abstract String getBaseDirectory();
+
+    protected abstract String getPrefix();
+
+    @Override
+    public String substitute(String str, Guide guide, GuidesOption option) {
+        for (String line : findMacroLines(str, getMacroName())) {
+            Optional<AsciidocMacro> asciidocMacroOptional = AsciidocMacro.of(getMacroName(), line);
+            if (asciidocMacroOptional.isEmpty()) {
+                continue;
+            }
+
+            AsciidocMacro macro = asciidocMacroOptional.get();
+            StringBuilder builder = new StringBuilder();
+
+            for (Attribute attribute : macro.attributes()) {
+                Argument argument = new Argument(attribute.key(), attribute.values().get(0));
+                builder.append(argument).append("\n");
+            }
+
+            Path target = Path.of(getBaseDirectory(), getPrefix() + macro.target());
+
+            IncludeDirective.Builder includeDirectiveBuilder = IncludeDirective.builder().target(target.toString());
+            builder.append(includeDirectiveBuilder.build());
+
+            str = str.replace(line, builder.toString());
+        }
+        return str;
+    }
+}

buildSrc/src/main/java/io/micronaut/guides/core/MacroUtils.java

@@ -24,9 +24,8 @@ static List<String> findMacroLines(@NonNull String str, @NonNull String macro) {
                 .toList();
     }
 
-    static List<String> findMacroInstances(@NonNull String str, @NonNull String macro) {
+    static List<String> findMacroInstances(@NonNull String str, @NonNull Pattern pattern) {
         List<String> matches = new ArrayList<>();
-        Pattern pattern = Pattern.compile("@(?:([\\w-]*):)?" + macro + "@");
         Matcher matcher = pattern.matcher(str);
 
         while (matcher.find()) {

buildSrc/src/main/java/io/micronaut/guides/core/PlaceholderWithTargetMacroSubstitution.java

@@ -4,6 +4,7 @@
 import io.micronaut.guides.core.asciidoc.PlacheholderMacro;
 
 import java.util.Optional;
+import java.util.regex.Pattern;
 
 abstract class PlaceholderWithTargetMacroSubstitution implements MacroSubstitution {
 
@@ -12,7 +13,8 @@ abstract class PlaceholderWithTargetMacroSubstitution implements MacroSubstituti
     protected abstract String getSubstitution(Guide guide, GuidesOption option, String app);
 
     public String substitute(String str, Guide guide, GuidesOption option) {
-        for (String instance : MacroUtils.findMacroInstances(str, getMacroName())) {
+        Pattern pattern = Pattern.compile("@(?:([\\w-]*):)?" + getMacroName() + "@");
+        for (String instance : MacroUtils.findMacroInstances(str, pattern)) {
             Optional<PlacheholderMacro> macroOptional = PlacheholderMacro.of(getMacroName(), instance);
             if (macroOptional.isEmpty()) {
                 continue;

buildSrc/src/main/java/io/micronaut/guides/core/asciidoc/Argument.java

@@ -0,0 +1,30 @@
+package io.micronaut.guides.core.asciidoc;
+
+import io.micronaut.core.annotation.NonNull;
+import io.micronaut.core.util.StringUtils;
+
+import java.util.Optional;
+
+public record Argument(String key, String value) {
+    private static final String ARGUMENT_DELIMITATOR = ":";
+
+    @NonNull
+    public static Optional<Argument> of(@NonNull String str) {
+        if (StringUtils.isEmpty(str)) {
+            return Optional.empty();
+        }
+
+        String[] parts = str.split("=", 2);
+        if (parts.length == 2 && !parts[0].isBlank() && !parts[1].isBlank()) {
+            return Optional.of(new Argument(parts[0], parts[1]));
+        }
+
+        return Optional.empty();
+    }
+
+    @Override
+    public String toString() {
+        return ARGUMENT_DELIMITATOR + key + ARGUMENT_DELIMITATOR + " " + value;
+    }
+}
+

buildSrc/src/main/java/io/micronaut/guides/core/asciidoc/AsciidocConfiguration.java

@@ -0,0 +1,41 @@
+package io.micronaut.guides.core.asciidoc;
+
+import org.asciidoctor.Placement;
+
+import java.io.File;
+
+public interface AsciidocConfiguration {
+    String getSourceDir();
+
+    String getSourceHighlighter();
+
+    Placement getToc();
+
+    int getToclevels();
+
+    boolean getSectnums();
+
+    String getIdprefix();
+
+    String getIdseparator();
+
+    String getIcons();
+
+    String getImagesdir();
+
+    boolean isNofooter();
+
+    String getDocType();
+
+    String getRuby();
+
+    File getTemplateDirs();
+
+    String getCommonsDir();
+
+    String getBaseDir();
+
+    String getGuidesDir();
+
+    String getCalloutsDir();
+}