aboutsummaryrefslogtreecommitdiff
path: root/tests/docx-reader.tests.js
blob: 68efb0a7c112a9cb78e4f6d906846ef0c3901c5d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
var assert = require("assert");

var docxReader = require("../lib/docx-reader");
var documents = require("../lib/documents");
var XmlElement = require("../lib/xmlreader").Element;

var testing = require("./testing");
var test = testing.test;
var testData = testing.testData;
var createFakeDocxFile = testing.createFakeDocxFile;


describe("docx-reader", function() {
    test("can read document with single paragraph with single run of text", function() {
        var expectedDocument = documents.Document([
            documents.Paragraph([
                documents.Run([
                    documents.Text("Hello.")
                ])
            ])
        ]);
        var docxFile = createFakeDocxFile({
            "word/document.xml": testData("simple/word/document.xml")
        });
        return docxReader.read(docxFile).then(function(result) {
            assert.deepEqual(expectedDocument, result.document);
        });
    });
    
    test("can read paragraph styles", function() {
        var docxFile = createFakeDocxFile({
            "word/document.xml": testData("paragraphStyles/word/document.xml")
        });
        return docxReader.read(docxFile).then(function(result) {
            var paragraph = result.document.children[0];
            assert.deepEqual("Heading1", paragraph.properties.styleName);
        });
    });
    
    test("hyperlink hrefs are read from relationships file", function() {
        var docxFile = createFakeDocxFile({
            "word/document.xml": testData("hyperlinks/word/document.xml"),
            "word/_rels/document.xml.rels": testData("hyperlinks/word/_rels/document.xml.rels")
        });
        return docxReader.read(docxFile).then(function(result) {
            var paragraph = result.document.children[0];
            assert.equal(1, paragraph.children.length);
            var hyperlink = paragraph.children[0];
            assert.equal(hyperlink.href, "http://www.example.com");
            assert.equal(hyperlink.children.length, 1);
        });
    });
});

function readXmlElement(element) {
    return new docxReader.DocumentReader({}).readXmlElement(element);
}

describe("readElement", function() {
    test("reads styles from run properties", function() {
        var runStyleXml = new XmlElement("w:rStyle", {"w:val": "Emphasis"});
        var runPropertiesXml = createRunPropertiesXml([runStyleXml]);
        var result = readXmlElement(runPropertiesXml);
        assert.equal(result.value.styleName, "Emphasis");
    });
    
    test("isBold is false if bold element is not present", function() {
        var runPropertiesXml = createRunPropertiesXml([]);
        var result = readXmlElement(runPropertiesXml);
        assert.equal(result.value.isBold, false);
    });
    
    test("isBold is true if bold element is present", function() {
        var boldXml = new XmlElement("w:b");
        var runPropertiesXml = createRunPropertiesXml([boldXml]);
        var result = readXmlElement(runPropertiesXml);
        assert.equal(result.value.isBold, true);
    });
    
    test("isItalic is false if bold element is not present", function() {
        var runPropertiesXml = createRunPropertiesXml([]);
        var result = readXmlElement(runPropertiesXml);
        assert.equal(result.value.isItalic, false);
    });
    
    test("isItalic is true if bold element is present", function() {
        var italicXml = new XmlElement("w:i");
        var runPropertiesXml = createRunPropertiesXml([italicXml]);
        var result = readXmlElement(runPropertiesXml);
        assert.equal(result.value.isItalic, true);
    });
    
    test("run properties are attached to run", function() {
        var runStyleXml = new XmlElement("w:rStyle", {"w:val": "Emphasis"});
        var runPropertiesXml = new XmlElement("w:rPr", {}, [runStyleXml]);
        var runXml = new XmlElement("w:r", {}, [runPropertiesXml]);
        var result = readXmlElement(runXml);
        assert.equal(result.value.properties.styleName, "Emphasis");
    });
    
    test("run properties not included as child of run", function() {
        var runStyleXml = new XmlElement("w:rStyle", {"w:val": "Emphasis"});
        var runPropertiesXml = new XmlElement("w:rPr", {}, [runStyleXml]);
        var runXml = new XmlElement("w:r", {}, [runPropertiesXml]);
        var result = readXmlElement(runXml);
        assert.deepEqual(result.value.children, []);
    });
    
    test("emits warning on unrecognised element", function() {
        var unrecognisedElement = new XmlElement("w:not-an-element");
        var result = readXmlElement(unrecognisedElement);
        assert.deepEqual(
            result.messages,
            [{
                type: "warning",
                message: "An unrecognised element was ignored: w:not-an-element"
            }]
        );
    });
    
    test("w:bookmarkStart is ignored without warning", function() {
        var ignoredElement = new XmlElement("w:bookmarkStart");
        var result = readXmlElement(ignoredElement);
        assert.deepEqual(result.messages, []);
        assert.equal(null, result.value);
    });
});

function createRunPropertiesXml(children) {
    return new XmlElement("w:rPr", {}, children);
}