diff options
| author | Michael Williamson <mike@zwobble.org> | 2016-07-07 21:03:42 +0100 |
|---|---|---|
| committer | Michael Williamson <mike@zwobble.org> | 2016-07-07 21:03:42 +0100 |
| commit | 1c439031d328a09bfb178b1182c09bb62d03782c (patch) | |
| tree | 172b7672783815fc65311b6254ca3c5352b3ec05 /test/document-to-html.tests.js | |
| parent | a8db31365fbb243a7c5a62336daea6d458a888f7 (diff) | |
Use export-style tests for document-to-html.tests.js
Diffstat (limited to 'test/document-to-html.tests.js')
| -rw-r--r-- | test/document-to-html.tests.js | 1014 |
1 files changed, 506 insertions, 508 deletions
diff --git a/test/document-to-html.tests.js b/test/document-to-html.tests.js index d765a30..436014f 100644 --- a/test/document-to-html.tests.js +++ b/test/document-to-html.tests.js @@ -3,7 +3,7 @@ var promises = require("../lib/promises"); var documents = require("../lib/documents"); var DocumentConverter = require("../lib/document-to-html").DocumentConverter; -var test = require("./testing").test; +var test = require("./test")(module); var htmlPaths = require("../lib/html-paths"); var xml = require("../lib/xml"); var results = require("../lib/results"); @@ -11,564 +11,562 @@ var documentMatchers = require("../lib/document-matchers"); var Html = require("../lib/html"); -describe('DocumentConverter', function() { - test('should empty document to empty string', function() { - var document = new documents.Document([]); - var converter = new DocumentConverter(); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value, ""); - }); +test('should empty document to empty string', function() { + var document = new documents.Document([]); + var converter = new DocumentConverter(); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, ""); }); - - test('should convert document containing one paragraph to single p element', function() { - var document = new documents.Document([ - paragraphOfText("Hello.") - ]); - var converter = new DocumentConverter(); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value, "<p>Hello.</p>"); - }); +}); + +test('should convert document containing one paragraph to single p element', function() { + var document = new documents.Document([ + paragraphOfText("Hello.") + ]); + var converter = new DocumentConverter(); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, "<p>Hello.</p>"); }); - - test('ignores empty paragraphs', function() { - var document = new documents.Document([ - paragraphOfText("") - ]); - var converter = new DocumentConverter(); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value, ""); - }); +}); + +test('ignores empty paragraphs', function() { + var document = new documents.Document([ + paragraphOfText("") + ]); + var converter = new DocumentConverter(); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, ""); }); - - test('text is HTML-escaped', function() { - var document = new documents.Document([ - paragraphOfText("1 < 2") - ]); - var converter = new DocumentConverter(); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value, "<p>1 < 2</p>"); - }); +}); + +test('text is HTML-escaped', function() { + var document = new documents.Document([ + paragraphOfText("1 < 2") + ]); + var converter = new DocumentConverter(); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, "<p>1 < 2</p>"); }); - - test('should convert document containing multiple paragraphs to multiple p elements', function() { - var document = new documents.Document([ - paragraphOfText("Hello."), - paragraphOfText("Goodbye.") - ]); - var converter = new DocumentConverter(); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value, "<p>Hello.</p><p>Goodbye.</p>"); - }); +}); + +test('should convert document containing multiple paragraphs to multiple p elements', function() { + var document = new documents.Document([ + paragraphOfText("Hello."), + paragraphOfText("Goodbye.") + ]); + var converter = new DocumentConverter(); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, "<p>Hello.</p><p>Goodbye.</p>"); }); - - test('uses style mappings to pick HTML element for docx paragraph', function() { - var document = new documents.Document([ - paragraphOfText("Hello.", "Heading1", "Heading 1") - ]); - var converter = new DocumentConverter({ - styleMap: [ - { - from: documentMatchers.paragraph({styleName: "Heading 1"}), - to: htmlPaths.topLevelElement("h1") - } - ] - }); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value, "<h1>Hello.</h1>"); - }); +}); + +test('uses style mappings to pick HTML element for docx paragraph', function() { + var document = new documents.Document([ + paragraphOfText("Hello.", "Heading1", "Heading 1") + ]); + var converter = new DocumentConverter({ + styleMap: [ + { + from: documentMatchers.paragraph({styleName: "Heading 1"}), + to: htmlPaths.topLevelElement("h1") + } + ] }); - - test('mappings for style names are case insensitive', function() { - var document = new documents.Document([ - paragraphOfText("Hello.", "Heading1", "heading 1") - ]); - var converter = new DocumentConverter({ - styleMap: [ - { - from: documentMatchers.paragraph({styleName: "Heading 1"}), - to: htmlPaths.topLevelElement("h1") - } - ] - }); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value, "<h1>Hello.</h1>"); - }); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, "<h1>Hello.</h1>"); }); - - test('can use non-default HTML element for unstyled paragraphs', function() { - var document = new documents.Document([ - paragraphOfText("Hello.") - ]); - var converter = new DocumentConverter({ - styleMap: [ - { - from: documentMatchers.paragraph(), - to: htmlPaths.topLevelElement("h1") - } - ] - }); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value, "<h1>Hello.</h1>"); - }); +}); + +test('mappings for style names are case insensitive', function() { + var document = new documents.Document([ + paragraphOfText("Hello.", "Heading1", "heading 1") + ]); + var converter = new DocumentConverter({ + styleMap: [ + { + from: documentMatchers.paragraph({styleName: "Heading 1"}), + to: htmlPaths.topLevelElement("h1") + } + ] }); - - test('warning is emitted if paragraph style is unrecognised', function() { - var document = new documents.Document([ - paragraphOfText("Hello.", "Heading1", "Heading 1") - ]); - var converter = new DocumentConverter(); - return converter.convertToHtml(document).then(function(result) { - assert.deepEqual(result.messages, [results.warning("Unrecognised paragraph style: 'Heading 1' (Style ID: Heading1)")]); - }); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, "<h1>Hello.</h1>"); }); - - test('can use stacked styles to generate nested HTML elements', function() { - var document = new documents.Document([ - paragraphOfText("Hello.") - ]); - var converter = new DocumentConverter({ - styleMap: [ - { - from: documentMatchers.paragraph(), - to: htmlPaths.elements(["h1", "span"]) - } - ] - }); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value, "<h1><span>Hello.</span></h1>"); - }); +}); + +test('can use non-default HTML element for unstyled paragraphs', function() { + var document = new documents.Document([ + paragraphOfText("Hello.") + ]); + var converter = new DocumentConverter({ + styleMap: [ + { + from: documentMatchers.paragraph(), + to: htmlPaths.topLevelElement("h1") + } + ] }); - - test('bold runs are wrapped in <strong> tags by default', function() { - var run = runOfText("Hello.", {isBold: true}); - var converter = new DocumentConverter(); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<strong>Hello.</strong>"); - }); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, "<h1>Hello.</h1>"); }); - - test('bold runs can be configured with style mapping', function() { - var run = runOfText("Hello.", {isBold: true}); - var converter = new DocumentConverter({ - styleMap: [ - { - from: documentMatchers.bold, - to: htmlPaths.elements([htmlPaths.element("em")]) - } - ] - }); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<em>Hello.</em>"); - }); +}); + +test('warning is emitted if paragraph style is unrecognised', function() { + var document = new documents.Document([ + paragraphOfText("Hello.", "Heading1", "Heading 1") + ]); + var converter = new DocumentConverter(); + return converter.convertToHtml(document).then(function(result) { + assert.deepEqual(result.messages, [results.warning("Unrecognised paragraph style: 'Heading 1' (Style ID: Heading1)")]); }); - - test('bold runs can exist inside other tags', function() { - var run = new documents.Paragraph([ - runOfText("Hello.", {isBold: true}) - ]); - var converter = new DocumentConverter(); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<p><strong>Hello.</strong></p>"); - }); +}); + +test('can use stacked styles to generate nested HTML elements', function() { + var document = new documents.Document([ + paragraphOfText("Hello.") + ]); + var converter = new DocumentConverter({ + styleMap: [ + { + from: documentMatchers.paragraph(), + to: htmlPaths.elements(["h1", "span"]) + } + ] }); - - test('consecutive bold runs are wrapped in a single <strong> element', function() { - var paragraph = new documents.Paragraph([ - runOfText("Hello", {isBold: true}), - runOfText(".", {isBold: true}) - ]); - var converter = new DocumentConverter(); - return converter.convertToHtml(paragraph).then(function(result) { - assert.equal(result.value, "<p><strong>Hello.</strong></p>"); - }); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, "<h1><span>Hello.</span></h1>"); }); - - test('underline runs are ignored by default', function() { - var run = runOfText("Hello.", {isUnderline: true}); - var converter = new DocumentConverter(); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "Hello."); - }); +}); + +test('bold runs are wrapped in <strong> tags by default', function() { + var run = runOfText("Hello.", {isBold: true}); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<strong>Hello.</strong>"); }); - - test('underline runs can be mapped using style mapping', function() { - var run = runOfText("Hello.", {isUnderline: true}); - var converter = new DocumentConverter({ - styleMap: [ - { - from: documentMatchers.underline, - to: htmlPaths.elements([htmlPaths.element("u")]) - } - ] - }); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<u>Hello.</u>"); - }); +}); + +test('bold runs can be configured with style mapping', function() { + var run = runOfText("Hello.", {isBold: true}); + var converter = new DocumentConverter({ + styleMap: [ + { + from: documentMatchers.bold, + to: htmlPaths.elements([htmlPaths.element("em")]) + } + ] }); - - test('style mapping for underline runs does not close parent elements', function() { - var run = runOfText("Hello.", {isUnderline: true, isBold: true}); - var converter = new DocumentConverter({ - styleMap: [ - { - from: documentMatchers.underline, - to: htmlPaths.elements([htmlPaths.element("u")]) - } - ] - }); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<strong><u>Hello.</u></strong>"); - }); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<em>Hello.</em>"); }); - - test('strikethrough runs are wrapped in <s> tags by default', function() { - var run = runOfText("Hello.", {isStrikethrough: true}); - var converter = new DocumentConverter(); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<s>Hello.</s>"); - }); +}); + +test('bold runs can exist inside other tags', function() { + var run = new documents.Paragraph([ + runOfText("Hello.", {isBold: true}) + ]); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<p><strong>Hello.</strong></p>"); }); - - test('strikethrough runs can be configured with style mapping', function() { - var run = runOfText("Hello.", {isStrikethrough: true}); - var converter = new DocumentConverter({ - styleMap: [ - { - from: documentMatchers.strikethrough, - to: htmlPaths.elements([htmlPaths.element("del")]) - } - ] - }); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<del>Hello.</del>"); - }); +}); + +test('consecutive bold runs are wrapped in a single <strong> element', function() { + var paragraph = new documents.Paragraph([ + runOfText("Hello", {isBold: true}), + runOfText(".", {isBold: true}) + ]); + var converter = new DocumentConverter(); + return converter.convertToHtml(paragraph).then(function(result) { + assert.equal(result.value, "<p><strong>Hello.</strong></p>"); }); +}); - test('italic runs are wrapped in <em> tags', function() { - var run = runOfText("Hello.", {isItalic: true}); - var converter = new DocumentConverter(); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<em>Hello.</em>"); - }); +test('underline runs are ignored by default', function() { + var run = runOfText("Hello.", {isUnderline: true}); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "Hello."); }); - - test('italic runs can be configured with style mapping', function() { - var run = runOfText("Hello.", {isItalic: true}); - var converter = new DocumentConverter({ - styleMap: [ - { - from: documentMatchers.italic, - to: htmlPaths.elements([htmlPaths.element("strong")]) - } - ] - }); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<strong>Hello.</strong>"); - }); +}); + +test('underline runs can be mapped using style mapping', function() { + var run = runOfText("Hello.", {isUnderline: true}); + var converter = new DocumentConverter({ + styleMap: [ + { + from: documentMatchers.underline, + to: htmlPaths.elements([htmlPaths.element("u")]) + } + ] }); - - test('run can be both bold and italic', function() { - var run = runOfText("Hello.", {isBold: true, isItalic: true}); - var converter = new DocumentConverter(); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<strong><em>Hello.</em></strong>"); - }); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<u>Hello.</u>"); }); - - test('superscript runs are wrapped in <sup> tags', function() { - var run = runOfText("Hello.", { - verticalAlignment: documents.verticalAlignment.superscript - }); - var converter = new DocumentConverter(); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<sup>Hello.</sup>"); - }); +}); + +test('style mapping for underline runs does not close parent elements', function() { + var run = runOfText("Hello.", {isUnderline: true, isBold: true}); + var converter = new DocumentConverter({ + styleMap: [ + { + from: documentMatchers.underline, + to: htmlPaths.elements([htmlPaths.element("u")]) + } + ] }); - - test('subscript runs are wrapped in <sub> tags', function() { - var run = runOfText("Hello.", { - verticalAlignment: documents.verticalAlignment.subscript - }); - var converter = new DocumentConverter(); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<sub>Hello.</sub>"); - }); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<strong><u>Hello.</u></strong>"); }); - - test('run styles are converted to HTML if mapping exists', function() { - var run = runOfText("Hello.", {styleId: "Heading1Char", styleName: "Heading 1 Char"}); - var converter = new DocumentConverter({ - styleMap: [ - { - from: documentMatchers.run({styleName: "Heading 1 Char"}), - to: htmlPaths.elements(["strong"]) - } - ] - }); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "<strong>Hello.</strong>"); - }); +}); + +test('strikethrough runs are wrapped in <s> tags by default', function() { + var run = runOfText("Hello.", {isStrikethrough: true}); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<s>Hello.</s>"); }); - - test('warning is emitted if run style is unrecognised', function() { - var run = runOfText("Hello.", {styleId: "Heading1Char", styleName: "Heading 1 Char"}); - var converter = new DocumentConverter(); - return converter.convertToHtml(run).then(function(result) { - assert.deepEqual(result.messages, [results.warning("Unrecognised run style: 'Heading 1 Char' (Style ID: Heading1Char)")]); - }); +}); + +test('strikethrough runs can be configured with style mapping', function() { + var run = runOfText("Hello.", {isStrikethrough: true}); + var converter = new DocumentConverter({ + styleMap: [ + { + from: documentMatchers.strikethrough, + to: htmlPaths.elements([htmlPaths.element("del")]) + } + ] }); - - test('docx hyperlink is converted to <a>', function() { - var hyperlink = new documents.Hyperlink( - [runOfText("Hello.")], - {href: "http://www.example.com"} - ); - var converter = new DocumentConverter(); - return converter.convertToHtml(hyperlink).then(function(result) { - assert.equal(result.value, '<a href="http://www.example.com">Hello.</a>'); - }); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<del>Hello.</del>"); }); +}); - test('docx hyperlink with anchor is converted to <a>', function() { - var hyperlink = new documents.Hyperlink( - [runOfText("Hello.")], - {anchor: "_Peter"} - ); - var converter = new DocumentConverter({ - idPrefix: "doc-42-" - }); - return converter.convertToHtml(hyperlink).then(function(result) { - assert.equal(result.value, '<a href="#doc-42-_Peter">Hello.</a>'); - }); +test('italic runs are wrapped in <em> tags', function() { + var run = runOfText("Hello.", {isItalic: true}); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<em>Hello.</em>"); }); +}); - test('bookmarks are converted to anchors', function() { - var bookmarkStart = new documents.BookmarkStart({name: "_Peter"}); - var converter = new DocumentConverter({ - idPrefix: "doc-42-" - }); - var document = new documents.Document([bookmarkStart]); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value, '<a id="doc-42-_Peter"></a>'); - }); +test('italic runs can be configured with style mapping', function() { + var run = runOfText("Hello.", {isItalic: true}); + var converter = new DocumentConverter({ + styleMap: [ + { + from: documentMatchers.italic, + to: htmlPaths.elements([htmlPaths.element("strong")]) + } + ] + }); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<strong>Hello.</strong>"); }); +}); - test('docx tab is converted to tab in HTML', function() { - var tab = new documents.Tab(); - var converter = new DocumentConverter(); - return converter.convertToHtml(tab).then(function(result) { - assert.equal(result.value, "\t"); - }); +test('run can be both bold and italic', function() { + var run = runOfText("Hello.", {isBold: true, isItalic: true}); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<strong><em>Hello.</em></strong>"); }); - - test('docx table is converted to table in HTML', function() { - var table = new documents.Table([ - new documents.TableRow([ - new documents.TableCell([paragraphOfText("Top left")]), - new documents.TableCell([paragraphOfText("Top right")]) - ]), - new documents.TableRow([ - new documents.TableCell([paragraphOfText("Bottom left")]), - new documents.TableCell([paragraphOfText("Bottom right")]) - ]) - ]); - var converter = new DocumentConverter(); - - return converter.convertToHtml(table).then(function(result) { - var expectedHtml = "<table>" + - "<tr><td><p>Top left</p></td><td><p>Top right</p></td></tr>" + - "<tr><td><p>Bottom left</p></td><td><p>Bottom right</p></td></tr>" + - "</table>"; - assert.equal(result.value, expectedHtml); - }); +}); + +test('superscript runs are wrapped in <sup> tags', function() { + var run = runOfText("Hello.", { + verticalAlignment: documents.verticalAlignment.superscript }); - - test('empty cells are preserved in table', function() { - var table = new documents.Table([ - new documents.TableRow([ - new documents.TableCell([paragraphOfText("")]), - new documents.TableCell([paragraphOfText("Top right")]) - ]) - ]); - var converter = new DocumentConverter(); - - return converter.convertToHtml(table).then(function(result) { - var expectedHtml = "<table>" + - "<tr><td></td><td><p>Top right</p></td></tr>" + - "</table>"; - assert.equal(result.value, expectedHtml); - }); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<sup>Hello.</sup>"); }); - - test('table cells are written with colSpan if not equal to one', function() { - var table = new documents.Table([ - new documents.TableRow([ - new documents.TableCell([paragraphOfText("Top left")], {colSpan: 2}), - new documents.TableCell([paragraphOfText("Top right")]) - ]) - ]); - var converter = new DocumentConverter(); - - return converter.convertToHtml(table).then(function(result) { - var expectedHtml = "<table>" + - "<tr><td colspan=\"2\"><p>Top left</p></td><td><p>Top right</p></td></tr>" + - "</table>"; - assert.equal(result.value, expectedHtml); - }); +}); + +test('subscript runs are wrapped in <sub> tags', function() { + var run = runOfText("Hello.", { + verticalAlignment: documents.verticalAlignment.subscript }); - - test('table cells are written with rowSpan if not equal to one', function() { - var table = new documents.Table([ - new documents.TableRow([ - new documents.TableCell([], {rowSpan: 2}) - ]) - ]); - var converter = new DocumentConverter(); - - return converter.convertToHtml(table).then(function(result) { - var expectedHtml = "<table>" + - "<tr><td rowspan=\"2\"></td></tr>" + - "</table>"; - assert.equal(result.value, expectedHtml); - }); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<sub>Hello.</sub>"); }); - - test('line break is converted to <br>', function() { - var lineBreak = new documents.LineBreak(); - var converter = new DocumentConverter(); - - return converter.convertToHtml(lineBreak).then(function(result) { - assert.equal(result.value, "<br />"); - }); +}); + +test('run styles are converted to HTML if mapping exists', function() { + var run = runOfText("Hello.", {styleId: "Heading1Char", styleName: "Heading 1 Char"}); + var converter = new DocumentConverter({ + styleMap: [ + { + from: documentMatchers.run({styleName: "Heading 1 Char"}), + to: htmlPaths.elements(["strong"]) + } + ] }); - - test('footnote reference is converted to superscript intra-page link', function() { - var footnoteReference = new documents.NoteReference({ - noteType: "footnote", - noteId: "4" - }); - var converter = new DocumentConverter({ - idPrefix: "doc-42-" - }); - return converter.convertToHtml(footnoteReference).then(function(result) { - assert.equal(result.value, '<sup><a href="#doc-42-footnote-4" id="doc-42-footnote-ref-4">[1]</a></sup>'); - }); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "<strong>Hello.</strong>"); + }); +}); + +test('warning is emitted if run style is unrecognised', function() { + var run = runOfText("Hello.", {styleId: "Heading1Char", styleName: "Heading 1 Char"}); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.deepEqual(result.messages, [results.warning("Unrecognised run style: 'Heading 1 Char' (Style ID: Heading1Char)")]); + }); +}); + +test('docx hyperlink is converted to <a>', function() { + var hyperlink = new documents.Hyperlink( + [runOfText("Hello.")], + {href: "http://www.example.com"} + ); + var converter = new DocumentConverter(); + return converter.convertToHtml(hyperlink).then(function(result) { + assert.equal(result.value, '<a href="http://www.example.com">Hello.</a>'); + }); +}); + +test('docx hyperlink with anchor is converted to <a>', function() { + var hyperlink = new documents.Hyperlink( + [runOfText("Hello.")], + {anchor: "_Peter"} + ); + var converter = new DocumentConverter({ + idPrefix: "doc-42-" + }); + return converter.convertToHtml(hyperlink).then(function(result) { + assert.equal(result.value, '<a href="#doc-42-_Peter">Hello.</a>'); + }); +}); + +test('bookmarks are converted to anchors', function() { + var bookmarkStart = new documents.BookmarkStart({name: "_Peter"}); + var converter = new DocumentConverter({ + idPrefix: "doc-42-" + }); + var document = new documents.Document([bookmarkStart]); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, '<a id="doc-42-_Peter"></a>'); }); +}); + +test('docx tab is converted to tab in HTML', function() { + var tab = new documents.Tab(); + var converter = new DocumentConverter(); + return converter.convertToHtml(tab).then(function(result) { + assert.equal(result.value, "\t"); + }); +}); + +test('docx table is converted to table in HTML', function() { + var table = new documents.Table([ + new documents.TableRow([ + new documents.TableCell([paragraphOfText("Top left")]), + new documents.TableCell([paragraphOfText("Top right")]) + ]), + new documents.TableRow([ + new documents.TableCell([paragraphOfText("Bottom left")]), + new documents.TableCell([paragraphOfText("Bottom right")]) + ]) + ]); + var converter = new DocumentConverter(); + + return converter.convertToHtml(table).then(function(result) { + var expectedHtml = "<table>" + + "<tr><td><p>Top left</p></td><td><p>Top right</p></td></tr>" + + "<tr><td><p>Bottom left</p></td><td><p>Bottom right</p></td></tr>" + + "</table>"; + assert.equal(result.value, expectedHtml); + }); +}); + +test('empty cells are preserved in table', function() { + var table = new documents.Table([ + new documents.TableRow([ + new documents.TableCell([paragraphOfText("")]), + new documents.TableCell([paragraphOfText("Top right")]) + ]) + ]); + var converter = new DocumentConverter(); + + return converter.convertToHtml(table).then(function(result) { + var expectedHtml = "<table>" + + "<tr><td></td><td><p>Top right</p></td></tr>" + + "</table>"; + assert.equal(result.value, expectedHtml); + }); +}); + +test('table cells are written with colSpan if not equal to one', function() { + var table = new documents.Table([ + new documents.TableRow([ + new documents.TableCell([paragraphOfText("Top left")], {colSpan: 2}), + new documents.TableCell([paragraphOfText("Top right")]) + ]) + ]); + var converter = new DocumentConverter(); + + return converter.convertToHtml(table).then(function(result) { + var expectedHtml = "<table>" + + "<tr><td colspan=\"2\"><p>Top left</p></td><td><p>Top right</p></td></tr>" + + "</table>"; + assert.equal(result.value, expectedHtml); + }); +}); + +test('table cells are written with rowSpan if not equal to one', function() { + var table = new documents.Table([ + new documents.TableRow([ + new documents.TableCell([], {rowSpan: 2}) + ]) + ]); + var converter = new DocumentConverter(); + + return converter.convertToHtml(table).then(function(result) { + var expectedHtml = "<table>" + + "<tr><td rowspan=\"2\"></td></tr>" + + "</table>"; + assert.equal(result.value, expectedHtml); + }); +}); + +test('line break is converted to <br>', function() { + var lineBreak = new documents.LineBreak(); + var converter = new DocumentConverter(); - test('footnotes are included after the main body', function() { - var footnoteReference = new documents.NoteReference({ - noteType: "footnote", - noteId: "4" - }); - var document = new documents.Document( - [new documents.Paragraph([ - runOfText("Knock knock"), - new documents.Run([footnoteReference]) - ])], - { - notes: new documents.Notes({ - 4: new documents.Note({ - noteType: "footnote", - noteId: "4", - body: [paragraphOfText("Who's there?")] - }) - }) - } - ); - - var converter = new DocumentConverter({ - idPrefix: "doc-42-" - }); - return converter.convertToHtml(document).then(function(result) { - var expectedOutput = '<p>Knock knock<sup><a href="#doc-42-footnote-4" id="doc-42-footnote-ref-4">[1]</a></sup></p>' + - '<ol><li id="doc-42-footnote-4"><p>Who\'s there? <a href="#doc-42-footnote-ref-4">↑</a></p></li></ol>'; - assert.equal(result.value, expectedOutput); - }); + return converter.convertToHtml(lineBreak).then(function(result) { + assert.equal(result.value, "<br />"); + }); +}); + +test('footnote reference is converted to superscript intra-page link', function() { + var footnoteReference = new documents.NoteReference({ + noteType: "footnote", + noteId: "4" }); + var converter = new DocumentConverter({ + idPrefix: "doc-42-" + }); + return converter.convertToHtml(footnoteReference).then(function(result) { + assert.equal(result.value, '<sup><a href="#doc-42-footnote-4" id="doc-42-footnote-ref-4">[1]</a></sup>'); + }); +}); + +test('footnotes are included after the main body', function() { + var footnoteReference = new documents.NoteReference({ + noteType: "footnote", + noteId: "4" + }); + var document = new documents.Document( + [new documents.Paragraph([ + runOfText("Knock knock"), + new documents.Run([footnoteReference]) + ])], + { + notes: new documents.Notes({ + 4: new documents.Note({ + noteType: "footnote", + noteId: "4", + body: [paragraphOfText("Who's there?")] + }) + }) + } + ); - test('comments are ignored by default', function() { - var reference = documents.commentReference("4"); - var comment = documents.comment({ - commentId: "4", - body: [paragraphOfText("Who's there?")] - }); - var document = documents.document([ - documents.paragraph([ - runOfText("Knock knock"), - documents.run([reference]) - ]) - ], {comments: [comment]}); - - var converter = new DocumentConverter({}); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value, '<p>Knock knock</p>'); - assert.deepEqual(result.messages, []); - }); - + var converter = new DocumentConverter({ + idPrefix: "doc-42-" }); + return converter.convertToHtml(document).then(function(result) { + var expectedOutput = '<p>Knock knock<sup><a href="#doc-42-footnote-4" id="doc-42-footnote-ref-4">[1]</a></sup></p>' + + '<ol><li id="doc-42-footnote-4"><p>Who\'s there? <a href="#doc-42-footnote-ref-4">↑</a></p></li></ol>'; + assert.equal(result.value, expectedOutput); + }); +}); + +test('comments are ignored by default', function() { + var reference = documents.commentReference("4"); + var comment = documents.comment({ + commentId: "4", + body: [paragraphOfText("Who's there?")] + }); + var document = documents.document([ + documents.paragraph([ + runOfText("Knock knock"), + documents.run([reference]) + ]) + ], {comments: [comment]}); - test('images are written with data URIs', function() { - var imageBuffer = new Buffer("Not an image at all!"); - var image = new documents.Image({ - readImage: function(encoding) { - return promises.when(imageBuffer.toString(encoding)); - }, - contentType: "image/png" - }); - var converter = new DocumentConverter(); - return converter.convertToHtml(image).then(function(result) { - assert.equal(result.value, '<img src="data:image/png;base64,' + imageBuffer.toString("base64") + '" />'); - }); + var converter = new DocumentConverter({}); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, '<p>Knock knock</p>'); + assert.deepEqual(result.messages, []); }); - test('images have alt attribute if available', function() { - var imageBuffer = new Buffer("Not an image at all!"); - var image = new documents.Image({ - readImage: function() { - return promises.when(imageBuffer); - }, - altText: "It's a hat" +}); + +test('images are written with data URIs', function() { + var imageBuffer = new Buffer("Not an image at all!"); + var image = new documents.Image({ + readImage: function(encoding) { + return promises.when(imageBuffer.toString(encoding)); + }, + contentType: "image/png" + }); + var converter = new DocumentConverter(); + return converter.convertToHtml(image).then(function(result) { + assert.equal(result.value, '<img src="data:image/png;base64,' + imageBuffer.toString("base64") + '" />'); + }); +}); + +test('images have alt attribute if available', function() { + var imageBuffer = new Buffer("Not an image at all!"); + var image = new documents.Image({ + readImage: function() { + return promises.when(imageBuffer); + }, + altText: "It's a hat" + }); + var converter = new DocumentConverter(); + return converter.convertToHtml(image) + .then(function(result) { + return xml.readString(result.value); + }) + .then(function(htmlImageElement) { + assert.equal(htmlImageElement.attributes.alt, "It's a hat"); }); - var converter = new DocumentConverter(); - return converter.convertToHtml(image) - .then(function(result) { - return xml.readString(result.value); - }) - .then(function(htmlImageElement) { - assert.equal(htmlImageElement.attributes.alt, "It's a hat"); +}); + +test('can add custom handler for images', function() { + var imageBuffer = new Buffer("Not an image at all!"); + var image = new documents.Image({ + readImage: function(encoding) { + return promises.when(imageBuffer.toString(encoding)); + }, + contentType: "image/png" + }); + var converter = new DocumentConverter({ + convertImage: function(element, messages) { + return element.read("utf8").then(function(altText) { + return [Html.selfClosingElement("img", {alt: altText})]; }); + } }); - - test('can add custom handler for images', function() { - var imageBuffer = new Buffer("Not an image at all!"); - var image = new documents.Image({ - readImage: function(encoding) { - return promises.when(imageBuffer.toString(encoding)); - }, - contentType: "image/png" - }); - var converter = new DocumentConverter({ - convertImage: function(element, messages) { - return element.read("utf8").then(function(altText) { - return [Html.selfClosingElement("img", {alt: altText})]; - }); - } - }); - return converter.convertToHtml(image).then(function(result) { - assert.equal(result.value, '<img alt="Not an image at all!" />'); - }); + return converter.convertToHtml(image).then(function(result) { + assert.equal(result.value, '<img alt="Not an image at all!" />'); }); - - test('long documents do not cause stack overflow', function() { - var paragraphs = []; - for (var i = 0; i < 1000; i++) { - paragraphs.push(paragraphOfText("Hello.")); - } - var document = new documents.Document(paragraphs); - var converter = new DocumentConverter(); - return converter.convertToHtml(document).then(function(result) { - assert.equal(result.value.indexOf("<p>Hello.</p>"), 0); - }); +}); + +test('long documents do not cause stack overflow', function() { + var paragraphs = []; + for (var i = 0; i < 1000; i++) { + paragraphs.push(paragraphOfText("Hello.")); + } + var document = new documents.Document(paragraphs); + var converter = new DocumentConverter(); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value.indexOf("<p>Hello.</p>"), 0); }); }); |
