Added a bridge to the league/commonmark Markdown parser

README.md

@@ -9,12 +9,8 @@ An implementation of YAML Front matter for PHP. Can parse the YAML *and* the Mar
 
 Require the project with Composer:
 
-```json
-{
-    "require": {
-        "mnapoli/front-yaml": "*"
-    }
-}
+```
+composer require mnapoli/front-yaml
 ```
 
 ## Usage
@@ -80,3 +76,11 @@ interface MarkdownParser
 ```
 
 FrontYAML uses by default [Parsedown Markdown parser](http://parsedown.org/).
+
+An adapter to [League CommonMark](https://github.com/thephpleague/commonmark) is also included (you need to require the `league/commonmark` though):
+
+```php
+use \Mni\FrontYAML\Bridge\CommonMark\CommonMarkParser;
+
+$parser = new Mni\FrontYAML\Parser(null, new CommonMarkParser());
+```

composer.json

@@ -6,11 +6,17 @@
             "Mni\\FrontYAML\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "Mni\\FrontYAML\\Test\\": "tests/"
+        }
+    },
     "require": {
         "symfony/yaml": "~2.1",
         "erusev/parsedown": "~1.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "~4.0"
+        "phpunit/phpunit": "~4.5",
+        "league/commonmark": "~0.7"
     }
 }

src/Bridge/CommonMark/CommonMarkParser.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * FrontYAML
+ *
+ * @copyright Matthieu Napoli http://mnapoli.fr
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT (see the LICENSE file)
+ */
+
+namespace Mni\FrontYAML\Bridge\CommonMark;
+
+use League\CommonMark\CommonMarkConverter;
+use Mni\FrontYAML\Markdown\MarkdownParser;
+
+/**
+ * Bridge to the League CommonMark parser
+ *
+ * @author Matthieu Napoli <[email protected]>
+ */
+class CommonMarkParser implements MarkdownParser
+{
+    public function __construct(CommonMarkConverter $commonMarkConverter = null)
+    {
+        $this->parser = $commonMarkConverter ?: new CommonMarkConverter();
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function parse($markdown)
+    {
+        return $this->parser->convertToHtml($markdown);
+    }
+}

tests/Bridge/CommonMark/CommonMarkParserTest.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Mni\FrontYAML\Test\Bridge\CommonMark;
+
+use Mni\FrontYAML\Bridge\CommonMark\CommonMarkParser;
+
+class CommonMarkParserTest extends \PHPUnit_Framework_TestCase
+{
+    public function testParseWithDefaultParser()
+    {
+        $parser = new CommonMarkParser();
+
+        $html = $parser->parse('# This is a title');
+
+        $this->assertEquals("<h1>This is a title</h1>\n", $html);
+    }
+
+    public function testParseWithGivenParser()
+    {
+        $markdown = '# This is a title';
+        $html = "<h1>This is a title</h1>\n";
+
+        $commonMark = $this->getMock('League\CommonMark\CommonMarkConverter');
+        $commonMark->expects($this->once())
+            ->method('convertToHtml')
+            ->with($markdown)
+            ->willReturn($html);
+
+        $parser = new CommonMarkParser($commonMark);
+
+        $this->assertEquals($html, $parser->parse($markdown));
+    }
+}

tests/FunctionalTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Test\Mni\FrontYAML\Parser;
+namespace Mni\FrontYAML\Test;
 
 use Mni\FrontYAML\Bridge\Parsedown\ParsedownParser;
 use Mni\FrontYAML\Bridge\Symfony\SymfonyYAMLParser;

tests/ParserTest.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Test\Mni\FrontYAML\Parser;
+namespace Mni\FrontYAML\Test;
 
 use Mni\FrontYAML\Parser;