1.6.0

Use late static binding for Parsedown::instance()

.travis.yml

@@ -1,10 +1,16 @@
 language: php
 
 php:
+  - 7.0
   - 5.6
   - 5.5
   - 5.4
   - 5.3
-  - 5.2
   - hhvm
+  - hhvm-nightly
 
+matrix:
+  fast_finish: true
+  allow_failures:
+    - php: 7.0
+    - php: hhvm-nightly

README.md

@@ -1,18 +1,22 @@
 ## Parsedown
 
-Better [Markdown](http://en.wikipedia.org/wiki/Markdown) parser for PHP.
+[![Build Status](https://img.shields.io/travis/erusev/parsedown/master.svg?style=flat-square)](https://travis-ci.org/erusev/parsedown)
+<!--[![Total Downloads](http://img.shields.io/packagist/dt/erusev/parsedown.svg?style=flat-square)](https://packagist.org/packages/erusev/parsedown)-->
 
-* [Demo](http://parsedown.org/demo)
-* [Test Suite](http://parsedown.org/tests/)
+Better Markdown Parser in PHP
+
+[Demo](http://parsedown.org/demo) |
+[Benchmarks](http://parsedown.org/speed) |
+[Tests](http://parsedown.org/tests/) |
+[Documentation](https://github.com/erusev/parsedown/wiki/)
 
 ### Features
 
-* [Fast](http://parsedown.org/speed)
-* [Consistent](http://parsedown.org/consistency)
-* [GitHub Flavored](https://help.github.com/articles/github-flavored-markdown)
-* [Tested](https://travis-ci.org/erusev/parsedown) in PHP 5.2, 5.3, 5.4, 5.5, 5.6 and [hhvm](http://www.hhvm.com/)
+* Super Fast
+* [GitHub flavored](https://help.github.com/articles/github-flavored-markdown)
 * Extensible
-* [Markdown Extra extension](https://github.com/erusev/parsedown-extra) <sup>new</sup>
+* Tested in 5.3 to 5.6
+* [Markdown Extra extension](https://github.com/erusev/parsedown-extra)
 
 ### Installation
 
@@ -26,15 +30,28 @@ $Parsedown = new Parsedown();
 echo $Parsedown->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>
 ```
 
-More examples in [the wiki](https://github.com/erusev/parsedown/wiki/Usage).
+More examples in [the wiki](https://github.com/erusev/parsedown/wiki/) and in [this video tutorial](http://youtu.be/wYZBY8DEikI).
 
 ### Questions
 
-**How does Parsedown work?**<br/>
-Parsedown recognises that the Markdown syntax is optimised for humans so it tries to read like one. It goes through text line by line. It looks at how lines start to identify blocks. It looks for special characters to identify inline elements.
+**How does Parsedown work?**
 
-**Why doesn’t Parsedown use namespaces?**<br/>
-Using namespaces would mean dropping support for PHP 5.2. Since Parsedown is a single class with an uncommon name, making this trade wouldn't make much sense.
+It tries to read Markdown like a human. First, it looks at the lines. It’s interested in how the lines start. This helps it recognise blocks. It knows, for example, that if a line start with a `-` then it perhaps belong to a list. Once it recognises the blocks, it continues to the content. As it reads, it watches out for special characters. This helps it recognise inline elements (or inlines).
 
-**Who uses Parsedown?**<br/>
-[phpDocumentor](http://www.phpdoc.org/), [Bolt CMS](http://bolt.cm/), [RaspberryPi.org](http://www.raspberrypi.org/) and [more](https://www.versioneye.com/php/erusev:parsedown/references).
+We call this approach "line based". We believe that Parsedown is the first Markdown parser to use it. Since the release of Parsedown, other developers have used the same approach to develop other Markdown parsers in PHP and in other languages.
+
+**Is it compliant with CommonMark?**
+
+It passes most of the CommonMark tests. Most of the tests that don't pass deal with cases that are quite uncommon. Still, as CommonMark matures, compliance should improve.
+
+**Who uses it?**
+
+[phpDocumentor](http://www.phpdoc.org/), [October CMS](http://octobercms.com/), [Bolt CMS](http://bolt.cm/), [Kirby CMS](http://getkirby.com/), [Grav CMS](http://getgrav.org/), [Statamic CMS](http://www.statamic.com/),  [RaspberryPi.org](http://www.raspberrypi.org/) and [more](https://www.versioneye.com/php/erusev:parsedown/references).
+
+**How can I help?**
+
+Use it, star it, share it and if you feel generous, [donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=528P3NZQMP8N2).
+
+---
+
+You might also like [Caret](http://caret.io) - our Markdown editor for the desktop.

phpunit.xml.dist

@@ -2,7 +2,7 @@
 <phpunit bootstrap="test/bootstrap.php" colors="true">
 	<testsuites>
 		<testsuite>
-			<file>test/Test.php</file>
+			<file>test/ParsedownTest.php</file>
 		</testsuite>
 	</testsuites>
 </phpunit>

test/CommonMarkTest.php

@@ -0,0 +1,74 @@
+<?php
+
+/**
+ * Test Parsedown against the CommonMark spec.
+ *
+ * Some code based on the original JavaScript test runner by jgm.
+ *
+ * @link http://commonmark.org/ CommonMark
+ * @link http://git.io/8WtRvQ JavaScript test runner
+ */
+class CommonMarkTest extends PHPUnit_Framework_TestCase
+{
+    const SPEC_URL = 'https://raw.githubusercontent.com/jgm/stmd/master/spec.txt';
+
+    /**
+     * @dataProvider data
+     * @param $section
+     * @param $markdown
+     * @param $expectedHtml
+     */
+    function test_($section, $markdown, $expectedHtml)
+    {
+        $Parsedown = new Parsedown();
+        $Parsedown->setUrlsLinked(false);
+
+        $actualHtml = $Parsedown->text($markdown);
+        $actualHtml = $this->normalizeMarkup($actualHtml);
+
+        $this->assertEquals($expectedHtml, $actualHtml);
+    }
+
+    function data()
+    {
+        $spec = file_get_contents(self::SPEC_URL);
+        $spec = strstr($spec, '<!-- END TESTS -->', true);
+
+        $tests = array();
+        $currentSection = '';
+
+        preg_replace_callback(
+            '/^\.\n([\s\S]*?)^\.\n([\s\S]*?)^\.$|^#{1,6} *(.*)$/m',
+            function($matches) use ( & $tests, & $currentSection, & $testCount) {
+                if (isset($matches[3]) and $matches[3]) {
+                    $currentSection = $matches[3];
+                } else {
+                    $testCount++;
+                    $markdown = $matches[1];
+                    $markdown = preg_replace('/→/', "\t", $markdown);
+                    $expectedHtml = $matches[2];
+                    $expectedHtml = $this->normalizeMarkup($expectedHtml);
+                    $tests []= array(
+                        $currentSection, # section
+                        $markdown, # markdown
+                        $expectedHtml, # html
+                    );
+                }
+            },
+            $spec
+        );
+
+        return $tests;
+    }
+
+    private function normalizeMarkup($markup)
+    {
+        $markup = preg_replace("/\n+/", "\n", $markup);
+        $markup = preg_replace('/^\s+/m', '', $markup);
+        $markup = preg_replace('/^((?:<[\w]+>)+)\n/m', '$1', $markup);
+        $markup = preg_replace('/\n((?:<\/[\w]+>)+)$/m', '$1', $markup);
+        $markup = trim($markup);
+
+        return $markup;
+    }
+}

test/ParsedownTest.php

@@ -0,0 +1,159 @@
+<?php
+
+class ParsedownTest extends PHPUnit_Framework_TestCase
+{
+    final function __construct($name = null, array $data = array(), $dataName = '')
+    {
+        $this->dirs = $this->initDirs();
+        $this->Parsedown = $this->initParsedown();
+
+        parent::__construct($name, $data, $dataName);
+    }
+
+    private $dirs, $Parsedown;
+
+    /**
+     * @return array
+     */
+    protected function initDirs()
+    {
+        $dirs []= dirname(__FILE__).'/data/';
+
+        return $dirs;
+    }
+
+    /**
+     * @return Parsedown
+     */
+    protected function initParsedown()
+    {
+        $Parsedown = new Parsedown();
+
+        return $Parsedown;
+    }
+
+    /**
+     * @dataProvider data
+     * @param $test
+     * @param $dir
+     */
+    function test_($test, $dir)
+    {
+        $markdown = file_get_contents($dir . $test . '.md');
+
+        $expectedMarkup = file_get_contents($dir . $test . '.html');
+
+        $expectedMarkup = str_replace("\r\n", "\n", $expectedMarkup);
+        $expectedMarkup = str_replace("\r", "\n", $expectedMarkup);
+
+        $actualMarkup = $this->Parsedown->text($markdown);
+
+        $this->assertEquals($expectedMarkup, $actualMarkup);
+    }
+
+    function data()
+    {
+        $data = array();
+
+        foreach ($this->dirs as $dir)
+        {
+            $Folder = new DirectoryIterator($dir);
+
+            foreach ($Folder as $File)
+            {
+                /** @var $File DirectoryIterator */
+
+                if ( ! $File->isFile())
+                {
+                    continue;
+                }
+
+                $filename = $File->getFilename();
+
+                $extension = pathinfo($filename, PATHINFO_EXTENSION);
+
+                if ($extension !== 'md')
+                {
+                    continue;
+                }
+
+                $basename = $File->getBasename('.md');
+
+                if (file_exists($dir . $basename . '.html'))
+                {
+                    $data []= array($basename, $dir);
+                }
+            }
+        }
+
+        return $data;
+    }
+
+    public function test_no_markup()
+    {
+        $markdownWithHtml = <<<MARKDOWN_WITH_MARKUP
+<div>_content_</div>
+
+sparse:
+
+<div>
+<div class="inner">
+_content_
+</div>
+</div>
+
+paragraph
+
+<style type="text/css">
+    p {
+        color: red;
+    }
+</style>
+
+comment
+
+<!-- html comment -->
+MARKDOWN_WITH_MARKUP;
+
+        $expectedHtml = <<<EXPECTED_HTML
+<p>&lt;div&gt;<em>content</em>&lt;/div&gt;</p>
+<p>sparse:</p>
+<p>&lt;div&gt;
+&lt;div class=&quot;inner&quot;&gt;
+<em>content</em>
+&lt;/div&gt;
+&lt;/div&gt;</p>
+<p>paragraph</p>
+<p>&lt;style type=&quot;text/css&quot;&gt;
+p {
+color: red;
+}
+&lt;/style&gt;</p>
+<p>comment</p>
+<p>&lt;!-- html comment --&gt;</p>
+EXPECTED_HTML;
+        $parsedownWithNoMarkup = new Parsedown();
+        $parsedownWithNoMarkup->setMarkupEscaped(true);
+        $this->assertEquals($expectedHtml, $parsedownWithNoMarkup->text($markdownWithHtml));
+    }
+
+    public function testLateStaticBinding()
+    {
+        include 'test/TestParsedown.php';
+
+        $parsedown = Parsedown::instance();
+        $this->assertInstanceOf('Parsedown', $parsedown);
+
+        // After instance is already called on Parsedown
+        // subsequent calls with the same arguments return the same instance
+        $sameParsedown = TestParsedown::instance();
+        $this->assertInstanceOf('Parsedown', $sameParsedown);
+        $this->assertSame($parsedown, $sameParsedown);
+
+        $testParsedown = TestParsedown::instance('test late static binding');
+        $this->assertInstanceOf('TestParsedown', $testParsedown);
+
+        $sameInstanceAgain = TestParsedown::instance('test late static binding');
+        $this->assertSame($testParsedown, $sameInstanceAgain);
+    }
+}

test/Test.php

@@ -1,65 +0,0 @@
-<?php
-
-class Test extends PHPUnit_Framework_TestCase
-{
-    public function __construct($name = null, array $data = array(), $dataName = '')
-    {
-        $this->dataDir = dirname(__FILE__).'/data/';
-
-        parent::__construct($name, $data, $dataName);
-    }
-
-    private $dataDir;
-
-    /**
-     * @dataProvider data
-     */
-    function test_($filename)
-    {
-        $markdown = file_get_contents($this->dataDir . $filename . '.md');
-
-        $expectedMarkup = file_get_contents($this->dataDir . $filename . '.html');
-
-        $expectedMarkup = str_replace("\r\n", "\n", $expectedMarkup);
-        $expectedMarkup = str_replace("\r", "\n", $expectedMarkup);
-
-        $actualMarkup = Parsedown::instance()->text($markdown);
-
-        $this->assertEquals($expectedMarkup, $actualMarkup);
-    }
-
-    function data()
-    {
-        $data = array();
-
-        $Folder = new DirectoryIterator($this->dataDir);
-
-        foreach ($Folder as $File)
-        {
-            /** @var $File DirectoryIterator */
-
-            if ( ! $File->isFile())
-            {
-                continue;
-            }
-
-            $filename = $File->getFilename();
-
-            $extension = pathinfo($filename, PATHINFO_EXTENSION);
-
-            if ($extension !== 'md')
-            {
-                continue;
-            }
-
-            $basename = $File->getBasename('.md');
-
-            if (file_exists($this->dataDir . $basename . '.html'))
-            {
-                $data []= array($basename);
-            }
-        }
-
-        return $data;
-    }
-}

test/TestParsedown.php

@@ -0,0 +1,5 @@
+<?php
+
+class TestParsedown extends Parsedown
+{
+}

test/data/aligned_table.html

@@ -1,21 +1,21 @@
 <table>
 <thead>
 <tr>
-<th align="left">header 1</th>
-<th align="center">header 2</th>
-<th align="right">header 2</th>
+<th style="text-align: left;">header 1</th>
+<th style="text-align: center;">header 2</th>
+<th style="text-align: right;">header 2</th>
 </tr>
 </thead>
 <tbody>
 <tr>
-<td align="left">cell 1.1</td>
-<td align="center">cell 1.2</td>
-<td align="right">cell 1.3</td>
+<td style="text-align: left;">cell 1.1</td>
+<td style="text-align: center;">cell 1.2</td>
+<td style="text-align: right;">cell 1.3</td>
 </tr>
 <tr>
-<td align="left">cell 2.1</td>
-<td align="center">cell 2.2</td>
-<td align="right">cell 2.3</td>
+<td style="text-align: left;">cell 2.1</td>
+<td style="text-align: center;">cell 2.2</td>
+<td style="text-align: right;">cell 2.3</td>
 </tr>
 </tbody>
 </table>

test/data/atx_heading.html

@@ -4,5 +4,6 @@
 <h4>h4</h4>
 <h5>h5</h5>
 <h6>h6</h6>
+<p>####### not a heading</p>
 <h1>closed h1</h1>
 <p>#</p>

test/data/atx_heading.md

@@ -10,6 +10,8 @@
 
 ###### h6
 
+####### not a heading
+
 # closed h1 #
 
 #

test/data/block-level_html.html

@@ -1,8 +1,12 @@
 <div>_content_</div>
-<p>sparse:</p>
-<div>
-<div class="inner">
-_content_
-</div>
-</div>
 <p>paragraph</p>
+<div>
+  <div class="inner">
+    _content_
+  </div>
+</div>
+<style type="text/css">
+  p {color: #789;}
+</style>
+<div>
+  <a href="/">home</a></div>

test/data/block-level_html.md

@@ -1,11 +1,16 @@
 <div>_content_</div>
 
-sparse:
+paragraph
 
 <div>
-<div class="inner">
-_content_
-</div>
+  <div class="inner">
+    _content_
+  </div>
 </div>
 
-paragraph
+<style type="text/css">
+  p {color: #789;}
+</style>
+
+<div>
+  <a href="/">home</a></div>

test/data/escaping.html

@@ -2,3 +2,5 @@
 <p><code>escaped \*emphasis\* in a code span</code></p>
 <pre><code>escaped \*emphasis\* in a code block</code></pre>
 <p>\ ` * _ { } [ ] ( ) > # + - . !</p>
+<p><em>one_two</em> <strong>one_two</strong></p>
+<p><em>one*two</em> <strong>one*two</strong></p>

test/data/escaping.md

@@ -5,3 +5,7 @@ escaped \*emphasis\*.
     escaped \*emphasis\* in a code block
 
 \\ \` \* \_ \{ \} \[ \] \( \) \> \# \+ \- \. \!
+
+_one\_two_ __one\_two__
+
+*one\*two* **one\*two**

test/data/image_reference.html

@@ -1 +1,2 @@
-<p><img alt="Markdown Logo" src="/md.png" /></p>
+<p><img src="/md.png" alt="Markdown Logo" /></p>
+<p>![missing reference]</p>

test/data/image_reference.md

@@ -1,3 +1,5 @@
 ![Markdown Logo][image]
 
 [image]: /md.png
+
+![missing reference]

test/data/image_title.html

@@ -1 +1,2 @@
-<p><img alt="alt" src="/md.png" title="title" /></p>
+<p><img src="/md.png" alt="alt" title="title" /></p>
+<p><img src="/md.png" alt="blank title" title="" /></p>

test/data/image_title.md

@@ -1 +1,3 @@
 ![alt](/md.png "title")
+
+![blank title](/md.png "")

test/data/inline_link.html

@@ -1,4 +1,6 @@
-<p><a href="http://example.com">link</a> and <a href="/tests/">another link</a></p>
+<p><a href="http://example.com">link</a></p>
+<p><a href="/url-(parentheses)">link</a> with parentheses in URL </p>
+<p>(<a href="/index.php">link</a>) in parentheses</p>
 <p><a href="http://example.com"><code>link</code></a></p>
-<p><a href="http://example.com"><img alt="MD Logo" src="http://parsedown.org/md.png" /></a></p>
-<p><a href="http://example.com"><img alt="MD Logo" src="http://parsedown.org/md.png" /> and text</a></p>
+<p><a href="http://example.com"><img src="http://parsedown.org/md.png" alt="MD Logo" /></a></p>
+<p><a href="http://example.com"><img src="http://parsedown.org/md.png" alt="MD Logo" /> and text</a></p>

test/data/inline_link.md

@@ -1,4 +1,8 @@
-[link](http://example.com) and [another link](/tests/)
+[link](http://example.com)
+
+[link](/url-(parentheses)) with parentheses in URL 
+
+([link](/index.php)) in parentheses
 
 [`link`](http://example.com)
 

test/data/inline_link_title.html

@@ -1 +1,6 @@
-<p><a href="http://example.com" title="Title">single quotes</a> and <a href="http://example.com" title="Title">double quotes</a></p>
+<p><a href="http://example.com" title="Title">single quotes</a></p>
+<p><a href="http://example.com" title="Title">double quotes</a></p>
+<p><a href="http://example.com" title="">single quotes blank</a></p>
+<p><a href="http://example.com" title="">double quotes blank</a></p>
+<p><a href="http://example.com" title="2 Words">space</a></p>
+<p><a href="http://example.com/url-(parentheses)" title="Title">parentheses</a></p>

test/data/inline_link_title.md

@@ -1 +1,11 @@
-[single quotes](http://example.com 'Title') and [double quotes](http://example.com "Title")
+[single quotes](http://example.com 'Title')
+
+[double quotes](http://example.com "Title")
+
+[single quotes blank](http://example.com '')
+
+[double quotes blank](http://example.com "")
+
+[space](http://example.com "2 Words")
+
+[parentheses](http://example.com/url-(parentheses) "Title")

test/data/simple_table.html

@@ -20,17 +20,17 @@
 <table>
 <thead>
 <tr>
-<th align="left">header 1</th>
+<th style="text-align: left;">header 1</th>
 <th>header 2</th>
 </tr>
 </thead>
 <tbody>
 <tr>
-<td align="left">cell 1.1</td>
+<td style="text-align: left;">cell 1.1</td>
 <td>cell 1.2</td>
 </tr>
 <tr>
-<td align="left">cell 2.1</td>
+<td style="text-align: left;">cell 2.1</td>
 <td>cell 2.2</td>
 </tr>
 </tbody>

test/data/sparse_html.html

@@ -0,0 +1,8 @@
+<div>
+line 1
+
+line 2
+line 3
+
+line 4
+</div>

test/data/sparse_html.md

@@ -0,0 +1,8 @@
+<div>
+line 1
+
+line 2
+line 3
+
+line 4
+</div>

test/data/special_characters.html

@@ -1,6 +1,6 @@
 <p>AT&amp;T has an ampersand in their name</p>
 <p>this &amp; that</p>
-<p>4 &lt; 5 and 6 > 5</p>
+<p>4 &lt; 5 and 6 &gt; 5</p>
 <p><a href="http://example.com/autolink?a=1&amp;b=2">http://example.com/autolink?a=1&amp;b=2</a></p>
 <p><a href="/script?a=1&amp;b=2">inline link</a></p>
 <p><a href="http://example.com/?a=1&amp;b=2">reference link</a></p>

test/data/table_inline_markdown.html

@@ -11,8 +11,12 @@
 <td><del>cell</del> 1.2</td>
 </tr>
 <tr>
-<td><code>cell</code> 2.1</td>
-<td>cell 2.2</td>
+<td><code>|</code> 2.1</td>
+<td>| 2.2</td>
+</tr>
+<tr>
+<td><code>\|</code> 2.1</td>
+<td><a href="/">link</a></td>
 </tr>
 </tbody>
 </table>

test/data/table_inline_markdown.md

@@ -1,4 +1,5 @@
 | _header_ 1   | header 2     |
 | ------------ | ------------ |
 | _cell_ 1.1   | ~~cell~~ 1.2 |
-| `cell` 2.1   | cell 2.2     |
+| `|` 2.1      | \| 2.2       |
+| `\|` 2.1     | [link](/)    |