use std::borrow::Cow;
use std::fmt::{self, Display, Write};
use crate::{ParamValue, Path, Problem};
#[derive(Debug, Clone, PartialEq)]
pub struct Issue {
path: Path,
problem: Problem,
message_override: Option<Cow<'static, str>>,
}
impl Issue {
#[must_use]
pub fn new(path: Path, problem: Problem) -> Self {
Self {
path,
problem,
message_override: None,
}
}
#[must_use]
pub fn with_message(mut self, message: impl Into<Cow<'static, str>>) -> Self {
self.message_override = Some(message.into());
self
}
#[must_use]
pub fn path(&self) -> &Path {
&self.path
}
#[must_use]
pub fn problem(&self) -> &Problem {
&self.problem
}
#[must_use]
pub fn message(&self) -> String {
match &self.message_override {
Some(message_override) => fill_placeholders(message_override, &self.problem.params()),
None => self.problem.to_string(),
}
}
}
fn fill_placeholders(message: &str, params: &[(&'static str, ParamValue)]) -> String {
let mut filled = String::with_capacity(message.len());
let mut rest = message;
while let Some(next_character) = rest.chars().next() {
rest = if let Some(after) = rest.strip_prefix("{{") {
filled.push('{');
after
} else if let Some(after) = rest.strip_prefix("}}") {
filled.push('}');
after
} else if let Some((value, after)) = param_placeholder_at_start_of(rest, params) {
write!(filled, "{value}").expect("a String takes any text");
after
} else {
filled.push(next_character);
&rest[next_character.len_utf8()..]
};
}
filled
}
fn param_placeholder_at_start_of<'text, 'params>(
text: &'text str,
params: &'params [(&'static str, ParamValue)],
) -> Option<(&'params ParamValue, &'text str)> {
let (name, after) = text.strip_prefix('{')?.split_once('}')?;
let (_, value) = params.iter().find(|(param_name, _)| *param_name == name)?;
Some((value, after))
}
impl Display for Issue {
fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
if self.path.is_root() {
return formatter.write_str(&self.message());
}
write!(formatter, "{}: {}", self.path, self.message())
}
}
#[cfg(test)]
mod tests {
use super::*;
fn reserved_name() -> Problem {
Problem::custom("reserved_name", "is reserved").with_param("name", "admin")
}
#[test]
fn an_issue_s_message_is_its_problem_s_message() {
let issue = Issue::new(Path::root().field("name"), reserved_name());
assert_eq!(issue.message(), "is reserved");
}
#[test]
fn a_message_override_replaces_the_problem_s_message() {
let issue = Issue::new(Path::root().field("name"), reserved_name()).with_message("is taken");
assert_eq!(issue.message(), "is taken");
}
#[test]
fn a_placeholder_in_a_message_override_is_filled_from_the_problem_s_params() {
let issue = Issue::new(Path::root().field("name"), reserved_name()).with_message("{name} is taken");
assert_eq!(issue.message(), "admin is taken");
}
#[test]
fn a_placeholder_of_a_number_param_is_filled_with_the_number() {
let too_many_guests = Problem::custom("too_many_guests", "has too many guests").with_param("max", 8);
let issue = Issue::new(Path::root().field("guests"), too_many_guests).with_message("{max} at most");
assert_eq!(issue.message(), "8 at most");
}
#[test]
fn a_placeholder_naming_no_param_is_left_as_written() {
let issue = Issue::new(Path::root().field("name"), reserved_name()).with_message("{nickname} is taken");
assert_eq!(issue.message(), "{nickname} is taken");
}
#[test]
fn doubled_braces_in_a_message_override_are_literal_braces() {
let issue = Issue::new(Path::root().field("name"), reserved_name()).with_message("{{name}} is {name}");
assert_eq!(issue.message(), "{name} is admin");
}
#[test]
fn an_unclosed_brace_in_a_message_override_is_left_as_written() {
let issue = Issue::new(Path::root().field("name"), reserved_name()).with_message("{name is taken");
assert_eq!(issue.message(), "{name is taken");
}
#[test]
fn an_issue_reads_as_its_path_and_message() {
let issue = Issue::new(Path::root().field("members").index(1).field("name"), reserved_name());
assert_eq!(issue.to_string(), "members[1].name: is reserved");
}
#[test]
fn an_issue_at_the_root_reads_as_its_message_alone() {
let issue = Issue::new(Path::root(), reserved_name());
assert_eq!(issue.to_string(), "is reserved");
}
}