rwml 0.1.0

Native Rust toolkit for Microsoft Word — read, write, edit, and render legacy .doc (Word 97-2003, [MS-DOC]) and modern .docx (OOXML): one document model, package-preserving edits, field evaluation, Markdown/HTML export, PDF preview
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

#![cfg(feature = "docx")]

//! REF numeric-picture (`\#`), lock-result (`\!`), and non-numeric-`\*` pin
//! coverage, driven end-to-end through the public `Document::open(..)` API.

use std::io::Write;

use rwml::{Document, FieldEvaluationReason, FieldEvaluationReasonCount};

fn docx_fixture(parts: &[(&str, &str)]) -> Vec<u8> {
    let mut out = Vec::new();
    {
        let cursor = std::io::Cursor::new(&mut out);
        let mut zip = zip::ZipWriter::new(cursor);
        let opt = zip::write::SimpleFileOptions::default();
        for (name, body) in parts {
            zip.start_file(*name, opt).unwrap();
            zip.write_all(body.as_bytes()).unwrap();
        }
        zip.finish().unwrap();
    }
    out
}

fn ref_docx(body_inner: &str) -> Vec<u8> {
    let document = format!(
        r#"<w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"><w:body>{body_inner}</w:body></w:document>"#
    );
    docx_fixture(&[
        (
            "[Content_Types].xml",
            r#"<?xml version="1.0"?><Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types"><Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/><Default Extension="xml" ContentType="application/xml"/><Override PartName="/word/document.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"/></Types>"#,
        ),
        (
            "_rels/.rels",
            r#"<?xml version="1.0"?><Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="word/document.xml"/></Relationships>"#,
        ),
        ("word/document.xml", &document),
    ])
}

/// Return the computed result for the single REF field whose instruction
/// matches `instruction`.
fn ref_computed(doc: &Document, instruction: &str) -> Option<String> {
    doc.fields()
        .into_iter()
        .find(|field| field.instruction == instruction)
        .unwrap_or_else(|| panic!("REF field `{instruction}` not extracted"))
        .computed_result
}

/// Return the cached result text for the single REF field matching `instruction`.
fn ref_cached(doc: &Document, instruction: &str) -> String {
    doc.fields()
        .into_iter()
        .find(|field| field.instruction == instruction)
        .unwrap_or_else(|| panic!("REF field `{instruction}` not extracted"))
        .result
}

/// Aggregate unsupported field-evaluation reasons for the whole document.
/// Each fixture below carries exactly one REF field, so this is a per-field
/// assertion in practice.
fn reasons(doc: &Document) -> Vec<FieldEvaluationReasonCount> {
    doc.report().features.unsupported_field_reasons
}

/// Slice 1 — `REF <bmk> \# "<picture>"` formats the numeric bookmark text.
#[test]
fn ref_numeric_picture_formats_bookmark_number() {
    let doc = Document::open(&ref_docx(
        r#"<w:p><w:bookmarkStart w:id="1" w:name="Total"/><w:r><w:t>1234.5</w:t></w:r><w:bookmarkEnd w:id="1"/></w:p><w:p><w:fldSimple w:instr=" REF Total \# &quot;$#,##0.00&quot; "><w:r><w:t>stale</w:t></w:r></w:fldSimple></w:p>"#,
    ))
    .expect("fixture opens");

    let instruction = r#"REF Total \# "$#,##0.00""#;
    assert_eq!(
        ref_computed(&doc, instruction).as_deref(),
        Some("$1,234.50")
    );
    // Cached text stays available; the field computes, so nothing unsupported.
    assert_eq!(ref_cached(&doc, instruction), "stale");
    assert_eq!(reasons(&doc), vec![]);
}

/// Slice 1 guard — non-numeric bookmark text under `\#` keeps cached text and
/// reports `NoComputedResult` (parses fine, but nothing to compute).
#[test]
fn ref_numeric_picture_non_numeric_keeps_cached() {
    let doc = Document::open(&ref_docx(
        r#"<w:p><w:bookmarkStart w:id="1" w:name="Name"/><w:r><w:t>Alice</w:t></w:r><w:bookmarkEnd w:id="1"/></w:p><w:p><w:fldSimple w:instr=" REF Name \# &quot;$#,##0.00&quot; "><w:r><w:t>stale</w:t></w:r></w:fldSimple></w:p>"#,
    ))
    .expect("fixture opens");

    let instruction = r#"REF Name \# "$#,##0.00""#;
    assert_eq!(ref_computed(&doc, instruction), None);
    assert_eq!(ref_cached(&doc, instruction), "stale");
    assert_eq!(
        reasons(&doc),
        vec![FieldEvaluationReasonCount {
            reason: FieldEvaluationReason::NoComputedResult,
            count: 1,
        }]
    );
}

/// Slice 1 ordering — `\#` numeric picture applies first, then a trailing
/// `\* Upper` text transform runs on the formatted result.
#[test]
fn ref_numeric_picture_then_case_transform() {
    let doc = Document::open(&ref_docx(
        r#"<w:p><w:bookmarkStart w:id="1" w:name="Qty"/><w:r><w:t>7</w:t></w:r><w:bookmarkEnd w:id="1"/></w:p><w:p><w:fldSimple w:instr=" REF Qty \# &quot;0&quot; \* Upper "><w:r><w:t>stale</w:t></w:r></w:fldSimple></w:p>"#,
    ))
    .expect("fixture opens");

    let instruction = r#"REF Qty \# "0" \* Upper"#;
    assert_eq!(ref_computed(&doc, instruction).as_deref(), Some("7"));
    assert_eq!(reasons(&doc), vec![]);
}

/// Slice 3 — `REF <bmk> \!` (lock result) is a neutral switch: it parses and
/// computes the normal bookmark text.
#[test]
fn ref_lock_result_switch_is_neutral() {
    let doc = Document::open(&ref_docx(
        r#"<w:p><w:bookmarkStart w:id="1" w:name="Figure1"/><w:r><w:t>Figure 1</w:t></w:r><w:bookmarkEnd w:id="1"/></w:p><w:p><w:fldSimple w:instr=" REF Figure1 \! "><w:r><w:t>stale</w:t></w:r></w:fldSimple></w:p>"#,
    ))
    .expect("fixture opens");

    let instruction = r#"REF Figure1 \!"#;
    assert_eq!(ref_computed(&doc, instruction).as_deref(), Some("Figure 1"));
    assert_eq!(reasons(&doc), vec![]);
}

/// Slice 2 (pin) — `REF <name> \* Arabic` with non-numeric bookmark text keeps
/// cached text and reports `NoComputedResult`. Pins existing behavior.
#[test]
fn ref_arabic_non_numeric_keeps_cached_pin() {
    let doc = Document::open(&ref_docx(
        r#"<w:p><w:bookmarkStart w:id="1" w:name="Name"/><w:r><w:t>Alice</w:t></w:r><w:bookmarkEnd w:id="1"/></w:p><w:p><w:fldSimple w:instr=" REF Name \* Arabic "><w:r><w:t>stale</w:t></w:r></w:fldSimple></w:p>"#,
    ))
    .expect("fixture opens");

    let instruction = r#"REF Name \* Arabic"#;
    assert_eq!(ref_computed(&doc, instruction), None);
    assert_eq!(ref_cached(&doc, instruction), "stale");
    assert_eq!(
        reasons(&doc),
        vec![FieldEvaluationReasonCount {
            reason: FieldEvaluationReason::NoComputedResult,
            count: 1,
        }]
    );
}