summaryrefslogtreecommitdiff
path: root/src/test/java/org/zwobble/mammoth/tests/docx/NumberingXmlTests.java
blob: 4853b5476f16a17df1416f0b53597547b1d5d9ca (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
132
133
134
135
136
package org.zwobble.mammoth.tests.docx;

import org.junit.jupiter.api.Test;
import org.zwobble.mammoth.internal.documents.NumberingStyle;
import org.zwobble.mammoth.internal.docx.Numbering;
import org.zwobble.mammoth.internal.docx.Styles;
import org.zwobble.mammoth.internal.xml.XmlElement;

import java.util.Optional;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.zwobble.mammoth.internal.docx.NumberingXml.readNumberingXmlElement;
import static org.zwobble.mammoth.internal.util.Lists.list;
import static org.zwobble.mammoth.internal.util.Maps.map;
import static org.zwobble.mammoth.internal.xml.XmlNodes.element;

public class NumberingXmlTests {
    private final static XmlElement SAMPLE_NUMBERING_XML = element("w:numbering", list(
        element("w:abstractNum", map("w:abstractNumId", "42"), list(
            element("w:lvl", map("w:ilvl", "0"), list(
                element("w:numFmt", map("w:val", "bullet")))),
            element("w:lvl", map("w:ilvl", "1"), list(
                element("w:numFmt", map("w:val", "decimal")))))),
        element("w:num", map("w:numId", "47"), list(
            element("w:abstractNumId", map("w:val", "42"))))));

    @Test
    public void findLevelReturnsNoneIfNumWithIdCannotBeFound() {
        Numbering numbering = readNumbering(element("w:numbering"));
        assertEquals(Optional.empty(), numbering.findLevel("47", "0"));
    }

    @Test
    public void levelIncludesLevelIndex() {
        Numbering numbering = readNumbering(SAMPLE_NUMBERING_XML);
        assertEquals("0", numbering.findLevel("47", "0").get().getLevelIndex());
        assertEquals("1", numbering.findLevel("47", "1").get().getLevelIndex());
    }

    @Test
    public void listIsNotOrderedIfFormattedAsBullet() {
        Numbering numbering = readNumbering(SAMPLE_NUMBERING_XML);
        assertEquals(false, numbering.findLevel("47", "0").get().isOrdered());
    }

    @Test
    public void listIsOrderedIfFormattedAsDecimal() {
        Numbering numbering = readNumbering(SAMPLE_NUMBERING_XML);
        assertEquals(true, numbering.findLevel("47", "1").get().isOrdered());
    }

    @Test
    public void listIsOrderedIfThereIsNotExplicitFormat() {
        XmlElement element = element("w:numbering", list(
            element("w:abstractNum", map("w:abstractNumId", "42"), list(
                element("w:lvl", map("w:ilvl", "0"))
            )),
            element("w:num", map("w:numId", "47"), list(
                element("w:abstractNumId", map("w:val", "42"))
            ))
        ));

        Numbering numbering = readNumbering(element);

        assertEquals(true, numbering.findLevel("47", "0").get().isOrdered());
    }

    @Test
    public void numReferencingNonExistentAbstractNumIsIgnored() {
        XmlElement element = element("w:numbering", list(
            element("w:num", map("w:numId", "47"), list(
                element("w:abstractNumId", map("w:val", "42"))
            ))
        ));

        Numbering numbering = readNumbering(element);

        assertEquals(Optional.empty(), numbering.findLevel("47", "0"));
    }

    @Test
    public void whenAbstractNumHasNumStyleLinkThenStyleIsUsedToFindNum() {
        Numbering numbering = readNumberingXmlElement(
            element("w:numbering", list(
                element("w:abstractNum", map("w:abstractNumId", "100"), list(
                    element("w:lvl", map("w:ilvl", "0"), list(
                        element("w:numFmt", map("w:val", "decimal"))
                    ))
                )),
                element("w:abstractNum", map("w:abstractNumId", "101"), list(
                    element("w:numStyleLink", map("w:val", "List1"))
                )),
                element("w:num", map("w:numId", "200"), list(
                    element("w:abstractNumId", map("w:val", "100"))
                )),
                element("w:num", map("w:numId", "201"), list(
                    element("w:abstractNumId", map("w:val", "101"))
                ))
            )),
            new Styles(
                map(),
                map(),
                map(),
                map("List1", new NumberingStyle(Optional.of("200")))
            )
        );
        assertEquals(true, numbering.findLevel("201", "0").get().isOrdered());
    }

    // See: 17.9.23 pStyle (Paragraph Style's Associated Numbering Level) in ECMA-376, 4th Edition
    @Test
    public void numberingLevelCanBeFoundByParagraphStyleId() {
        Numbering numbering = readNumbering(
            element("w:numbering", list(
                element("w:abstractNum", map("w:abstractNumId", "42"), list(
                    element("w:lvl", map("w:ilvl", "0"), list(
                        element("w:numFmt", map("w:val", "bullet"))
                    ))
                )),
                element("w:abstractNum", map("w:abstractNumId", "43"), list(
                    element("w:lvl", map("w:ilvl", "0"), list(
                        element("w:pStyle", map("w:val", "List")),
                        element("w:numFmt", map("w:val", "decimal"))
                    ))
                ))
            ))
        );
        assertEquals(true, numbering.findLevelByParagraphStyleId("List").get().isOrdered());
        assertEquals(false, numbering.findLevelByParagraphStyleId("Paragraph").isPresent());
    }


    private Numbering readNumbering(XmlElement element) {
        return readNumberingXmlElement(element, Styles.EMPTY);
    }
}