update readme

Conflicts:
	Parsedown.php
	phpunit.xml.dist
	test/ParsedownTest.php

README.md

@@ -11,8 +11,8 @@ Better Markdown Parser in PHP
 * [GitHub flavored](https://help.github.com/articles/github-flavored-markdown)
 * [Tested](http://parsedown.org/tests/) in PHP 5.2, 5.3, 5.4, 5.5, 5.6 and [hhvm](http://www.hhvm.com/)
 * Extensible
-* [Markdown Extra extension](https://github.com/erusev/parsedown-extra) <sup>new</sup>
-* [JavaScript port](https://github.com/hkdobrev/parsedown.js) under development <sup>new</sup>
+* [Markdown Extra extension](https://github.com/erusev/parsedown-extra)
+* [JavaScript port](https://github.com/hkdobrev/parsedown.js) under development
 
 ### Installation
 
@@ -31,13 +31,16 @@ More examples in [the wiki](https://github.com/erusev/parsedown/wiki/Usage) and
 ### 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.
+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).
 
 **Why doesn’t Parsedown use namespaces?**<br/>
-Using namespaces would mean dropping support for PHP 5.2. We believe that since Parsedown is a single class with an uncommon name, making this trade wouldn't be worth it.
+It'd mean no support for PHP 5.2. Would it be worth it?
 
 **Is Parsedown compliant with CommonMark?**<br/>
-We are [working on it](https://github.com/erusev/parsedown/tree/commonmark).
+The majority of the CommonMark tests pass. Most of the tests that don't pass deal with cases that are quite extreme. Yet, we are working on them. As CommonMark matures, compliance should improve.
 
 **Who uses Parsedown?**<br/>
-[phpDocumentor](http://www.phpdoc.org/), [October CMS](http://octobercms.com/), [Bolt CMS](http://bolt.cm/), [RaspberryPi.org](http://www.raspberrypi.org/) and [more](https://www.versioneye.com/php/erusev:parsedown/references).
+[phpDocumentor](http://www.phpdoc.org/), [October CMS](http://octobercms.com/), [Bolt CMS](http://bolt.cm/), [Kirby CMS](http://getkirby.com/),  [RaspberryPi.org](http://www.raspberrypi.org/) and [more](https://www.versioneye.com/php/erusev:parsedown/references).
+
+**How can I help?**<br/>
+Use the project, tell friends about it and if you feel generous, [donate some money](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=528P3NZQMP8N2).

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

@@ -116,21 +116,21 @@ comment
 MARKDOWN_WITH_MARKUP;
 
         $expectedHtml = <<<EXPECTED_HTML
-<p>&lt;div><em>content</em>&lt;/div></p>
+<p>&lt;div&gt;<em>content</em>&lt;/div&gt;</p>
 <p>sparse:</p>
-<p>&lt;div>
-&lt;div class="inner">
+<p>&lt;div&gt;
+&lt;div class=&quot;inner&quot;&gt;
 <em>content</em>
-&lt;/div>
-&lt;/div></p>
+&lt;/div&gt;
+&lt;/div&gt;</p>
 <p>paragraph</p>
-<p>&lt;style type="text/css"></p>
-<pre><code>p {
-    color: red;
-}</code></pre>
-<p>&lt;/style></p>
+<p>&lt;style type=&quot;text/css&quot;&gt;
+p {
+color: red;
+}
+&lt;/style&gt;</p>
 <p>comment</p>
-<p>&lt;!-- html comment --></p>
+<p>&lt;!-- html comment --&gt;</p>
 EXPECTED_HTML;
         $parsedownWithNoMarkup = new Parsedown();
         $parsedownWithNoMarkup->setMarkupEscaped(true);

test/data/atx_heading.html

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

test/data/atx_heading.md

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

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 @@
-<p><img alt="alt" src="/md.png" title="title" /></p>
+<p><img src="/md.png" alt="alt" title="title" /></p>

test/data/inline_link.html

@@ -1,4 +1,4 @@
 <p><a href="http://example.com">link</a> and <a href="/tests/">another link</a></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/self-closing_html.html

@@ -1,12 +1,12 @@
-<hr>
+<hr />
 <p>paragraph</p>
-<hr/>
+<hr />
 <p>paragraph</p>
 <hr />
 <p>paragraph</p>
 <hr class="foo" id="bar" />
 <p>paragraph</p>
-<hr class="foo" id="bar"/>
+<hr class="foo" id="bar" />
 <p>paragraph</p>
-<hr class="foo" id="bar" >
+<hr class="foo" id="bar" />
 <p>paragraph</p>

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>