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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
use std::{borrow::Borrow, fmt::Display};
use miette::{Diagnostic, LabeledSpan, SourceCode};
use mit_commit::CommitMessage;
use thiserror::Error;
use crate::model::code::Code;
/// Information about the breaking of the lint
#[derive(Error, Debug, Eq, PartialEq, Clone)]
#[error("{error}")]
pub struct Problem {
error: String,
tip: String,
code: Code,
commit_message: String,
labels: Option<Vec<(String, usize, usize)>>,
url: Option<String>,
}
impl Diagnostic for Problem {
/// Unique diagnostic code that can be used to look up more information
/// about this Diagnostic. Ideally also globally unique, and documented in
/// the toplevel crate's documentation for easy searching. Rust path
/// format (`foo::bar::baz`) is recommended, but more classic codes like
/// `E0123` or Enums will work just fine.
fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>> {
Some(Box::new(format!("{:?}", self.code)))
}
/// Additional help text related to this Diagnostic. Do you have any
/// advice for the poor soul who's just run into this issue?
fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>> {
Some(Box::new(&self.tip))
}
fn source_code(&self) -> Option<&dyn SourceCode> {
Some(&self.commit_message)
}
fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>> {
match &self.labels {
None => None,
Some(labels) => {
Some(Box::new(labels.iter().map(|(label, offset, len)| {
LabeledSpan::new(Some(label.clone()), *offset, *len)
}))
as Box<dyn Iterator<Item = LabeledSpan> + '_>)
}
}
}
fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>> {
match self.url.borrow() {
None => None,
Some(url) => Some(Box::new(url)),
}
}
}
impl Problem {
/// Create a new problem
///
/// # Examples
///
/// ```rust
/// use std::option::Option::None;
///
/// use mit_lint::{Code, Problem};
/// let problem = Problem::new(
/// "Error title".to_string(),
/// "Some advice on how to fix it".to_string(),
/// Code::BodyWiderThan72Characters,
/// &"Commit Message".into(),
/// None,
/// None,
/// );
///
/// assert_eq!(problem.error(), "Error title".to_string())
/// ```
#[must_use]
pub fn new(
error: String,
tip: String,
code: Code,
commit_message: &CommitMessage,
labels: Option<Vec<(String, usize, usize)>>,
url: Option<String>,
) -> Problem {
Problem {
error,
tip,
code,
commit_message: String::from(commit_message.clone()),
labels,
url,
}
}
/// Get the code for this problem
///
/// # Examples
///
/// ```rust
/// use std::option::Option::None;
///
/// use mit_lint::{Code, Problem};
/// let problem = Problem::new(
/// "Error title".to_string(),
/// "Some advice on how to fix it".to_string(),
/// Code::BodyWiderThan72Characters,
/// &"Commit Message".into(),
/// None,
/// None,
/// );
///
/// assert_eq!(problem.code(), &Code::BodyWiderThan72Characters)
/// ```
#[must_use]
pub fn code(&self) -> &Code {
&self.code
}
/// Get the commit message for this problem
///
/// # Examples
///
/// ```rust
/// use std::option::Option::None;
///
/// use mit_commit::CommitMessage;
/// use mit_lint::{Code, Problem};
/// let problem = Problem::new(
/// "Error title".to_string(),
/// "Some advice on how to fix it".to_string(),
/// Code::BodyWiderThan72Characters,
/// &"Commit Message".into(),
/// None,
/// None,
/// );
///
/// assert_eq!(
/// problem.commit_message(),
/// CommitMessage::from("Commit Message")
/// )
/// ```
#[must_use]
pub fn commit_message(&self) -> CommitMessage {
self.commit_message.clone().into()
}
/// Get the descriptive title for this error
///
/// # Examples
///
/// ```rust
/// use std::option::Option::None;
///
/// use mit_lint::{Code, Problem};
/// let problem = Problem::new(
/// "Error title".to_string(),
/// "Some advice on how to fix it".to_string(),
/// Code::BodyWiderThan72Characters,
/// &"Commit Message".into(),
/// None,
/// None,
/// );
///
/// assert_eq!(problem.error(), "Error title".to_string())
/// ```
#[must_use]
pub fn error(&self) -> &str {
&self.error
}
/// Get advice on how to fix the problem
///
/// This should be a description of why this is a problem, and how to fix it
///
/// # Examples
///
/// ```rust
/// use std::option::Option::None;
///
/// use mit_lint::{Code, Problem};
/// let problem = Problem::new(
/// "Error title".to_string(),
/// "Some advice on how to fix it".to_string(),
/// Code::BodyWiderThan72Characters,
/// &"Commit Message".into(),
/// None,
/// None,
/// );
///
/// assert_eq!(problem.tip(), "Some advice on how to fix it".to_string())
/// ```
#[must_use]
pub fn tip(&self) -> &str {
&self.tip
}
}
#[cfg(test)]
mod tests {
use std::option::Option::None;
use miette::Diagnostic;
use mit_commit::CommitMessage;
use crate::model::{code::Code, Problem};
#[test]
fn test_has_error() {
let problem = Problem::new(
"Some error".into(),
"".into(),
Code::NotConventionalCommit,
&"".into(),
None,
None,
);
assert_eq!(problem.error(), "Some error");
}
#[test]
fn test_has_has_tip() {
let problem = Problem::new(
"".into(),
"Some tip".into(),
Code::NotConventionalCommit,
&"".into(),
None,
None,
);
assert_eq!(problem.tip(), "Some tip");
}
#[test]
fn test_has_has_code() {
let problem = Problem::new(
"".into(),
"".into(),
Code::NotConventionalCommit,
&"".into(),
None,
None,
);
assert_eq!(problem.code(), &Code::NotConventionalCommit);
}
#[test]
fn test_it_contains_the_triggering_message() {
let problem = Problem::new(
"".into(),
"".into(),
Code::NotConventionalCommit,
&CommitMessage::from("Commit message"),
None,
None,
);
assert_eq!(
problem.commit_message(),
CommitMessage::from("Commit message")
);
}
#[test]
fn test_it_contains_the_labels() {
let problem = Problem::new(
"".into(),
"".into(),
Code::NotConventionalCommit,
&CommitMessage::from("Commit message"),
Some(vec![("String".to_string(), 10_usize, 20_usize)]),
None,
);
assert_eq!(
problem
.labels()
.unwrap()
.map(|x| (x.label().unwrap().to_string(), x.offset(), x.len()))
.collect::<Vec<_>>(),
vec![("String".to_string(), 10_usize, 20_usize)]
);
}
}