prosesmasher-app-core 0.1.7

Internal core checks crate for the prosesmasher workspace. Published to support the workspace dependency graph.
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

//! Required terms check — ALL configured terms must appear in the document.

use low_expectations::ExpectationSuite;
use prosesmasher_domain_types::{CheckConfig, Document, Locale};

use crate::check::Check;

/// Checks that every term in `config.quality.lexical.required_terms` appears
/// in the document. Each missing term is a failure.
#[derive(Debug)]
pub struct RequiredTermsCheck;

impl Check for RequiredTermsCheck {
    fn id(&self) -> &'static str {
        "required-terms"
    }

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

    fn supported_locales(&self) -> Option<&'static [Locale]> {
        None
    }

    fn run(&self, doc: &Document, config: &CheckConfig, suite: &mut ExpectationSuite) {
        if config.quality.lexical.required_terms.is_empty() {
            return;
        }

        let all_words: Vec<&str> = doc
            .sections
            .iter()
            .flat_map(|s| &s.blocks)
            .flat_map(|b| super::collect_paragraph_words(b))
            .collect();

        let lower_words: Vec<String> = all_words.iter().map(|w| w.to_lowercase()).collect();

        for term in &config.quality.lexical.required_terms {
            let lower_term = term.to_lowercase();
            let found = lower_words.contains(&lower_term);
            let observed = i64::from(found);
            let _result = suite
                .expect_value_to_be_at_least(
                    &format!("required-term-{term}"),
                    observed,
                    1,
                )
                .label("Required Terms")
                .checking(&format!("term \"{term}\" must appear"));
        }
    }
}

#[cfg(test)]
#[path = "required_terms_tests.rs"]
mod tests;