accessibility-rs 0.1.7

Web accessibility engine for 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
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

#![warn(missing_docs)]

//! Audit html to see how it complies with WCAG
//! standards.
//!
//! accessibility-rs is a web accessibility
//! engine that can replicate websites without
//! a browser to get complex accessibility reports.
//!
//! # How to use accessibility-rs
//!
//! There are a couple of ways to use accessibility-rs:
//!
//! - **Audit** perform an audit against an html page.
//!   - [`audit`] is used to audit a web page for issues.
//!
//! [`audit`]: fn.audit.html#method.audit
//!
//! # Examples
//!
//! A basic WCAG audit for a website:
//!
//! ```no_run
//! use accessibility_rs::{audit, AuditConfig};
//!
//! #[cfg(not(feature = "tokio"))]
//! fn main() {
//!     let config = AuditConfig::basic(r###"<html><body><h1>My Title</h1><input type="text" placeholder="Type me"></input><img src="tabby_cat.png"></img></body></html>"###);
//!     let audit = audit(config);
//!     println!("{:?}", audit);
//! }
//!
//! #[cfg(all(feature = "tokio", not(feature = "spider")))]
//! #[tokio::main]
//! async fn main() {
//!     let config = AuditConfig::basic(r###"<html><body><h1>My Title</h1><input type="text" placeholder="Type me"></input><img src="tabby_cat.png"></img></body></html>"###);
//!     let audit = audit(config).await;
//!     println!("{:?}", audit);
//! }
//!
//! #[cfg(feature = "spider")]
//! #[tokio::main]
//! async fn main() {
//!     let mut config = AuditConfig::default();
//!     config.url = "https://example.com".into();
//!     let audit = audit(config).await;
//!     println!("{:?}", audit);
//! }
//! ```
//!

#[macro_use]
extern crate lazy_static;
#[macro_use]
extern crate rust_i18n;

#[cfg(feature = "spider")]
pub use spider;

/// the main engine for accessibility auditing.
pub mod engine;
/// locales for translations.
pub mod i18n;

pub use accessibility_scraper;
pub use accessibility_scraper::fast_html5ever;
pub use accessibility_scraper::Html;
pub use accessibility_scraper::ElementRef;

pub use crate::engine::audit::auditor::Auditor;
pub use crate::engine::issue::Issue;

i18n!("locales", fallback = "en");

/// support guidelines for auditing
#[derive(Default)]
pub enum Conformance {
    /// Level AAA includes all Level A, AA, and AAA requirements
    #[default]
    WCAGAAA,
}

/// configs for the audit
#[derive(Default)]
#[cfg(feature = "tokio")]
pub struct AuditConfig {
    /// the html source code
    pub html: String,
    /// the css rules to apply
    pub css: String,
    /// extract bounding box of elements
    pub bounding_box: bool,
    /// the locale of the audit translations
    pub locale: String,
    /// the guideline spec
    pub conformance: Conformance,
    /// crawl and perform audits on the entire website
    #[cfg(feature = "spider")]
    pub url: String,
}

/// configs for the audit
#[derive(Default)]
#[cfg(not(feature = "tokio"))]
pub struct AuditConfig<'a> {
    /// the html source code
    pub html: &'a str,
    /// the css rules to apply
    pub css: &'a str,
    /// extract bounding box of elements
    pub bounding_box: bool,
    /// the locale of the audit translations
    pub locale: &'a str,
    /// the guideline spec
    pub conformance: Conformance,
    /// crawl and perform audits on the entire website
    #[cfg(feature = "spider")]
    pub url: &'a str,
}

#[cfg(not(feature = "tokio"))]
impl<'a> AuditConfig<'a> {
    /// a new audit configuration
    pub fn new(html: &'a str, css: &'a str, bounding_box: bool, locale: &'a str) -> Self {
        AuditConfig {
            html: html.into(),
            css: css.into(),
            bounding_box,
            locale: locale.into(),
            ..Default::default()
        }
    }

    /// basic audit
    pub fn basic(html: &'a str) -> Self {
        AuditConfig {
            html: html.into(),
            ..Default::default()
        }
    }

    /// a new audit configuration crawling a website. This does nothing without the 'spider' flag enabled.
    #[cfg(feature = "spider")]
    pub fn new_website(url: &'a str, css: &'a str, bounding_box: bool, locale: &'a str) -> Self {
        AuditConfig {
            url: url.into(),
            css: css.into(),
            bounding_box,
            locale: locale.into(),
            ..Default::default()
        }
    }

    /// a new audit configuration crawling a website. This does nothing without the 'spider' flag enabled.
    #[cfg(not(feature = "spider"))]
    pub fn new_website(
        _url: &'a str,
        _css: &'a str,
        _bounding_box: bool,
        _locale: &'a str,
    ) -> Self {
        AuditConfig::default()
    }
}

#[cfg(feature = "tokio")]
impl AuditConfig {
    /// a new audit configuration
    pub fn new(html: &str, css: &str, bounding_box: bool, locale: &str) -> Self {
        AuditConfig {
            html: html.into(),
            css: css.into(),
            bounding_box,
            locale: locale.into(),
            ..Default::default()
        }
    }

    /// basic audit
    pub fn basic(html: &str) -> Self {
        AuditConfig {
            html: html.into(),
            ..Default::default()
        }
    }

    /// a new audit configuration crawling a website. This does nothing without the 'spider' flag enabled.
    #[cfg(feature = "spider")]
    pub fn new_website(url: &str, css: &str, bounding_box: bool, locale: &str) -> Self {
        AuditConfig {
            url: url.into(),
            css: css.into(),
            bounding_box,
            locale: locale.into(),
            ..Default::default()
        }
    }
    /// a new audit configuration crawling a website. This does nothing without the 'spider' flag enabled.
    #[cfg(not(feature = "spider"))]
    pub fn new_website(_url: &str, _css: &str, _bounding_box: bool, _locale: &str) -> Self {
        AuditConfig::default()
    }
}

/// audit a web page passing the html and css rules.
#[cfg(all(feature = "tokio", not(feature = "spider")))]
pub async fn audit(config: AuditConfig) -> Vec<Issue> {
    let document = accessibility_scraper::Html::parse_document(&config.html).await;
    let auditor = Auditor::new(&document, &config.css, config.bounding_box, &config.locale);
    engine::audit::wcag::WCAGAAA::audit(auditor).await
}

#[cfg(feature = "spider")]
#[derive(Debug, Clone)]
/// The accessibility audit results either a single page or entire website.
pub enum AuditResults {
    /// Crawl results from multiple websites
    Page(spider::hashbrown::HashMap<String, Vec<Issue>>),
    /// Raw html markup results
    Html(Vec<Issue>),
}

/// audit a web page passing the html and css rules.
#[cfg(all(feature = "spider"))]
pub async fn audit(config: &AuditConfig) -> AuditResults {
    if !config.url.is_empty() {
        use spider::website::Website;
        let mut website: Website = Website::new(&config.url);
        let mut rx2: tokio::sync::broadcast::Receiver<spider::page::Page> =
            website.subscribe(16).unwrap();
        let bounding_box = config.bounding_box;
        let locale = config.locale.clone();

        let audits = tokio::spawn(async move {
            let mut issues: spider::hashbrown::HashMap<String, Vec<Issue>> =
                spider::hashbrown::HashMap::new();

            while let Ok(res) = rx2.recv().await {
                let document = accessibility_scraper::Html::parse_document(&res.get_html()).await;
                let auditor = Auditor::new(&document, &"", bounding_box, &locale);
                let issue = engine::audit::wcag::WCAGAAA::audit(auditor).await;
                issues.insert(res.get_url().into(), issue);
            }

            issues
        });

        website.crawl().await;
        website.unsubscribe();
        AuditResults::Page(audits.await.unwrap_or_default())
    } else {
        let document = accessibility_scraper::Html::parse_document(&config.html).await;
        let auditor = Auditor::new(&document, &config.css, config.bounding_box, &config.locale);
        AuditResults::Html(engine::audit::wcag::WCAGAAA::audit(auditor).await)
    }
}

/// audit a web page passing the html and css rules.
#[cfg(not(feature = "tokio"))]
pub fn audit(config: &AuditConfig) -> Vec<Issue> {
    let document = accessibility_scraper::Html::parse_document(&config.html);
    let auditor = Auditor::new(&document, &config.css, config.bounding_box, &config.locale);
    engine::audit::wcag::WCAGAAA::audit(auditor)
}