refactor(core): New package structure to support multiple extensions …

…in the future
rodnansol · Feb 9, 2023 · 78251a7 · 78251a7
1 parent adb2f5f
commit 78251a7
Show file tree

Hide file tree

Showing 15 changed files with 109 additions and 55 deletions.
diff --git a/src/main/java/org/rodnansol/asciidoctorj/CodeBlockProcessor.java b/src/main/java/org/rodnansol/asciidoctorj/CodeBlockProcessor.java
diff --git a/...sol/asciidoctorj/JavaSourceExtension.java → ...asciidoctorj/CustomExtensionRegistry.java b/...sol/asciidoctorj/JavaSourceExtension.java → ...asciidoctorj/CustomExtensionRegistry.java
@@ -2,21 +2,23 @@
 
 import org.asciidoctor.Asciidoctor;
 import org.asciidoctor.jruby.extension.spi.ExtensionRegistry;
+import org.rodnansol.asciidoctorj.javasource.JavaSourceBlockMacroProcessor;
+import org.rodnansol.asciidoctorj.javasource.JavaSourceIncludeProcessor;
 
 /**
  * Extension registry.
  *
  * @author nandorholozsnyak
  * @since 0.1.0
  */
-public class JavaSourceExtension implements ExtensionRegistry {
+public class CustomExtensionRegistry implements ExtensionRegistry {
 
     @Override
     public void register(Asciidoctor asciidoctor) {
         asciidoctor.javaExtensionRegistry()
             .blockMacro(JavaSourceBlockMacroProcessor.class);
         asciidoctor.javaExtensionRegistry()
-            .includeProcessor(JavaMethodIncludeProcessor.class);
+            .includeProcessor(JavaSourceIncludeProcessor.class);
     }
 
 }
diff --git a/src/main/java/org/rodnansol/asciidoctorj/javasource/CodeBlockProcessor.java b/src/main/java/org/rodnansol/asciidoctorj/javasource/CodeBlockProcessor.java
@@ -0,0 +1,40 @@
+package org.rodnansol.asciidoctorj.javasource;
+
+import org.asciidoctor.ast.Document;
+import org.asciidoctor.extension.PreprocessorReader;
+
+import java.util.Map;
+
+/**
+ * Interface describes a block processor blueprint that can handle different attributes from the 'javasource' include macro.
+ *
+ * @author nandorholozsnyak
+ * @since 0.1.0
+ */
+public interface CodeBlockProcessor {
+
+    /**
+     * Checks if the current instance should be active for processing or not.
+     *
+     * @param attributes AsciiDoc attributes coming outside.
+     * @return <b>true</b> if the processor must be active based on the attributes, otherwise <b>false</b>
+     */
+    boolean isActive(Map<String, Object> attributes);
+
+    /**
+     * Processes the incoming source code and creates and extra block into the requested document file.
+     *
+     * @param extractCommand base extract command.
+     * @param document       AsciiDoc document instance.
+     * @param reader         pre-processor reader.
+     * @param target         target section.
+     * @param attributes     AsciiDoc attributes.
+     * @throws JavaSourceCodeExtractionException when the source code can not be read or transformed.
+     */
+    void process(ExtractCommand extractCommand,
+                 Document document,
+                 PreprocessorReader reader,
+                 String target,
+                 Map<String, Object> attributes);
+
+}
diff --git a/...odnansol/asciidoctorj/ExtractCommand.java → ...ciidoctorj/javasource/ExtractCommand.java b/...odnansol/asciidoctorj/ExtractCommand.java → ...ciidoctorj/javasource/ExtractCommand.java
@@ -1,4 +1,4 @@
-package org.rodnansol.asciidoctorj;
+package org.rodnansol.asciidoctorj.javasource;
 
 import java.util.Objects;
 

diff --git a/...sol/asciidoctorj/ExtractFieldCommand.java → ...ctorj/javasource/ExtractFieldCommand.java b/...sol/asciidoctorj/ExtractFieldCommand.java → ...ctorj/javasource/ExtractFieldCommand.java
@@ -1,4 +1,4 @@
-package org.rodnansol.asciidoctorj;
+package org.rodnansol.asciidoctorj.javasource;
 
 import java.util.Objects;
 
@@ -21,8 +21,8 @@ public ExtractFieldCommand(ExtractCommand extractCommand, String fieldName) {
      * @param sourceCodePath Java source file's path.
      * @param fieldName      field name to extract.
      * @param spaceSize      space size for indentation.
-     * @param withJavaDoc
-     * @param lineLength
+     * @param withJavaDoc    if the JavaDoc should be included or not.
+     * @param lineLength     maximum length of the line.
      */
     public ExtractFieldCommand(String sourceCodePath, String fieldName, int spaceSize, boolean withJavaDoc, int lineLength) {
         super(sourceCodePath, spaceSize, withJavaDoc, lineLength);

diff --git a/...ol/asciidoctorj/ExtractMethodCommand.java → ...torj/javasource/ExtractMethodCommand.java b/...ol/asciidoctorj/ExtractMethodCommand.java → ...torj/javasource/ExtractMethodCommand.java
@@ -1,4 +1,4 @@
-package org.rodnansol.asciidoctorj;
+package org.rodnansol.asciidoctorj.javasource;
 
 import java.util.Arrays;
 import java.util.Objects;
@@ -26,7 +26,7 @@ public ExtractMethodCommand(ExtractCommand extractCommand, String methodName,Str
      * @param spaceSize      space size for indentation.
      * @param methodName     method's name that should be extracted from the source code.
      * @param withJavaDoc    if the JavaDoc should be included or not.
-     * @param lineLength
+     * @param lineLength     maximum length of the line.
      * @param paramTypes     list of the method argument types in String values.
      */
     public ExtractMethodCommand(String sourceCodePath, int spaceSize, String methodName, boolean withJavaDoc, int lineLength, String... paramTypes) {

diff --git a/...idoctorj/JavaFieldCodeBlockProcessor.java → ...vasource/JavaFieldCodeBlockProcessor.java b/...idoctorj/JavaFieldCodeBlockProcessor.java → ...vasource/JavaFieldCodeBlockProcessor.java
@@ -1,7 +1,9 @@
-package org.rodnansol.asciidoctorj;
+package org.rodnansol.asciidoctorj.javasource;
 
 import org.asciidoctor.ast.Document;
 import org.asciidoctor.extension.PreprocessorReader;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.File;
 import java.io.IOException;
@@ -15,6 +17,8 @@
  */
 public class JavaFieldCodeBlockProcessor implements CodeBlockProcessor {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(JavaFieldCodeBlockProcessor.class);
+
     private static final String KEY_FIELD = "field";
 
     @Override
@@ -26,6 +30,7 @@ public boolean isActive(Map<String, Object> attributes) {
     public void process(ExtractCommand extractCommand, Document document, PreprocessorReader reader, String target, Map<String, Object> attributes) {
         String field = (String) attributes.get(KEY_FIELD);
         if (field != null && !field.isEmpty()) {
+            LOGGER.info("Extracting field:[{}] from source code at path:[{}]", field, extractCommand.getSourceCodePath());
             try {
                 String fullField = JavaSourceHelper.getField(new ExtractFieldCommand(extractCommand, field));
                 reader.pushInclude(

diff --git a/...doctorj/JavaMethodCodeBlockProcessor.java → ...asource/JavaMethodCodeBlockProcessor.java b/...doctorj/JavaMethodCodeBlockProcessor.java → ...asource/JavaMethodCodeBlockProcessor.java
@@ -1,7 +1,9 @@
-package org.rodnansol.asciidoctorj;
+package org.rodnansol.asciidoctorj.javasource;
 
 import org.asciidoctor.ast.Document;
 import org.asciidoctor.extension.PreprocessorReader;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.io.File;
 import java.io.IOException;
@@ -15,6 +17,8 @@
  */
 public class JavaMethodCodeBlockProcessor implements CodeBlockProcessor {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(JavaMethodCodeBlockProcessor.class);
+
     private static final String KEY_METHOD = "method";
     private static final String KEY_METHOD_PARAM_TYPES = "types";
 
@@ -29,6 +33,7 @@ public void process(ExtractCommand extractCommand, Document document, Preprocess
         try {
             String paramTypeList = (String) attributes.getOrDefault(KEY_METHOD_PARAM_TYPES, "");
             String[] paramTypes = paramTypeList.split(",");
+            LOGGER.info("Extracting method:[{}] with type list:[{}] from source code at path:[{}]", method, paramTypeList, extractCommand.getSourceCodePath());
             String fullMethod = JavaSourceHelper.getMethod(new ExtractMethodCommand(extractCommand, method, paramTypes));
 
             reader.pushInclude(

diff --git a/...octorj/JavaSourceBlockMacroProcessor.java → ...source/JavaSourceBlockMacroProcessor.java b/...octorj/JavaSourceBlockMacroProcessor.java → ...source/JavaSourceBlockMacroProcessor.java
@@ -1,4 +1,4 @@
-package org.rodnansol.asciidoctorj;
+package org.rodnansol.asciidoctorj.javasource;
 
 import org.asciidoctor.ast.StructuralNode;
 import org.asciidoctor.extension.BlockMacroProcessor;
@@ -20,7 +20,6 @@ public class JavaSourceBlockMacroProcessor extends BlockMacroProcessor {
     @Override
     public Object process(StructuralNode parent, String target, Map<String, Object> attributes) {
         try {
-            System.out.println("### ATTRIBUTES:" + parent.getAttributes());
             String method = JavaSourceHelper.getMethod(target, (String) attributes.get("method"));
             String content = new StringBuilder()
                 .append("<div class=\"listingblock\">\n")

diff --git a/...rj/JavaSourceCodeExtractionException.java → ...ce/JavaSourceCodeExtractionException.java b/...rj/JavaSourceCodeExtractionException.java → ...ce/JavaSourceCodeExtractionException.java
@@ -1,4 +1,4 @@
-package org.rodnansol.asciidoctorj;
+package org.rodnansol.asciidoctorj.javasource;
 
 /**
  * Exception to be thrown when the Java Source code can not be extracted.

diff --git a/...nansol/asciidoctorj/JavaSourceHelper.java → ...idoctorj/javasource/JavaSourceHelper.java b/...nansol/asciidoctorj/JavaSourceHelper.java → ...idoctorj/javasource/JavaSourceHelper.java
@@ -1,4 +1,4 @@
-package org.rodnansol.asciidoctorj;
+package org.rodnansol.asciidoctorj.javasource;
 
 import org.jboss.forge.roaster.Roaster;
 import org.jboss.forge.roaster._shade.org.apache.commons.lang3.StringUtils;

diff --git a/...iidoctorj/JavaMethodIncludeProcessor.java → ...avasource/JavaSourceIncludeProcessor.java b/...iidoctorj/JavaMethodIncludeProcessor.java → ...avasource/JavaSourceIncludeProcessor.java
@@ -1,11 +1,13 @@
-package org.rodnansol.asciidoctorj;
+package org.rodnansol.asciidoctorj.javasource;
 
 import org.asciidoctor.ast.Document;
 import org.asciidoctor.extension.IncludeProcessor;
 import org.asciidoctor.extension.PreprocessorReader;
+import org.jboss.forge.roaster._shade.org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.io.File;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
@@ -34,10 +36,9 @@
  * @author nandorholozsnyak
  * @since 0.1.0
  */
-public class JavaMethodIncludeProcessor extends IncludeProcessor {
-
-    private static final Logger LOGGER = LoggerFactory.getLogger(JavaMethodIncludeProcessor.class);
+public class JavaSourceIncludeProcessor extends IncludeProcessor {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(JavaSourceIncludeProcessor.class);
     private static final String MACRO_JAVASOURCE = "javasource";
     private static final String KEY_SOURCE = "source";
     private static final String KEY_SPACE_SIZE = "spaceSize";
@@ -46,11 +47,11 @@ public class JavaMethodIncludeProcessor extends IncludeProcessor {
 
     private final List<CodeBlockProcessor> codeBlockProcessorList;
 
-    public JavaMethodIncludeProcessor() {
+    public JavaSourceIncludeProcessor() {
         this(Arrays.asList(new JavaMethodCodeBlockProcessor(), new JavaFieldCodeBlockProcessor()));
     }
 
-    public JavaMethodIncludeProcessor(List<CodeBlockProcessor> codeBlockProcessorList) {
+    public JavaSourceIncludeProcessor(List<CodeBlockProcessor> codeBlockProcessorList) {
         this.codeBlockProcessorList = codeBlockProcessorList;
     }
 
@@ -69,15 +70,37 @@ public void process(Document document,
         if (source == null || source.isEmpty()) {
             throw new JavaSourceCodeExtractionException("'source' attribute is empty.");
         }
-        int spaceSize = Integer.parseInt((String) attributes.getOrDefault(KEY_SPACE_SIZE, String.valueOf(JavaSourceHelper.DEFAULT_SPACE_SIZE)));
-        int lineLength = Integer.parseInt((String) attributes.getOrDefault(KEY_LINE_LENGTH, String.valueOf(JavaSourceHelper.DEFAULT_LINE_LENGTH)));
+        String spaceSizeRawValue = (String) attributes.get(KEY_SPACE_SIZE);
+        String keyLineLengthRaw = (String) attributes.get(KEY_LINE_LENGTH);
+        int spaceSize = Integer.parseInt(StringUtils.isEmpty(spaceSizeRawValue) ? String.valueOf(JavaSourceHelper.DEFAULT_SPACE_SIZE) : spaceSizeRawValue);
+        int lineLength = Integer.parseInt(StringUtils.isEmpty(keyLineLengthRaw) ? String.valueOf(JavaSourceHelper.DEFAULT_LINE_LENGTH) : keyLineLengthRaw);
         boolean withJavaDoc = Boolean.parseBoolean((String) attributes.getOrDefault(KEY_WITH_JAVA_DOC, "false"));
         ExtractCommand extractCommand = new ExtractCommand(source, spaceSize, withJavaDoc, lineLength);
         LOGGER.debug("Extracting items from source code with basic command:[{}]", extractCommand);
-        codeBlockProcessorList.stream()
-            .filter(codeBlockProcessor -> codeBlockProcessor.isActive(attributes))
-            .findFirst()
-            .ifPresent(codeBlockProcessor -> codeBlockProcessor.process(extractCommand, document, reader, target, attributes));
+        try {
+            codeBlockProcessorList.stream()
+                .filter(codeBlockProcessor -> codeBlockProcessor.isActive(attributes))
+                .findFirst()
+                .ifPresentOrElse(processor -> processor.process(extractCommand, document, reader, target, attributes),
+                    () -> LOGGER.warn("No processor was found to handle incoming request for command:[{}]", extractCommand));
+        } catch (Exception e) {
+            renderErrorMessage(reader, target, attributes, e);
+        }
 
     }
+
+    private void renderErrorMessage(PreprocessorReader reader, String target, Map<String, Object> attributes, Exception exception) {
+        StringBuilder errorMessageBuilder = new StringBuilder()
+            .append("Unable to render the requested block, please see the stack trace for more information.\n\n")
+            .append("Error message: ").append(exception.getMessage()).append(" \n");
+        if (exception.getCause() != null) {
+            errorMessageBuilder.append("Original error message: ").append(exception.getCause().getMessage()).append(" \n");
+        }
+        reader.pushInclude(
+            errorMessageBuilder.toString(),
+            target,
+            new File(".").getAbsolutePath(),
+            1,
+            attributes);
+    }
 }
diff --git a/src/main/resources/META-INF/services/org.asciidoctor.jruby.extension.spi.ExtensionRegistry b/src/main/resources/META-INF/services/org.asciidoctor.jruby.extension.spi.ExtensionRegistry
@@ -1 +1 @@
-org.rodnansol.asciidoctorj.JavaSourceExtension
+org.rodnansol.asciidoctorj.CustomExtensionRegistry
diff --git a/...ol/asciidoctorj/JavaSourceHelperTest.java → ...torj/javasource/JavaSourceHelperTest.java b/...ol/asciidoctorj/JavaSourceHelperTest.java → ...torj/javasource/JavaSourceHelperTest.java
@@ -1,4 +1,4 @@
-package org.rodnansol.asciidoctorj;
+package org.rodnansol.asciidoctorj.javasource;
 
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -55,11 +55,11 @@ static Stream<Arguments> getMethodArgs() {
             arguments("createUser","public final User createUser(String username, String password) {\n" +
                 "    LOGGER.info(\"Creating new user with username:[{}]\", username);\n" +
                 "    userRepository.save(new User(username, password));\n" +
-                "}",(Object) new String[]{"String","String"}),
+                "}", new String[]{"String","String"}),
             arguments("deleteUser","protected void deleteUser(String username) {\n" +
                 "    LOGGER.info(\"Deleting user with username:[{}]\", username);\n" +
                 "    userRepository.deleteByUsername(username);\n" +
-                "}",(Object) new String[]{"String"}),
+                "}", new String[]{"String"}),
             arguments("disableUser","void disableUser(User user) {\n" +
                 "    LOGGER.info(\"Disabling user with username:[{}]\", user.username);\n" +
                 "    if (user.enabled == true) {\n" +
@@ -68,7 +68,7 @@ static Stream<Arguments> getMethodArgs() {
                 "    } else {\n" +
                 "        logUnableToDisableUser();\n" +
                 "    }\n" +
-                "}",(Object) new String[]{"User"}),
+                "}", new String[]{"User"}),
             arguments("logUnableToDisableUser","private static void logUnableToDisableUser() {\n" +
                 "    LOGGER.info(\"Unable to disable disabled user\");\n" +
                 "}", new String[]{})

diff --git a/src/test/resources/UserService.java b/src/test/resources/UserService.java
@@ -20,6 +20,10 @@ protected void deleteUser(String username) {
         userRepository.deleteByUsername(username);
     }
 
+    /**
+     * Disables the incoming user.
+     * @param user user to disable.
+     */
     void disableUser(User user) {
         LOGGER.info("Disabling user with username:[{}]", user.username);
         if (user.enabled == true) {