decruft 0.1.1

Extract clean, readable content from web pages
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
#![allow(clippy::panic)]

use decruft::{DecruftOptions, parse};

fn opts() -> DecruftOptions {
    let mut o = DecruftOptions::default();
    o.url = Some("https://example.com/article".into());
    o
}

fn opts_debug() -> DecruftOptions {
    let mut o = DecruftOptions::default();
    o.url = Some("https://example.com/article".into());
    o.debug = true;
    o
}

fn load_fixture(name: &str) -> String {
    let path = format!("{}/tests/fixtures/{name}", env!("CARGO_MANIFEST_DIR"));
    std::fs::read_to_string(&path)
        .unwrap_or_else(|e| panic!("fixture {name} not found at {path}: {e}"))
}

// ── Complex blog post tests ──────────────────────────────────────

#[test]
fn blog_extracts_article_content() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        result.content.contains("Rust's ownership system"),
        "should contain the article's opening paragraph"
    );
    assert!(
        result.content.contains("Borrowing and References"),
        "should contain the h2 heading"
    );
    assert!(
        result.content.contains("Lifetimes"),
        "should contain the lifetimes section"
    );
}

#[test]
fn blog_preserves_code_blocks() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        result.content.contains("<pre><code"),
        "should preserve code blocks"
    );
    assert!(
        result.content.contains("String::from"),
        "should keep code content"
    );
}

#[test]
fn blog_removes_navigation() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("main-nav"),
        "should remove navigation"
    );
    assert!(
        !result.content.contains("Home</a>"),
        "should not contain nav links from header"
    );
}

#[test]
fn blog_removes_ads() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("ad-banner"),
        "should remove ad banners"
    );
    assert!(
        !result.content.contains("sidebar-ad"),
        "should remove sidebar ads"
    );
    assert!(
        !result.content.contains("banner-728x90"),
        "should remove ad images"
    );
}

#[test]
fn blog_removes_sidebar() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("Popular Posts"),
        "should remove sidebar popular posts widget"
    );
    assert!(
        !result.content.contains("Follow Us"),
        "should remove sidebar social links"
    );
}

#[test]
fn blog_removes_cookie_consent() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("cookie"),
        "should remove cookie consent banner"
    );
}

#[test]
fn blog_removes_footer() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("Privacy Policy"),
        "should remove footer links"
    );
    assert!(
        !result.content.contains("All rights reserved"),
        "should remove copyright notice"
    );
}

#[test]
fn blog_removes_share_buttons() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("share-twitter"),
        "should remove share buttons"
    );
    assert!(
        !result.content.contains("Share this article"),
        "should remove share heading"
    );
}

#[test]
fn blog_removes_comments() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("Comments (12)"),
        "should remove comments section"
    );
}

#[test]
fn blog_removes_newsletter_cta() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("newsletter"),
        "should remove newsletter signup"
    );
}

#[test]
fn blog_removes_related_posts() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("You Might Also Like"),
        "should remove related posts heading"
    );
}

#[test]
fn blog_removes_hidden_elements() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("promo-popup"),
        "should remove hidden modal"
    );
    assert!(
        !result.content.contains("pixel.gif"),
        "should remove tracking pixels"
    );
}

#[test]
fn blog_extracts_metadata() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert_eq!(result.title, "Understanding Rust Ownership");
    assert_eq!(result.author, "Alice Chen");
    assert!(
        result.description.contains("ownership model"),
        "description: {}",
        result.description
    );
    assert_eq!(result.site, "TechBlog Daily");
    assert_eq!(
        result.image,
        "https://techblog.example.com/images/rust-ownership.jpg"
    );
}

#[test]
fn blog_extracts_published_date() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        result.published.contains("2025-03-15"),
        "published: {}",
        result.published
    );
}

#[test]
fn blog_extracts_schema_org() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        result.schema_org_data.is_some(),
        "should have schema.org data"
    );
    let schema = result.schema_org_data.as_ref().expect("schema");
    assert_eq!(
        schema.get("@type").and_then(|v| v.as_str()),
        Some("Article")
    );
}

#[test]
fn blog_has_reasonable_word_count() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts());

    assert!(
        result.word_count > 200,
        "word count should be > 200, got {}",
        result.word_count
    );
    assert!(
        result.word_count < 1000,
        "word count should be < 1000 (no clutter), got {}",
        result.word_count
    );
}

// ── News article tests ───────────────────────────────────────────

#[test]
fn news_extracts_article_body() {
    let html = load_fixture("news_article.html");
    let result = parse(&html, &opts());

    assert!(
        result.content.contains("Marine biologists"),
        "should contain article lead"
    );
    assert!(
        result.content.contains("Aurelia profundis"),
        "should contain species name"
    );
    assert!(
        result.content.contains("The Three New Species"),
        "should contain subheading"
    );
    assert!(
        result.content.contains("chemosynthetic"),
        "should contain science content"
    );
}

#[test]
fn news_preserves_blockquotes() {
    let html = load_fixture("news_article.html");
    let result = parse(&html, &opts());

    assert!(
        result.content.contains("<blockquote"),
        "should preserve blockquotes"
    );
    assert!(
        result.content.contains("last great frontier"),
        "should keep quote content"
    );
}

#[test]
fn news_preserves_figures() {
    let html = load_fixture("news_article.html");
    let result = parse(&html, &opts());

    assert!(
        result.content.contains("<figure"),
        "should preserve figure elements"
    );
    assert!(
        result.content.contains("figcaption"),
        "should preserve figcaptions"
    );
}

#[test]
fn news_removes_inline_ads() {
    let html = load_fixture("news_article.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("inline-ad"),
        "should remove inline ads"
    );
    assert!(
        !result.content.contains("ADVERTISEMENT"),
        "should remove ad labels"
    );
}

#[test]
fn news_removes_sidebars() {
    let html = load_fixture("news_article.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("Trending Now"),
        "should remove trending sidebar"
    );
    assert!(
        !result.content.contains("Recommended For You"),
        "should remove recommendations sidebar"
    );
    assert!(
        !result.content.contains("Sponsored Stories"),
        "should remove sponsored content"
    );
}

#[test]
fn news_removes_breaking_ticker() {
    let html = load_fixture("news_article.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("BREAKING"),
        "should remove breaking news ticker"
    );
    assert!(
        !result.content.contains("Stock markets"),
        "should remove ticker items"
    );
}

#[test]
fn news_removes_more_stories() {
    let html = load_fixture("news_article.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("More Science Stories"),
        "should remove more stories section"
    );
}

#[test]
fn news_removes_notification_popup() {
    let html = load_fixture("news_article.html");
    let result = parse(&html, &opts());

    assert!(
        !result.content.contains("Enable notifications"),
        "should remove notification popup"
    );
}

#[test]
fn news_extracts_metadata() {
    let html = load_fixture("news_article.html");
    let result = parse(&html, &opts());

    assert_eq!(
        result.title,
        "Scientists Discover New Species in Deep Ocean"
    );
    assert_eq!(result.author, "Sarah Mitchell");
    assert_eq!(result.site, "World News Today");
    assert!(result.published.contains("2025-06-20"));
}

#[test]
fn news_extracts_graph_schema() {
    let html = load_fixture("news_article.html");
    let result = parse(&html, &opts());

    assert!(result.schema_org_data.is_some());
    let schema = result.schema_org_data.as_ref().expect("schema");
    // Should have flattened the @graph into an array
    assert!(schema.is_array(), "schema should be a flattened array");
}

// ── Debug mode tests ─────────────────────────────────────────────

#[test]
fn debug_mode_includes_removals() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts_debug());

    assert!(result.debug.is_some(), "debug info should be present");
    let debug = result.debug.as_ref().expect("debug");
    assert!(!debug.removals.is_empty(), "should have recorded removals");
    assert!(
        !debug.content_selector.is_empty(),
        "should have content selector path"
    );
}

#[test]
fn debug_mode_includes_meta_tags() {
    let html = load_fixture("complex_blog.html");
    let result = parse(&html, &opts_debug());

    assert!(
        result.meta_tags.is_some(),
        "debug mode should include meta tags"
    );
    let tags = result.meta_tags.as_ref().expect("tags");
    assert!(!tags.is_empty(), "should have meta tags");
}

// ── Option toggle tests ──────────────────────────────────────────

#[test]
fn no_images_removes_all_images() {
    let html = load_fixture("news_article.html");
    let mut opts = DecruftOptions::default();
    opts.url = Some("https://example.com".into());
    opts.remove_images = true;
    let result = parse(&html, &opts);

    assert!(!result.content.contains("<img"), "should remove all images");
}

#[test]
fn custom_selector_overrides_detection() {
    let html = load_fixture("complex_blog.html");
    let mut opts = DecruftOptions::default();
    opts.url = Some("https://example.com".into());
    opts.content_selector = Some("article.post-content".into());
    let result = parse(&html, &opts);

    assert!(
        result.content.contains("Rust's ownership system"),
        "custom selector should still extract article"
    );
}

#[test]
fn disabling_all_filters_preserves_more_content() {
    let html = load_fixture("complex_blog.html");
    let strict = parse(&html, &opts());
    let relaxed = parse(&html, &{
        let mut o = DecruftOptions::default();
        o.url = Some("https://example.com".into());
        o.remove_exact_selectors = false;
        o.remove_partial_selectors = false;
        o.remove_hidden_elements = false;
        o.remove_low_scoring = false;
        o.remove_content_patterns = false;
        o
    });

    assert!(
        relaxed.word_count >= strict.word_count,
        "relaxed ({}) should have >= words than strict ({})",
        relaxed.word_count,
        strict.word_count
    );
}

// ── Edge case tests ──────────────────────────────────────────────

#[test]
fn empty_document() {
    let result = parse("", &DecruftOptions::default());
    assert!(result.content.is_empty() || result.word_count == 0);
}

#[test]
fn minimal_document() {
    let html = "<html><body><p>Hello world</p></body></html>";
    let result = parse(html, &DecruftOptions::default());
    assert!(result.content.contains("Hello world"));
}

#[test]
fn document_with_only_navigation() {
    let html = r#"<html><body>
        <nav><ul><li><a href="/">Home</a></li><li><a href="/about">About</a></li></ul></nav>
        <footer><p>Copyright 2025</p></footer>
    </body></html>"#;
    let result = parse(html, &DecruftOptions::default());
    // Should still return something, even if it's mostly empty
    assert!(result.word_count < 10);
}

#[test]
fn cjk_word_counting() {
    let html = "<html><body><article><p>This article discusses \u{4E2D}\u{6587}\u{5185}\u{5BB9} which is Chinese content with English mixed in.</p></article></body></html>";
    let result = parse(html, &DecruftOptions::default());
    assert!(
        result.word_count > 8,
        "should count CJK characters as words, got {}",
        result.word_count
    );
}

#[test]
fn preserves_semantic_html() {
    let html = r"<html><body>
        <article>
            <h1>Title</h1>
            <p>First paragraph with <strong>bold</strong> and <em>italic</em> text.</p>
            <ul><li>Item one</li><li>Item two</li></ul>
            <table><tr><th>Header</th></tr><tr><td>Data</td></tr></table>
        </article>
    </body></html>";
    let result = parse(html, &DecruftOptions::default());

    assert!(result.content.contains("<strong>bold</strong>"));
    assert!(result.content.contains("<em>italic</em>"));
    assert!(result.content.contains("<ul>"));
    assert!(result.content.contains("<table>"));
}

#[test]
fn handles_multiple_articles() {
    let html = r"<html><body>
        <article>
            <h1>Main Article</h1>
            <p>This is the main article with substantial content that should be the primary extraction target because it has many more words than the sidebar teaser.</p>
            <p>Additional paragraph with more meaningful content about the topic being discussed in this important article.</p>
        </article>
        <aside>
            <article>
                <h2>Sidebar Teaser</h2>
                <p>Short teaser</p>
            </article>
        </aside>
    </body></html>";
    let result = parse(html, &DecruftOptions::default());

    assert!(
        result.content.contains("Main Article"),
        "should prefer the main article"
    );
}

// ── Real-world fixture tests (if available) ──────────────────────

#[test]
fn paulgraham_if_available() {
    let path = format!(
        "{}/tests/fixtures/paulgraham.html",
        env!("CARGO_MANIFEST_DIR")
    );
    let html =
        std::fs::read_to_string(&path).unwrap_or_else(|e| panic!("fixture missing: {path}: {e}"));

    let result = parse(&html, &{
        let mut o = DecruftOptions::default();
        o.url = Some("https://www.paulgraham.com/read.html".into());
        o
    });

    assert!(
        result.word_count > 100,
        "PG essays should have substantial content, got {}",
        result.word_count
    );
    assert!(
        result.title.len() > 2,
        "should extract a title: '{}'",
        result.title
    );
}

#[test]
fn rust_blog_if_available() {
    let path = format!(
        "{}/tests/fixtures/rust_blog.html",
        env!("CARGO_MANIFEST_DIR")
    );
    let html =
        std::fs::read_to_string(&path).unwrap_or_else(|e| panic!("fixture missing: {path}: {e}"));

    let result = parse(&html, &{
        let mut o = DecruftOptions::default();
        o.url = Some("https://blog.rust-lang.org/2024/11/28/Rust-2024-Edition.html".into());
        o
    });

    assert!(
        result.word_count > 100,
        "Rust blog should have content, got {}",
        result.word_count
    );
    assert!(!result.content.contains("footer"));
}

#[test]
fn wikipedia_if_available() {
    let path = format!(
        "{}/tests/fixtures/wikipedia.html",
        env!("CARGO_MANIFEST_DIR")
    );
    let html =
        std::fs::read_to_string(&path).unwrap_or_else(|e| panic!("fixture missing: {path}: {e}"));

    let result = parse(&html, &{
        let mut o = DecruftOptions::default();
        o.url = Some("https://en.wikipedia.org/wiki/Rust_(programming_language)".into());
        o
    });

    assert!(
        result.word_count > 500,
        "Wikipedia should have lots of content, got {}",
        result.word_count
    );
    assert!(
        result.language == "en",
        "should detect English, got '{}'",
        result.language
    );
}

#[test]
fn wikipedia_bengaluru_extraction() {
    let path = format!(
        "{}/tests/fixtures/wikipedia_bengaluru.html",
        env!("CARGO_MANIFEST_DIR")
    );
    let html =
        std::fs::read_to_string(&path).unwrap_or_else(|e| panic!("fixture missing: {path}: {e}"));

    let result = parse(&html, &{
        let mut o = DecruftOptions::default();
        o.url = Some("https://en.wikipedia.org/wiki/Bengaluru".into());
        o
    });

    // Title should strip "- Wikipedia" suffix (domain-derived site name)
    assert_eq!(result.title, "Bengaluru", "title: {}", result.title);

    // Metadata
    assert_eq!(result.language, "en");
    assert_eq!(result.domain, "en.wikipedia.org");

    // Content should include the article text
    assert!(
        result.content.contains("Bengaluru"),
        "should contain city name"
    );
    assert!(
        result.content.contains("Karnataka"),
        "should contain state name"
    );

    // Should NOT contain navboxes, infoboxes, reference lists
    assert!(
        !result.content.contains("class=\"navbox"),
        "should strip navbox tables"
    );
    assert!(
        !result.content.contains("class=\"infobox"),
        "should strip infobox tables"
    );
    assert!(
        !result.content.contains("class=\"reflist"),
        "should strip reference lists"
    );

    // Should NOT leak internal attributes
    assert!(
        !result.content.contains("data-decruft-"),
        "should strip internal data-decruft attributes"
    );

    // Word count should be reasonable (within range of defuddle's ~13400)
    assert!(
        result.word_count > 8000,
        "too few words: {}",
        result.word_count
    );
    assert!(
        result.word_count < 25000,
        "too many words (including clutter?): {}",
        result.word_count
    );
}