html-cleaning 0.3.0

HTML cleaning, sanitization, and text processing utilities
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
160
161
162
163
164
165
166
167
168

//! Configuration options for HTML cleaning.

/// Configuration for HTML cleaning operations.
///
/// # Example
///
/// ```
/// use html_cleaning::CleaningOptions;
///
/// let options = CleaningOptions {
///     tags_to_remove: vec!["script".into(), "style".into()],
///     prune_empty: true,
///     ..Default::default()
/// };
/// ```
#[derive(Debug, Clone, Default)]
pub struct CleaningOptions {
    /// HTML tags to remove completely (including children).
    ///
    /// Example: `["script", "style", "noscript"]`
    pub tags_to_remove: Vec<String>,

    /// HTML tags to strip (remove tag, keep children).
    ///
    /// Example: `["span", "font"]`
    pub tags_to_strip: Vec<String>,

    /// CSS selectors for elements to remove.
    ///
    /// Example: `[".advertisement", "#cookie-banner"]`
    pub selectors_to_remove: Vec<String>,

    /// Remove elements with no text content.
    pub prune_empty: bool,

    /// Tags considered "empty" for pruning.
    ///
    /// Default: `["div", "span", "p", "section", "article"]`
    pub empty_tags: Vec<String>,

    /// Normalize whitespace in text nodes.
    pub normalize_whitespace: bool,

    /// Remove HTML comment nodes (`<!-- ... -->`).
    pub remove_comments: bool,

    /// Remove all attributes from elements.
    pub strip_attributes: bool,

    /// Attributes to preserve when `strip_attributes` is true.
    ///
    /// Example: `["href", "src", "alt"]`
    pub preserved_attributes: Vec<String>,
}

impl CleaningOptions {
    /// Create a new builder for `CleaningOptions`.
    #[must_use]
    pub fn builder() -> CleaningOptionsBuilder {
        CleaningOptionsBuilder::default()
    }
}

/// Builder for `CleaningOptions`.
#[derive(Debug, Clone, Default)]
pub struct CleaningOptionsBuilder {
    options: CleaningOptions,
}

impl CleaningOptionsBuilder {
    /// Add tags to remove (including children).
    #[must_use]
    pub fn remove_tags(mut self, tags: &[&str]) -> Self {
        self.options
            .tags_to_remove
            .extend(tags.iter().map(|s| (*s).to_string()));
        self
    }

    /// Add tags to strip (keep children).
    #[must_use]
    pub fn strip_tags(mut self, tags: &[&str]) -> Self {
        self.options
            .tags_to_strip
            .extend(tags.iter().map(|s| (*s).to_string()));
        self
    }

    /// Add CSS selectors to remove.
    #[must_use]
    pub fn remove_selectors(mut self, selectors: &[&str]) -> Self {
        self.options
            .selectors_to_remove
            .extend(selectors.iter().map(|s| (*s).to_string()));
        self
    }

    /// Enable empty element pruning.
    #[must_use]
    pub fn prune_empty(mut self, enabled: bool) -> Self {
        self.options.prune_empty = enabled;
        self
    }

    /// Set tags to consider as empty for pruning.
    #[must_use]
    pub fn empty_tags(mut self, tags: &[&str]) -> Self {
        self.options.empty_tags = tags.iter().map(|s| (*s).to_string()).collect();
        self
    }

    /// Enable whitespace normalization.
    #[must_use]
    pub fn normalize_whitespace(mut self, enabled: bool) -> Self {
        self.options.normalize_whitespace = enabled;
        self
    }

    /// Enable HTML comment removal.
    #[must_use]
    pub fn remove_comments(mut self, enabled: bool) -> Self {
        self.options.remove_comments = enabled;
        self
    }

    /// Enable attribute stripping.
    #[must_use]
    pub fn strip_attributes(mut self, enabled: bool) -> Self {
        self.options.strip_attributes = enabled;
        self
    }

    /// Set preserved attributes (when `strip_attributes` is enabled).
    #[must_use]
    pub fn preserve_attributes(mut self, attrs: &[&str]) -> Self {
        self.options.preserved_attributes = attrs.iter().map(|s| (*s).to_string()).collect();
        self
    }

    /// Build the `CleaningOptions`.
    #[must_use]
    pub fn build(self) -> CleaningOptions {
        self.options
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_default_options() {
        let options = CleaningOptions::default();
        assert!(options.tags_to_remove.is_empty());
        assert!(!options.prune_empty);
    }

    #[test]
    fn test_builder() {
        let options = CleaningOptions::builder()
            .remove_tags(&["script", "style"])
            .prune_empty(true)
            .build();

        assert_eq!(options.tags_to_remove.len(), 2);
        assert!(options.prune_empty);
    }
}