rust_scrapling 0.4.1

Modern web scraping: spiders, CSS selectors, robots.txt/AutoThrottle politeness, and LLM/RAG-ready Markdown extraction - a Rust port of Scrapling
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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
use rust_scrapling::parser::Selector;

const HTML: &str = r#"
<html>
<head><title>Test Page</title></head>
<body>
  <div id="main" class="container">
    <h1 class="title">Hello World</h1>
    <p class="description">This is a <strong>test</strong> page.</p>
    <ul id="items">
      <li class="item" data-price="19.99">Item 1</li>
      <li class="item" data-price="29.99">Item 2</li>
      <li class="item special" data-price="39.99">Item 3</li>
    </ul>
    <a href="/next" class="nav-link">Next Page</a>
    <script>var x = 1;</script>
  </div>
</body>
</html>
"#;

#[test]
fn test_from_html_creates_valid_selector() {
    let sel = Selector::from_html(HTML);
    assert_eq!(sel.tag(), "html");
}

#[test]
fn test_css_h1_title() {
    let sel = Selector::from_html(HTML);
    let results = sel.css("h1.title");
    assert_eq!(results.len(), 1);
    let h1 = &results[0];
    assert_eq!(h1.text().as_str(), "Hello World");
}

#[test]
fn test_css_li_item() {
    let sel = Selector::from_html(HTML);
    let items = sel.css("li.item");
    assert_eq!(items.len(), 3);
}

#[test]
fn test_css_id_main() {
    let sel = Selector::from_html(HTML);
    let divs = sel.css("#main");
    assert_eq!(divs.len(), 1);
    assert_eq!(divs[0].tag(), "div");
}

#[test]
fn test_css_data_attribute() {
    let sel = Selector::from_html(HTML);
    let results = sel.css("[data-price]");
    assert_eq!(results.len(), 3);
}

#[test]
fn test_tag_returns_correct_names() {
    let sel = Selector::from_html(HTML);
    let h1 = sel.css("h1");
    assert_eq!(h1[0].tag(), "h1");
    let ul = sel.css("ul");
    assert_eq!(ul[0].tag(), "ul");
    let a = sel.css("a");
    assert_eq!(a[0].tag(), "a");
}

#[test]
fn test_text_returns_direct_text() {
    let sel = Selector::from_html(HTML);
    let p = sel.css("p.description");
    assert_eq!(p.len(), 1);
    // Direct text of <p> is "This is a " and " page." (not "test" which is in <strong>)
    let text = p[0].text();
    assert!(text.as_str().contains("This is a"));
    assert!(text.as_str().contains("page."));
    assert!(!text.as_str().contains("test"));
}

#[test]
fn test_attrib_returns_attributes() {
    let sel = Selector::from_html(HTML);
    let a = sel.css("a.nav-link");
    assert_eq!(a.len(), 1);
    let attrs = a[0].attrib();
    assert_eq!(attrs.get("href").unwrap().as_str(), "/next");
    assert_eq!(attrs.get("class").unwrap().as_str(), "nav-link");
}

#[test]
fn test_html_content_includes_inner_tags() {
    let sel = Selector::from_html(HTML);
    let p = sel.css("p.description");
    let inner = p[0].html_content();
    assert!(inner.as_str().contains("<strong>test</strong>"));
    assert!(inner.as_str().contains("This is a"));
}

#[test]
fn test_get_all_text_ignores_script() {
    let sel = Selector::from_html(HTML);
    let div = sel.css("#main");
    assert_eq!(div.len(), 1);
    let text = div[0].get_all_text(" ", true, &["script"], None);
    assert!(text.as_str().contains("Hello World"));
    assert!(text.as_str().contains("Item 1"));
    assert!(!text.as_str().contains("var x"));
}

#[test]
fn test_children_of_ul() {
    let sel = Selector::from_html(HTML);
    let ul = sel.css("ul#items");
    assert_eq!(ul.len(), 1);
    let children = ul[0].children();
    assert_eq!(children.len(), 3);
    for child in &children {
        assert_eq!(child.tag(), "li");
    }
}

#[test]
fn test_parent_of_li() {
    let sel = Selector::from_html(HTML);
    let li = sel.css("li.item");
    let parent = li[0].parent().unwrap();
    assert_eq!(parent.tag(), "ul");
}

#[test]
fn test_has_class_positive_and_negative() {
    let sel = Selector::from_html(HTML);
    let li = sel.css("li.item");
    assert!(li[0].has_class("item"));
    assert!(!li[0].has_class("special"));
    assert!(li[2].has_class("special"));
    assert!(li[2].has_class("item"));
}

#[test]
fn test_selectors_len_first_last() {
    let sel = Selector::from_html(HTML);
    let items = sel.css("li.item");
    assert_eq!(items.len(), 3);
    assert!(!items.is_empty());
    assert_eq!(items.first().unwrap().text().as_str(), "Item 1");
    assert_eq!(items.last().unwrap().text().as_str(), "Item 3");
}

#[test]
fn test_selectors_filter() {
    let sel = Selector::from_html(HTML);
    let items = sel.css("li.item");
    let special = items.filter(|s| s.has_class("special"));
    assert_eq!(special.len(), 1);
    assert_eq!(special[0].text().as_str(), "Item 3");
}

#[test]
fn test_selectors_search() {
    let sel = Selector::from_html(HTML);
    let items = sel.css("li.item");
    let found = items.search(|s| s.text().as_str().contains("Item 2"));
    assert!(found.is_some());
    assert_eq!(found.unwrap().text().as_str(), "Item 2");
}

#[test]
fn test_urljoin_with_base_url() {
    let sel = Selector::from_html_with_url(HTML, "https://example.com/page/1");
    let a = sel.css("a.nav-link");
    let href = a[0].get_attribute("href").unwrap();
    let full_url = a[0].urljoin(href.as_str());
    assert_eq!(full_url, "https://example.com/next");
}

#[test]
fn test_find_by_text_exact() {
    let sel = Selector::from_html(HTML);
    let found = sel.find_by_text("Hello World", true, false, true);
    assert!(found.is_some());
    assert_eq!(found.unwrap().tag(), "h1");
}

#[test]
fn test_find_by_text_partial() {
    let sel = Selector::from_html(HTML);
    let found = sel.find_by_text("Hello", true, true, true);
    assert!(found.is_some());
    assert_eq!(found.unwrap().tag(), "h1");
}

#[test]
fn test_find_by_regex() {
    let sel = Selector::from_html(HTML);
    let found = sel.find_by_regex(r"Item \d+", true, true);
    assert!(found.is_some());
    // First element whose recursive text matches is the <html> element (it contains all text)
    // so let's search within a narrower scope
    let ul = sel.css("ul#items");
    let found = ul[0].find_by_regex(r"^Item 2$", true, true);
    assert!(found.is_some());
    assert_eq!(found.unwrap().tag(), "li");
}

#[test]
fn test_json_on_script() {
    let json_html = r#"<html><body><script>{"key": "value"}</script></body></html>"#;
    let sel = Selector::from_html(json_html);
    let script = sel.css("script");
    assert_eq!(script.len(), 1);
    let val = script[0].json().unwrap();
    assert_eq!(val["key"], "value");
}

#[test]
fn test_empty_css_result() {
    let sel = Selector::from_html(HTML);
    let results = sel.css("div.nonexistent");
    assert_eq!(results.len(), 0);
    assert!(results.is_empty());
}

#[test]
fn test_outer_html() {
    let sel = Selector::from_html(HTML);
    let h1 = sel.css("h1.title");
    let outer = h1[0].outer_html();
    assert!(outer.as_str().contains("<h1"));
    assert!(outer.as_str().contains("Hello World"));
    assert!(outer.as_str().contains("</h1>"));
}

#[test]
fn test_next_sibling() {
    let sel = Selector::from_html(HTML);
    let items = sel.css("li.item");
    let next = items[0].next();
    assert!(next.is_some());
    assert_eq!(next.unwrap().text().as_str(), "Item 2");
}

#[test]
fn test_previous_sibling() {
    let sel = Selector::from_html(HTML);
    let items = sel.css("li.item");
    let prev = items[1].previous();
    assert!(prev.is_some());
    assert_eq!(prev.unwrap().text().as_str(), "Item 1");
}

#[test]
fn test_siblings() {
    let sel = Selector::from_html(HTML);
    let items = sel.css("li.item");
    let siblings = items[0].siblings();
    assert_eq!(siblings.len(), 2);
}

#[test]
fn test_get_attribute() {
    let sel = Selector::from_html(HTML);
    let li = sel.css("li.item");
    let price = li[0].get_attribute("data-price");
    assert!(price.is_some());
    assert_eq!(price.unwrap().as_str(), "19.99");

    let missing = li[0].get_attribute("nonexistent");
    assert!(missing.is_none());
}

#[test]
fn test_selectors_getall() {
    let sel = Selector::from_html(HTML);
    let items = sel.css("li.item");
    let all = items.getall();
    assert_eq!(all.len(), 3);
    assert_eq!(all[0].as_str(), "Item 1");
    assert_eq!(all[1].as_str(), "Item 2");
    assert_eq!(all[2].as_str(), "Item 3");
}

#[test]
fn test_selectors_get_first() {
    let sel = Selector::from_html(HTML);
    let items = sel.css("li.item");
    let first = items.get_first(None);
    assert!(first.is_some());
    assert_eq!(first.unwrap().as_str(), "Item 1");

    let empty = sel.css("div.nonexistent");
    let fallback = empty.get_first(Some(rust_scrapling::core::TextHandler::new("default")));
    assert_eq!(fallback.unwrap().as_str(), "default");
}

#[test]
fn test_css_from_element_level() {
    let sel = Selector::from_html(HTML);
    let div = sel.css("#main");
    // CSS from an element (not document root) should work
    let h1 = div[0].css("h1");
    assert_eq!(h1.len(), 1);
    assert_eq!(h1[0].text().as_str(), "Hello World");
}

#[test]
fn test_find_all_by_text() {
    let sel = Selector::from_html(HTML);
    let found = sel.find_all_by_text("Item", true, true);
    // Should find at least the 3 li elements (and potentially the ul that contains them)
    assert!(found.len() >= 3);
}

#[test]
fn test_css_getall_text_pseudo_element() {
    let sel = Selector::from_html(HTML);
    let texts: Vec<String> = sel
        .css_getall("li.item::text")
        .into_iter()
        .map(|t| t.as_str().to_string())
        .collect();
    assert_eq!(texts, vec!["Item 1", "Item 2", "Item 3"]);
}

#[test]
fn test_css_getall_attr_pseudo_element() {
    let sel = Selector::from_html(HTML);
    let prices: Vec<String> = sel
        .css_getall("li.item::attr(data-price)")
        .into_iter()
        .map(|t| t.as_str().to_string())
        .collect();
    assert_eq!(prices, vec!["19.99", "29.99", "39.99"]);
    // Elements without the attribute are skipped, not empty.
    assert!(sel.css_getall("h1::attr(data-missing)").is_empty());
}

#[test]
fn test_css_get_returns_first_value() {
    let sel = Selector::from_html(HTML);
    assert_eq!(
        sel.css_get("li.item::text").map(|t| t.as_str().to_string()),
        Some("Item 1".to_string())
    );
    assert_eq!(
        sel.css_get("a.nav-link::attr(href)")
            .map(|t| t.as_str().to_string()),
        Some("/next".to_string())
    );
    assert!(sel.css_get(".does-not-exist::text").is_none());
}

#[test]
fn test_css_get_plain_selector_yields_outer_html() {
    let sel = Selector::from_html(HTML);
    let html = sel.css_get("h1.title").unwrap();
    assert!(html.as_str().contains("<h1"));
    assert!(html.as_str().contains("Hello World"));
}

#[test]
fn test_css_getall_recursive_text() {
    // ::text extracts the full recursive text of each match.
    let sel = Selector::from_html(HTML);
    let texts: Vec<String> = sel
        .css_getall("p.description::text")
        .into_iter()
        .map(|t| t.as_str().to_string())
        .collect();
    assert_eq!(texts, vec!["This is a test page."]);
}

#[test]
fn test_find_by_text_first_and_last_match_agree_on_nested_text() {
    // Regression: find_by_text(first_match=true) used to match only an
    // element's DIRECT text, while first_match=false (via find_all_by_text)
    // matched the full RECURSIVE text — so the same query could find
    // different elements depending on the flag. Both must use the same
    // (recursive) text source.
    let html = r#"<html><body><div id="outer"><span id="inner">hello</span></div></body></html>"#;
    let sel = Selector::from_html(html);

    let first = sel
        .find_by_text("hello", true, false, true)
        .expect("first_match=true must find the span (or an ancestor) via recursive text");
    assert_eq!(first.tag(), "span");

    let last = sel
        .find_by_text("hello", false, false, true)
        .expect("first_match=false must find a match too");
    assert_eq!(last.tag(), "span");
}

#[test]
fn test_css_text_skips_text_less_elements() {
    // Parity with Parsel and symmetry with ::attr: an element with no text
    // nodes yields nothing, so css_get returns the first element that has
    // actual text instead of Some("").
    let html = r#"<html><body><ul><li></li><li>real</li></ul></body></html>"#;
    let sel = Selector::from_html(html);
    let texts: Vec<String> = sel
        .css_getall("li::text")
        .into_iter()
        .map(|t| t.as_str().to_string())
        .collect();
    assert_eq!(texts, vec!["real"]);
    assert_eq!(
        sel.css_get("li::text").map(|t| t.as_str().to_string()),
        Some("real".to_string())
    );
}