improve readme

Remove "tested in PHP 5.2"

.travis.yml

@@ -5,6 +5,4 @@ php:
   - 5.5
   - 5.4
   - 5.3
-  - 5.2
   - hhvm
-  

README.md

@@ -1,17 +1,20 @@
 ## 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)
-- [Tests](http://parsedown.org/tests/)
+Better Markdown Parser in PHP
+
+[See Demo](http://parsedown.org/demo)
 
 ### 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/)
-* Extensible
+* [GitHub flavored](https://help.github.com/articles/github-flavored-markdown)
+* [Tested](http://parsedown.org/tests/) in PHP 5.3, 5.4, 5.5, 5.6 and [HHVM](http://www.hhvm.com/)
+* [Extensible](https://github.com/erusev/parsedown/wiki/Writing-Extensions)
+* [Markdown Extra extension](https://github.com/erusev/parsedown-extra)
 
 ### Installation
 
@@ -24,3 +27,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 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 some money](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=528P3NZQMP8N2).

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

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/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/html_simple.html

@@ -1,28 +0,0 @@
-<p>Headings:</p>
-<h2 id="overview">Overview</h2>
-<p>blah</p>
-<H2 id="block">Block Elements</H2>
-<p>blah</p>
-<h3 id="span">
-      Span Elements
-</h3>
-<p>blah</p>
-<p>Hr's:</p>
-<hr>
-<p>blah</p>
-<hr/>
-<p>blah</p>
-<hr />
-<p>blah</p>
-<hr>   
-<p>blah</p>
-<hr/>  
-<p>blah</p>
-<hr /> 
-<p>blah</p>
-<hr class="foo" id="bar" />
-<p>blah</p>
-<hr class="foo" id="bar"/>
-<p>blah</p>
-<hr class="foo" id="bar" >
-<p>blah</p>

test/data/html_simple.md

@@ -1,39 +0,0 @@
-Headings:
-
-<h2 id="overview">Overview</h2>
-blah
-<H2 id="block">Block Elements</H2>
-blah
-<h3 id="span">
-      Span Elements
-</h3>
-blah
-
-Hr's:
-
-<hr>
-blah
-
-<hr/>
-blah
-
-<hr />
-blah
-
-<hr>   
-blah
-
-<hr/>  
-blah
-
-<hr /> 
-blah
-
-<hr class="foo" id="bar" />
-blah
-
-<hr class="foo" id="bar"/>
-blah
-
-<hr class="foo" id="bar" >
-blah

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")
+![alt](/md.png "title")
+
+![blank title](/md.png "")

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

@@ -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/self-closing_block-level_html.html

@@ -1,4 +0,0 @@
-<hr />
-<p>attributes:</p>
-<hr style="background: #9bd;" />
-<p>...</p>

test/data/self-closing_block-level_html.md

@@ -1,7 +0,0 @@
-<hr />
-
-attributes:
-
-<hr style="background: #9bd;" />
-
-...

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/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/span-level_html.html

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

@@ -3,4 +3,6 @@ an <b>important</b> <a href=''>link</a>
 broken<br/>
 line
 
-<b>inline tag</b> at the beginning
+<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>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](/)    |