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

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

/// StringLengthMatcher offers a flexible way to assert various length properties of string.
///
/// # Example
///```
/// use clearcheck::matchers::string::length::have_atleast_same_length;
/// use clearcheck::matchers::Matcher;
///
/// let matcher = have_atleast_same_length(3);
/// assert!(matcher.test(&"clearcheck").passed());
/// ```
pub enum StringLengthMatcher {
    Same(usize),
    Atleast(usize),
    Atmost(usize),
}

impl<T> Matcher<T> for StringLengthMatcher
    where T: AsRef<str>
{
    fn test(&self, value: &T) -> MatcherResult {
        match self {
            StringLengthMatcher::Same(input_length) => MatcherResult::formatted(
                value.as_ref().len() == *input_length,
                format!(
                    "{:?} length {:?} should be {:?}",
                    value.as_ref(), input_length, input_length,
                ),
                format!(
                    "{:?} length {:?} should not be {:?}",
                    value.as_ref(), input_length, input_length,
                ),
            ),
            StringLengthMatcher::Atleast(input_length) => MatcherResult::formatted(
                value.as_ref().len() >= *input_length,
                format!(
                    "{:?} length {:?} should be atleast {:?}",
                    value.as_ref(), input_length, input_length,
                ),
                format!(
                    "{:?} length {:?} should not be atleast {:?}",
                    value.as_ref(), input_length, input_length,
                ),
            ),
            StringLengthMatcher::Atmost(input_length) => MatcherResult::formatted(
                value.as_ref().len() <= *input_length,
                format!(
                    "{:?} length {:?} should be atmost {:?}",
                    value.as_ref(), input_length, input_length,
                ),
                format!(
                    "{:?} length {:?} should not be atmost {:?}",
                    value.as_ref(), input_length, input_length,
                ),
            ),
        }
    }
}

/// Creates a StringLengthMatcher that asserts whether the length of a string is same as the given length.
pub fn have_same_length(length: usize) -> StringLengthMatcher {
    StringLengthMatcher::Same(length)
}

/// Creates a StringLengthMatcher that asserts whether the length of a string is greater than or equal to the given length.
pub fn have_atleast_same_length(length: usize) -> StringLengthMatcher {
    StringLengthMatcher::Atleast(length)
}

/// Creates a StringLengthMatcher that asserts whether the length of a string is less than or equal to the given length.
pub fn have_atmost_same_length(length: usize) -> StringLengthMatcher {
    StringLengthMatcher::Atmost(length)
}

#[cfg(test)]
mod tests {
    use crate::assertions::bool::TrueFalseAssertion;
    use crate::matchers::Matcher;
    use crate::matchers::string::length::{have_atleast_same_length, have_atmost_same_length, have_same_length};

    #[test]
    fn should_have_same_length() {
        let matcher = have_same_length(4);
        matcher.test(&"test").passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_have_same_length_but_was_not() {
        let matcher = have_same_length(4);
        matcher.test(&"clearcheck").passed.should_be_true();
    }

    #[test]
    fn should_have_atleast_same_length() {
        let matcher = have_atleast_same_length(4);
        matcher.test(&"clearcheck").passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_have_atleast_same_length_but_was_not() {
        let matcher = have_atleast_same_length(20);
        matcher.test(&"clearcheck").passed.should_be_true();
    }

    #[test]
    fn should_have_atmost_length() {
        let matcher = have_atmost_same_length(5);
        matcher.test(&"junit").passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_have_atmost_length_but_was_not() {
        let matcher = have_atmost_same_length(3);
        matcher.test(&"junit").passed.should_be_true();
    }
}