html-helpers 0.1.0

A collection of high-level utilities for cleaning, transforming, and converting HTML content.
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358

use crate::{Elem, Error, Result};
use scraper::{Html, Selector};

/// Selects HTML elements based on a list of CSS selectors and returns them as a list of `Elem`.
/// The selectors are combined with a comma, effectively performing an "OR" match.
/// Elements are returned in document order.
///
/// # Arguments
///
/// * `html_content` - A string slice containing the HTML content to parse.
/// * `selectors` - An iterator of string-like items, each representing a CSS selector.
///
/// # Returns
///
/// A `Result` containing:
/// - `Ok(Vec<Elem>)`: A vector of `Elem` objects representing the selected elements.
/// - `Err(Error)`: An error if parsing the HTML or the combined selector fails.
pub fn select<S>(html_content: &str, selectors: S) -> Result<Vec<Elem>>
where
	S: IntoIterator,
	S::Item: AsRef<str>,
{
	// -- Build the selectors_str
	let mut selectors_str = String::new();
	for s_ref in selectors {
		let s = s_ref.as_ref().trim();
		if s.is_empty() {
			continue;
		}
		if !selectors_str.is_empty() {
			selectors_str.push(',');
		}
		selectors_str.push_str(s);
	}
	// if empty, just return empty vector
	if selectors_str.is_empty() {
		return Ok(Vec::new());
	}
	// build the scraper seletor
	let css_selector = Selector::parse(&selectors_str).map_err(|err| Error::SelectorParse {
		selector: selectors_str.clone(),
		cause: err.to_string(),
	})?;

	// -- Parse and select
	let html = Html::parse_document(html_content);

	let mut els = Vec::new();
	for element_ref in html.select(&css_selector) {
		els.push(Elem::from_element_ref(element_ref));
	}

	Ok(els)
}

// region:    --- Tests

#[cfg(test)]
mod tests {
	use super::*;
	// General test functions use this local `Result<T>` for `Box<dyn Error>`.
	type Result<T> = core::result::Result<T, Box<dyn std::error::Error>>;

	#[test]
	fn test_selector_select_simple_single_selector() -> Result<()> {
		// -- Setup & Fixtures
		let html_content = r#"
			<!DOCTYPE html>
			<html>
			<head><title>Test</title></head>
			<body>
				<div id="main" class="container">
					<h1>Title</h1>
					<p>First paragraph.</p>
					<p class="highlight">Second paragraph with <span>span text</span>.</p>
					<ul>
						<li>Item 1</li>
						<li>Item 2</li>
					</ul>
				</div>
			</body>
			</html>
		"#;

		// -- Exec
		let els_p = select(html_content, vec!["p"])?;

		// -- Check
		assert_eq!(els_p.len(), 2);

		assert_eq!(els_p[0].tag, "p");
		assert!(els_p[0].attrs.is_none());
		assert_eq!(els_p[0].text.as_deref(), Some("First paragraph."));
		assert_eq!(els_p[0].inner_html.as_deref(), Some("First paragraph."));

		assert_eq!(els_p[1].tag, "p");
		assert_eq!(
			els_p[1]
				.attrs
				.as_ref()
				.ok_or("Should have attrs")?
				.get("class")
				.map(|s| s.as_str()),
			Some("highlight")
		);
		assert_eq!(els_p[1].text.as_deref(), Some("Second paragraph with span text."));
		assert_eq!(
			els_p[1].inner_html.as_deref(),
			Some("Second paragraph with <span>span text</span>.")
		);

		// -- Exec & Check - Span inside p.highlight
		let els_span_in_p = select(html_content, ["p.highlight span"])?;
		assert_eq!(els_span_in_p.len(), 1);
		assert_eq!(els_span_in_p[0].tag, "span");
		assert_eq!(els_span_in_p[0].text.as_deref(), Some("span text"));
		assert_eq!(els_span_in_p[0].inner_html.as_deref(), Some("span text"));

		Ok(())
	}

	#[test]
	fn test_selector_select_multiple_selectors_or_logic() -> Result<()> {
		// -- Setup & Fixtures
		let html_content = r#"
            <h1>Title 1</h1>
            <p>Paragraph 1</p>
            <h2>Title 2</h2>
            <div>Div content</div>
            <p>Paragraph 2</p>
        "#;

		// -- Exec
		// Selects elements matching h1 OR p OR h3. (h3 does not exist)
		// Order should be document order.
		let els = select(html_content, ["h1", "p", "h3"])?;

		// -- Check
		assert_eq!(els.len(), 3, "Should find one h1 and two p tags");
		assert_eq!(els[0].tag, "h1");
		assert_eq!(els[0].text.as_deref(), Some("Title 1"));
		assert_eq!(els[1].tag, "p");
		assert_eq!(els[1].text.as_deref(), Some("Paragraph 1"));
		assert_eq!(els[2].tag, "p");
		assert_eq!(els[2].text.as_deref(), Some("Paragraph 2"));

		// -- Exec & Check - Different order of selectors, same result order
		let els_reordered_selectors = select(html_content, ["p", "h1"])?;
		assert_eq!(els_reordered_selectors.len(), 3);
		assert_eq!(
			els_reordered_selectors[0].tag, "h1",
			"Order is document order, not selector order"
		);
		assert_eq!(els_reordered_selectors[1].tag, "p");
		assert_eq!(els_reordered_selectors[2].tag, "p");

		// -- Exec & Check - Select div and h2
		let els_div_h2 = select(html_content, ["div", "h2"])?;
		assert_eq!(els_div_h2.len(), 2);
		assert_eq!(els_div_h2[0].tag, "h2");
		assert_eq!(els_div_h2[0].text.as_deref(), Some("Title 2"));
		assert_eq!(els_div_h2[1].tag, "div");
		assert_eq!(els_div_h2[1].text.as_deref(), Some("Div content"));

		Ok(())
	}

	#[test]
	fn test_selector_select_by_id_and_class_single_selector() -> Result<()> {
		// -- Setup & Fixtures
		let html_content = r#"
			<div id="unique">ID Content</div>
			<div class="group">Class Content 1</div>
			<span class="group">Class Content 2</span>
		"#;

		// -- Exec & Check - By ID
		let els_id = select(html_content, ["#unique"])?;
		assert_eq!(els_id.len(), 1);
		assert_eq!(els_id[0].tag, "div");
		assert_eq!(
			els_id[0]
				.attrs
				.as_ref()
				.ok_or("Should have attrs")?
				.get("id")
				.map(|s| s.as_str()),
			Some("unique")
		);
		assert_eq!(els_id[0].text.as_deref(), Some("ID Content"));

		// -- Exec & Check - By Class
		let els_class = select(html_content, [".group"])?;
		assert_eq!(els_class.len(), 2);
		assert_eq!(els_class[0].tag, "div");
		assert_eq!(els_class[0].text.as_deref(), Some("Class Content 1"));
		assert_eq!(els_class[1].tag, "span");
		assert_eq!(els_class[1].text.as_deref(), Some("Class Content 2"));

		Ok(())
	}

	#[test]
	fn test_selector_select_empty_selector_single() -> Result<()> {
		// -- Setup & Fixtures
		let html_content = "<p>No divs here</p>";

		// -- Exec & Check - Non-existent tag
		let els_div = select(html_content, ["div"])?;
		assert!(els_div.is_empty());

		// -- Exec & Check - Non-existent class
		let els_class = select(html_content, [".missing"])?;
		assert!(els_class.is_empty());

		// -- Exec & Check - Multiple non-existent selectors
		let els_multiple_missing = select(html_content, ["div.foo", ".bar", "main"])?;
		assert!(els_multiple_missing.is_empty());

		Ok(())
	}

	#[test]
	fn test_selector_select_empty_selector_multiple() -> Result<()> {
		// -- Setup & Fixtures
		let html_content = "<p>Some content</p>";

		// -- Exec
		let res = select(html_content, ["", ""])?;

		// -- Check
		assert!(res.is_empty(), "Elem vector should be empty");

		Ok(())
	}

	#[test]
	fn test_selector_select_empty_selector_mixed() -> Result<()> {
		// -- Setup & Fixtures
		let html_content = "<p>Some content</p><span> other content<span>";

		// -- Exec
		let res = select(html_content, ["", "p", ""])?;

		// -- Check
		assert_eq!(res.len(), 1,);
		let el = res.first().ok_or("Should have one item")?;
		assert_eq!(&el.tag, "p");

		Ok(())
	}

	#[test]
	fn test_selector_select_invalid_selector_syntax() -> Result<()> {
		// -- Setup & Fixtures
		let html_content = "<p>Some content</p>";

		// -- Exec
		let res = select(html_content, ["p", "h1[", "div"]); // Invalid selector syntax

		// -- Check
		let Err(err) = res else {
			panic!("Should have been an error for invalid selector syntax")
		};
		let err_string = err.to_string();
		// scraper's error for "p[" is "Invalid selector: Expected an attribute name, found Eof"
		assert!(err_string.contains("is invalid"));

		Ok(())
	}

	#[test]
	fn test_selector_select_empty_iterator_is_error() -> Result<()> {
		// -- Setup & Fixtures
		let html_content = "<p>Some content</p>";

		// -- Exec
		let res = select(html_content, Vec::<&str>::new())?; // Empty iterator

		// -- Check
		assert!(res.is_empty(), "Elem vector should be empty");

		Ok(())
	}

	#[test]
	fn test_selector_select_attributes_and_inner_html_single_selector() -> Result<()> {
		// -- Setup & Fixtures
		let html_content =
			r#"<a href="https://example.com" title="Test Link" class="external link">Click <b>here</b></a>"#;

		// -- Exec
		let snodes = select(html_content, ["a.link"])?;

		// -- Check
		assert_eq!(snodes.len(), 1);
		let node = &snodes[0];
		assert_eq!(node.tag, "a");
		let attrs = node.attrs.as_ref().ok_or("should have attrs")?;
		assert_eq!(attrs.len(), 3);
		assert_eq!(attrs.get("href").map(|s| s.as_str()), Some("https://example.com"));
		assert_eq!(attrs.get("title").map(|s| s.as_str()), Some("Test Link"));
		assert_eq!(attrs.get("class").map(|s| s.as_str()), Some("external link"));

		assert_eq!(node.text.as_deref(), Some("Click here"));
		assert_eq!(node.inner_html.as_deref(), Some("Click <b>here</b>"));

		Ok(())
	}

	// NOTE: Now, the lib does not trim anymore.
	#[test]
	fn test_selector_select_text_and_inner_html_trimming_single_selector() -> Result<()> {
		// -- Setup & Fixtures
		let html_content = r#"
            <p>  Trimmed text here  </p>
            <div>  <span>  Inner  </span>  </div>
            <pre>
            Untrimmed  
            </pre>
            <button>  </button>
        "#;

		// -- Exec & Check - Paragraph text
		let p_nodes = select(html_content, ["p"])?;
		assert_eq!(p_nodes.len(), 1);
		assert_eq!(p_nodes[0].text.as_deref(), Some("  Trimmed text here  "));
		assert_eq!(p_nodes[0].inner_html.as_deref(), Some("  Trimmed text here  "));

		// -- Exec & Check - Div with span
		let div_nodes = select(html_content, ["div"])?;
		assert_eq!(div_nodes.len(), 1);
		assert_eq!(div_nodes[0].text.as_deref(), Some("    Inner    "));
		assert_eq!(div_nodes[0].inner_html.as_deref(), Some("  <span>  Inner  </span>  "));

		// -- Exec & Check - Pre
		let pre_nodes = select(html_content, ["pre"])?;
		assert_eq!(pre_nodes.len(), 1);
		assert_eq!(
			pre_nodes[0].text.as_deref(),
			Some("            Untrimmed  \n            ")
		);
		assert_eq!(
			pre_nodes[0].inner_html.as_deref(),
			Some("            Untrimmed  \n            ")
		);

		// -- Exec & Check - Empty button
		let button_nodes = select(html_content, ["button"])?;
		assert_eq!(button_nodes.len(), 1);
		assert_eq!(button_nodes[0].text, None);
		assert_eq!(button_nodes[0].inner_html, None);

		Ok(())
	}
}

// endregion: --- Tests