@depup/mammoth 1.12.0-depup.54

package/test/html/simplify.tests.js

@@ -0,0 +1,141 @@
+var assert = require("assert");
+
+var _ = require("underscore");
+
+var test = require("../test")(module);
+var html = require("../../lib/html");
+var htmlPaths = require("../../lib/styles/html-paths");
+
+var nonFreshElement = html.nonFreshElement;
+var text = html.text;
+
+test("empty text nodes are removed", function() {
+    assert.deepEqual(
+        simplifyNode(text("")),
+        []
+    );
+});
+
+test("elements with no children are removed", function() {
+    assert.deepEqual(
+        simplifyNode(nonFreshElement("p", {}, [])),
+        []
+    );
+});
+
+test("elements only containing empty nodes are removed", function() {
+    assert.deepEqual(
+        simplifyNode(nonFreshElement("p", {}, [text("")])),
+        []
+    );
+});
+
+test("empty children of element are removed", function() {
+    assert.deepEqual(
+        simplifyNode(nonFreshElement("p", {}, [text("Hello"), text("")])),
+        [nonFreshElement("p", {}, [text("Hello")])]
+    );
+});
+
+test("empty void elements are not removed", function() {
+    assert.deepEqual(
+        simplifyNode(nonFreshElement("br", {}, [])),
+        [nonFreshElement("br", {}, [])]
+    );
+});
+
+test("successive fresh elements are not collapsed", function() {
+    var path = htmlPaths.elements([
+        htmlPaths.element("p", {}, {fresh: true})
+    ]);
+    var original = concat(
+        pathToNodes(path, [text("Hello")]),
+        pathToNodes(path, [text(" there")])
+    );
+    
+    assert.deepEqual(
+        html.simplify(original),
+        original);
+});
+
+test("successive plain non-fresh elements are collapsed if they have the same tag name", function() {
+    var path = htmlPaths.elements([
+        htmlPaths.element("p", {}, {fresh: false})
+    ]);
+    assert.deepEqual(
+        html.simplify(concat(
+            pathToNodes(path, [text("Hello")]),
+            pathToNodes(path, [text(" there")])
+        )),
+        pathToNodes(path, [text("Hello"), text(" there")])
+    );
+});
+
+test("non-fresh can collapse into preceding fresh element", function() {
+    var freshPath = htmlPaths.elements([
+        htmlPaths.element("p", {}, {fresh: true})]);
+    var nonFreshPath = htmlPaths.elements([
+        htmlPaths.element("p", {}, {fresh: false})]);
+    assert.deepEqual(
+        html.simplify(concat(
+            pathToNodes(freshPath, [text("Hello")]),
+            pathToNodes(nonFreshPath, [text(" there")])
+        )),
+        pathToNodes(freshPath, [text("Hello"), text(" there")])
+    );
+});
+
+test("children of collapsed element can collapse with children of another collapsed element", function() {
+    assert.deepEqual(
+        html.simplify([
+            nonFreshElement("blockquote", {}, [nonFreshElement("p", {}, [text("Hello")])]),
+            nonFreshElement("blockquote", {}, [nonFreshElement("p", {}, [text("there")])])
+        ]),
+        [nonFreshElement("blockquote", {}, [nonFreshElement("p", {}, [text("Hello"), text("there")])])]
+    );
+});
+
+test("empty elements are removed before collapsing", function() {
+    var freshPath = htmlPaths.elements([
+        htmlPaths.element("p", {}, {fresh: true})]);
+    var nonFreshPath = htmlPaths.elements([
+        htmlPaths.element("p", {}, {fresh: false})]);
+    assert.deepEqual(
+        html.simplify(concat(
+            pathToNodes(nonFreshPath, [text("Hello")]),
+            pathToNodes(freshPath, []),
+            pathToNodes(nonFreshPath, [text(" there")])
+        )),
+        pathToNodes(nonFreshPath, [text("Hello"), text(" there")])
+    );
+});
+
+test("when separator is present then separator is prepended to collapsed element", function() {
+    var unseparatedPath = htmlPaths.elements([
+        htmlPaths.element("pre", {}, {fresh: false})
+    ]);
+    var separatedPath = htmlPaths.elements([
+        htmlPaths.element("pre", {}, {fresh: false, separator: "\n"})
+    ]);
+    assert.deepEqual(
+        html.simplify(concat(
+            pathToNodes(unseparatedPath, [text("Hello")]),
+            pathToNodes(separatedPath, [text(" the"), text("re")])
+        )),
+        pathToNodes(unseparatedPath, [text("Hello"), text("\n"), text(" the"), text("re")])
+    );
+});
+
+function simplifyNode(node) {
+    return html.simplify([node]);
+}
+
+function concat() {
+    return _.flatten(arguments, true);
+}
+
+function pathToNodes(path, nodes) {
+    return path.wrap(function() {
+        return nodes;
+    });
+}

package/test/html/write.tests.js

@@ -0,0 +1,42 @@
+var assert = require("assert");
+
+var test = require("../test")(module);
+var html = require("../../lib/html");
+var writers = require("../../lib/writers");
+
+
+test("text is HTML escaped", function() {
+    assert.equal(
+        generateString(html.text("<>&")),
+        "&lt;&gt;&amp;");
+});
+
+test("double quotes outside of attributes are not escaped", function() {
+    assert.equal(
+        generateString(html.text('"')),
+        '"');
+});
+
+test("element attributes are HTML escaped", function() {
+    assert.equal(
+        generateString(html.freshElement("p", {"x": "<"})),
+        '<p x="&lt;"></p>');
+});
+
+test("double quotes inside attributes are escaped", function() {
+    assert.equal(
+        generateString(html.freshElement("p", {"x": '"'})),
+        '<p x="&quot;"></p>');
+});
+
+test("element children are written", function() {
+    assert.equal(
+        generateString(html.freshElement("p", {}, [html.text("Hello")])),
+        '<p>Hello</p>');
+});
+
+function generateString(node) {
+    var writer = writers.writer();
+    html.write(writer, [node]);
+    return writer.asString();
+}

package/test/images.tests.js

@@ -0,0 +1,112 @@
+var assert = require("assert");
+
+var hamjest = require("hamjest");
+var assertThat = hamjest.assertThat;
+var contains = hamjest.contains;
+var equalTo = hamjest.equalTo;
+var hasProperties = hamjest.hasProperties;
+
+var mammoth = require("../");
+var documents = require("../lib/documents");
+var promises = require("../lib/promises");
+
+var test = require("./test")(module);
+
+
+test('mammoth.images.inline() should be an alias of mammoth.images.imgElement()', function() {
+    assert.ok(mammoth.images.inline === mammoth.images.imgElement);
+});
+
+
+test('mammoth.images.dataUri() encodes images in base64', function() {
+    var imageBuffer = new Buffer("abc");
+    var image = new documents.Image({
+        readImage: function(encoding) {
+            return promises.when(imageBuffer.toString(encoding));
+        },
+        contentType: "image/jpeg"
+    });
+
+    return mammoth.images.dataUri(image).then(function(result) {
+        assertThat(result, contains(
+            hasProperties({tag: hasProperties({attributes: {"src": "data:image/jpeg;base64,YWJj"}})})
+        ));
+    });
+});
+
+
+test('mammoth.images.imgElement()', {
+    'when element does not have alt text then alt attribute is not set': function() {
+        var imageBuffer = new Buffer("abc");
+        var image = new documents.Image({
+            readImage: function(encoding) {
+                return promises.when(imageBuffer.toString(encoding));
+            },
+            contentType: "image/jpeg"
+        });
+
+        var result = mammoth.images.imgElement(function(image) {
+            return {src: "<src>"};
+        })(image);
+
+        return result.then(function(result) {
+            assertThat(result, contains(
+                hasProperties({
+                    tag: hasProperties({
+                        attributes: equalTo({src: "<src>"})
+                    })
+                })
+            ));
+        });
+    },
+
+    'when element has alt text then alt attribute is set': function() {
+        var imageBuffer = new Buffer("abc");
+        var image = new documents.Image({
+            readImage: function(encoding) {
+                return promises.when(imageBuffer.toString(encoding));
+            },
+            contentType: "image/jpeg",
+            altText: "<alt>"
+        });
+
+        var result = mammoth.images.imgElement(function(image) {
+            return {src: "<src>"};
+        })(image);
+
+        return result.then(function(result) {
+            assertThat(result, contains(
+                hasProperties({
+                    tag: hasProperties({
+                        attributes: equalTo({alt: "<alt>", src: "<src>"})
+                    })
+                })
+            ));
+        });
+    },
+
+    'image alt text can be overridden by alt attribute returned from function': function() {
+        var imageBuffer = new Buffer("abc");
+        var image = new documents.Image({
+            readImage: function(encoding) {
+                return promises.when(imageBuffer.toString(encoding));
+            },
+            contentType: "image/jpeg",
+            altText: "<alt>"
+        });
+
+        var result = mammoth.images.imgElement(function(image) {
+            return {alt: "<alt override>", src: "<src>"};
+        })(image);
+
+        return result.then(function(result) {
+            assertThat(result, contains(
+                hasProperties({
+                    tag: hasProperties({
+                        attributes: equalTo({alt: "<alt override>", src: "<src>"})
+                    })
+                })
+            ));
+        });
+    }
+});

package/test/main.tests.js

@@ -0,0 +1,89 @@
+var assert = require("assert");
+var child_process = require("child_process"); // eslint-disable-line camelcase
+var path = require("path");
+var fs = require("fs");
+
+var temp = require('temp').track();
+
+var promises = require("../lib/promises");
+var test = require("./test")(module);
+var testPath = require("./testing").testPath;
+
+test("HTML is printed to stdout if output file is not set", function() {
+    return runMammoth(testPath("single-paragraph.docx")).then(function(result) {
+        assert.equal(result.stderrOutput, "");
+        assert.equal(result.output, "<p>Walking on imported air</p>");
+    });
+});
+
+test("HTML is written to file if output file is set", function() {
+    return createTempDir().then(function(tempDir) {
+        var outputPath = path.join(tempDir, "output.html");
+        return runMammoth(testPath("single-paragraph.docx"), outputPath).then(function(result) {
+            assert.equal(result.stderrOutput, "");
+            assert.equal(result.output, "");
+            assert.equal(fs.readFileSync(outputPath, "utf8"), "<p>Walking on imported air</p>");
+        });
+    });
+});
+
+var imageBase64 = "iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAIAAAACUFjqAAAAAXNSR0IArs4c6QAAAAlwSFlzAAAOvgAADr4B6kKxwAAAABNJREFUKFNj/M+ADzDhlWUYqdIAQSwBE8U+X40AAAAASUVORK5CYII=";
+
+test("inline images are included in output if writing to single file", function() {
+    return runMammoth(testPath("tiny-picture.docx")).then(function(result) {
+        assert.equal(result.stderrOutput, "");
+        assert.equal(result.output, '<p><img src="data:image/png;base64,' + imageBase64 + '" /></p>');
+    });
+});
+
+test("images are written to separate files if output dir is set", function() {
+    return createTempDir().then(function(tempDir) {
+        var outputPath = path.join(tempDir, "tiny-picture.html");
+        var imagePath = path.join(tempDir, "1.png");
+        return runMammoth(testPath("tiny-picture.docx"), "--output-dir", tempDir).then(function(result) {
+            assert.equal(result.stderrOutput, "");
+            assert.equal(result.output, "");
+            assert.equal(fs.readFileSync(outputPath, "utf8"), '<p><img src="1.png" /></p>');
+            assert.equal(fs.readFileSync(imagePath, "base64"), imageBase64);
+        });
+    });
+});
+
+test("style map is used if set", function() {
+    return createTempDir().then(function(tempDir) {
+        var styleMapPath = path.join(tempDir, "style-map");
+        fs.writeFileSync(styleMapPath, "p => span:fresh");
+        return runMammoth(testPath("single-paragraph.docx"), "--style-map", styleMapPath).then(function(result) {
+            assert.equal(result.stderrOutput, "");
+            assert.equal(result.output, "<span>Walking on imported air</span>");
+        });
+    });
+});
+
+test("--output-format=markdown option generate markdown output", function() {
+    return runMammoth(testPath("single-paragraph.docx"), "--output-format=markdown").then(function(result) {
+        assert.equal(result.stderrOutput, "");
+        assert.equal(result.output, "Walking on imported air\n\n");
+    });
+});
+
+
+function runMammoth() {
+    var args = Array.prototype.slice.call(arguments, 0);
+    var deferred = promises.defer();
+    
+    var processArgs = ["node", "bin/mammoth"].concat(args);
+    // TODO: proper escaping of args
+    var command = processArgs.join(" ");
+    child_process.exec(command, function(error, stdout, stderr) { // eslint-disable-line camelcase
+        console.log(stderr); // eslint-disable-line no-console
+        assert.equal(error, null);
+        deferred.resolve({output: stdout, stderrOutput: stderr});
+    });
+    
+    return deferred.promise;
+}
+
+function createTempDir() {
+    return promises.nfcall(temp.mkdir, null);
+}