merman-render 0.8.0

Headless layout + SVG renderer for Mermaid (parity-focused; upstream SVG goldens).
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
155
156
157
158
159

//! Small entity decoding helpers used by a few render paths.
//!
//! This intentionally matches the current "minimal" decoding behavior and does not aim to be a
//! fully compliant HTML entity decoder.

use std::borrow::Cow;

/// Decodes Mermaid's preprocessor placeholders before text is emitted or measured.
pub(crate) fn decode_mermaid_entities_for_render_text(text: &str) -> Cow<'_, str> {
    if !text.contains('\u{fb02}') && !text.contains('\u{00b6}') && !text.contains('#') {
        return Cow::Borrowed(text);
    }
    merman_core::entities::decode_mermaid_entities_to_unicode(text)
}

/// Mirrors Mermaid `createText.ts::decodeHTMLEntities` for SVG text nodes.
///
/// SVG labels are assigned through `textContent`, so Mermaid decodes only the entities introduced
/// by its sanitizer. Other spellings such as `&nbsp;`, `&#160;`, and unknown entities remain
/// literal text and must continue to participate in text measurement with that spelling.
pub(crate) fn decode_svg_text_content_entities(text: &str) -> Cow<'_, str> {
    if !text.contains("&lt;") && !text.contains("&gt;") && !text.contains("&amp;") {
        return Cow::Borrowed(text);
    }
    Cow::Owned(decode_stage1_lt_gt_amp(text))
}

/// Decodes a minimal subset of entities used by Mermaid labels.
///
/// This matches the historical replacement order used in this repo:
/// - `&lt;` / `&gt;` first
/// - `&amp;` next
/// - `&quot;` / `&#39;` last
///
/// The replacement order matters: for example `&amp;quot;` becomes `"` (two-step), while
/// `&amp;lt;` stays as `&lt;` (one-step).
pub(crate) fn decode_entities_minimal(text: &str) -> String {
    if !text.contains('&') {
        return text.to_string();
    }

    let stage1 = decode_stage1_lt_gt_amp(text);
    if !stage1.contains('&') {
        return stage1;
    }
    if !stage1.contains("&quot;") && !stage1.contains("&#39;") {
        return stage1;
    }
    decode_stage2_quot_apos(&stage1)
}

pub(crate) fn decode_entities_minimal_cow(text: &str) -> Cow<'_, str> {
    if !text.contains('&') {
        return Cow::Borrowed(text);
    }
    Cow::Owned(decode_entities_minimal(text))
}

fn decode_stage1_lt_gt_amp(text: &str) -> String {
    let mut out = String::with_capacity(text.len());
    let mut rest = text;
    while let Some(pos) = rest.find('&') {
        out.push_str(&rest[..pos]);
        let tail = &rest[pos..];
        if let Some(stripped) = tail.strip_prefix("&lt;") {
            out.push('<');
            rest = stripped;
        } else if let Some(stripped) = tail.strip_prefix("&gt;") {
            out.push('>');
            rest = stripped;
        } else if let Some(stripped) = tail.strip_prefix("&amp;") {
            out.push('&');
            rest = stripped;
        } else {
            out.push('&');
            rest = &tail[1..];
        }
    }
    out.push_str(rest);
    out
}

fn decode_stage2_quot_apos(text: &str) -> String {
    let mut out = String::with_capacity(text.len());
    let mut rest = text;
    while let Some(pos) = rest.find('&') {
        out.push_str(&rest[..pos]);
        let tail = &rest[pos..];
        if let Some(stripped) = tail.strip_prefix("&quot;") {
            out.push('"');
            rest = stripped;
        } else if let Some(stripped) = tail.strip_prefix("&#39;") {
            out.push('\'');
            rest = stripped;
        } else {
            out.push('&');
            rest = &tail[1..];
        }
    }
    out.push_str(rest);
    out
}

#[cfg(test)]
mod tests {
    use super::{
        decode_entities_minimal, decode_mermaid_entities_for_render_text,
        decode_svg_text_content_entities,
    };

    #[test]
    fn mermaid_placeholders_share_one_render_text_decoder() {
        assert_eq!(
            decode_mermaid_entities_for_render_text(
                "left \u{fb02}\u{00b0}lt\u{00b6}\u{00df} right"
            ),
            "left < right"
        );
    }

    #[test]
    fn decode_entities_minimal_direct_entities() {
        assert_eq!(decode_entities_minimal("&lt;"), "<");
        assert_eq!(decode_entities_minimal("&gt;"), ">");
        assert_eq!(decode_entities_minimal("&amp;"), "&");
        assert_eq!(decode_entities_minimal("&quot;"), "\"");
        assert_eq!(decode_entities_minimal("&#39;"), "'");
    }

    #[test]
    fn decode_entities_minimal_preserves_unknown_entities() {
        assert_eq!(decode_entities_minimal("&unknown;"), "&unknown;");
        assert_eq!(decode_entities_minimal("a&b"), "a&b");
    }

    #[test]
    fn decode_entities_minimal_order_matters_like_replace_chain() {
        assert_eq!(decode_entities_minimal("&amp;quot;"), "\"");
        assert_eq!(decode_entities_minimal("&amp;#39;"), "'");
        assert_eq!(decode_entities_minimal("&amp;lt;"), "&lt;");
        assert_eq!(decode_entities_minimal("&amp;gt;"), "&gt;");
    }

    #[test]
    fn decode_entities_minimal_mixed_text() {
        assert_eq!(
            decode_entities_minimal("a &lt; b &amp;&amp; b &gt; c"),
            "a < b && b > c"
        );
    }

    #[test]
    fn svg_text_content_decodes_only_sanitizer_entities() {
        assert_eq!(
            decode_svg_text_content_entities("&amp; &lt; &gt; &nbsp; &#160; &quot; &unknown;"),
            "& < > &nbsp; &#160; &quot; &unknown;"
        );
    }
}