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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

//! Average sentence length check — flags overly long sentences on average.

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

use crate::check::Check;

/// Checks that the document's average sentence length (in words) stays
/// at or below the configured maximum.
///
/// Formula: `total_words / total_sentences`
#[derive(Debug)]
pub struct AvgSentenceLengthCheck;

impl Check for AvgSentenceLengthCheck {
    fn id(&self) -> &'static str {
        "avg-sentence-length"
    }

    fn label(&self) -> &'static str {
        "Average Sentence Length"
    }

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

    fn run(&self, doc: &Document, config: &CheckConfig, suite: &mut ExpectationSuite) {
        if !config.quality.readability.enabled {
            return;
        }
        let Some(max) = config.quality.readability.avg_sentence_length_max else {
            return;
        };

        let total_sentences = doc.metadata.total_sentences;
        if total_sentences == 0 {
            return;
        }

        let avg = doc.metadata.total_words.checked_div(total_sentences).unwrap_or(0);

        let avg_i64 = i64::try_from(avg).unwrap_or(i64::MAX);
        let max_i64 = i64::try_from(max).unwrap_or(i64::MAX);

        let _result = suite
            .record_custom_values(
                "avg-sentence-length",
                avg_i64 <= max_i64,
                json!({
                    "max_words_per_sentence": max_i64,
                    "formula": "total_words / total_sentences",
                }),
                json!({
                    "average_words_per_sentence": avg_i64,
                    "total_words": doc.metadata.total_words,
                    "total_sentences": total_sentences,
                }),
                &[json!({
                    "average_words_per_sentence": avg_i64,
                    "total_words": doc.metadata.total_words,
                    "total_sentences": total_sentences,
                    "max_words_per_sentence": max_i64,
                })],
            )
            .label("Average Sentence Length")
            .checking("words per sentence");
    }
}

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