unhwp 0.5.1

A high-performance library for extracting HWP/HWPX documents into structured Markdown
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

/// Quality regression tests using real-world HWP/HWPX fixture files.
///
/// These tests verify that core rendering properties hold across known documents:
///   - Parse succeeds without panicking
///   - Markdown output is non-empty and structurally sound
///   - Bullet characters render as list markers without requiring cleanup opt-in
///
/// Files in test-files/ are local-only and not committed to the repo.
/// Tests skip gracefully when fixture files are not present (CI environment).
use unhwp::{parse_file, to_markdown, RenderOptions};

const SAMPLE_HWP: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/test-files/Sample.hwp");
const HWPX_2016: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/test-files/HWP2016.hwpx");
const TIKA_HWP: &str = concat!(
    env!("CARGO_MANIFEST_DIR"),
    "/test-files/tika-testHWP_5.0.hwp"
);

fn skip_if_missing(path: &str) -> bool {
    if !std::path::Path::new(path).exists() {
        eprintln!("skip: fixture not found: {path}");
        return true;
    }
    false
}

// ── Parse succeeds ────────────────────────────────────────────────────────────

#[test]
fn sample_hwp_parse_succeeds() {
    if skip_if_missing(SAMPLE_HWP) {
        return;
    }
    let doc = parse_file(SAMPLE_HWP).expect("Sample.hwp must parse without error");
    assert!(
        !doc.sections.is_empty(),
        "parsed document must have at least one section"
    );
}

#[test]
fn hwpx_2016_parse_succeeds() {
    if skip_if_missing(HWPX_2016) {
        return;
    }
    let doc = parse_file(HWPX_2016).expect("HWP2016.hwpx must parse without error");
    assert!(
        !doc.sections.is_empty(),
        "parsed document must have at least one section"
    );
}

#[test]
fn tika_hwp_parse_succeeds() {
    if skip_if_missing(TIKA_HWP) {
        return;
    }
    let doc = parse_file(TIKA_HWP).expect("tika-testHWP_5.0.hwp must parse without error");
    assert!(
        !doc.sections.is_empty(),
        "parsed document must have at least one section"
    );
}

// ── Markdown output is non-empty ─────────────────────────────────────────────

#[test]
fn sample_hwp_markdown_non_empty() {
    if skip_if_missing(SAMPLE_HWP) {
        return;
    }
    let md = to_markdown(SAMPLE_HWP).expect("to_markdown must succeed");
    assert!(!md.trim().is_empty(), "markdown output must not be empty");
}

#[test]
fn hwpx_2016_markdown_non_empty() {
    if skip_if_missing(HWPX_2016) {
        return;
    }
    let md = to_markdown(HWPX_2016).expect("to_markdown must succeed");
    assert!(!md.trim().is_empty(), "markdown output must not be empty");
}

// ── Bullet rendering without cleanup ─────────────────────────────────────────

#[test]
fn bullet_chars_render_as_list_marker_without_cleanup() {
    if skip_if_missing(HWPX_2016) {
        return;
    }
    let opts = RenderOptions::default();
    let doc = parse_file(HWPX_2016).expect("must parse");
    let md = unhwp::render::render_markdown(&doc, &opts).expect("must render");

    // The markdown must not contain raw PUA bullet chars
    // (these would indicate the renderer failed to convert HWP private-use bullets)
    let pua_bullets = [
        '\u{F0A3}', '\u{F09F}', '\u{F09E}', '\u{F020}', '\u{F076}', '\u{F0A8}',
    ];
    for ch in pua_bullets {
        assert!(
            !md.contains(ch),
            "PUA bullet char U+{:04X} must not appear in rendered output — should be converted to '- '",
            ch as u32
        );
    }
}

// ── Bold/italic bit ordering (end-to-end) ────────────────────────────────────

#[test]
fn tika_hwp_headings_render_correctly() {
    if skip_if_missing(TIKA_HWP) {
        return;
    }
    let opts = RenderOptions::default().with_heading_analysis();
    let doc = parse_file(TIKA_HWP).expect("must parse");
    let md = unhwp::render::render_markdown(&doc, &opts).expect("must render");
    assert!(
        md.contains('#'),
        "document with heading styles must produce Markdown headings, got: {:?}",
        &md[..md.len().min(200)]
    );
}