Add plugin mechanism for Loggers

asciidoctor · Jun 16, 2018 · 41362ce · 41362ce
1 parent af104d9
commit 41362ce
Show file tree

Hide file tree

Showing 25 changed files with 767 additions and 31 deletions.
diff --git a/asciidoctorj-core/build.gradle b/asciidoctorj-core/build.gradle
@@ -62,7 +62,7 @@ jar {
 
 test {
   useJUnit {
-    excludeCategories 'org.asciidoctor.categories.Polluted'
+    excludeCategories 'org.asciidoctor.categories.Polluted', 'org.asciidoctor.categories.OwnVM'
   }
 }
 
@@ -105,3 +105,40 @@ task pollutedTest(type: Test) {
 
 test.dependsOn pollutedTest
 
+task ownVMTest(type: Test) {
+  useJUnit {
+    includeCategories 'org.asciidoctor.categories.OwnVM'
+  }
+  forkEvery = 10
+  minHeapSize = '128m'
+  maxHeapSize = '1024m'
+  if (JavaVersion.current().isJava8Compatible()) {
+    jvmArgs '-XX:-UseGCOverheadLimit'
+  }
+  else {
+    jvmArgs '-XX:MaxPermSize=256m', '-XX:-UseGCOverheadLimit'
+  }
+  forkEvery 1
+
+  testLogging {
+    // events 'passed', 'failed', 'skipped', 'standard_out', 'standard_error'
+    // events 'standard_out', 'standard_error'
+    afterSuite { desc, result ->
+      if (!desc.parent && logger.infoEnabled) {
+        logger.info "Test results: ${result.resultType} (${result.testCount} tests, ${result.successfulTestCount} passed, ${result.failedTestCount} failed, ${result.skippedTestCount} skipped)"
+      }
+    }
+  }
+
+  reports {
+    html {
+      destination file("$buildDir/reports/ownVMTest")
+    }
+    junitXml {
+      destination file("$buildDir/ownVMTest-result")
+    }
+  }
+}
+
+test.dependsOn ownVMTest
+
diff --git a/asciidoctorj-core/src/main/java/org/asciidoctor/Asciidoctor.java b/asciidoctorj-core/src/main/java/org/asciidoctor/Asciidoctor.java
@@ -16,6 +16,7 @@
 import org.asciidoctor.extension.JavaExtensionRegistry;
 import org.asciidoctor.extension.RubyExtensionRegistry;
 import org.asciidoctor.internal.JRubyAsciidoctor;
+import org.asciidoctor.log.LogHandler;
 
 /**
  * 
@@ -910,5 +911,8 @@ public static Asciidoctor create(List<String> loadPaths, String gemPath) {
      */
     Document loadFile(File file, Map<String, Object> options);
 
+    void registerLogHandler(LogHandler logHandler);
+
+    void unregisterLogHandler(LogHandler logHandler);
 
 }
diff --git a/asciidoctorj-core/src/main/java/org/asciidoctor/ast/impl/CursorImpl.java b/asciidoctorj-core/src/main/java/org/asciidoctor/ast/impl/CursorImpl.java
@@ -4,6 +4,8 @@
 import org.asciidoctor.internal.RubyObjectWrapper;
 import org.jruby.runtime.builtin.IRubyObject;
 
+import java.util.Objects;
+
 public class CursorImpl extends RubyObjectWrapper implements Cursor {
 
     public CursorImpl(IRubyObject rubyNode) {
@@ -17,17 +19,24 @@ public int getLineNumber() {
 
     @Override
     public String getPath() {
-        return getString("path");
+        final Object result = getProperty("path");
+        return result == null ? null : result.toString();
     }
 
     @Override
     public String getDir() {
-        return getString("dir");
+        final Object result = getProperty("dir");
+        return result == null ? null : result.toString();
     }
 
     @Override
     public String getFile() {
-        return getString("file");
+        final Object result = getProperty("file");
+        return result == null ? null : result.toString();
     }
 
+    @Override
+    public String toString() {
+        return getString("to_s");
+    }
 }
diff --git a/asciidoctorj-core/src/main/java/org/asciidoctor/extension/Contexts.java b/asciidoctorj-core/src/main/java/org/asciidoctor/extension/Contexts.java
@@ -18,9 +18,9 @@
  *         super(blockName);
  *     }
  *
- *     public Object process(StructuralNode parent, Reader reader, Map<String, Object> attributes) {
- *         List<String> lines = reader.readLines();
- *         List<String> newLines = new ArrayList<>();
+ *     public Object process(StructuralNode parent, Reader reader, Map&lt;String, Object&gt; attributes) {
+ *         List&lt;String&gt; lines = reader.readLines();
+ *         List&lt;String&gt; newLines = new ArrayList<>();
  *         for (String line: lines) {
  *             newLines.add(line.toUpperCase());
  *         }

diff --git a/asciidoctorj-core/src/main/java/org/asciidoctor/internal/JRubyAsciidoctor.java b/asciidoctorj-core/src/main/java/org/asciidoctor/internal/JRubyAsciidoctor.java
@@ -11,7 +11,6 @@
 import org.asciidoctor.ast.NodeConverter;
 import org.asciidoctor.ast.StructuralNode;
 import org.asciidoctor.ast.StructuredDocument;
-import org.asciidoctor.ast.Title;
 import org.asciidoctor.ast.impl.ContentPartImpl;
 import org.asciidoctor.ast.impl.DocumentHeaderImpl;
 import org.asciidoctor.ast.impl.StructuredDocumentImpl;
@@ -21,6 +20,11 @@
 import org.asciidoctor.extension.JavaExtensionRegistry;
 import org.asciidoctor.extension.RubyExtensionRegistry;
 import org.asciidoctor.extension.internal.ExtensionRegistryExecutor;
+import org.asciidoctor.log.LogHandler;
+import org.asciidoctor.log.LogRecord;
+import org.asciidoctor.log.internal.JULLogHandler;
+import org.asciidoctor.log.internal.JavaLogger;
+import org.asciidoctor.log.internal.LogHandlerRegistryExecutor;
 import org.jruby.Ruby;
 import org.jruby.RubyClass;
 import org.jruby.RubyHash;
@@ -44,9 +48,10 @@
 import java.util.List;
 import java.util.Map;
 import java.util.UUID;
+import java.util.logging.Level;
 import java.util.logging.Logger;
 
-public class JRubyAsciidoctor implements Asciidoctor {
+public class JRubyAsciidoctor implements Asciidoctor, LogHandler {
 
     private static final Logger logger = Logger.getLogger(JRubyAsciidoctor.class.getName());
 
@@ -59,6 +64,10 @@ public class JRubyAsciidoctor implements Asciidoctor {
 
     private RubyClass extensionGroupClass;
 
+    private List<LogHandler> logHandlers = new ArrayList<>();
+
+    private final static Logger LOGGER = Logger.getLogger("asciidoctorj");
+
     private JRubyAsciidoctor(final Ruby rubyRuntime) {
         this.rubyRuntime = rubyRuntime;
 
@@ -67,6 +76,7 @@ private JRubyAsciidoctor(final Ruby rubyRuntime) {
         this.rubyRuntime.evalScriptlet(script);
 
         this.rubyGemsPreloader = new RubyGemsPreloader(this.rubyRuntime);
+        this.logHandlers.add(new JULLogHandler());
     }
 
     public static JRubyAsciidoctor create() {
@@ -96,6 +106,7 @@ public static JRubyAsciidoctor create(List<String> loadPaths, String gemPath) {
     private static JRubyAsciidoctor processRegistrations(JRubyAsciidoctor asciidoctor) {
         registerExtensions(asciidoctor);
         registerConverters(asciidoctor);
+        registerLogHandlers(asciidoctor);
         return asciidoctor;
     }
 
@@ -107,6 +118,10 @@ private static void registerExtensions(Asciidoctor asciidoctor) {
         new ExtensionRegistryExecutor(asciidoctor).registerAllExtensions();
     }
 
+    private static void registerLogHandlers(Asciidoctor asciidoctor) {
+        new LogHandlerRegistryExecutor(asciidoctor).registerAllLogHandlers();
+    }
+
     private static JRubyAsciidoctor createJRubyAsciidoctorInstance(Map<String, String> environmentVars, List<String> loadPaths, ClassLoader classloader) {
 
         Map<String, String> env = environmentVars != null ?
@@ -120,7 +135,11 @@ private static JRubyAsciidoctor createJRubyAsciidoctorInstance(Map<String, Strin
 
         Ruby rubyRuntime = JavaEmbedUtils.initialize(loadPaths, config);
 
-        return new JRubyAsciidoctor(rubyRuntime);
+        JRubyAsciidoctor jrubyAsciidoctor = new JRubyAsciidoctor(rubyRuntime);
+
+        JavaLogger.install(rubyRuntime, jrubyAsciidoctor);
+
+        return jrubyAsciidoctor;
     }
 
     private static void injectEnvironmentVariables(RubyInstanceConfig config, Map<String, String> environmentVars) {
@@ -132,6 +151,18 @@ private static RubyInstanceConfig createOptimizedConfiguration() {
         return new RubyInstanceConfig();
     }
 
+    @Override
+    public void registerLogHandler(final LogHandler logHandler) {
+        if (!this.logHandlers.contains(logHandler)) {
+            this.logHandlers.add(logHandler);
+        }
+    }
+
+    @Override
+    public void unregisterLogHandler(final LogHandler logHandler) {
+        this.logHandlers.remove(logHandler);
+    }
+
     public Ruby getRubyRuntime() {
         return rubyRuntime;
     }
@@ -140,7 +171,7 @@ private DocumentHeader toDocumentHeader(Document document) {
 
         Document documentImpl = (Document) NodeConverter.createASTNode(document);
 
-        return DocumentHeaderImpl.createDocumentHeader((Title) documentImpl.getStructuredDoctitle(), documentImpl.getDoctitle(),
+        return DocumentHeaderImpl.createDocumentHeader(documentImpl.getStructuredDoctitle(), documentImpl.getDoctitle(),
                 documentImpl.getAttributes());
     }
 
@@ -642,4 +673,15 @@ private RubyClass getExtensionGroupClass() {
         }
         return extensionGroupClass;
     }
+
+    @Override
+    public void log(LogRecord logRecord) {
+        for (LogHandler logHandler: logHandlers) {
+            try {
+                logHandler.log(logRecord);
+            } catch (Exception e) {
+                LOGGER.log(Level.WARNING, "Unexpected exception while logging Asciidoctor log entry", e);
+            }
+        }
+    }
 }
diff --git a/asciidoctorj-core/src/main/java/org/asciidoctor/log/LogHandler.java b/asciidoctorj-core/src/main/java/org/asciidoctor/log/LogHandler.java
@@ -0,0 +1,7 @@
+package org.asciidoctor.log;
+
+public interface LogHandler {
+
+    void log(LogRecord logRecord);
+
+}
diff --git a/asciidoctorj-core/src/main/java/org/asciidoctor/log/LogRecord.java b/asciidoctorj-core/src/main/java/org/asciidoctor/log/LogRecord.java
@@ -0,0 +1,44 @@
+package org.asciidoctor.log;
+
+import org.asciidoctor.ast.Cursor;
+
+public class LogRecord {
+
+    private final Severity severity;
+
+    private final Cursor cursor;
+
+    private final String message;
+
+    private final String sourceFileName;
+
+    private final String sourceMethodName;
+
+    public LogRecord(Severity severity, Cursor cursor, String message, String sourceFileName, String sourceMethodName) {
+        this.severity = severity;
+        this.cursor = cursor;
+        this.message = message;
+        this.sourceFileName = sourceFileName;
+        this.sourceMethodName = sourceMethodName;
+    }
+
+    public Severity getSeverity() {
+        return severity;
+    }
+
+    public Cursor getCursor() {
+        return cursor;
+    }
+
+    public String getMessage() {
+        return message;
+    }
+
+    public String getSourceFileName() {
+        return sourceFileName;
+    }
+
+    public String getSourceMethodName() {
+        return sourceMethodName;
+    }
+}
diff --git a/asciidoctorj-core/src/main/java/org/asciidoctor/log/Severity.java b/asciidoctorj-core/src/main/java/org/asciidoctor/log/Severity.java
@@ -0,0 +1,20 @@
+package org.asciidoctor.log;
+
+public enum Severity {
+    DEBUG(0),
+    INFO(1),
+    WARN(2),
+    ERROR(3),
+    FATAL(4),
+    UNKNOWN(5);
+
+    private int rubyId;
+
+    private Severity(final int rubyId) {
+        this.rubyId = rubyId;
+    }
+
+    public int getRubyId() {
+        return rubyId;
+    }
+}
diff --git a/asciidoctorj-core/src/main/java/org/asciidoctor/log/internal/JULLogHandler.java b/asciidoctorj-core/src/main/java/org/asciidoctor/log/internal/JULLogHandler.java
@@ -0,0 +1,45 @@
+package org.asciidoctor.log.internal;
+
+import org.asciidoctor.log.LogHandler;
+import org.asciidoctor.log.LogRecord;
+import org.asciidoctor.log.Severity;
+
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+public class JULLogHandler implements LogHandler {
+
+    private final static Logger LOGGER = Logger.getLogger("asciidoctor");
+
+    @Override
+    public void log(LogRecord logRecord) {
+        final java.util.logging.LogRecord julLogRecord =
+            new java.util.logging.LogRecord(
+                mapSeverity(logRecord.getSeverity()),
+                logRecord.getCursor() != null ? logRecord.getCursor().toString() + ": " + logRecord.getMessage() : logRecord.getMessage());
+
+        julLogRecord.setSourceClassName(logRecord.getSourceFileName());
+        julLogRecord.setSourceMethodName(logRecord.getSourceMethodName());
+        julLogRecord.setParameters(new Object[] { logRecord.getCursor() });
+        LOGGER.log(julLogRecord);
+    }
+
+    private static Level mapSeverity(Severity severity) {
+        switch (severity) {
+            case DEBUG:
+                return Level.FINEST;
+            case INFO:
+                return Level.INFO;
+            case WARN:
+                return Level.WARNING;
+            case ERROR:
+                return Level.SEVERE;
+            case FATAL:
+                return Level.SEVERE;
+            case UNKNOWN:
+            default:
+                return Level.INFO;
+        }
+    }
+
+}