test: add karlcow's testsuite

Also refactor tests to improve maintainability

Gruntfile.js

@@ -95,6 +95,15 @@ module.exports = function (grunt) {
           reporter: 'spec'
         }
       },
+      karlcow: {
+        src: 'test/node/testsuite.karlcow.js',
+        options: {
+          globals: ['should'],
+          timeout: 3000,
+          ignoreLeaks: false,
+          reporter: 'spec'
+        }
+      },
       browser: {
         src: 'test/browser/**/*.js',
         options: {

dist/showdown.js

@@ -1,4 +1,4 @@
-;/*! showdown 08-06-2015 */
+;/*! showdown 11-06-2015 */
 (function(){
 /**
  * Created by Tivie on 06-01-2015.
@@ -1543,7 +1543,7 @@ showdown.subParser('images', function (text, options, globals) {
     url = showdown.helper.escapeCharacters(url, '*_', false);
     var result = '<img src="' + url + '" alt="' + altText + '"';
 
-    if (title != "") {
+    if (title) {
       title = title.replace(/"/g, '&quot;');
       title = showdown.helper.escapeCharacters(title, '*_', false);
       result += ' title="' + title + '"';

package.json

@@ -45,6 +45,7 @@
     "grunt-conventional-changelog": "^1.1.0",
     "grunt-jscs": "^1.2.0",
     "grunt-simple-mocha": "^0.4.0",
+    "js-beautify": "^1.5.6",
     "jscs": "^1.10.0",
     "load-grunt-tasks": "^3.2.0",
     "mocha": "*",

src/subParsers/images.js

@@ -39,7 +39,7 @@ showdown.subParser('images', function (text, options, globals) {
     url = showdown.helper.escapeCharacters(url, '*_', false);
     var result = '<img src="' + url + '" alt="' + altText + '"';
 
-    if (title != "") {
+    if (title) {
       title = title.replace(/"/g, '&quot;');
       title = showdown.helper.escapeCharacters(title, '*_', false);
       result += ' title="' + title + '"';

test/bootstrap.js

@@ -0,0 +1,89 @@
+/**
+ * Created by Estevao on 08-06-2015.
+ */
+
+//jscs:disable requireCamelCaseOrUpperCaseIdentifiers
+require('source-map-support').install();
+require('chai').should();
+var fs = require('fs'),
+    os = require('os'),
+    beautify = require('js-beautify').html_beautify,
+    beauOptions = {
+      eol: os.EOL,
+      indent_size: 2,
+      preserve_newlines: false
+    };
+
+function getTestSuite(dir) {
+  return fs.readdirSync(dir)
+    .filter(filter())
+    .map(map(dir));
+}
+
+function filter() {
+  return function (file) {
+    var ext = file.slice(-3);
+    return (ext === '.md');
+  };
+}
+
+function map(dir) {
+  return function (file) {
+    var name = file.replace('.md', ''),
+      htmlPath = dir + name + '.html',
+      html = fs.readFileSync(htmlPath, 'utf8'),
+      mdPath = dir + name + '.md',
+      md = fs.readFileSync(mdPath, 'utf8');
+
+    return {
+      name:     name,
+      input:    md,
+      expected: html
+    };
+  };
+}
+
+function assertion(testCase, converter) {
+  return function () {
+    testCase.actual = converter.makeHtml(testCase.input);
+    testCase = normalize(testCase);
+
+    // Compare
+    testCase.actual.should.equal(testCase.expected);
+  };
+}
+
+//Normalize input/output
+function normalize(testCase) {
+
+  // Normalize line returns
+  testCase.expected = testCase.expected.replace(/(\r\n)|\n|\r/g, '\n');
+  testCase.actual = testCase.actual.replace(/(\r\n)|\n|\r/g, '\n');
+
+  // Ignore all leading/trailing whitespace
+  testCase.expected = testCase.expected.split('\n').map(function (x) {
+    return x.trim();
+  }).join('\n');
+  testCase.actual = testCase.actual.split('\n').map(function (x) {
+    return x.trim();
+  }).join('\n');
+
+  // Remove extra lines
+  testCase.expected = testCase.expected.trim();
+  testCase.actual = testCase.actual.trim();
+
+  //Beautify
+  testCase.expected = beautify(testCase.expected, beauOptions);
+  testCase.actual = beautify(testCase.actual, beauOptions);
+
+  // Normalize line returns
+  testCase.expected = testCase.expected.replace(/(\r\n)|\n|\r/g, os.EOL);
+  testCase.actual = testCase.actual.replace(/(\r\n)|\n|\r/g, os.EOL);
+
+  return testCase;
+}
+
+module.exports = {
+  getTestSuite: getTestSuite,
+  assertion: assertion
+};

test/karlcow/2-paragraphs-hard-return-spaces.html

@@ -0,0 +1,5 @@
+<p>This is a first paragraph,
+on multiple lines.</p>
+
+<p>This is a second paragraph.
+There are spaces in between the two.</p>

test/karlcow/2-paragraphs-hard-return-spaces.md

@@ -0,0 +1,5 @@
+This is a first paragraph,
+on multiple lines.
+     
+This is a second paragraph.
+There are spaces in between the two.

test/karlcow/2-paragraphs-hard-return.html

@@ -0,0 +1,5 @@
+<p>This is a first paragraph,
+on multiple lines.</p>
+
+<p>This is a second paragraph
+which has multiple lines too.</p>

test/karlcow/2-paragraphs-hard-return.md

@@ -0,0 +1,5 @@
+This is a first paragraph,
+on multiple lines.
+
+This is a second paragraph
+which has multiple lines too.

test/karlcow/2-paragraphs-line-returns.html

@@ -0,0 +1,3 @@
+<p>A first paragraph.</p>
+
+<p>A second paragraph after 3 CR (carriage return).</p>

test/karlcow/2-paragraphs-line-returns.md

@@ -0,0 +1,5 @@
+A first paragraph.
+
+
+
+A second paragraph after 3 CR (carriage return).

test/karlcow/2-paragraphs-line-spaces.html

@@ -0,0 +1,3 @@
+<p>This a very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long paragraph on 1 line.</p>
+
+<p>A few spaces and a new long long long long long long long long long long long long long long long long paragraph on 1 line.</p>

test/karlcow/2-paragraphs-line-spaces.md

@@ -0,0 +1,3 @@
+This a very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long paragraph on 1 line.
+     
+A few spaces and a new long long long long long long long long long long long long long long long long paragraph on 1 line.

test/karlcow/2-paragraphs-line-tab.html

@@ -0,0 +1,3 @@
+<p>This a very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long paragraph on 1 line.</p>
+
+<p>1 tab to separate them and a new long long long long long long long long long long long long long long long long paragraph on 1 line.</p>

test/karlcow/2-paragraphs-line-tab.md

@@ -0,0 +1,3 @@
+This a very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long paragraph on 1 line.
+	
+1 tab to separate them and a new long long long long long long long long long long long long long long long long paragraph on 1 line.

test/karlcow/2-paragraphs-line.html

@@ -0,0 +1,3 @@
+<p>This a very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long paragraph on 1 line.</p>
+
+<p>A new long long long long long long long long long long long long long long long long paragraph on 1 line.</p>

test/karlcow/2-paragraphs-line.md

@@ -0,0 +1,3 @@
+This a very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long paragraph on 1 line.
+
+A new long long long long long long long long long long long long long long long long paragraph on 1 line.

test/karlcow/EOL-CR+LF.html

@@ -0,0 +1,5 @@
+<p>These lines all end with end of line (EOL) sequences.</p>
+
+<p>Seriously, they really do.</p>
+
+<p>If you don't believe me: HEX EDIT!</p>

test/karlcow/EOL-CR+LF.md

@@ -0,0 +1,6 @@
+These lines all end with end of line (EOL) sequences.
+
+Seriously, they really do.
+
+If you don't believe me: HEX EDIT!
+

test/karlcow/EOL-CR.html

@@ -0,0 +1 @@
+<p>These lines all end with end of line (EOL) sequences.</p>

<p>Seriously, they really do.</p>

<p>If you don't believe me: HEX EDIT!</p>

test/karlcow/EOL-CR.md

@@ -0,0 +1 @@
+These lines all end with end of line (EOL) sequences.

Seriously, they really do.

If you don't believe me: HEX EDIT!

test/karlcow/EOL-LF.html

@@ -0,0 +1,5 @@
+<p>These lines all end with end of line (EOL) sequences.</p>
+
+<p>Seriously, they really do.</p>
+
+<p>If you don't believe me: HEX EDIT!</p>

test/karlcow/EOL-LF.md

@@ -0,0 +1,6 @@
+These lines all end with end of line (EOL) sequences.
+
+Seriously, they really do.
+
+If you don't believe me: HEX EDIT!
+

test/karlcow/ampersand-text-flow.html

@@ -0,0 +1 @@
+<p>An ampersand &amp; in the text flow is escaped as an html entity.</p>

test/karlcow/ampersand-text-flow.md

@@ -0,0 +1 @@
+An ampersand & in the text flow is escaped as an html entity.

test/karlcow/ampersand-uri.html

@@ -0,0 +1 @@
+<p>There is an <a href="http://validator.w3.org/check?uri=http://www.w3.org/&amp;verbose=1">ampersand</a> in the URI.</p>

test/karlcow/ampersand-uri.md

@@ -0,0 +1 @@
+There is an [ampersand](http://validator.w3.org/check?uri=http://www.w3.org/&verbose=1) in the URI.

test/karlcow/asterisk-near-text.html

@@ -0,0 +1 @@
+<p>This is *an asterisk which should stay as is.</p>

test/karlcow/asterisk-near-text.md

@@ -0,0 +1 @@
+This is \*an asterisk which should stay as is.

test/karlcow/asterisk.html

@@ -0,0 +1 @@
+<p>This is * an asterisk which should stay as is.</p>

test/karlcow/asterisk.md

@@ -0,0 +1 @@
+This is * an asterisk which should stay as is.

test/karlcow/backslash-escape.html

@@ -0,0 +1,12 @@
+<p>\   backslash
+`   backtick
+*   asterisk
+_   underscore
+{}  curly braces
+[]  square brackets
+()  parentheses
+#   hash mark
++   plus sign
+-   minus sign (hyphen)
+.   dot
+!   exclamation mark</p>

test/karlcow/backslash-escape.md

@@ -0,0 +1,12 @@
+\\   backslash
+\`   backtick
+\*   asterisk
+\_   underscore
+\{\}  curly braces
+\[\]  square brackets
+\(\)  parentheses
+\#   hash mark
+\+   plus sign
+\-   minus sign (hyphen)
+\.   dot
+\!   exclamation mark

test/karlcow/blockquote-added-markup.html

@@ -0,0 +1,5 @@
+<blockquote>
+<h1>heading level 1</h1>
+
+<p>paragraph</p>
+</blockquote>

test/karlcow/blockquote-added-markup.md

@@ -0,0 +1,3 @@
+> # heading level 1
+> 
+> paragraph

test/karlcow/blockquote-line-2-paragraphs.html

@@ -0,0 +1,5 @@
+<blockquote>
+<p>A blockquote with a very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long line.</p>
+
+<p>and a second very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long line.</p>
+</blockquote>

test/karlcow/blockquote-line-2-paragraphs.md

@@ -0,0 +1,3 @@
+>A blockquote with a very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long line.
+
+>and a second very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long line.

test/karlcow/blockquote-line.html

@@ -0,0 +1,3 @@
+<blockquote>
+<p>This a very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long paragraph in a blockquote.</p>
+</blockquote>

test/karlcow/blockquote-line.md

@@ -0,0 +1 @@
+>This a very long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long long paragraph in a blockquote.

test/karlcow/blockquote-multiline-1-space-begin.html

@@ -0,0 +1,5 @@
+<blockquote>
+<p>A blockquote
+on multiple lines
+like this.</p>
+</blockquote>

test/karlcow/blockquote-multiline-1-space-begin.md

@@ -0,0 +1,3 @@
+> A blockquote
+> on multiple lines
+> like this.

test/karlcow/blockquote-multiline-1-space-end.html

@@ -0,0 +1,5 @@
+<blockquote>
+<p>A blockquote 
+on multiple lines 
+like this. </p>
+</blockquote>

test/karlcow/blockquote-multiline-1-space-end.md

@@ -0,0 +1,3 @@
+>A blockquote 
+>on multiple lines 
+>like this. 

test/karlcow/blockquote-multiline-2-paragraphs.html

@@ -0,0 +1,8 @@
+<blockquote>
+<p>A blockquote
+on multiple lines
+like this.</p>
+
+<p>But it has
+two paragraphs.</p>
+</blockquote>

test/karlcow/blockquote-multiline-2-paragraphs.md

@@ -0,0 +1,6 @@
+>A blockquote
+>on multiple lines
+>like this.
+>
+>But it has
+>two paragraphs.

test/karlcow/blockquote-multiline.html

@@ -0,0 +1,5 @@
+<blockquote>
+<p>A blockquote
+on multiple lines
+like this</p>
+</blockquote>

test/karlcow/blockquote-multiline.md

@@ -0,0 +1,3 @@
+>A blockquote
+>on multiple lines
+>like this

test/karlcow/blockquote-nested-multiplereturn-level1.html

@@ -0,0 +1,9 @@
+<blockquote>
+<p>This is the first level of quoting.</p>
+
+<blockquote>
+<p>This is nested blockquote.</p>
+</blockquote>
+
+<p>Back to the first level.</p>
+</blockquote>

test/karlcow/blockquote-nested-multiplereturn-level1.md

@@ -0,0 +1,5 @@
+> This is the first level of quoting.
+>
+> > This is nested blockquote.
+>
+> Back to the first level.

test/karlcow/blockquote-nested-multiplereturn.html

@@ -0,0 +1,7 @@
+<blockquote>
+<p>This is the first level of quoting.</p>
+
+<blockquote>
+<p>This is nested blockquote.</p>
+</blockquote>
+</blockquote>

test/karlcow/blockquote-nested-multiplereturn.md

@@ -0,0 +1,3 @@
+> This is the first level of quoting.
+>
+> > This is nested blockquote.

test/karlcow/blockquote-nested-return-level1.html

@@ -0,0 +1,8 @@
+<blockquote>
+<p>This is the first level of quoting.</p>
+
+<blockquote>
+<p>This is nested blockquote.
+Back to the first level.</p>
+</blockquote>
+</blockquote>

test/karlcow/blockquote-nested-return-level1.md

@@ -0,0 +1,3 @@
+> This is the first level of quoting.
+> > This is nested blockquote.
+> Back to the first level.

test/karlcow/blockquote-nested.html

@@ -0,0 +1,7 @@
+<blockquote>
+<p>This is the first level of quoting.</p>
+
+<blockquote>
+<p>This is nested blockquote.</p>
+</blockquote>
+</blockquote>

test/karlcow/blockquote-nested.md

@@ -0,0 +1,2 @@
+> This is the first level of quoting.
+> > This is nested blockquote.

test/karlcow/code-1-tab.html

@@ -0,0 +1,3 @@
+<pre><code>10 PRINT HELLO INFINITE
+20 GOTO 10
+</code></pre>

test/karlcow/code-1-tab.md

@@ -0,0 +1,2 @@
+	10 PRINT HELLO INFINITE
+	20 GOTO 10

test/karlcow/code-4-spaces-escaping.html

@@ -0,0 +1,3 @@
+<pre><code>10 PRINT &lt; &gt; &amp;
+20 GOTO 10
+</code></pre>

test/karlcow/code-4-spaces-escaping.md

@@ -0,0 +1,2 @@
+    10 PRINT < > &
+    20 GOTO 10

test/karlcow/code-4-spaces.html

@@ -0,0 +1,3 @@
+<pre><code>10 PRINT HELLO INFINITE
+20 GOTO 10
+</code></pre>

test/karlcow/code-4-spaces.md

@@ -0,0 +1,2 @@
+    10 PRINT HELLO INFINITE
+    20 GOTO 10

test/karlcow/em-middle-word.html

@@ -0,0 +1 @@
+<p>as<em>te</em>risks</p>

test/karlcow/em-middle-word.md

@@ -0,0 +1 @@
+as*te*risks

test/karlcow/em-star.html

@@ -0,0 +1 @@
+<p><em>single asterisks</em></p>

test/karlcow/em-star.md

@@ -0,0 +1 @@
+*single asterisks*

test/karlcow/em-underscore.html

@@ -0,0 +1 @@
+<p><em>single underscores</em></p>

test/karlcow/em-underscore.md

@@ -0,0 +1 @@
+_single underscores_

test/karlcow/entities-text-flow.html

@@ -0,0 +1 @@
+<p>HTML entities are written using ampersand notation: &copy;</p>

test/karlcow/entities-text-flow.md

@@ -0,0 +1 @@
+HTML entities are written using ampersand notation: ©

test/karlcow/header-level1-equal-underlined.html

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

test/karlcow/header-level1-equal-underlined.md

@@ -0,0 +1,2 @@
+This is an H1
+=============

test/karlcow/header-level1-hash-sign-closed.html

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

test/karlcow/header-level1-hash-sign-closed.md

@@ -0,0 +1 @@
+# This is an H1 #

test/karlcow/header-level1-hash-sign-trailing-1-space.html

@@ -0,0 +1 @@
+<p># This is an H1</p>

test/karlcow/header-level1-hash-sign-trailing-1-space.md

@@ -0,0 +1 @@
+ # This is an H1

test/karlcow/header-level1-hash-sign-trailing-2-spaces.html

@@ -0,0 +1,3 @@
+<h1>this is an h1 with two trailing spaces</h1>
+
+<p>A new paragraph.</p>

test/karlcow/header-level1-hash-sign-trailing-2-spaces.md

@@ -0,0 +1,2 @@
+# this is an h1 with two trailing spaces  
+A new paragraph.

test/karlcow/header-level1-hash-sign.html

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

test/karlcow/header-level1-hash-sign.md

@@ -0,0 +1 @@
+# This is an H1

test/karlcow/header-level2-dash-underlined.html

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

test/karlcow/header-level2-dash-underlined.md

@@ -0,0 +1,2 @@
+This is an H2
+-------------

test/karlcow/header-level2-hash-sign-closed.html

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

test/karlcow/header-level2-hash-sign-closed.md

@@ -0,0 +1 @@
+## This is an H2 ##

test/karlcow/header-level2-hash-sign.html

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

test/karlcow/header-level2-hash-sign.md

@@ -0,0 +1 @@
+## This is an H2

test/karlcow/header-level3-hash-sign-closed.html

@@ -0,0 +1 @@
+<h3>This is an H3</h3>

test/karlcow/header-level3-hash-sign-closed.md

@@ -0,0 +1 @@
+### This is an H3 ###

test/karlcow/header-level3-hash-sign.html

@@ -0,0 +1 @@
+<h3>This is an H3</h3>

test/karlcow/header-level3-hash-sign.md

@@ -0,0 +1 @@
+### This is an H3

test/karlcow/header-level4-hash-sign-closed.html

@@ -0,0 +1 @@
+<h4>This is an H4</h4>

test/karlcow/header-level4-hash-sign-closed.md

@@ -0,0 +1 @@
+#### This is an H4 ####

test/karlcow/header-level4-hash-sign.html

@@ -0,0 +1 @@
+<h4>This is an H4</h4>

test/karlcow/header-level4-hash-sign.md

@@ -0,0 +1 @@
+#### This is an H4

test/karlcow/header-level5-hash-sign-closed.html

@@ -0,0 +1 @@
+<h5>This is an H5</h5>

test/karlcow/header-level5-hash-sign-closed.md

@@ -0,0 +1 @@
+##### This is an H5 #####

test/karlcow/header-level5-hash-sign.html

@@ -0,0 +1 @@
+<h5>This is an H5</h5>

test/karlcow/header-level5-hash-sign.md

@@ -0,0 +1 @@
+##### This is an H5