auditmysite 1.0.0

Resource-efficient WCAG 2.1 Accessibility Checker in Rust
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

//! `AuditModule` implementation for the commerce audit.
//!
//! Derive-only: reads the SEO module's JSON-LD (`discoverability.seo`), the
//! screen-reader link inventory (`screen_reader_audit`, populated before
//! `derive_all`) for anchor texts, and the tech stack (`discoverability.tech_stack`)
//! for the shop gate. Writes `report.commerce`. Self-gating via `analyze_commerce`.

use async_trait::async_trait;

use crate::audit::module::{AuditModule, ModuleContext, ModuleData};
use crate::audit::{AuditReport, PipelineConfig};
use crate::error::Result;
use crate::tech_stack::TechCategory;

use super::analyze_commerce;

pub struct CommerceModule;

#[async_trait]
impl AuditModule for CommerceModule {
    fn id(&self) -> &'static str {
        "commerce"
    }

    fn label(&self) -> &'static str {
        "Commerce"
    }

    fn is_enabled(&self, cfg: &PipelineConfig) -> bool {
        // Derived from the SEO module's structured data; only meaningful when SEO ran.
        cfg.check_seo
    }

    fn depends_on(&self) -> &'static [&'static str] {
        &["seo", "tech_stack"]
    }

    async fn collect(&self, _ctx: &ModuleContext<'_>) -> Result<ModuleData> {
        Ok(ModuleData::None)
    }

    fn derive(&self, report: &mut AuditReport, _locale: &str) -> Result<()> {
        let anchor_texts: Vec<String> = report
            .screen_reader_audit
            .as_ref()
            .map(|sr| {
                sr.navigation_views
                    .links
                    .iter()
                    .filter_map(|l| l.text.clone())
                    .collect()
            })
            .unwrap_or_default();

        // Broader visible-text corpus (all announced node names) for payment /
        // free-shipping / guest-checkout keyword detection.
        let page_texts: Vec<String> = report
            .screen_reader_audit
            .as_ref()
            .map(|sr| {
                sr.reading_sequence
                    .iter()
                    .filter_map(|a| a.item.name.clone())
                    .collect()
            })
            .unwrap_or_default();

        let is_ecommerce_stack = report
            .discoverability
            .tech_stack
            .as_ref()
            .map(|t| {
                t.detected
                    .iter()
                    .any(|d| d.category == TechCategory::Ecommerce)
            })
            .unwrap_or(false);

        let url = report.url.clone();
        report.commerce = report.discoverability.seo.as_ref().and_then(|seo| {
            analyze_commerce(
                &url,
                &seo.structured_data,
                &anchor_texts,
                &page_texts,
                is_ecommerce_stack,
            )
        });
        Ok(())
    }
}