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
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

use regex::Regex;

use crate::matchers::{Should, ShouldNot};
use crate::matchers::string::regex::match_with;

/// RegularExpressionAssertion enables assertions about whether a string (or str) matches a regular expression.
pub trait RegularExpressionAssertion {
    /// - Asserts that the string matches the given regular expression.
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use regex::Regex;
    /// use clearcheck::assertions::string::regex::RegularExpressionAssertion;
    ///
    /// let regex = Regex::new(r"(\d{4})-(\d{2})-(\d{2})").unwrap();
    /// let phrase = "Started clearcheck on 2024-01-02.";
    /// phrase.should_match(regex);
    /// ```
    fn should_match(&self, regex: Regex) -> &Self;

    /// - Asserts that the string does not match the given regular expression.
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use regex::Regex;
    /// use clearcheck::assertions::string::regex::RegularExpressionAssertion;
    ///
    /// let regex = Regex::new(r"(\d{4})-(\d{2})-(\d{2})").unwrap();
    /// let phrase = String::from("Started clearcheck on 02nd January 2024");
    /// phrase.should_not_match(regex);
    /// ```
    fn should_not_match(&self, regex: Regex) -> &Self;
}

impl<T> RegularExpressionAssertion for T
    where T: AsRef<str> {
    fn should_match(&self, regex: Regex) -> &Self {
        self.should(&match_with(regex));
        self
    }

    fn should_not_match(&self, regex: Regex) -> &Self {
        self.should_not(&match_with(regex));
        self
    }
}

#[cfg(all(test, feature = "regex"))]
mod tests {
    use regex::Regex;

    use crate::assertions::string::regex::RegularExpressionAssertion;

    #[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.";
        str.should_match(regex);
    }

    #[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";
        str.should_match(regex);
    }

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

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

#[cfg(all(test, feature = "regex"))]
mod string_tests {
    use regex::Regex;

    use crate::assertions::string::regex::RegularExpressionAssertion;

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

    #[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 = String::from("Started clearcheck on 02nd January 2024");
        str.should_match(regex);
    }

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

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