Something went wrong. Try again.
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310//! Pattern dictionary types and bundled TOML loading.
use std::collections::HashSet;
use crate::errors::{PatternLoadError, PatternValidationError};
/// TOML files bundled into `tropius-core`.pub const BUNDLED_PATTERN_FILES: &[(&str, &str)] = &[ ("formatting.toml", include_str!("patterns/formatting.toml")), ( "sentence-structure.toml", include_str!("patterns/sentence-structure.toml"), ), ( "composition.toml", include_str!("patterns/composition.toml"), ), ("tone.toml", include_str!("patterns/tone.toml")), ( "word-choice.toml", include_str!("patterns/word-choice.toml"), ),];
/// Severity attached to a pattern or detector finding.#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Deserialize)]#[serde(rename_all = "lowercase")]pub enum Severity { /// Low-confidence or low-impact signal. Low, /// Medium-confidence signal. Medium, /// High-confidence signal. High,}
impl Severity { /// Returns the report symbol for this severity. pub fn symbol(self) -> &'static str { match self { Self::Low => "ℹ", Self::Medium => "⚠", Self::High => "✕", } }}
/// A deserialized TOML pattern file.#[derive(Debug, Clone, PartialEq, Eq, serde::Deserialize)]pub struct PatternFile { /// Pattern entries declared by the file. pub patterns: Vec<Pattern>,}
impl PatternFile { /// Deserializes a pattern file from TOML text. pub fn from_toml(input: &str) -> Result<Self, toml::de::Error> { toml::from_str(input) }}
/// One phrase-based trope pattern.#[derive(Debug, Clone, PartialEq, Eq, serde::Deserialize)]pub struct Pattern { /// Stable dotted id, such as `word_choice.delve`. pub id: String, /// Human-readable pattern name. pub name: String, /// Pattern severity. pub severity: Severity, /// Literal phrases matched case-insensitively by the phrase detector. pub phrases: Vec<String>,}
/// Loads and validates the pattern dictionaries bundled with the crate.pub fn bundled_patterns() -> Result<Vec<Pattern>, PatternLoadError> { let mut patterns = Vec::new();
for (_, input) in BUNDLED_PATTERN_FILES { patterns.extend(PatternFile::from_toml(input)?.patterns); }
validate_patterns(&patterns)?;
Ok(patterns)}
/// Validates pattern ids and phrases across all loaded pattern files.pub fn validate_patterns(patterns: &[Pattern]) -> Result<(), PatternValidationError> { let mut ids = HashSet::new(); let mut phrases = HashSet::new();
for pattern in patterns { if pattern.id.trim().is_empty() { return Err(PatternValidationError::EmptyPatternId); }
if pattern.name.trim().is_empty() { return Err(PatternValidationError::EmptyPatternName { id: pattern.id.clone(), }); }
if pattern.phrases.is_empty() { return Err(PatternValidationError::EmptyPhraseList { id: pattern.id.clone(), }); }
if !ids.insert(pattern.id.as_str()) { return Err(PatternValidationError::DuplicatePatternId { id: pattern.id.clone(), }); }
for phrase in &pattern.phrases { if phrase.trim().is_empty() { return Err(PatternValidationError::EmptyPhrase { id: pattern.id.clone(), }); }
let normalized = phrase.to_ascii_lowercase();
if !phrases.insert(normalized) { return Err(PatternValidationError::DuplicatePhrase { phrase: phrase.clone(), }); } } }
Ok(())}
#[cfg(test)]mod tests { use super::*;
#[test] fn deserializes_pattern_file() { let file = PatternFile::from_toml( r#"[[patterns]]id = "word_choice.delve"name = "Delve and Friends"severity = "medium"phrases = ["delve into", "robust"]"#, ) .unwrap();
assert_eq!(file.patterns.len(), 1);
let pattern = &file.patterns[0]; assert_eq!(pattern.id, "word_choice.delve"); assert_eq!(pattern.name, "Delve and Friends"); assert_eq!(pattern.severity, Severity::Medium); assert_eq!(pattern.phrases, ["delve into", "robust"]); }
#[test] fn rejects_unknown_severity() { let error = PatternFile::from_toml( r#"[[patterns]]id = "word_choice.delve"name = "Delve and Friends"severity = "extreme"phrases = ["delve into"]"#, ) .unwrap_err();
assert!(error.to_string().contains("unknown variant")); }
#[test] fn deserializes_bundled_pattern_files() { let patterns = bundled_patterns().unwrap();
assert!( patterns .iter() .any(|pattern| pattern.id == "word_choice.delve") ); assert!( patterns .iter() .any(|pattern| pattern.id == "sentence_structure.negative_parallelism") ); }
#[test] fn rejects_duplicate_pattern_ids() { let patterns = vec![ Pattern { id: "word_choice.delve".to_owned(), name: "Delve".to_owned(), severity: Severity::Medium, phrases: vec!["delve into".to_owned()], }, Pattern { id: "word_choice.delve".to_owned(), name: "Delve Again".to_owned(), severity: Severity::Medium, phrases: vec!["delving deeper".to_owned()], }, ];
assert_eq!( validate_patterns(&patterns), Err(PatternValidationError::DuplicatePatternId { id: "word_choice.delve".to_owned(), }) ); }
#[test] fn rejects_duplicate_phrases_case_insensitively() { let patterns = vec![ Pattern { id: "one".to_owned(), name: "One".to_owned(), severity: Severity::Medium, phrases: vec!["Delve Into".to_owned()], }, Pattern { id: "two".to_owned(), name: "Two".to_owned(), severity: Severity::Medium, phrases: vec!["delve into".to_owned()], }, ];
assert_eq!( validate_patterns(&patterns), Err(PatternValidationError::DuplicatePhrase { phrase: "delve into".to_owned(), }) ); }
#[test] fn rejects_empty_pattern_ids() { let patterns = vec![Pattern { id: " ".to_owned(), name: "Empty".to_owned(), severity: Severity::Medium, phrases: vec!["delve into".to_owned()], }];
assert_eq!( validate_patterns(&patterns), Err(PatternValidationError::EmptyPatternId) ); }
#[test] fn rejects_empty_pattern_names() { let patterns = vec![Pattern { id: "word_choice.delve".to_owned(), name: " ".to_owned(), severity: Severity::Medium, phrases: vec!["delve into".to_owned()], }];
assert_eq!( validate_patterns(&patterns), Err(PatternValidationError::EmptyPatternName { id: "word_choice.delve".to_owned(), }) ); }
#[test] fn rejects_empty_phrase_lists() { let patterns = vec![Pattern { id: "word_choice.delve".to_owned(), name: "Delve".to_owned(), severity: Severity::Medium, phrases: Vec::new(), }];
assert_eq!( validate_patterns(&patterns), Err(PatternValidationError::EmptyPhraseList { id: "word_choice.delve".to_owned(), }) ); }
#[test] fn rejects_empty_phrases() { let patterns = vec![Pattern { id: "word_choice.delve".to_owned(), name: "Delve".to_owned(), severity: Severity::Medium, phrases: vec![" ".to_owned()], }];
assert_eq!( validate_patterns(&patterns), Err(PatternValidationError::EmptyPhrase { id: "word_choice.delve".to_owned(), }) ); }}