improve test suite

Parsedown.php

@@ -18,11 +18,10 @@ class Parsedown
     #
     # Philosophy
 
-    # Markdown is intended to be easy-to-read by humans - those of us who read
+    # Parsedown recognises that the Markdown syntax is optimised for humans so
-    # line by line, left to right, top to bottom. In order to take advantage of
+    # it tries to read like one. It goes through text line by line. It looks at
-    # this, Parsedown tries to read in a similar way. It breaks texts into
+    # how lines start to identify blocks. It looks for special characters to
-    # lines, it iterates through them and it looks at how they start and relate
+    # identify inline elements.
-    # to each other.
 
     #
     # ~
@@ -87,7 +86,7 @@ class Parsedown
         '8' => array('List'),
         '9' => array('List'),
         ':' => array('Table'),
-        '<' => array('Markup'),
+        '<' => array('Comment', 'Markup'),
         '=' => array('Setext'),
         '>' => array('Quote'),
         '_' => array('Rule'),
@@ -346,6 +345,43 @@ class Parsedown
         return $Block;
     }
 
+    #
+    # Comment
+
+    protected function identifyComment($Line)
+    {
+        if (isset($Line['text'][3]) and $Line['text'][3] === '-' and $Line['text'][2] === '-' and $Line['text'][1] === '!')
+        {
+            $Block = array(
+                'element' => $Line['body'],
+            );
+
+            if (preg_match('/-->$/', $Line['text']))
+            {
+                $Block['closed'] = true;
+            }
+
+            return $Block;
+        }
+    }
+
+    protected function addToComment($Line, array $Block)
+    {
+        if (isset($Block['closed']))
+        {
+            return;
+        }
+
+        $Block['element'] .= "\n" . $Line['body'];
+
+        if (preg_match('/-->$/', $Line['text']))
+        {
+            $Block['closed'] = true;
+        }
+
+        return $Block;
+    }
+
     #
     # Fenced Code
 
@@ -601,8 +637,7 @@ class Parsedown
             else
             {
                 $Block['depth'] = 0;
-                $Block['start'] = '<'.$matches[1].'>';
+                $Block['name'] = $matches[1];
-                $Block['end'] = '</'.$matches[1].'>';
             }
 
             return $Block;
@@ -616,12 +651,12 @@ class Parsedown
             return;
         }
 
-        if (stripos($Line['text'], $Block['start']) !== false) # opening tag
+        if (preg_match('/<'.$Block['name'].'([ ][^\/]+)?>/', $Line['text'])) # opening tag
         {
             $Block['depth'] ++;
         }
 
-        if (stripos($Line['text'], $Block['end']) !== false) # closing tag
+        if (stripos($Line['text'], '</'.$Block['name'].'>') !== false) # closing tag
         {
             if ($Block['depth'] > 0)
             {

README.md

@@ -2,8 +2,8 @@
 
 Better [Markdown](http://en.wikipedia.org/wiki/Markdown) parser for PHP.
 
-- [Demo](http://parsedown.org/demo)
+* [Demo](http://parsedown.org/demo)
-- [Tests](http://parsedown.org/tests/)
+* [Test Suite](http://parsedown.org/tests/)
 
 ### Features
 
@@ -12,6 +12,7 @@ Better [Markdown](http://en.wikipedia.org/wiki/Markdown) parser for PHP.
 * [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
+* [Markdown Extra extension](https://github.com/erusev/parsedown-extra) <sup>new</sup>
 
 ### Installation
 
@@ -24,3 +25,16 @@ $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).
+
+### 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.
+
+**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.
+
+**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).

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

@@ -1,5 +1,8 @@
 <div>_content_</div>
 <p>sparse:</p>
 <div>
+<div class="inner">
 _content_
-</div>
+</div>
+</div>
+<p>paragraph</p>

test/data/block-level_html.md

@@ -3,5 +3,9 @@
 sparse:
 
 <div>
+<div class="inner">
 _content_
-</div>
+</div>
+</div>
+
+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/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