rust-docx 0.2.11

Rust parser, document model, and serializer for DOCX and legacy Word documents
Documentation 
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

//! Word substitutes application defaults for omitted document defaults.
//! Expectations come from native Word 16.106 controls (glyph heights and line
//! pitch in exported PDFs), recorded under output/playwright/word-breaks-20261012.
use std::collections::HashMap;

use rust_docx::model::{
    DocModel, DocNode, ParagraphChildNode, ParagraphLineRule, ParagraphNode, TextStyle,
};
use rust_docx::{build_doc_model, OoxmlPackage, OoxmlPart};

const W: &str = "http://schemas.openxmlformats.org/wordprocessingml/2006/main";

fn package(styles: &str) -> OoxmlPackage {
    let document = format!(
        r#"<w:document xmlns:w="{W}"><w:body><w:p><w:r><w:t>Text</w:t></w:r></w:p></w:body></w:document>"#
    );
    OoxmlPackage {
        parts: [
            ("word/document.xml", document),
            (
                "word/styles.xml",
                format!(r#"<w:styles xmlns:w="{W}">{styles}</w:styles>"#),
            ),
        ]
        .into_iter()
        .map(|(name, content)| {
            (
                name.to_string(),
                OoxmlPart {
                    name: name.to_string(),
                    content,
                },
            )
        })
        .collect(),
        binary_assets: HashMap::new(),
        warnings: Vec::new(),
    }
}

fn paragraph(model: &DocModel) -> &ParagraphNode {
    let DocNode::Paragraph(paragraph) = &model.nodes[0] else {
        panic!("paragraph")
    };
    paragraph
}

fn run_style(model: &DocModel) -> TextStyle {
    let ParagraphChildNode::Text(run) = &paragraph(model).children[0] else {
        panic!("text run")
    };
    run.style.as_deref().cloned().expect("resolved run style")
}

fn spacing(model: &DocModel) -> (Option<i64>, Option<i64>, Option<ParagraphLineRule>) {
    paragraph(model)
        .style
        .as_ref()
        .and_then(|style| style.spacing.as_ref())
        .map(|spacing| (spacing.after_twips, spacing.line_twips, spacing.line_rule))
        .unwrap_or((None, None, None))
}

const NORMAL: &str = r#"<w:style w:type="paragraph" w:default="1" w:styleId="Normal"><w:name w:val="Normal"/></w:style>"#;

#[test]
fn declared_defaults_without_a_size_use_ten_points_and_single_spacing() {
    let model = build_doc_model(&package(&format!(
        r#"<w:docDefaults><w:rPrDefault><w:rPr><w:rFonts w:ascii="Arial" w:hAnsi="Arial"/></w:rPr></w:rPrDefault><w:pPrDefault/></w:docDefaults>{NORMAL}"#
    )));
    let style = run_style(&model);
    assert_eq!(style.font_size_pt, Some(10.0));
    assert_eq!(style.font_size_cs_pt, Some(10.0));
    assert_eq!(spacing(&model), (None, None, None));
}

#[test]
fn empty_declared_run_defaults_still_use_ten_points() {
    let model = build_doc_model(&package(&format!(
        r#"<w:docDefaults><w:rPrDefault/><w:pPrDefault/></w:docDefaults>{NORMAL}"#
    )));
    assert_eq!(run_style(&model).font_size_pt, Some(10.0));
}

#[test]
fn omitted_defaults_use_word_application_defaults() {
    let model = build_doc_model(&package(
        r#"<w:style w:type="paragraph" w:styleId="Heading1"><w:name w:val="heading 1"/></w:style>"#,
    ));
    let style = run_style(&model);
    assert_eq!(style.font_size_pt, Some(12.0));
    assert_eq!(style.font_family.as_deref(), Some("Aptos"));
    assert_eq!(
        spacing(&model),
        (Some(160), Some(276), Some(ParagraphLineRule::Auto))
    );
}

#[test]
fn omitted_paragraph_defaults_add_application_spacing_to_declared_run_defaults() {
    let model = build_doc_model(&package(&format!(
        r#"<w:docDefaults><w:rPrDefault><w:rPr><w:rFonts w:ascii="Arial" w:hAnsi="Arial"/></w:rPr></w:rPrDefault></w:docDefaults>{NORMAL}"#
    )));
    assert_eq!(run_style(&model).font_size_pt, Some(10.0));
    assert_eq!(
        spacing(&model),
        (Some(160), Some(276), Some(ParagraphLineRule::Auto))
    );
}

#[test]
fn normal_style_overrides_application_defaults() {
    let model = build_doc_model(&package(
        r#"<w:style w:type="paragraph" w:default="1" w:styleId="Normal"><w:name w:val="Normal"/><w:pPr><w:spacing w:after="0" w:line="240" w:lineRule="auto"/></w:pPr><w:rPr><w:rFonts w:ascii="Arial" w:hAnsi="Arial"/><w:sz w:val="20"/></w:rPr></w:style>"#,
    ));
    let style = run_style(&model);
    assert_eq!(style.font_size_pt, Some(10.0));
    assert_eq!(style.font_family.as_deref(), Some("Arial"));
    assert_eq!(
        spacing(&model),
        (Some(0), Some(240), Some(ParagraphLineRule::Auto))
    );
}