#[shallguard::enforces("REQ-SPEC-007")]
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum EvidenceMark {
Test,
EndToEnd,
ReviewOnly,
Pending,
}
const VARIATION_SELECTOR: char = '\u{FE0F}';
impl EvidenceMark {
pub const ALL: [EvidenceMark; 4] = [
EvidenceMark::Test,
EvidenceMark::EndToEnd,
EvidenceMark::ReviewOnly,
EvidenceMark::Pending,
];
#[must_use]
pub const fn keyword(self) -> &'static str {
match self {
EvidenceMark::Test => "[test]",
EvidenceMark::EndToEnd => "[e2e]",
EvidenceMark::ReviewOnly => "[review]",
EvidenceMark::Pending => "[pending]",
}
}
#[must_use]
pub const fn emoji(self) -> char {
match self {
EvidenceMark::Test => '\u{2705}', EvidenceMark::EndToEnd => '\u{1F52C}', EvidenceMark::ReviewOnly => '\u{1F441}', EvidenceMark::Pending => '\u{23F3}', }
}
#[must_use]
pub const fn description(self) -> &'static str {
match self {
EvidenceMark::Test => "automated test",
EvidenceMark::EndToEnd => "end-to-end validation",
EvidenceMark::ReviewOnly => "code review only",
EvidenceMark::Pending => "pending",
}
}
#[must_use]
pub fn is_claimed_in(self, text: &str) -> bool {
text.contains(self.keyword()) || text.contains(self.emoji())
}
#[must_use]
pub fn any_claimed_in(text: &str) -> bool {
EvidenceMark::ALL
.iter()
.any(|mark| mark.is_claimed_in(text))
}
#[must_use]
pub fn canonicalize(text: &str) -> String {
let mut canonical = text.to_string();
for mark in EvidenceMark::ALL {
if canonical.contains(mark.keyword()) {
continue;
}
let emoji = mark.emoji().to_string();
let with_selector = format!("{emoji}{VARIATION_SELECTOR}");
let paired = format!("{} {emoji}", mark.keyword());
canonical = canonical.replace(&with_selector, &emoji);
canonical = canonical.replace(&emoji, &paired);
}
canonical
}
#[must_use]
pub fn keyword_list() -> String {
let keywords: Vec<&str> = EvidenceMark::ALL
.iter()
.map(|mark| mark.keyword())
.collect();
keywords.join(", ")
}
}
#[cfg(test)]
mod tests {
use super::*;
#[shallguard::verifies("REQ-SPEC-007")]
#[test]
fn recognizes_keywords_and_emoji_aliases() {
for mark in EvidenceMark::ALL {
let keyword_text = format!("{} `src/lib.rs` (`t`)", mark.keyword());
let emoji_text = format!("{} `src/lib.rs` (`t`)", mark.emoji());
let paired_text = format!("{} {} `src/lib.rs` (`t`)", mark.keyword(), mark.emoji());
assert!(mark.is_claimed_in(&keyword_text), "{mark:?} keyword");
assert!(mark.is_claimed_in(&emoji_text), "{mark:?} emoji");
assert_eq!(
EvidenceMark::canonicalize(&emoji_text),
paired_text,
"{mark:?} canonical form keeps the emoji"
);
assert_eq!(
EvidenceMark::canonicalize(&paired_text),
paired_text,
"{mark:?} canonical form is stable"
);
assert_eq!(EvidenceMark::canonicalize(&keyword_text), keyword_text);
}
assert!(!EvidenceMark::any_claimed_in("code review"));
assert!(!EvidenceMark::Test.is_claimed_in("[e2e] differential"));
}
#[shallguard::verifies("REQ-SPEC-007")]
#[test]
fn canonicalize_removes_variation_selectors_and_keeps_keywords() {
let text = "\u{1F441}\u{FE0F} code review only";
assert_eq!(
EvidenceMark::canonicalize(text),
"[review] \u{1F441} code review only"
);
let already = "[test] `src/lib.rs` (`t`) [pending]";
assert_eq!(EvidenceMark::canonicalize(already), already);
assert_eq!(
EvidenceMark::keyword_list(),
"[test], [e2e], [review], [pending]"
);
}
}