oxvg_optimiser 0.0.5

The OXVG optimiser is library for optimising SVG 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

use oxvg_ast::{
    element::Element,
    has_attribute, is_element,
    visitor::{Context, Visitor},
};
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};

#[cfg(feature = "wasm")]
use tsify::Tsify;

use crate::error::JobsError;

#[cfg_attr(feature = "wasm", derive(Tsify))]
#[cfg_attr(feature = "napi", napi(object))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
#[derive(Debug, Clone, Default)]
#[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
/// Removes empty `<text>` and `<tspan>` elements. Removes `<tref>` elements that don't
/// reference anything within the document.
///
/// # Correctness
///
/// This job should never visually change the document.
///
/// # Errors
///
/// Never.
///
/// If this job produces an error or panic, please raise an [issue](https://github.com/noahbald/oxvg/issues)
pub struct RemoveEmptyText {
    /// Whether to remove empty text elements.
    #[cfg_attr(feature = "wasm", tsify(optional))]
    pub text: Option<bool>,
    /// Whether to remove empty tspan elements.
    #[cfg_attr(feature = "wasm", tsify(optional))]
    pub tspan: Option<bool>,
    /// Whether to remove useless tref elements.
    ///
    /// `tref` is deprecated and generally unsupported by browsers.
    #[cfg_attr(feature = "wasm", tsify(optional))]
    pub tref: Option<bool>,
}

impl<'input, 'arena> Visitor<'input, 'arena> for RemoveEmptyText {
    type Error = JobsError<'input>;

    fn element(
        &self,
        element: &Element<'input, 'arena>,
        _context: &mut Context<'input, 'arena, '_>,
    ) -> Result<(), Self::Error> {
        if self.text.unwrap_or(true) && is_element!(element, Text) && element.is_empty() {
            element.remove();
        }

        if self.tspan.unwrap_or(true) && is_element!(element, TSpan) && element.is_empty() {
            element.remove();
        }

        if self.tref.unwrap_or(true)
            && is_element!(element, TRef)
            && !has_attribute!(element, XLinkHref)
        {
            element.remove();
        }

        Ok(())
    }
}

#[test]
fn remove_empty_text() -> anyhow::Result<()> {
    use crate::test_config;

    insta::assert_snapshot!(test_config(
        r#"{ "removeEmptyText": {} }"#,
        Some(
            r#"<svg xmlns="http://www.w3.org/2000/svg">
    <!-- remove empty text -->
    <g>
        <text></text>
    </g>
</svg>"#
        ),
    )?);

    insta::assert_snapshot!(test_config(
        r#"{ "removeEmptyText": {} }"#,
        Some(
            r#"<svg xmlns="http://www.w3.org/2000/svg">
    <!-- remove empty tspan -->
    <g>
        <tspan></tspan>
    </g>
</svg>"#
        ),
    )?);

    insta::assert_snapshot!(test_config(
        r#"{ "removeEmptyText": {} }"#,
        Some(
            r#"<svg xmlns="http://www.w3.org/2000/svg">
    <!-- remove non-linking tref -->
    <g>
        <tref>...</tref>
    </g>
</svg>"#
        ),
    )?);

    Ok(())
}