Bump version const to 1.8.0-beta-1

Update readme install instructions

.gitattributes

@@ -1,5 +1,6 @@
 # Ignore all tests for archive
 /test               export-ignore
 /.gitattributes     export-ignore
+/.gitignore         export-ignore
 /.travis.yml        export-ignore
 /phpunit.xml.dist   export-ignore

.gitignore

@@ -0,0 +1,2 @@
+composer.lock
+vendor/

.travis.yml

@@ -13,11 +13,13 @@ matrix:
     - php: 7.0
     - php: 7.1
     - php: 7.2
-    - php: 7.3
     - php: nightly
+    - php: hhvm
+    - php: hhvm-nightly
   fast_finish: true
   allow_failures:
     - php: nightly
+    - php: hhvm-nightly
 
 install:
   - composer install --prefer-dist --no-interaction --no-progress

README.md

@@ -19,12 +19,21 @@ Better Markdown Parser in PHP
 * Super Fast
 * Extensible
 * [GitHub flavored](https://help.github.com/articles/github-flavored-markdown)
-* Tested in 5.3 to 7.1 and in HHVM
+* Tested in 5.3 to 7.2 and in HHVM
 * [Markdown Extra extension](https://github.com/erusev/parsedown-extra)
 
 ### Installation
+#### Composer
+Install the [composer package] by running the following command:
 
-Include `Parsedown.php` or install [the composer package](https://packagist.org/packages/erusev/parsedown).
+    composer require erusev/parsedown
+
+#### Manual
+1. Download the "Source code" from the [latest release]
+2. Include `Parsedown.php`
+
+[composer package]: https://packagist.org/packages/erusev/parsedown "The Parsedown package on packagist.org"
+[latest release]: https://github.com/erusev/parsedown/releases/latest "The latest release of Parsedown"
 
 ### Example
 
@@ -32,6 +41,8 @@ Include `Parsedown.php` or install [the composer package](https://packagist.org/
 $Parsedown = new Parsedown();
 
 echo $Parsedown->text('Hello _Parsedown_!'); # prints: <p>Hello <em>Parsedown</em>!</p>
+// you can also parse inline markdown only
+echo $Parsedown->line('Hello _Parsedown_!'); # prints: Hello <em>Parsedown</em>!
 ```
 
 More examples in [the wiki](https://github.com/erusev/parsedown/wiki/) and in [this video tutorial](http://youtu.be/wYZBY8DEikI).

test/ParsedownTest.php

@@ -1,4 +1,5 @@
 <?php
+require 'SampleExtensions.php';
 
 use PHPUnit\Framework\TestCase;
 
@@ -12,7 +13,8 @@ class ParsedownTest extends TestCase
         parent::__construct($name, $data, $dataName);
     }
 
-    private $dirs, $Parsedown;
+    private $dirs;
+    protected $Parsedown;
 
     /**
      * @return array
@@ -49,12 +51,48 @@ class ParsedownTest extends TestCase
         $expectedMarkup = str_replace("\r", "\n", $expectedMarkup);
 
         $this->Parsedown->setSafeMode(substr($test, 0, 3) === 'xss');
+        $this->Parsedown->setStrictMode(substr($test, 0, 6) === 'strict');
+        $this->Parsedown->setLiteralBreaks(substr($test, 0, 14) === 'literal_breaks');
 
         $actualMarkup = $this->Parsedown->text($markdown);
 
         $this->assertEquals($expectedMarkup, $actualMarkup);
     }
 
+    function testRawHtml()
+    {
+        $markdown = "```php\nfoobar\n```";
+        $expectedMarkup = '<pre><code class="language-php"><p>foobar</p></code></pre>';
+        $expectedSafeMarkup = '<pre><code class="language-php">&lt;p&gt;foobar&lt;/p&gt;</code></pre>';
+
+        $unsafeExtension = new UnsafeExtension;
+        $actualMarkup = $unsafeExtension->text($markdown);
+
+        $this->assertEquals($expectedMarkup, $actualMarkup);
+
+        $unsafeExtension->setSafeMode(true);
+        $actualSafeMarkup = $unsafeExtension->text($markdown);
+
+        $this->assertEquals($expectedSafeMarkup, $actualSafeMarkup);
+    }
+
+    function testTrustDelegatedRawHtml()
+    {
+        $markdown = "```php\nfoobar\n```";
+        $expectedMarkup = '<pre><code class="language-php"><p>foobar</p></code></pre>';
+        $expectedSafeMarkup = $expectedMarkup;
+
+        $unsafeExtension = new TrustDelegatedExtension;
+        $actualMarkup = $unsafeExtension->text($markdown);
+
+        $this->assertEquals($expectedMarkup, $actualMarkup);
+
+        $unsafeExtension->setSafeMode(true);
+        $actualSafeMarkup = $unsafeExtension->text($markdown);
+
+        $this->assertEquals($expectedSafeMarkup, $actualSafeMarkup);
+    }
+
     function data()
     {
         $data = array();
@@ -123,12 +161,12 @@ MARKDOWN_WITH_MARKUP;
 <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;
+&lt;div class="inner"&gt;
 <em>content</em>
 &lt;/div&gt;
 &lt;/div&gt;</p>
 <p>paragraph</p>
-<p>&lt;style type=&quot;text/css&quot;&gt;
+<p>&lt;style type="text/css"&gt;
 p {
 color: red;
 }

test/SampleExtensions.php

@@ -0,0 +1,40 @@
+<?php
+
+class UnsafeExtension extends Parsedown
+{
+    protected function blockFencedCodeComplete($Block)
+    {
+        $text = $Block['element']['element']['text'];
+        unset($Block['element']['element']['text']);
+
+        // WARNING: There is almost always a better way of doing things!
+        //
+        // This example is one of them, unsafe behaviour is NOT needed here.
+        // Only use this if you trust the input and have no idea what
+        // the output HTML will look like (e.g. using an external parser).
+        $Block['element']['element']['rawHtml'] = "<p>$text</p>";
+
+        return $Block;
+    }
+}
+
+
+class TrustDelegatedExtension extends Parsedown
+{
+    protected function blockFencedCodeComplete($Block)
+    {
+        $text = $Block['element']['element']['text'];
+        unset($Block['element']['element']['text']);
+
+        // WARNING: There is almost always a better way of doing things!
+        //
+        // This behaviour is NOT needed in the demonstrated case.
+        // Only use this if you are sure that the result being added into
+        // rawHtml is safe.
+        // (e.g. using an external parser with escaping capabilities).
+        $Block['element']['element']['rawHtml'] = "<p>$text</p>";
+        $Block['element']['element']['allowRawHtmlInSafeMode'] = true;
+
+        return $Block;
+    }
+}

test/data/atx_heading.html

@@ -6,4 +6,8 @@
 <h6>h6</h6>
 <p>####### not a heading</p>
 <h1>closed h1</h1>
-<p>#</p>
+<h1></h1>
+<h2></h2>
+<h1># of levels</h1>
+<h1># of levels #</h1>
+<h1>heading</h1>

test/data/atx_heading.md

@@ -15,3 +15,11 @@
 # closed h1 #
 
 #
+
+##
+
+# # of levels
+
+# # of levels # #
+
+#heading

test/data/deeply_nested_list.html

@@ -1,12 +1,40 @@
 <ul>
-<li>li
-<ul>
-<li>li
-<ul>
+<li>li<ul>
+<li>li<ul>
 <li>li</li>
 <li>li</li>
-</ul></li>
-<li>li</li>
-</ul></li>
-<li>li</li>
+</ul>
+</li>
+<li>li</li>
+</ul>
+</li>
+<li>li</li>
+</ul>
+<hr />
+<ul>
+<li>level 1<ul>
+<li>level 2<ul>
+<li>level 3<ul>
+<li>level 4<ul>
+<li>level 5</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+<hr />
+<ul>
+<li>a</li>
+<li>b</li>
+<li>c</li>
+<li>d</li>
+<li>e</li>
+<li>f</li>
+<li>g</li>
+<li>h</li>
+<li>i</li>
 </ul>

test/data/deeply_nested_list.md

@@ -4,3 +4,23 @@
         - li
     - li
 - li
+
+---
+
+- level 1
+  - level 2
+    - level 3
+      - level 4
+        - level 5
+
+---
+
+- a
+ - b
+  - c
+   - d
+    - e
+   - f
+  - g
+ - h
+- i

test/data/email.html

@@ -1 +1,2 @@
 <p>my email is <a href="mailto:me@example.com">me@example.com</a></p>
+<p>html tags shouldn't start an email autolink <strong>first.last@example.com</strong></p>

test/data/email.md

@@ -1 +1,3 @@
 my email is <me@example.com>
+
+html tags shouldn't start an email autolink <strong>first.last@example.com</strong>

test/data/fenced_code_block.html

@@ -9,3 +9,6 @@ echo $message;</code></pre>
 echo "Hello World";
 ?&gt;
 &lt;a href="http://auraphp.com" &gt;Aura Project&lt;/a&gt;</code></pre>
+<pre><code>the following isn't quite enough to close
+```
+still a fenced code block</code></pre>

test/data/fenced_code_block.md

@@ -23,3 +23,9 @@ echo "Hello World";
 ?>
 <a href="http://auraphp.com" >Aura Project</a>
 ```
+
+````
+the following isn't quite enough to close
+```
+still a fenced code block
+````

test/data/html_comment.html

@@ -3,3 +3,9 @@
 <!-- 
   multiline -->
 <p>paragraph</p>
+<!-- sss -->abc
+<ul>
+<li>abcd</li>
+<li>bbbb</li>
+<li>cccc</li>
+</ul>

test/data/html_comment.md

@@ -6,3 +6,9 @@ paragraph
   multiline -->
 
 paragraph
+
+<!-- sss -->abc
+
+* abcd
+* bbbb
+* cccc

test/data/lazy_blockquote.html

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

test/data/literal_breaks.html

@@ -0,0 +1,6 @@
+<p>first line
+<br />
+<br />
+<br />
+<br />
+sixth line</p>

test/data/literal_breaks.md

@@ -0,0 +1,6 @@
+first line
+
+
+
+
+sixth line

test/data/markup_consecutive_one.html

@@ -0,0 +1,3 @@
+<div>Markup</div>
+_No markdown_ without blank line for **strict** compliance with CommonMark.
+<p><strong>Markdown</strong></p>

test/data/markup_consecutive_one.md

@@ -0,0 +1,4 @@
+<div>Markup</div>
+_No markdown_ without blank line for **strict** compliance with CommonMark.
+
+**Markdown**

test/data/markup_consecutive_one_line.html

@@ -0,0 +1,4 @@
+<div>One markup on
+two lines</div>
+_No markdown_
+<p><strong>Markdown</strong></p>

test/data/markup_consecutive_one_line.md

@@ -0,0 +1,5 @@
+<div>One markup on
+two lines</div>
+_No markdown_
+
+**Markdown**

test/data/markup_consecutive_one_stripped.html

@@ -0,0 +1,3 @@
+<div><p>Stripped markup</p></div>
+_No markdown_
+<p><strong>Markdown</strong></p>

test/data/markup_consecutive_one_stripped.md

@@ -0,0 +1,4 @@
+<div><p>Stripped markup</p></div>
+_No markdown_
+
+**Markdown**

test/data/markup_consecutive_two.html

@@ -0,0 +1,3 @@
+<div>First markup</div><p>and second markup on the same line.</p>
+_No markdown_
+<p><strong>Markdown</strong></p>

test/data/markup_consecutive_two.md

@@ -0,0 +1,4 @@
+<div>First markup</div><p>and second markup on the same line.</p>
+_No markdown_
+
+**Markdown**

test/data/markup_consecutive_two_lines.html

@@ -0,0 +1,4 @@
+<div>First markup</div><p>and partial markup
+on two lines.</p>
+_No markdown_
+<p><strong>Markdown</strong></p>

test/data/markup_consecutive_two_lines.md

@@ -0,0 +1,5 @@
+<div>First markup</div><p>and partial markup
+on two lines.</p>
+_No markdown_
+
+**Markdown**

test/data/markup_consecutive_two_stripped.html

@@ -0,0 +1,4 @@
+<div><p>Stripped markup
+on two lines</p></div>
+_No markdown_
+<p><strong>Markdown</strong></p>

test/data/markup_consecutive_two_stripped.md

@@ -0,0 +1,5 @@
+<div><p>Stripped markup
+on two lines</p></div>
+_No markdown_
+
+**Markdown**

test/data/ordered_list.html

@@ -11,3 +11,6 @@
 <ol start="123">
 <li>one</li>
 </ol>
+<p>foo 1. the following should not start a list
+100.<br />
+200. </p>

test/data/ordered_list.md

@@ -9,3 +9,7 @@ repeating numbers:
 large numbers:
 
 123. one
+
+foo 1. the following should not start a list
+100.  
+200. 

test/data/self-closing_html.md

@@ -1,12 +1,18 @@
 <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/setext_header_spaces.html

@@ -0,0 +1,12 @@
+<h1>trailing space</h1>
+<h2>trailing space</h2>
+<h1>leading and trailing space</h1>
+<h2>leading and trailing space</h2>
+<h1>1 leading space</h1>
+<h2>1 leading space</h2>
+<h1>3 leading spaces</h1>
+<h2>3 leading spaces</h2>
+<p>too many leading spaces
+==</p>
+<p>too many leading spaces
+--</p>

test/data/setext_header_spaces.md

@@ -0,0 +1,29 @@
+trailing space
+== 
+
+trailing space
+-- 
+
+leading and trailing space
+ == 
+
+leading and trailing space
+ -- 
+
+1 leading space
+ ==
+
+1 leading space
+ --
+
+3 leading spaces
+   ==
+
+3 leading spaces
+   --
+
+too many leading spaces
+    ==
+
+too many leading spaces
+    --

test/data/simple_blockquote.html

@@ -9,3 +9,18 @@
 <blockquote>
 <p>quote</p>
 </blockquote>
+<hr />
+<blockquote>
+<blockquote>
+<blockquote>
+<p>Info 1 text</p>
+</blockquote>
+</blockquote>
+</blockquote>
+<blockquote>
+<blockquote>
+<blockquote>
+<p>Info 2 text</p>
+</blockquote>
+</blockquote>
+</blockquote>

test/data/simple_blockquote.md

@@ -5,3 +5,9 @@ indented:
 
 no space after `>`:
 >quote
+
+---
+
+>>> Info 1 text
+
+>>> Info 2 text

test/data/simple_table.html

@@ -35,3 +35,35 @@
 </tr>
 </tbody>
 </table>
+<hr />
+<table>
+<thead>
+<tr>
+<th style="text-align: left;">header 1</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td style="text-align: left;">cell 1.1</td>
+</tr>
+<tr>
+<td style="text-align: left;">cell 2.1</td>
+</tr>
+</tbody>
+</table>
+<hr />
+<table>
+<thead>
+<tr>
+<th>header 1</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>cell 1.1</td>
+</tr>
+<tr>
+<td>cell 2.1</td>
+</tr>
+</tbody>
+</table>

test/data/simple_table.md

@@ -9,3 +9,17 @@ header 1 | header 2
 :------- | --------
 cell 1.1 | cell 1.2
 cell 2.1 | cell 2.2
+
+---
+
+header 1
+:-------
+cell 1.1
+cell 2.1
+
+---
+
+header 1
+-------|
+cell 1.1
+cell 2.1

test/data/sparse_html.html

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

test/data/strict_atx_heading.html

@@ -0,0 +1,13 @@
+<h1>h1</h1>
+<h2>h2</h2>
+<h3>h3</h3>
+<h4>h4</h4>
+<h5>h5</h5>
+<h6>h6</h6>
+<p>####### not a heading</p>
+<p>#not a heading</p>
+<h1>closed h1</h1>
+<h1></h1>
+<h2></h2>
+<h1># of levels</h1>
+<h1># of levels #</h1>

test/data/strict_atx_heading.md

@@ -0,0 +1,25 @@
+# h1
+
+## h2
+
+### h3
+
+#### h4
+
+##### h5
+
+###### h6
+
+####### not a heading
+
+#not a heading
+
+# closed h1 #
+
+#
+
+##
+
+# # of levels
+
+# # of levels # #

test/data/unordered_list.html

@@ -2,9 +2,21 @@
 <li>li</li>
 <li>li</li>
 </ul>
-<p>mixed markers:</p>
+<p>mixed unordered markers:</p>
 <ul>
 <li>li</li>
-<li>li</li>
+</ul>
+<ul>
 <li>li</li>
 </ul>
+<ul>
+<li>li</li>
+</ul>
+<p>mixed ordered markers:</p>
+<ol>
+<li>starting at 1, list one</li>
+<li>number 2, list one</li>
+</ol>
+<ol start="3">
+<li>starting at 3, list two</li>
+</ol>

test/data/unordered_list.md

@@ -1,8 +1,14 @@
 - li
 - li
 
-mixed markers:
+mixed unordered markers:
 
 * li
 + li
 - li
+
+mixed ordered markers:
+
+1. starting at 1, list one
+2. number 2, list one
+3) starting at 3, list two