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

//! Humble-bragger check — flags sentences containing humble-bragging phrases.

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

use crate::check::Check;

/// Detects humble-bragging phrases in prose
/// (e.g., "In my experience", "As someone who has").
#[derive(Debug)]
pub struct HumbleBraggerCheck;

impl Check for HumbleBraggerCheck {
    fn id(&self) -> &'static str {
        "humble-bragger"
    }

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

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

    fn run(&self, doc: &Document, config: &CheckConfig, suite: &mut ExpectationSuite) {
        if !config.quality.heuristics.humble_bragger.enabled {
            return;
        }
        let humble_bragger_phrases = super::resolve_humble_bragger_phrases(config);
        if humble_bragger_phrases.is_empty() {
            return;
        }
        let evidence = super::collect_sentence_phrase_evidence(
            doc,
            &humble_bragger_phrases,
            super::sentence_contains,
        );
        let _result = suite
            .record_custom_values(
                "humble-bragger",
                evidence.is_empty(),
                json!({ "min": 0, "max": 0, "absent": humble_bragger_phrases }),
                json!(evidence.len()),
                &evidence,
            )
            .label("Humble Bragger")
            .checking("sentences containing humble-bragging phrases");
    }
}

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