Implemented the latest DispatcherInterface that allows disbaling the dispatching of comment block events.

Author: Martin Brecht-Precht

composer.json

@@ -24,7 +24,7 @@
   },
   "require": {
     "php": ">=5.3",
-    "markdom/handler-interface": "^1.0.8",
+    "markdom/handler-interface": "^1.0.9",
     "markenwerk/stack-util": "~1.0",
     "markenwerk/string-builder": "^1.0.4",
     "markenwerk/json-pretty-printer": "~1.0",

example/commonmark-01.php

@@ -9,5 +9,7 @@
 
 $handler = new CommonmarkHandler();
 $dispatcher = new JsonDispatcher($handler);
-$dispatcher->processFile(__DIR__ . '/example-data-simple.json');
+$dispatcher
+	->setDispatchCommentBlocks(false)
+	->processFile(__DIR__ . '/example-data.json');
 fwrite(STDOUT, $handler->getResult());

src/Dispatcher/AbstractDispatcher.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Markdom\Dispatcher;
+
+use Markdom\DispatcherInterface\DispatcherInterface;
+
+/**
+ * Class AbstractDispatcher
+ *
+ * @package Markdom\Dispatcher
+ */
+abstract class AbstractDispatcher implements DispatcherInterface
+{
+
+	/**
+	 * @var bool
+	 */
+	private $dispatchCommentBlocks = true;
+
+	/**
+	 * @return boolean
+	 */
+	public function getDispatchCommentBlocks()
+	{
+		return $this->dispatchCommentBlocks;
+	}
+
+	/**
+	 * @param boolean $dispatchCommentBlocks
+	 * @return $this
+	 */
+	public function setDispatchCommentBlocks($dispatchCommentBlocks)
+	{
+		$this->dispatchCommentBlocks = $dispatchCommentBlocks;
+		return $this;
+	}
+
+}

src/Dispatcher/CommonmarkDispatcher.php

@@ -7,15 +7,14 @@
 use Markdom\Dispatcher\CommonmarkUtil\DocumentProcessor;
 use Markdom\Dispatcher\Exception\DispatcherException;
 use Markdom\Dispatcher\HtmlProcessor\HtmlProcessorInterface;
-use Markdom\DispatcherInterface\DispatcherInterface;
 use Markdom\HandlerInterface\HandlerInterface;
 
 /**
  * Class CommonmarkDispatcher
  *
  * @package Markdom\Dispatcher
  */
-class CommonmarkDispatcher implements DispatcherInterface
+class CommonmarkDispatcher extends AbstractDispatcher
 {
 
 	/**
@@ -79,7 +78,9 @@ public function processFile($sourceFile)
 	public function process($source)
 	{
 		$commonMarkEnvironment = Environment::createCommonMarkEnvironment();
-		$commonMarkEnvironment->addDocumentProcessor(new DocumentProcessor($this->markdomHandler, $this->htmlProcessor));
+		$commonMarkEnvironment->addDocumentProcessor(
+			new DocumentProcessor($this->markdomHandler, $this->getDispatchCommentBlocks(), $this->htmlProcessor)
+		);
 		$docParser = new DocParser($commonMarkEnvironment);
 		$docParser->parse($source);
 		return $this;

src/Dispatcher/CommonmarkUtil/DocumentProcessor.php

@@ -49,6 +49,11 @@ final class DocumentProcessor implements DocumentProcessorInterface
 	 */
 	private $htmlProcessor;
 
+	/**
+	 * @var bool
+	 */
+	private $dispatchCommentBlocks;
+
 	/**
 	 * @var Stack
 	 */
@@ -58,16 +63,21 @@ final class DocumentProcessor implements DocumentProcessorInterface
 	 * DocumentProcessor constructor.
 	 *
 	 * @param HandlerInterface $markdomHandler
+	 * @param bool $dispatchCommentBlocks
 	 * @param HtmlProcessorInterface $htmlProcessor
 	 */
-	public function __construct(HandlerInterface $markdomHandler, HtmlProcessorInterface $htmlProcessor = null)
-	{
+	public function __construct(
+		HandlerInterface $markdomHandler,
+		$dispatchCommentBlocks,
+		HtmlProcessorInterface $htmlProcessor = null
+	) {
 		$this->markdomHandler = $markdomHandler;
-		$this->imageStack = new Stack();
+		$this->dispatchCommentBlocks = $dispatchCommentBlocks;
 		if (is_null($htmlProcessor)) {
 			$htmlProcessor = new HtmlTextProcessor();
 		}
 		$this->htmlProcessor = $htmlProcessor;
+		$this->imageStack = new Stack();
 	}
 
 	/**
@@ -77,7 +87,11 @@ public function __construct(HandlerInterface $markdomHandler, HtmlProcessorInter
 	 */
 	public function processDocument(Document $document)
 	{
-		$markdomHandlerEventDispatcher = new MarkdomEventBridge($this->markdomHandler, $this->htmlProcessor);
+		$markdomHandlerEventDispatcher = new MarkdomEventBridge(
+			$this->markdomHandler,
+			$this->dispatchCommentBlocks,
+			$this->htmlProcessor
+		);
 		$walker = $document->walker();
 		while ($event = $walker->next()) {
 			$node = $event->getNode();

src/Dispatcher/CommonmarkUtil/MarkdomEventBridge.php

@@ -42,6 +42,11 @@ final class MarkdomEventBridge
 	 */
 	private $htmlProcessor;
 
+	/**
+	 * @var bool
+	 */
+	private $dispatchCommentBlocks;
+
 	/**
 	 * @var Node
 	 */
@@ -51,12 +56,17 @@ final class MarkdomEventBridge
 	 * MarkdomHandlerEventDispatcher constructor.
 	 *
 	 * @param HandlerInterface $commonmarkHandler
+	 * @param bool $dispatchCommentBlocks
 	 * @param HtmlProcessorInterface $htmlProcessor
 	 */
-	public function __construct(HandlerInterface $commonmarkHandler, HtmlProcessorInterface $htmlProcessor)
-	{
+	public function __construct(
+		HandlerInterface $commonmarkHandler,
+		$dispatchCommentBlocks,
+		HtmlProcessorInterface $htmlProcessor
+	) {
 		$this->markdomHandler = $commonmarkHandler;
 		$this->htmlProcessor = $htmlProcessor;
+		$this->dispatchCommentBlocks = $dispatchCommentBlocks;
 	}
 
 	/**
@@ -200,7 +210,7 @@ private function transmitContainerBeginEvent(Node $node)
 				break;
 			case DocumentProcessor::BLOCK_NODE_HTML_BLOCK:
 				/** @var HtmlBlock $node */
-				if ($node->getType() == $node::TYPE_2_COMMENT) {
+				if ($node->getType() == $node::TYPE_2_COMMENT && $this->dispatchCommentBlocks) {
 					$this->dispatchBlockBeginEvents(BlockType::TYPE_COMMENT);
 					$comment = $node->getStringContent();
 					if (mb_strpos($comment, '<!--') === 0) {
@@ -213,7 +223,7 @@ private function transmitContainerBeginEvent(Node $node)
 					$this->markdomHandler->onCommentBlock($comment);
 				} else {
 					$this->htmlProcessor->handleHtmlBlock($node, $this->markdomHandler);
-					if(!is_null($node->next())){
+					if (!is_null($node->next())) {
 						$this->markdomHandler->onNextBlock();
 					}
 				}

src/Dispatcher/PhpObjectDispatcher.php

@@ -4,7 +4,6 @@
 
 use Markdom\Dispatcher\EventDispatcher\SimpleMarkdomEventDispatcher;
 use Markdom\Dispatcher\Exception\DispatcherException;
-use Markdom\DispatcherInterface\DispatcherInterface;
 use Markdom\Handler\TypeNameTranslator\KeyNameTranslator;
 use Markdom\HandlerInterface\HandlerInterface;
 
@@ -13,7 +12,7 @@
  *
  * @package Markdom\Dispatcher
  */
-class PhpObjectDispatcher implements DispatcherInterface
+class PhpObjectDispatcher extends AbstractDispatcher
 {
 
 	/**
@@ -49,13 +48,13 @@ public function process($source)
 		if (!is_object($source)) {
 			throw new DispatcherException('Markdom invalid: root node is no object.');
 		}
-		if(!isset($source->version) || !is_object($source->version)){
+		if (!isset($source->version) || !is_object($source->version)) {
 			throw new DispatcherException('Markdom invalid: no document version specified.');
 		}
-		if(!isset($source->version->major) || !isset($source->version->minor)){
+		if (!isset($source->version->major) || !isset($source->version->minor)) {
 			throw new DispatcherException('Markdom invalid: no document valid version specified.');
 		}
-		if((int)$source->version->major !== 1 || (int)$source->version->minor !== 0){
+		if ((int)$source->version->major !== 1 || (int)$source->version->minor !== 0) {
 			throw new DispatcherException('Markdom invalid: version mismatch Expected version 1.0.');
 		}
 		$this->eventDispatcher->onDocumentBegin();
@@ -85,7 +84,9 @@ private function processBlocks(array $blocks)
 					$this->eventDispatcher->onCodeBlock($node->code, $hint);
 					break;
 				case KeyNameTranslator::TYPE_COMMENT:
-					$this->eventDispatcher->onCommentBlock($node->comment);
+					if ($this->getDispatchCommentBlocks()) {
+						$this->eventDispatcher->onCommentBlock($node->comment);
+					}
 					break;
 				case KeyNameTranslator::TYPE_DIVISION:
 					$this->eventDispatcher->onDivisionBlock();

src/Dispatcher/XmlDispatcher.php

@@ -4,7 +4,6 @@
 
 use Markdom\Dispatcher\EventDispatcher\SimpleMarkdomEventDispatcher;
 use Markdom\Dispatcher\Exception\DispatcherException;
-use Markdom\DispatcherInterface\DispatcherInterface;
 use Markdom\Handler\TypeNameTranslator\KeyNameTranslator;
 use Markdom\HandlerInterface\HandlerInterface;
 
@@ -13,7 +12,7 @@
  *
  * @package Markdom\Dispatcher
  */
-class XmlDispatcher implements DispatcherInterface
+class XmlDispatcher extends AbstractDispatcher
 {
 
 	/**
@@ -85,7 +84,9 @@ private function processBlocks(\DOMNodeList $blocks)
 					$this->eventDispatcher->onCodeBlock($node->textContent, $hint);
 					break;
 				case KeyNameTranslator::TYPE_COMMENT:
-					$this->eventDispatcher->onCommentBlock($node->textContent);
+					if ($this->getDispatchCommentBlocks()) {
+						$this->eventDispatcher->onCommentBlock($node->textContent);
+					}
 					break;
 				case KeyNameTranslator::TYPE_DIVISION:
 					$this->eventDispatcher->onDivisionBlock();