setext headings should support inline elements

Better parsing of emphasis and strong elements

.coveralls.yml

@@ -0,0 +1 @@
+src_dir: .

.travis.yml

@@ -0,0 +1,15 @@
+language: php
+
+php:
+  - 5.4
+  - 5.3
+
+before_script:
+  - composer require satooshi/php-coveralls:dev-master
+  - mkdir -p build/logs
+
+script:
+  - phpunit --coverage-clover build/logs/clover.xml
+
+after_script:
+  - php vendor/bin/coveralls

Parsedown.php

@@ -120,7 +120,7 @@ class Parsedown
 		
 		foreach ($blocks as $block)
 		{
-			if (isset($block) and $block[0] > 'A')
+			if (isset($block) and $block[0] >= 'A')
 			{
 				$quick_block = $block;
 				
@@ -147,7 +147,7 @@ class Parsedown
 				
 				unset($block);
 			}
-			elseif (isset($list) and $block[0] === ' ') # list item block 
+			elseif (isset($block) and isset($list) and $block[0] === ' ') # list item block 
 			{
 				$list .= "\n\n".$block;
 				
@@ -311,7 +311,7 @@ class Parsedown
 			
 			# Paragraph 
 			
-			if (isset($line) and $line[0] > 'A')
+			if (isset($line) and $line[0] >= 'A')
 			{
 				$quick_line = $line;
 				
@@ -432,12 +432,13 @@ class Parsedown
 				{
 					if ($line[0] === $setext_character and preg_match('/^['.$setext_character.']+[ ]*$/', $line))
 					{
-						$atx_heading_level = $index + 1;
+						$setext_heading_level = $index + 1;
 						
-						$markup .= '<h'.$atx_heading_level.'>'.$paragraph.'</h'.$atx_heading_level.'>'."\n";
+						$setext_heading_text = $this->parse_inline_elements($paragraph);
 						
-						unset($paragraph);
-						unset($line);
+						$markup .= '<h'.$setext_heading_level.'>'.$setext_heading_text.'</h'.$setext_heading_level.'>'."\n";
+						
+						unset($paragraph, $line);
 						
 						continue 2;
 					}
@@ -557,7 +558,7 @@ class Parsedown
 		
 		# Inline Link / Image 
 		
-		if (strpos($text, ']') !== FALSE and preg_match_all('/(!?)\[(.*?)\][ ]?\((.*?)\)/', $text, $matches, PREG_SET_ORDER)) # inline 
+		if (strpos($text, '](') !== FALSE and preg_match_all('/(!?)\[(.*?)\]\((.*?)\)/', $text, $matches, PREG_SET_ORDER)) # inline 
 		{
 			foreach ($matches as $matches)
 			{
@@ -605,19 +606,13 @@ class Parsedown
 				$index ++;
 			}
 		}
-		
-		if (strpos($text, '*') !== FALSE)
+
+		if (strpos($text, '*') !== FALSE or strpos($text, '_') !== FALSE)
 		{
-			$text = preg_replace('/\*{2}(.*?)\*{2}/', '<strong>$1</strong>', $text);
-			$text = preg_replace('/\*(.*?)\*/', '<em>$1</em>', $text);
+			$text = preg_replace('/(\*\*|__)(.+?[*_]*)(?<=\S)\1/', '<strong>$2</strong>', $text);
+			$text = preg_replace('/(\*|_)(.+?)(?<=\S)\1/', '<em>$2</em>', $text);
 		}
-		
-		if (strpos($text, '_') !== FALSE)
-		{
-			$text = preg_replace('/_{2}(\S.*?\S)_{2}/', '<strong>$1</strong>', $text);
-			$text = preg_replace('/_(\S.*?\S)_/', '<em>$1</em>', $text);
-		}
-		
+
 		$text = strtr($text, $map);
 		
 		return $text;

README.md

@@ -1,4 +1,20 @@
-Parsedown is a parser for Markdown. It parses Markdown text the way people do. First, it divides texts into blocks. Then it looks at how these blocks start and how they relate to each other. Finally, it looks for special characters to identify inline elements. As a result, Parsedown is (super) fast, predictable and its (open) source code - easy to read.
+## Parsedown PHP
+
+Parsedown is a parser for Markdown. It parses Markdown text the way people do. First, it divides texts into blocks. Then it looks at how these blocks start and how they relate to each other. Finally, it looks for special characters to identify inline elements. As a result, Parsedown is (super) fast, consistent and clean.
 
 [Explorer (demo)](http://parsedown.org/explorer/)  
-[Tests](http://parsedown.org/tests/)  
+[Tests](http://parsedown.org/tests/)
+
+### Installation
+
+Include `Parsedown.php` or install [the composer package](https://packagist.org/packages/erusev/parsedown).
+
+### Example
+
+```php
+$text = 'Hello **Parsedown**!';
+
+$result = Parsedown::instance()->parse($text);
+
+echo $result; # prints: <p>Hello <strong>Parsedown</strong>!</p>
+```

phpunit.xml.dist

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit colors="true">
+	<testsuites>
+		<testsuite>
+			<file>tests/Test.php</file>
+		</testsuite>
+	</testsuites>
+</phpunit>

tests/.htaccess

@@ -1,7 +0,0 @@
-RewriteEngine on
-RewriteBase /
-
-RewriteCond %{REQUEST_FILENAME} !-f
-RewriteCond %{REQUEST_FILENAME} !-d
-
-RewriteRule ^(.*)$ tests/index.php?$1 [L]

tests/Test.php

@@ -0,0 +1,45 @@
+<?php
+
+include 'Parsedown.php';
+
+class Test extends PHPUnit_Framework_TestCase
+{
+	const provider_dir = 'data/';
+	
+	/**
+	 * @dataProvider provider
+	 */
+	function test_($markdown, $expected_markup)
+	{
+		$actual_markup = Parsedown::instance()->parse($markdown);
+
+		$this->assertEquals($expected_markup, $actual_markup);
+	}
+	
+	function provider()
+	{
+		$provider = array();
+		
+		$DirectoryIterator = new DirectoryIterator(__DIR__ . '/' . self::provider_dir);
+		
+		foreach ($DirectoryIterator as $Item)
+		{
+			if ($Item->isFile() and $Item->getExtension() === 'md')
+			{
+				$basename = $Item->getBasename('.md');
+				
+				$markdown = file_get_contents(__DIR__ . '/' . self::provider_dir . $basename . '.md');
+				
+				if (!$markdown)
+					continue;
+				
+				$expected_markup = file_get_contents(__DIR__ . '/' . self::provider_dir . $basename . '.html');
+				
+				$provider [] = array($markdown, $expected_markup);
+			}
+		}
+		
+		return $provider;
+	}
+}
+

tests/data/atx_heading.html

@@ -0,0 +1,14 @@
+<h1>This is an h1</h1>
+<h2>This is an h2</h2>
+<h3>This is an h3</h3>
+<h4>This is an h4</h4>
+<h5>This is an h5</h5>
+<h6>This is an h6</h6>
+<h1>This is a closed h1</h1>
+<h2>This is a closed h2</h2>
+<h3>This is a closed h3</h3>
+<h4>This is a closed h4</h4>
+<h5>This is a closed h5</h5>
+<h6>This is a closed h6</h6>
+<h1>This is an irregularly closed h1</h1>
+<h4>This is an irregularly closed h4</h4>

tests/data/atx_heading.md

@@ -0,0 +1,27 @@
+# This is an h1
+
+## This is an h2
+
+### This is an h3
+
+#### This is an h4
+
+##### This is an h5
+
+###### This is an h6
+
+# This is a closed h1 #
+
+## This is a closed h2 ##
+
+### This is a closed h3 ###
+
+#### This is a closed h4 ####
+
+##### This is a closed h5 #####
+
+###### This is a closed h6 ######
+
+# This is an irregularly closed h1 ###
+
+#### This is an irregularly closed h4 ##

tests/data/emphasis.html

@@ -0,0 +1,8 @@
+<p>Here's <em>an emphasis</em>.</p>
+<p>A short emphasis <em>a</em> <em>b</em> .</p>
+<p>Here's <strong>a strong one</strong>. </p>
+<p>Here's <em>an emphasis that uses underscores</em>. </p>
+<p>Here's <strong>a strong emphasis that uses underscores</strong>.</p>
+<p>This is _ not an emphasis _ neither is * that * .</p>
+<p>Empty emphasis ** is not __ an emphasis.</p>
+<p>Three asterisks are an emphasized asterisk <em>*</em> .</p>

tests/data/emphasis.md

@@ -0,0 +1,15 @@
+Here's *an emphasis*.
+
+A short emphasis _a_ *b* .
+
+Here's **a strong one**. 
+
+Here's _an emphasis that uses underscores_. 
+
+Here's __a strong emphasis that uses underscores__.
+
+This is _ not an emphasis _ neither is * that * .
+
+Empty emphasis ** is not __ an emphasis.
+
+Three asterisks are an emphasized asterisk *** .

tests/index.css

@@ -1,51 +0,0 @@
-
-
-.page {
-	margin: 0 auto; 
-	width: 640px;
-}
-
-.header {
-	background: #555;
-	color: #fff;
-}
-
-.odd {
-	background: #fff;	
-}
-
-.even {
-	background: #eee;
-}
-
-div.fail {
-	background: #f55;
-}
-
-div.pass {
-	background: #595;
-}
-
-span.fail {
-	color: #d55;
-}
-
-span.pass {
-	color: #595;
-}
-
-/* ~ */
-
-p {
-	margin: 10px 0;
-}
-
-th {
-	font-weight: normal;
-	text-align: left;
-}
-
-th, td {
-	border-bottom: 1px solid #ddd;
-	padding: 5px 10px;
-}

tests/index.php

@@ -1,12 +0,0 @@
-<?php 
-
-include '../Parsedown.php';
-
-$page = $_SERVER['QUERY_STRING']
-	? 'test'
-	: 'index';
-
-$dir = 'tests/';
-
-include $page.'_controller.php';
-include $page.'_view.php';

tests/index_controller.php

@@ -1,46 +0,0 @@
-<?php 
-				
-$DirectoryIterator = new DirectoryIterator($dir);
-
-$failed_test_count = 0;
-
-foreach ($DirectoryIterator as $Item) 
-{
-	if ($Item->isFile() and $Item->getBasename() != '.DS_Store')
-	{
-		if ($Item->getExtension() === 'md')
-		{
-			$basename = $Item->getBasename('.md');
-
-			$markdown = file_get_contents($dir.$basename.'.md');
-			$expected_markup = file_get_contents($dir.$basename.'.html');
-
-			if ( ! $markdown)
-				continue;
-			
-			$Parsedown = Parsedown::instance();
-
-			$start = microtime(true);
-
-			$actual_markup = $Parsedown->parse($markdown);
-
-			$time = microtime(true) - $start;
-			$time = $time * 1000; # ms?
-			$time = round($time, 2);
-
-			$result = $expected_markup === $actual_markup
-				? 'pass'
-				: 'fail';
-
-			$result === 'fail' and $failed_test_count ++;
-			
-			$Tests []= array(
-				'basename' => $basename,
-				'name' => str_replace('_', ' ', $basename),
-				'result' => $result,
-				'time' => $time,
-			);
-		}
-	}
-}
-

tests/index_view.php

@@ -1,54 +0,0 @@
-<!DOCTYPE html>
-
-<!-- (c) 2009 - 2013 Emanuil Rusev, All rights reserved. -->
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-
-	<head>
-		
-		<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
-		
-		<link href="reset.css" rel="stylesheet" type="text/css" />
-		<link href="index.css" rel="stylesheet" type="text/css" />
-		
-		<title>Parsedown Test</title>
-		
-	</head>
-	
-	<body>
-		
-		<div style="padding: 50px; width: 500px;">
-			
-			<h1 style="margin: 0;"><a href="/">Parsedown PHP</a> » Tests</h1>
-			
-			<br/>
-			
-			<table>
-
-				<tr class="header">
-					<th style="width: 480px;">Test</th>
-					<th style="text-align: right; width: 120px">Time</th>
-				</tr>
-
-				<?php foreach ($Tests as $index => $Test): ?>
-				<tr class="<?= $index % 2 ? 'even' : 'odd' ?>">
-					<td><a href="/tests/<?= $Test['basename'] ?>"><?= $Test['name'] ?></a> - <span class="<?= $Test['result'] ?>"><?= $Test['result'] ?></span></td>
-					<td style="text-align: right;"><?= $Test['time'] ?> ms</td>
-				</tr>
-				<?php endforeach ?>
-
-			</table>
-			
-			<div class="<?= $failed_test_count ? 'fail' : 'pass' ?>" style="border-top: 1px solid #555; color: #fff; margin-top: 1px; padding:5px 10px;">
-				<?php if ($failed_test_count): ?>
-				<?= $failed_test_count ?> tests failed.
-				<?php else: ?>
-				All <?= count($Tests) ?> tests passed.
-				<?php endif ?>
-			</div>
-		
-		</div>
-			
-	</body>
-	
-</html>

tests/reset.css

@@ -1,108 +0,0 @@
-/*
- *
- * 
- *
- */
-
-a {
-	color: #159;
-	outline: none;
-	text-decoration: none;
-}
-
-a img {
-	border: none;
-}
-
-abbr {
-	border-bottom: 1px solid #ddd;
-	cursor: help;
-	padding: 2px 3px;
-}
-
-body {
-	background: #ddd;
-	color: #333;
-	font-family: Verdana, Sans-serif;
-	font-size: 14px;
-	height: 100%;
-	line-height: 20px;
-	margin: 0;
-	padding: 0;
-}
-
-blockquote {
-	background: #eee;
-	margin: 0 0 10px 0;
-	padding: 10px 10px 1px 10px;
-}
-
-form {
-	margin: 0;
-	padding: 0;
-}
-
-h1, h2, h3, h4, h5, h6 {
-	font-family: Georgia, "Times New Roman", Times, serif;
-	font-weight: normal;
-	letter-spacing: 1px;
-	margin: 20px 0;
-}
-
-h1 {
-	line-height: 30px; 
-}
-
-html {
-	height: 100%;
-	margin: 0;
-	padding: 0;
-	overflow-y: scroll;
-}
-
-img {
-	outline: none;
-}
-
-input {
-	font-family: Verdana, Sans-serif;
-	font-size: 14px;
-	line-height: 20px;
-	margin: 0;
-}
-
-object {
-	outline: none;
-}
-
-p {
-	margin-top: 0;
-	margin-bottom: 10px;
-}
-
-select {
-	font-family: Verdana, Sans-serif;
-	font-size: 14px;
-	/* Makes for the same height as <input>. */
-	height: 40px;
-	margin: 0;
-}
-
-table {
-	border-spacing: 0;
-}
-
-textarea {
-	background: #fff;
-	font-family: Verdana, Sans-serif;
-	font-size: 14px;
-	line-height: 20px;
-	margin: 0;
-	padding: 9px;
-	width: 280px;
-}
-
-ul {
-	list-style-type: square;
-}
-

tests/test.css

@@ -1,58 +0,0 @@
-/*
- *
- * ...
- * 
- */
-
-tr.header td {
-	background: #333;
-	color: #fff;
-	padding: 20px;
-}
-
-tr.header a {
-	color: #fff;
-	text-decoration: underline;
-}
-
-tr.body td {
-	background: #fff;
-	padding: 20px;
-	width: 35%;
-}
-
-tr.footer td {
-	background: #fff;
-	border-top: 1px solid #999;
-	padding: 10px 20px;
-}
-
-/* ~ */
-
-tr.fail td {
-	background: #f55;
-}
-
-tr.pass td {
-	background: #5d5;
-}
-
-/* ~ */
-
-code {
-	font-family: Source Code Pro, Monaco, monospace;
-}
-
-pre {
-	margin: 0;
-	white-space: -moz-pre-wrap; /* Mozilla, supported since 1999 */
-	white-space: -pre-wrap; /* Opera */
-	white-space: -o-pre-wrap; /* Opera */
-	white-space: pre-wrap; /* CSS3 - Text module (Candidate Recommendation) http://www.w3.org/TR/css3-text/#white-space */
-	word-wrap: break-word; /* IE 5.5+ */
-}
-
-span.tag {
-	color: #b19;
-}
-

tests/test_controller.php

@@ -1,27 +0,0 @@
-<?php
-
-$test = $_SERVER['QUERY_STRING'];
-
-preg_match('/^\w+$/', $test) or die('illegal test name');
-
-$md_file = $dir.$test.'.md';
-$mu_file = $dir.$test.'.html';
-
-file_exists($md_file) or die("$md_file not found");
-file_exists($mu_file) or die("$mu_file not found");
-
-$md = file_get_contents($md_file);
-
-$expected_mu = file_get_contents($mu_file);
-$actual_mu = Parsedown::instance()->parse($md);
-
-$result = $expected_mu === $actual_mu
-	? 'pass'
-	: 'fail';
-
-$md = htmlentities($md, ENT_NOQUOTES);
-$expected_mu = htmlentities($expected_mu, ENT_NOQUOTES);
-$actual_mu = htmlentities($actual_mu, ENT_NOQUOTES);
-
-$name = str_replace('_', ' ', $test);
-$name = ucwords($name);

tests/test_view.php

@@ -1,62 +0,0 @@
-<!DOCTYPE html>
-
-<!-- (c) 2009 - 2013 Emanuil Rusev, All rights reserved. -->
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-
-	<head>
-		
-		<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
-		
-		<link href="reset.css" rel="stylesheet" type="text/css" />
-		<link href="test.css" rel="stylesheet" type="text/css" />
-		
-		<script src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r224/prettify.js" type="text/javascript"></script>
-		<script src="http://code.jquery.com/jquery-2.0.0.min.js" type="text/javascript"></script>
-		
-		<title><?= $name ?> &laquo; Parsedown Test</title>
-		
-	</head>
-	
-	<body onload="prettyPrint();">
-		
-		<table style="width: 100%; height: 100%;">
-			<tr class="<?= $result ?>">
-				<td colspan="3"></td>
-			</tr>
-			<tr class="header">
-				<td colspan="2"><a href="/">Parsedown PHP</a> » <a href=".">Tests</a> » <?= $name ?></td>
-				<td style="text-align: right;">
-					<form action="http://parsedown.org<?= $_SERVER['SERVER_NAME'] === 'parsedown.org.local' ? '.local' : '' ?>/explorer/" method="post">
-						<input type="hidden" name="text" />
-						<a id="explorer" href="">Open in Explorer</a>
-					</form>
-				</td>
-			</tr>
-			<tr class="body" style="height: 100%; vertical-align: top;">
-				<td style="background: #eee; width: 30%;">
-					<pre id="md" style="word-wrap: break-word;"><?= $md ?></pre>
-				</td>
-				<td><pre class="prettyprint"><code><?= $expected_mu ?></code></pre></td>
-				<td><pre class="prettyprint"><code><?= $actual_mu ?></code></pre></td>
-			</tr>
-			<tr class="footer">
-				<td style="background: #eee;">Markdown</td>
-				<td>Expected Markup</td>
-				<td>Actual Markup</td>
-			</tr>
-		</table>
-		
-		<script type="text/javascript">
-			
-			$('#explorer').click(function(e) {
-				$('input[name=text]').val($('#md').text());
-				$('form').submit();
-				return false;
-			});
-			
-		</script>
-		
-	</body>
-	
-</html>

tests/tests/atx_heading.html

@@ -1,2 +0,0 @@
-<h1>This is an h1</h1>
-<h2>This is an h2</h2>

tests/tests/atx_heading.md

@@ -1,3 +0,0 @@
-# This is an h1
-
-## This is an h2

tests/tests/emphasis.html

@@ -1,5 +0,0 @@
-<p>Here's <em>an emphasis</em>.</p>
-<p>Here's <strong>a strong one</strong>. </p>
-<p>Here's <em>an emphasis that uses underscores</em>. </p>
-<p>Here's <strong>a strong emphasis that uses underscores</strong>.</p>
-<p>This is _ not an emphasis _.</p>

tests/tests/emphasis.md

@@ -1,9 +0,0 @@
-Here's *an emphasis*.
-
-Here's **a strong one**. 
-
-Here's _an emphasis that uses underscores_. 
-
-Here's __a strong emphasis that uses underscores__.
-
-This is _ not an emphasis _.