clearcheck 0.0.2

Elegant and extensible assertions in rust.
Documentation 
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

use regex::Regex;

use crate::matchers::{Matcher, MatcherResult};

/// RegexMatcher offers a flexible way to assert whether a string matches a regular expression.
///
/// # Example
///```
/// use regex::Regex;
/// use clearcheck::matchers::string::regex::match_with;
/// use clearcheck::matchers::Matcher;
///
/// let matcher = match_with(Regex::new(r"(\d{4})-(\d{2})-(\d{2})").unwrap());
/// assert!(matcher.test(&"Started clearcheck on On 2024-01-02.").passed());
/// ```
pub struct RegexMatcher {
    regexp: Regex,
}

impl<T: AsRef<str>> Matcher<T> for RegexMatcher {
    fn test(&self, value: &T) -> MatcherResult {
        MatcherResult::formatted(
            self.regexp.is_match(value.as_ref()),
            format!(
                "{:?} should match the regular expression {:?}",
                value.as_ref(), self.regexp
            ),
            format!(
                "{:?} should not match the regular expression {:?}",
                value.as_ref(), self.regexp
            ),
        )
    }
}

/// Creates a RegexMatcher that asserts whether a string matches the given regular expression.
pub fn match_with(regular_expression: Regex) -> RegexMatcher {
    RegexMatcher {
        regexp: regular_expression,
    }
}

#[cfg(all(test, feature = "regex"))]
mod tests {
    use crate::assertions::bool::TrueFalseAssertion;
    use crate::matchers::string::regex::match_with;
    use crate::matchers::Matcher;
    use regex::Regex;

    #[test]
    fn should_match_regular_expression() {
        let regex = Regex::new(r"(\d{4})-(\d{2})-(\d{2})").unwrap();
        let str = "Started clearcheck on On 2024-01-02.";

        let matcher = match_with(regex);
        matcher.test(&str).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_match_regular_expression_but_it_did_not() {
        let regex = Regex::new(r"(\d{4})-(\d{2})-(\d{2})").unwrap();
        let str = "Started clearcheck on On 02nd January 2024";

        let matcher = match_with(regex);
        matcher.test(&str).passed.should_be_true();
    }
}