resolve #184

in the old implementation it wasn’t possible to have multiline
definitions

.travis.yml

@@ -7,3 +7,4 @@ php:
   - 5.3
   - 5.2
   - hhvm
+  

README.md

@@ -1,17 +1,17 @@
 ## Parsedown
 
-Better [Markdown](http://en.wikipedia.org/wiki/Markdown) parser for PHP.
+Better Markdown Parser in PHP
 
-- [Demo](http://parsedown.org/demo)
+[[ demo ]](http://parsedown.org/demo)
-- [Tests](http://parsedown.org/tests/)
 
 ### Features
 
 * [Fast](http://parsedown.org/speed)
 * [Consistent](http://parsedown.org/consistency)
-* [GitHub Flavored](https://help.github.com/articles/github-flavored-markdown)
+* [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/)
+* [Tested](http://parsedown.org/tests/) in PHP 5.2, 5.3, 5.4, 5.5, 5.6 and [hhvm](http://www.hhvm.com/)
-* Extensible
+* [Extensible](https://github.com/erusev/parsedown/wiki/Writing-Extensions)
+* [Markdown Extra extension](https://github.com/erusev/parsedown-extra)
 
 ### Installation
 
@@ -24,3 +24,25 @@ $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) and in [this video tutorial](http://youtu.be/wYZBY8DEikI).
+
+### Questions
+
+**How does Parsedown work?**
+
+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).
+
+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 Parsedown compliant with 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?**
+
+[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 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).

phpunit.xml.dist

@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit colors="true">
+<phpunit bootstrap="test/bootstrap.php" colors="true">
 	<testsuites>
 		<testsuite>
-			<file>tests/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,139 @@
+<?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));
+    }
+}

test/bootstrap.php

@@ -0,0 +1,3 @@
+<?php
+
+include 'Parsedown.php';

test/data/atx_heading.html

@@ -1,8 +1,9 @@
-<h1>h1</h1>
+<h1>h1</h1>
-<h2>h2</h2>
+<h2>h2</h2>
-<h3>h3</h3>
+<h3>h3</h3>
-<h4>h4</h4>
+<h4>h4</h4>
-<h5>h5</h5>
+<h5>h5</h5>
-<h6>h6</h6>
+<h6>h6</h6>
-<h1>closed h1</h1>
+<p>####### not a heading</p>
+<h1>closed h1</h1>
 <p>#</p>

test/data/atx_heading.md

@@ -1,15 +1,17 @@
-# h1
+# h1
-
+
-## h2
+## h2
-
+
-### h3
+### h3
-
+
-#### h4
+#### h4
-
+
-##### h5
+##### h5
-
+
-###### h6
+###### h6
-
+
-# closed h1 #
+####### not a heading
-
+
+# closed h1 #
+
 #

test/data/block-level_html.html

@@ -0,0 +1,13 @@
+<div>_content_</div>
+<p>sparse:</p>
+<div>
+<div class="inner">
+_content_
+</div>
+</div>
+<p>paragraph</p>
+<style type="text/css">
+    p {
+        color: red;
+    }
+</style>

test/data/block-level_html.md

@@ -0,0 +1,17 @@
+<div>_content_</div>
+
+sparse:
+
+<div>
+<div class="inner">
+_content_
+</div>
+</div>
+
+paragraph
+
+<style type="text/css">
+    p {
+        color: red;
+    }
+</style>

test/data/code_block.html

@@ -1,8 +1,8 @@
-<pre><code>&lt;?php
+<pre><code>&lt;?php
-
+
-$message = 'Hello World!';
+$message = 'Hello World!';
-echo $message;</code></pre>
+echo $message;</code></pre>
-<hr />
+<hr />
-<pre><code>&gt; not a quote
+<pre><code>&gt; not a quote
-- not a list item
+- not a list item
 [not a reference]: http://foo.com</code></pre>

test/data/code_block.md

@@ -1,10 +1,10 @@
-    <?php
+    <?php
-
+
-    $message = 'Hello World!';
+    $message = 'Hello World!';
-    echo $message;
+    echo $message;
-
+
----
+---
-
+
-    > not a quote
+    > not a quote
-    - not a list item
+    - not a list item
     [not a reference]: http://foo.com

test/data/deeply_nested_list.md

@@ -1,6 +1,6 @@
 - li
-  - li
     - li
+        - li
+        - li
     - li
-  - li
 - li

test/data/emphasis.html

@@ -1,8 +1,8 @@
-<p><em>underscore</em>, <em>asterisk</em>, <em>one two</em>, <em>three four</em>, <em>a</em>, <em>b</em></p>
+<p><em>underscore</em>, <em>asterisk</em>, <em>one two</em>, <em>three four</em>, <em>a</em>, <em>b</em></p>
-<p><strong>strong</strong> and <em>em</em> and <strong>strong</strong> and <em>em</em></p>
+<p><strong>strong</strong> and <em>em</em> and <strong>strong</strong> and <em>em</em></p>
-<p><em>line
+<p><em>line
-line
+line
-line</em></p>
+line</em></p>
-<p>this_is_not_an_emphasis</p>
+<p>this_is_not_an_emphasis</p>
-<p>an empty emphasis __ ** is not an emphasis</p>
+<p>an empty emphasis __ ** is not an emphasis</p>
 <p>*mixed *<em>double and</em> single asterisk** spans</p>

test/data/emphasis.md

@@ -1,13 +1,13 @@
-_underscore_, *asterisk*, _one two_, *three four*, _a_, *b*
+_underscore_, *asterisk*, _one two_, *three four*, _a_, *b*
-
+
-**strong** and *em* and **strong** and *em*
+**strong** and *em* and **strong** and *em*
-
+
-_line
+_line
-line
+line
-line_
+line_
-
+
-this_is_not_an_emphasis
+this_is_not_an_emphasis
-
+
-an empty emphasis __ ** is not an emphasis
+an empty emphasis __ ** is not an emphasis
-
+
 *mixed **double and* single asterisk** spans

test/data/escaping.html

@@ -1,4 +1,6 @@
 <p>escaped *emphasis*.</p>
 <p><code>escaped \*emphasis\* in a code span</code></p>
 <pre><code>escaped \*emphasis\* in a code block</code></pre>
-<p>\ ` * _ { } [ ] ( ) > # + - . !</p>
+<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

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

test/data/horizontal_rule.html

@@ -1,5 +1,5 @@
-<hr />
+<hr />
-<hr />
+<hr />
-<hr />
+<hr />
-<hr />
+<hr />
 <hr />

test/data/horizontal_rule.md

@@ -1,9 +1,9 @@
----
+---
-
+
-- - -
+- - -
-
+
-   - - -
+   - - -
-
+
-***
+***
-
+
 ___

test/data/html_comment.html

@@ -0,0 +1,5 @@
+<!-- single line -->
+<p>paragraph</p>
+<!-- 
+  multiline -->
+<p>paragraph</p>

test/data/html_comment.md

@@ -0,0 +1,8 @@
+<!-- single line -->
+
+paragraph
+
+<!-- 
+  multiline -->
+
+paragraph

test/data/image_reference.html

@@ -0,0 +1,2 @@
+<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

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

test/data/implicit_reference.html

@@ -1,3 +1,4 @@
 <p>an <a href="http://example.com">implicit</a> reference link</p>
 <p>an <a href="http://example.com">implicit</a> reference link with an empty link definition</p>
+<p>an <a href="http://example.com">implicit</a> reference link followed by <a href="http://cnn.com">another</a></p>
 <p>an <a href="http://example.com" title="Example">explicit</a> reference link with a title</p>

test/data/implicit_reference.md

@@ -4,6 +4,10 @@ an [implicit] reference link
 
 an [implicit][] reference link with an empty link definition
 
+an [implicit][] reference link followed by [another][]
+
+[another]: http://cnn.com
+
 an [explicit][example] reference link with a title
 
 [example]: http://example.com "Example"

test/data/inline_link.html

@@ -0,0 +1,4 @@
+<p><a href="http://example.com">link</a> and <a href="/url-with-(parentheses)">another link</a></p>
+<p><a href="http://example.com"><code>link</code></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,4 @@
-[link](http://example.com) and [another link](/tests/)
+[link](http://example.com) and [another link](/url-with-(parentheses))
 
 [`link`](http://example.com)
 

test/data/inline_link_title.html

@@ -0,0 +1,4 @@
+<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="2 Words">space</a></p>
+<p><a href="http://example.com/url-(parentheses)" title="Title">parentheses</a></p>

test/data/inline_link_title.md

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

test/data/lazy_blockquote.html

@@ -1,4 +1,6 @@
 <blockquote>
 <p>quote
 the rest of it</p>
+<p>another paragraph
+the rest of it</p>
 </blockquote>

test/data/lazy_blockquote.md

@@ -0,0 +1,5 @@
+> quote
+the rest of it
+
+> another paragraph
+the rest of it

test/data/line_break.html

@@ -1,2 +1,2 @@
-<p>line<br />
+<p>line<br />
 line</p>

test/data/line_break.md

@@ -1,2 +1,2 @@
-line  
+line  
 line

test/data/self-closing_html.html

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

test/data/self-closing_html.md

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

test/data/separated_nested_list.html

@@ -0,0 +1,9 @@
+<ul>
+<li>
+<p>li</p>
+<ul>
+<li>li</li>
+<li>li</li>
+</ul>
+</li>
+</ul>

test/data/separated_nested_list.md

@@ -0,0 +1,4 @@
+- li
+
+    - li
+    - li

test/data/setext_header.html

@@ -1,5 +1,5 @@
-<h1>h1</h1>
+<h1>h1</h1>
-<h2>h2</h2>
+<h2>h2</h2>
-<h2>single character</h2>
+<h2>single character</h2>
-<p>not a header</p>
+<p>not a header</p>
 <hr />

test/data/setext_header.md

@@ -1,12 +1,12 @@
-h1
+h1
-==
+==
-
+
-h2
+h2
---
+--
-
+
-single character
+single character
--
+-
-
+
-not a header
+not a header
-
+
 ------------

test/data/span-level_html.html

@@ -0,0 +1,5 @@
+<p>an <b>important</b> <a href=''>link</a></p>
+<p>broken<br/>
+line</p>
+<p><b>inline tag</b> at the beginning</p>
+<p><span><a href="http://example.com">http://example.com</a></span></p>

test/data/span-level_html.md

@@ -0,0 +1,8 @@
+an <b>important</b> <a href=''>link</a>
+
+broken<br/>
+line
+
+<b>inline tag</b> at the beginning
+
+<span>http://example.com</span>

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>AT&amp;T has an ampersand in their name</p>
-<p>this &amp; that</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="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="/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/special_characters.md

@@ -1,13 +1,13 @@
-AT&T has an ampersand in their name
+AT&T has an ampersand in their name
-
+
-this & that
+this & that
-
+
-4 < 5 and 6 > 5
+4 < 5 and 6 > 5
-
+
-<http://example.com/autolink?a=1&b=2>
+<http://example.com/autolink?a=1&b=2>
-
+
-[inline link](/script?a=1&b=2)
+[inline link](/script?a=1&b=2)
-
+
-[reference link][1]
+[reference link][1]
-
+
 [1]: http://example.com/?a=1&b=2

test/data/table_inline_markdown.html

@@ -11,8 +11,8 @@
 <td><del>cell</del> 1.2</td>
 </tr>
 <tr>
-<td><code>cell</code> 2.1</td>
+<td><code>|</code> 2.1</td>
-<td>cell 2.2</td>
+<td>| 2.2</td>
 </tr>
 </tbody>
 </table>