use serde::{Deserialize, Serialize};
use std::fmt;
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum UnitKind {
Pitfall,
Workaround,
ToolRecommendation,
ToolGapSignal,
}
impl UnitKind {
pub const ALL: [UnitKind; 4] = [
UnitKind::Pitfall,
UnitKind::Workaround,
UnitKind::ToolRecommendation,
UnitKind::ToolGapSignal,
];
pub const fn level(self) -> u8 {
match self {
UnitKind::Pitfall => 1,
UnitKind::Workaround => 2,
UnitKind::ToolRecommendation => 3,
UnitKind::ToolGapSignal => 4,
}
}
pub const fn as_str(self) -> &'static str {
match self {
UnitKind::Pitfall => "pitfall",
UnitKind::Workaround => "workaround",
UnitKind::ToolRecommendation => "tool_recommendation",
UnitKind::ToolGapSignal => "tool_gap_signal",
}
}
pub const fn can_supersede(self, other: UnitKind) -> bool {
matches!(
(self, other),
(UnitKind::Pitfall, UnitKind::Pitfall)
| (UnitKind::Workaround, UnitKind::Workaround)
| (UnitKind::ToolRecommendation, UnitKind::ToolRecommendation)
| (UnitKind::ToolGapSignal, UnitKind::ToolGapSignal)
| (UnitKind::ToolRecommendation, UnitKind::Workaround)
)
}
pub const fn is_actionable_advice(self) -> bool {
!matches!(self, UnitKind::ToolGapSignal)
}
}
impl fmt::Display for UnitKind {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(self.as_str())
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn levels_are_the_cq_levels() {
assert_eq!(
UnitKind::ALL.map(UnitKind::level),
[1, 2, 3, 4],
"ALL must stay in ladder order"
);
}
#[test]
fn every_kind_admits_a_correction_from_its_own_kind() {
for k in UnitKind::ALL {
assert!(k.can_supersede(k), "{k} must admit corrections");
}
}
#[test]
fn only_tooling_replaces_a_workaround_across_kinds() {
let mut cross = Vec::new();
for a in UnitKind::ALL {
for b in UnitKind::ALL {
if a != b && a.can_supersede(b) {
cross.push((a, b));
}
}
}
assert_eq!(
cross,
vec![(UnitKind::ToolRecommendation, UnitKind::Workaround)],
"exactly one cross-kind supersession is legal"
);
}
#[test]
fn a_gap_signal_is_not_advice() {
assert!(!UnitKind::ToolGapSignal.is_actionable_advice());
for k in [
UnitKind::Pitfall,
UnitKind::Workaround,
UnitKind::ToolRecommendation,
] {
assert!(k.is_actionable_advice());
}
}
#[test]
fn wire_tokens_round_trip() {
for k in UnitKind::ALL {
let j = serde_json::to_string(&k).unwrap();
assert_eq!(j, format!("\"{}\"", k.as_str()));
assert_eq!(serde_json::from_str::<UnitKind>(&j).unwrap(), k);
}
}
}