aboutsummaryrefslogtreecommitdiff
path: root/test/writers
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2016-07-03 19:19:21 +0100
committerMichael Williamson <mike@zwobble.org>2016-07-03 19:20:00 +0100
commit0b56dfce42c3944cce47e284608e6806f4c839c3 (patch)
tree5f96f9c2908f1c5b00a7192e71d4c192abd7cf47 /test/writers
parent627c4a755395e313234bdb1914d168392006c483 (diff)
Move tests to test for easier Mocha usage
Diffstat (limited to 'test/writers')
-rw-r--r--test/writers/html-writer.tests.js117
-rw-r--r--test/writers/markdown-writer.tests.js306
2 files changed, 423 insertions, 0 deletions
diff --git a/test/writers/html-writer.tests.js b/test/writers/html-writer.tests.js
new file mode 100644
index 0000000..41d8839
--- /dev/null
+++ b/test/writers/html-writer.tests.js
@@ -0,0 +1,117 @@
+var assert = require("assert");
+var test = require("../testing").test;
+
+var htmlWriter = require("../../lib/writers/html-writer");
+
+
+describe('html-writer', function() {
+ test('can generate simple paragraph', function() {
+ var writer = htmlWriter.writer();
+ writer.open("p");
+ writer.text("Hello");
+ writer.close("p");
+ return assert.equal(writer.asString(), "<p>Hello</p>");
+ });
+
+ test('can nest elements', function() {
+ var writer = htmlWriter.writer();
+ writer.open("ul");
+ writer.open("li");
+ writer.text("One");
+ writer.close("li");
+ writer.open("li");
+ writer.text("Two");
+ writer.close("li");
+ writer.close("ul");
+ return assert.equal(writer.asString(), "<ul><li>One</li><li>Two</li></ul>");
+ });
+
+ test('indents text if prettyPrint is true', function() {
+ var writer = htmlWriter.writer({prettyPrint: true});
+ writer.open("p");
+ writer.text("One");
+ writer.close("p");
+ writer.open("p");
+ writer.text("Two");
+ writer.close("p");
+ return assert.equal(writer.asString(), "<p>\n One\n</p>\n<p>\n Two\n</p>");
+ });
+
+ test('indents element if prettyPrint is true', function() {
+ var writer = htmlWriter.writer({prettyPrint: true});
+ writer.open("ul");
+ writer.open("li");
+ writer.text("One");
+ writer.close("li");
+ writer.open("li");
+ writer.text("Two");
+ writer.close("li");
+ writer.close("ul");
+ return assert.equal(writer.asString(), "<ul>\n <li>\n One\n </li>\n <li>\n Two\n </li>\n</ul>");
+ });
+
+ test('when prettyPrint is true inner elements do not have new lines', function() {
+ var writer = htmlWriter.writer({prettyPrint: true});
+ writer.open("p");
+ writer.text("One");
+ writer.open("em");
+ writer.text("Two");
+ writer.close("em");
+ writer.close("p");
+ return assert.equal(writer.asString(), "<p>\n One<em>Two</em>\n</p>");
+ });
+
+ test('indents closing element correctly when nested inside another indented element', function() {
+ var writer = htmlWriter.writer({prettyPrint: true});
+ writer.open("div");
+ writer.open("div");
+ writer.open("div");
+ writer.text("Hello");
+ writer.close("div");
+ writer.close("div");
+ writer.close("div");
+ return assert.equal(writer.asString(), "<div>\n <div>\n <div>\n Hello\n </div>\n </div>\n</div>");
+ });
+
+ test('newlines in text are indented', function() {
+ var writer = htmlWriter.writer({prettyPrint: true});
+ writer.open("p");
+ writer.text("One\nTwo");
+ writer.close("p");
+ return assert.equal(writer.asString(), "<p>\n One\n Two\n</p>");
+ });
+
+ test('run of text has only one new line', function() {
+ var writer = htmlWriter.writer({prettyPrint: true});
+ writer.open("p");
+ writer.text("One");
+ writer.text("Two");
+ writer.close("p");
+ return assert.equal(writer.asString(), "<p>\n OneTwo\n</p>");
+ });
+
+ test('run of html has only one new line', function() {
+ var writer = htmlWriter.writer({prettyPrint: true});
+ writer.open("p");
+ writer.append("One");
+ writer.append("Two");
+ writer.close("p");
+ return assert.equal(writer.asString(), "<p>\n OneTwo\n</p>");
+ });
+
+ test('self closing elements are indented', function() {
+ var writer = htmlWriter.writer({prettyPrint: true});
+ writer.open("p");
+ writer.selfClosing("br");
+ writer.close("p");
+ return assert.equal(writer.asString(), "<p>\n <br />\n</p>");
+ });
+
+ test('newlines in appended HTML are indented', function() {
+ var writer = htmlWriter.writer({prettyPrint: true});
+ writer.open("p");
+ writer.append("One\nTwo");
+ writer.close("p");
+ return assert.equal(writer.asString(), "<p>\n One\n Two\n</p>");
+ });
+});
diff --git a/test/writers/markdown-writer.tests.js b/test/writers/markdown-writer.tests.js
new file mode 100644
index 0000000..38d2afe
--- /dev/null
+++ b/test/writers/markdown-writer.tests.js
@@ -0,0 +1,306 @@
+var assert = require("assert");
+var test = require("../testing").test;
+
+var mdWriter = require("../../lib/writers/markdown-writer");
+
+describe('markdown-writer', function() {
+ test('special markdown characters are escaped', function() {
+ var writer = mdWriter.writer();
+ writer.text("\\*");
+ return assert.equal(writer.asString(), "\\\\\\*");
+ });
+
+ test('unrecognised elements are treated as normal text', function() {
+ var writer = mdWriter.writer();
+ writer.open("blah");
+ writer.text("Hello");
+ writer.close("blah");
+ return assert.equal(writer.asString(), "Hello");
+ });
+
+ test('paragraphs are terminated with double new line', function() {
+ var writer = mdWriter.writer();
+ writer.open("p");
+ writer.text("Hello");
+ writer.close("p");
+ return assert.equal(writer.asString(), "Hello\n\n");
+ });
+
+ test('h1 elements are converted to heading with leading hash', function() {
+ var writer = mdWriter.writer();
+ writer.open("h1");
+ writer.text("Hello");
+ writer.close("h1");
+ return assert.equal(writer.asString(), "# Hello\n\n");
+ });
+
+ test('h6 elements are converted to heading with six leading hashes', function() {
+ var writer = mdWriter.writer();
+ writer.open("h6");
+ writer.text("Hello");
+ writer.close("h6");
+ return assert.equal(writer.asString(), "###### Hello\n\n");
+ });
+
+ test('br is written as two spaces followed by new line', function() {
+ var writer = mdWriter.writer();
+ writer.text("Hello World");
+ writer.selfClosing("br");
+ return assert.equal(writer.asString(), "Hello World \n");
+ });
+
+ test('strong text is surrounded by two underscores', function() {
+ var writer = mdWriter.writer();
+ writer.text("Hello ");
+ writer.open("strong");
+ writer.text("World");
+ writer.close("strong");
+ return assert.equal(writer.asString(), "Hello __World__");
+ });
+
+ test('emphasised text is surrounded by one asterix', function() {
+ var writer = mdWriter.writer();
+ writer.text("Hello ");
+ writer.open("em");
+ writer.text("World");
+ writer.close("em");
+ return assert.equal(writer.asString(), "Hello *World*");
+ });
+
+ test('anchor tags are written as hyperlinks', function() {
+ var writer = mdWriter.writer();
+ writer.open("a", {"href": "http://example.com"});
+ writer.text("Hello");
+ writer.close("a");
+ return assert.equal(writer.asString(), "[Hello](http://example.com)");
+ });
+
+ test('anchor tags without href attribute are treated as ordinary text', function() {
+ var writer = mdWriter.writer();
+ writer.open("a");
+ writer.text("Hello");
+ writer.close("a");
+ return assert.equal(writer.asString(), "Hello");
+ });
+
+ test('elements with IDs have anchor tags with IDs appended to start of markdown element', function() {
+ var writer = mdWriter.writer();
+ writer.open("h1", {id: "start"});
+ writer.text("Hello");
+ writer.close("h1");
+ return assert.equal(writer.asString(), '# <a id="start"></a>Hello\n\n');
+ });
+
+ test('links have anchors before opening square bracket', function() {
+ var writer = mdWriter.writer();
+ writer.open("a", {href: "http://example.com", id: "start"});
+ writer.text("Hello");
+ writer.close("a");
+ return assert.equal(writer.asString(), '<a id="start"></a>[Hello](http://example.com)');
+ });
+
+ test('can generate images', function() {
+ var writer = mdWriter.writer();
+ writer.selfClosing("img", {"src": "http://example.com/image.jpg", "alt": "Alt Text"});
+ return assert.equal(writer.asString(), "![Alt Text](http://example.com/image.jpg)");
+ });
+
+ test('can generate images with missing alt attribute', function() {
+ var writer = mdWriter.writer();
+ writer.selfClosing("img", {"src": "http://example.com/image.jpg"});
+ return assert.equal(writer.asString(), "![](http://example.com/image.jpg)");
+ });
+
+ test('can generate images with missing src attribute', function() {
+ var writer = mdWriter.writer();
+ writer.selfClosing("img", {"alt": "Alt Text"});
+ return assert.equal(writer.asString(), "![Alt Text]()");
+ });
+
+ test("doesn't display empty images", function() {
+ var writer = mdWriter.writer();
+ writer.selfClosing("img");
+ return assert.equal(writer.asString(), "");
+ });
+
+ test('list item outside of list is treated as unordered list', function() {
+ var writer = mdWriter.writer();
+ writer.open("li");
+ writer.text("Hello");
+ writer.close("li");
+ return assert.equal(writer.asString(), "- Hello\n");
+ });
+
+ test('can generate an ordered list', function() {
+ var writer = mdWriter.writer();
+ writer.open("ol");
+ writer.open("li");
+ writer.text("Hello");
+ writer.close("li");
+ writer.open("li");
+ writer.text("World");
+ writer.close("li");
+ writer.close("ol");
+ return assert.equal(writer.asString(), "1. Hello\n2. World\n\n");
+ });
+
+ test('can generate an unordered list', function() {
+ var writer = mdWriter.writer();
+ writer.open("ul");
+ writer.open("li");
+ writer.text("Hello");
+ writer.close("li");
+ writer.open("li");
+ writer.text("World");
+ writer.close("li");
+ writer.close("ul");
+ return assert.equal(writer.asString(), "- Hello\n- World\n\n");
+ });
+
+ test('can generate a nested ordered list with correct numbering', function() {
+ var writer = mdWriter.writer();
+ writer.open("ol");
+ writer.open("li");
+ writer.text("Outer One");
+
+ writer.open("ol");
+ writer.open("li");
+ writer.text("Nested One");
+ writer.close("li");
+ writer.open("li");
+ writer.text("Nested Two");
+ writer.close("li");
+ writer.close("ol");
+
+ writer.close("li");
+ writer.open("li");
+ writer.text("Outer Two");
+ writer.close("li");
+ writer.close("ol");
+ return assert.equal(writer.asString(), "1. Outer One\n\t1. Nested One\n\t2. Nested Two\n2. Outer Two\n\n");
+ });
+
+ test('can generate a multi-level nested ordered list', function() {
+ var writer = mdWriter.writer();
+ writer.open("ol");
+ writer.open("li");
+ writer.text("Outer One");
+
+ writer.open("ol");
+ writer.open("li");
+ writer.text("Nested One");
+
+ writer.open("ol");
+ writer.open("li");
+ writer.text("Inner One");
+ writer.close("li");
+ writer.close("ol");
+
+ writer.close("li");
+ writer.close("ol");
+
+ writer.close("li");
+ writer.close("ol");
+ return assert.equal(writer.asString(), "1. Outer One\n\t1. Nested One\n\t\t1. Inner One\n\n");
+ });
+
+ test('new ordered list resets numbering', function() {
+ var writer = mdWriter.writer();
+ writer.open("ol");
+ writer.open("li");
+ writer.text("First");
+ writer.close("li");
+ writer.close("ol");
+
+ writer.open("p");
+ writer.text("Hello");
+ writer.close("p");
+
+ writer.open("ol");
+ writer.open("li");
+ writer.text("Second");
+ writer.close("li");
+ writer.close("ol");
+
+ return assert.equal(writer.asString(), "1. First\n\nHello\n\n1. Second\n\n");
+ });
+
+ test('can generate a nested unordered list', function() {
+ var writer = mdWriter.writer();
+ writer.open("ul");
+ writer.open("li");
+ writer.text("Outer One");
+
+ writer.open("ul");
+ writer.open("li");
+ writer.text("Nested One");
+ writer.close("li");
+ writer.open("li");
+ writer.text("Nested Two");
+ writer.close("li");
+ writer.close("ul");
+
+ writer.close("li");
+ writer.open("li");
+ writer.text("Outer Two");
+ writer.close("li");
+ writer.close("ul");
+ return assert.equal(writer.asString(), "- Outer One\n\t- Nested One\n\t- Nested Two\n- Outer Two\n\n");
+ });
+
+ test('can nest inline elements', function() {
+ var writer = mdWriter.writer();
+ writer.open("p");
+ writer.text("Lorem ");
+ writer.open("strong");
+ writer.text("ipsum ");
+ writer.open("em");
+ writer.text("dolor");
+ writer.close("em");
+ writer.text(" sit");
+ writer.close("strong");
+ writer.text(" amet");
+ writer.close("p");
+ return assert.equal(writer.asString(), "Lorem __ipsum *dolor* sit__ amet\n\n");
+ });
+
+ test('can emphasise list text', function() {
+ var writer = mdWriter.writer();
+ writer.open("ol");
+ writer.open("li");
+ writer.text("Hello ");
+ writer.open("strong");
+ writer.text("Strong");
+ writer.close("strong");
+ writer.text(" World");
+ writer.close("li");
+ writer.open("li");
+ writer.text("Hello ");
+ writer.open("em");
+ writer.text("Emphasis");
+ writer.close("em");
+ writer.text(" World");
+ writer.close("li");
+ writer.close("ol");
+ return assert.equal(writer.asString(), "1. Hello __Strong__ World\n2. Hello *Emphasis* World\n\n");
+ });
+
+ test('generates correct spacing between paragraphs and lists', function() {
+ var writer = mdWriter.writer();
+ writer.open("p");
+ writer.text("Hello World");
+ writer.close("p");
+ writer.open("ul");
+ writer.open("li");
+ writer.text("First Item");
+ writer.close("li");
+ writer.open("li");
+ writer.text("Second Item");
+ writer.close("li");
+ writer.close("ul");
+ writer.open("p");
+ writer.text("Hello World");
+ writer.close("p");
+ return assert.equal(writer.asString(), "Hello World\n\n- First Item\n- Second Item\n\nHello World\n\n");
+ });
+});