From b0ff9fc6b25bbe74aaa7245d24a6476b4f5f1ec6 Mon Sep 17 00:00:00 2001 From: Michael Williamson Date: Thu, 7 Jul 2016 20:49:22 +0100 Subject: Test that comments are ignored by default --- test/document-to-html.tests.js | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'test/document-to-html.tests.js') diff --git a/test/document-to-html.tests.js b/test/document-to-html.tests.js index 0b4f905..a4678ec 100644 --- a/test/document-to-html.tests.js +++ b/test/document-to-html.tests.js @@ -486,6 +486,26 @@ describe('DocumentConverter', function() { }); }); + 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, '

Knock knock

'); + }); + + }); + test('images are written with data URIs', function() { var imageBuffer = new Buffer("Not an image at all!"); var image = new documents.Image({ -- cgit v1.2.3 From a8db31365fbb243a7c5a62336daea6d458a888f7 Mon Sep 17 00:00:00 2001 From: Michael Williamson Date: Thu, 7 Jul 2016 20:49:58 +0100 Subject: Test no messages when ignoring comments --- test/document-to-html.tests.js | 1 + 1 file changed, 1 insertion(+) (limited to 'test/document-to-html.tests.js') diff --git a/test/document-to-html.tests.js b/test/document-to-html.tests.js index a4678ec..d765a30 100644 --- a/test/document-to-html.tests.js +++ b/test/document-to-html.tests.js @@ -502,6 +502,7 @@ describe('DocumentConverter', function() { var converter = new DocumentConverter({}); return converter.convertToHtml(document).then(function(result) { assert.equal(result.value, '

Knock knock

'); + assert.deepEqual(result.messages, []); }); }); -- cgit v1.2.3 From 1c439031d328a09bfb178b1182c09bb62d03782c Mon Sep 17 00:00:00 2001 From: Michael Williamson Date: Thu, 7 Jul 2016 21:03:42 +0100 Subject: Use export-style tests for document-to-html.tests.js --- test/document-to-html.tests.js | 1014 ++++++++++++++++++++-------------------- 1 file changed, 506 insertions(+), 508 deletions(-) (limited to 'test/document-to-html.tests.js') 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, "

Hello.

"); - }); +}); + +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, "

Hello.

"); }); - - 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, "

1 < 2

"); - }); +}); + +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, "

1 < 2

"); }); - - 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, "

Hello.

Goodbye.

"); - }); +}); + +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, "

Hello.

Goodbye.

"); }); - - 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, "

Hello.

"); - }); +}); + +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, "

Hello.

"); - }); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, "

Hello.

"); }); - - 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, "

Hello.

"); - }); +}); + +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, "

Hello.

"); }); - - 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, "

Hello.

"); - }); +}); + +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 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, "Hello."); - }); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, "

Hello.

"); }); - - 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, "Hello."); - }); +}); + +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, "

Hello.

"); - }); +}); + +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 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, "

Hello.

"); - }); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, "

Hello.

"); }); - - 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 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, "Hello."); }); - - 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, "Hello."); - }); +}); + +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, "Hello."); - }); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "Hello."); }); - - test('strikethrough runs are wrapped in 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, "Hello."); - }); +}); + +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, "

Hello.

"); }); - - 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, "Hello."); - }); +}); + +test('consecutive bold runs are wrapped in a single 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, "

Hello.

"); }); +}); - test('italic runs are wrapped in tags', function() { - var run = runOfText("Hello.", {isItalic: true}); - var converter = new DocumentConverter(); - return converter.convertToHtml(run).then(function(result) { - assert.equal(result.value, "Hello."); - }); +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, "Hello."); - }); +}); + +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, "Hello."); - }); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "Hello."); }); - - test('superscript runs are wrapped in 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, "Hello."); - }); +}); + +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 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, "Hello."); - }); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "Hello."); }); - - 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, "Hello."); - }); +}); + +test('strikethrough runs are wrapped in 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, "Hello."); }); - - 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 ', 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, 'Hello.'); - }); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "Hello."); }); +}); - test('docx hyperlink with anchor is converted to ', 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, 'Hello.'); - }); +test('italic runs are wrapped in tags', function() { + var run = runOfText("Hello.", {isItalic: true}); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "Hello."); }); +}); - 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, ''); - }); +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, "Hello."); }); +}); - 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, "Hello."); }); - - 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 = "" + - "" + - "" + - "

Top left

Top right

Bottom left

Bottom right

"; - assert.equal(result.value, expectedHtml); - }); +}); + +test('superscript runs are wrapped in 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 = "" + - "" + - "

Top right

"; - assert.equal(result.value, expectedHtml); - }); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "Hello."); }); - - 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 = "" + - "" + - "

Top left

Top right

"; - assert.equal(result.value, expectedHtml); - }); +}); + +test('subscript runs are wrapped in 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 = "" + - "" + - "
"; - assert.equal(result.value, expectedHtml); - }); + var converter = new DocumentConverter(); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "Hello."); }); - - test('line break is converted to
', function() { - var lineBreak = new documents.LineBreak(); - var converter = new DocumentConverter(); - - return converter.convertToHtml(lineBreak).then(function(result) { - assert.equal(result.value, "
"); - }); +}); + +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, '[1]'); - }); + return converter.convertToHtml(run).then(function(result) { + assert.equal(result.value, "Hello."); + }); +}); + +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 ', 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, 'Hello.'); + }); +}); + +test('docx hyperlink with anchor is converted to ', 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, 'Hello.'); + }); +}); + +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, ''); }); +}); + +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 = "" + + "" + + "" + + "

Top left

Top right

Bottom left

Bottom right

"; + 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 = "" + + "" + + "

Top right

"; + 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 = "" + + "" + + "

Top left

Top right

"; + 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 = "" + + "" + + "
"; + assert.equal(result.value, expectedHtml); + }); +}); + +test('line break is converted to
', 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 = '

Knock knock[1]

' + - '
  1. Who\'s there? ↑

'; - assert.equal(result.value, expectedOutput); - }); + return converter.convertToHtml(lineBreak).then(function(result) { + assert.equal(result.value, "
"); + }); +}); + +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, '[1]'); + }); +}); + +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, '

Knock knock

'); - assert.deepEqual(result.messages, []); - }); - + var converter = new DocumentConverter({ + idPrefix: "doc-42-" }); + return converter.convertToHtml(document).then(function(result) { + var expectedOutput = '

Knock knock[1]

' + + '
  1. Who\'s there? ↑

'; + 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, ''); - }); + var converter = new DocumentConverter({}); + return converter.convertToHtml(document).then(function(result) { + assert.equal(result.value, '

Knock knock

'); + 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, ''); + }); +}); + +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, 'Not an image at all!'); - }); + return converter.convertToHtml(image).then(function(result) { + assert.equal(result.value, '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("

Hello.

"), 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("

Hello.

"), 0); }); }); -- cgit v1.2.3 From c0a14c171f5bdfda6cb76b1589a43ada3b5768ce Mon Sep 17 00:00:00 2001 From: Michael Williamson Date: Thu, 7 Jul 2016 21:27:53 +0100 Subject: Add conversion of comments --- lib/document-matchers.js | 2 +- lib/document-to-html.js | 88 +++++++++++++++++++++++++++++++++++++----- lib/documents.js | 3 +- test/document-to-html.tests.js | 32 ++++++++++++++- 4 files changed, 112 insertions(+), 13 deletions(-) (limited to 'test/document-to-html.tests.js') diff --git a/lib/document-matchers.js b/lib/document-matchers.js index 60bc65f..bdc213c 100644 --- a/lib/document-matchers.js +++ b/lib/document-matchers.js @@ -4,7 +4,7 @@ exports.bold = new Matcher("bold"); exports.italic = new Matcher("italic"); exports.underline = new Matcher("underline"); exports.strikethrough = new Matcher("strikethrough"); -exports.commentReference = new Matcher("comment-reference"); +exports.commentReference = new Matcher("commentReference"); function paragraph(options) { diff --git a/lib/document-to-html.js b/lib/document-to-html.js index 2b7815a..1b3a3df 100644 --- a/lib/document-to-html.js +++ b/lib/document-to-html.js @@ -13,18 +13,25 @@ exports.DocumentConverter = DocumentConverter; function DocumentConverter(options) { return { - convertToHtml: function() { - var conversion = new DocumentConversion(options); - return conversion.convertToHtml.apply(this, arguments); + convertToHtml: function(element) { + var comments = _.indexBy( + element.type === documents.types.document ? element.comments : [], + "commentId" + ); + var conversion = new DocumentConversion(options, comments); + return conversion.convertToHtml(element); } }; } -function DocumentConversion(options) { +function DocumentConversion(options, comments) { var noteNumber = 1; var noteReferences = []; + var referencedComments = []; + var commentCountByInitials = {}; + options = _.extend({ignoreEmptyParagraphs: true}, options); var idPrefix = options.idPrefix === undefined ? "" : options.idPrefix; @@ -154,9 +161,9 @@ function DocumentConversion(options) { } function findHtmlPathForRunProperty(elementType, defaultTagName) { - var style = findStyle({type: elementType}); - if (style) { - return style.to; + var path = findHtmlPath({type: elementType}); + if (path) { + return path; } else if (defaultTagName) { return htmlPaths.element(defaultTagName, {}, {fresh: false}); } else { @@ -164,6 +171,11 @@ function DocumentConversion(options) { } } + function findHtmlPath(element, defaultPath) { + var style = findStyle(element); + return style ? style.to : defaultPath; + } + function findStyle(element) { for (var i = 0; i < styleMap.length; i++) { if (styleMap[i].from.matches(element)) { @@ -190,11 +202,19 @@ function DocumentConversion(options) { } function noteHtmlId(note) { - return htmlId(note.noteType + "-" + note.noteId); + return referentHtmlId(note.noteType, note.noteId); } function noteRefHtmlId(note) { - return htmlId(note.noteType + "-ref-" + note.noteId); + return referenceHtmlId(note.noteType, note.noteId); + } + + function referentHtmlId(referenceType, referenceId) { + return htmlId(referenceType + "-" + referenceId); + } + + function referenceHtmlId(referenceType, referenceId) { + return htmlId(referenceType + "-ref-" + referenceId); } function htmlId(suffix) { @@ -224,6 +244,49 @@ function DocumentConversion(options) { ]; } + function convertCommentReference(reference, messages) { + return findHtmlPath(reference, htmlPaths.ignore).wrap(function() { + var comment = comments[reference.commentId]; + if (commentCountByInitials[comment.authorInitials] === undefined) { + commentCountByInitials[comment.authorInitials] = 0; + } + var count = ++commentCountByInitials[comment.authorInitials]; + var label = "[" + comment.authorInitials + count + "]"; + referencedComments.push({label: label, comment: comment}); + // TODO: remove duplication with note references + return [ + Html.freshElement("a", { + href: "#" + referentHtmlId("comment", reference.commentId), + id: referenceHtmlId("comment", reference.commentId) + }, [Html.text(label)]) + ]; + }); + } + + function convertComment(referencedComment, messages) { + // TODO: remove duplication with note references + + var label = referencedComment.label; + var comment = referencedComment.comment; + var body = convertElements(comment.body).concat([ + Html.nonFreshElement("p", {}, [ + Html.text(" "), + Html.freshElement("a", {"href": "#" + referenceHtmlId("comment", comment.commentId)}, [ + Html.text("↑") + ]) + ]) + ]); + + return [ + Html.freshElement( + "dt", + {"id": referentHtmlId("comment", comment.commentId)}, + [Html.text("Comment " + label)] + ), + Html.freshElement("dd", {}, body) + ]; + } + function wrapChildrenInFreshElement(element, wrapElementName, messages) { var children = convertElements(element.children, messages); return [ @@ -239,7 +302,10 @@ function DocumentConversion(options) { }); var notesNodes = convertElements(notes, messages); return children.concat([ - Html.freshElement("ol", {}, notesNodes) + Html.freshElement("ol", {}, notesNodes), + Html.freshElement("dl", {}, flatMap(referencedComments, function(referencedComment) { + return convertComment(referencedComment, messages); + })) ]); }, "paragraph": convertParagraph, @@ -281,6 +347,8 @@ function DocumentConversion(options) { return Html.freshElement("li", {id: noteHtmlId(element)}, body); }, + "commentReference": convertCommentReference, + "comment": convertComment, "image": deferredConversion(recoveringConvertImage(options.convertImage || defaultConvertImage)), "table": convertTable, "tableRow": convertTableRow, diff --git a/lib/documents.js b/lib/documents.js index 9f01d88..428dc09 100644 --- a/lib/documents.js +++ b/lib/documents.js @@ -24,7 +24,8 @@ function Document(children, options) { return { type: types.document, children: children, - notes: options.notes || new Notes({}) + notes: options.notes || new Notes({}), + comments: options.comments || [] }; } diff --git a/test/document-to-html.tests.js b/test/document-to-html.tests.js index 436014f..af08050 100644 --- a/test/document-to-html.tests.js +++ b/test/document-to-html.tests.js @@ -486,7 +486,7 @@ test('footnotes are included after the main body', function() { }); test('comments are ignored by default', function() { - var reference = documents.commentReference("4"); + var reference = documents.commentReference({commentId: "4"}); var comment = documents.comment({ commentId: "4", body: [paragraphOfText("Who's there?")] @@ -503,7 +503,37 @@ test('comments are ignored by default', function() { assert.equal(result.value, '

Knock knock

'); assert.deepEqual(result.messages, []); }); +}); +test('comment references are linked to comment after main body', function() { + var reference = documents.commentReference({commentId: "4"}); + var comment = documents.comment({ + commentId: "4", + body: [paragraphOfText("Who's there?")], + authorName: "The Piemaker", + authorInitials: "TP" + }); + var document = documents.document([ + documents.paragraph([ + runOfText("Knock knock"), + documents.run([reference]) + ]) + ], {comments: [comment]}); + + var converter = new DocumentConverter({ + idPrefix: "doc-42-", + styleMap: [ + {from: documentMatchers.commentReference, to: htmlPaths.element("sup")} + ] + }); + return converter.convertToHtml(document).then(function(result) { + var expectedHtml = ( + '

Knock knock[TP1]

' + + '
Comment [TP1]

Who\'s there? ↑

' + ); + assert.equal(result.value, expectedHtml); + assert.deepEqual(result.messages, []); + }); }); test('images are written with data URIs', function() { -- cgit v1.2.3 From ade35ac659f20fc27bb4c87d8511789cc7d05c07 Mon Sep 17 00:00:00 2001 From: Michael Williamson Date: Thu, 7 Jul 2016 22:32:35 +0100 Subject: Handle comments without initials --- lib/document-to-html.js | 6 +++++- test/document-to-html.tests.js | 14 +++++++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) (limited to 'test/document-to-html.tests.js') diff --git a/lib/document-to-html.js b/lib/document-to-html.js index eb7c8e1..bc61e34 100644 --- a/lib/document-to-html.js +++ b/lib/document-to-html.js @@ -247,7 +247,7 @@ function DocumentConversion(options, comments) { return findHtmlPath(reference, htmlPaths.ignore).wrap(function() { var comment = comments[reference.commentId]; var count = referencedComments.length + 1; - var label = "[" + comment.authorInitials + count + "]"; + var label = "[" + commentAuthorLabel(comment) + count + "]"; referencedComments.push({label: label, comment: comment}); // TODO: remove duplication with note references return [ @@ -393,3 +393,7 @@ function walkHtml(nodes, callback) { } }); } + +var commentAuthorLabel = exports.commentAuthorLabel = function commentAuthorLabel(comment) { + return comment.authorInitials || ""; +}; diff --git a/test/document-to-html.tests.js b/test/document-to-html.tests.js index af08050..cc8aff5 100644 --- a/test/document-to-html.tests.js +++ b/test/document-to-html.tests.js @@ -2,7 +2,9 @@ var assert = require("assert"); var promises = require("../lib/promises"); var documents = require("../lib/documents"); -var DocumentConverter = require("../lib/document-to-html").DocumentConverter; +var documentToHtml = require("../lib/document-to-html"); +var DocumentConverter = documentToHtml.DocumentConverter; +var commentAuthorLabel = documentToHtml.commentAuthorLabel; var test = require("./test")(module); var htmlPaths = require("../lib/html-paths"); var xml = require("../lib/xml"); @@ -612,3 +614,13 @@ function runOfText(text, properties) { var textElement = new documents.Text(text); return new documents.Run([textElement], properties); } + +test('when initials are not blank then comment author label is initials', function() { + assert.equal(commentAuthorLabel({authorInitials: "TP"}), "TP") +}); + +test('when initials are blank then comment author label is blank', function() { + assert.equal(commentAuthorLabel({authorInitials: ""}), "") + assert.equal(commentAuthorLabel({authorInitials: undefined}), "") + assert.equal(commentAuthorLabel({authorInitials: null}), "") +}); -- cgit v1.2.3