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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use std::fmt::Debug;

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

/// OrderedMatcher offers a flexible way to assert ordering relationships between values.
///
/// Works with any data type that implements the PartialOrd trait.
///
/// # Example
///```
/// use clearcheck::matchers::Matcher;
/// use clearcheck::matchers::ordered::be_greater_than;
///
/// let value = 100;
/// let matcher = be_greater_than(90);
///
/// assert!(matcher.test(&value).passed());
/// ```
pub enum OrderedMatcher<T: PartialOrd> {
    Gt(T),
    Gte(T),
    Lt(T),
    Lte(T),
}

impl<T: Debug + PartialOrd> Matcher<T> for OrderedMatcher<T> {
    fn test(&self, value: &T) -> MatcherResult {
        match self {
            OrderedMatcher::Gt(other) => MatcherResult::formatted(
                value > other,
                format!("{:?} should be greater than {:?}", value, other),
                format!("{:?} should not be greater than {:?}", value, other),
            ),
            OrderedMatcher::Gte(other) => MatcherResult::formatted(
                value >= other,
                format!("{:?} should be greater than equals to {:?}", value, other),
                format!(
                    "{:?} should not be greater than equals to {:?}",
                    value, other
                ),
            ),
            OrderedMatcher::Lt(other) => MatcherResult::formatted(
                value < other,
                format!("{:?} should be less than {:?}", value, other),
                format!("{:?} should not be less than {:?}", value, other),
            ),
            OrderedMatcher::Lte(other) => MatcherResult::formatted(
                value <= other,
                format!("{:?} should be less than equals to {:?}", value, other),
                format!("{:?} should not be less than equals to {:?}", value, other),
            ),
        }
    }
}

/// Creates an OrderedMatcher that asserts whether a value is greater than the given value.
pub fn be_greater_than<T: PartialOrd>(other: T) -> OrderedMatcher<T> {
    OrderedMatcher::Gt(other)
}

/// Creates an OrderedMatcher that asserts whether a value is greater than or equal to the given value.
pub fn be_greater_than_equal_to<T: PartialOrd>(other: T) -> OrderedMatcher<T> {
    OrderedMatcher::Gte(other)
}

/// Creates an OrderedMatcher that asserts whether a value is less than the given value.
pub fn be_less_than<T: PartialOrd>(other: T) -> OrderedMatcher<T> {
    OrderedMatcher::Lt(other)
}

/// Creates an OrderedMatcher that asserts whether a value is less than or equal to the given value.
pub fn be_less_than_equal_to<T: PartialOrd>(other: T) -> OrderedMatcher<T> {
    OrderedMatcher::Lte(other)
}

#[cfg(test)]
mod tests {
    use crate::assertions::bool::TrueFalseAssertion;
    use crate::matchers::ordered::{
        be_greater_than, be_greater_than_equal_to, be_less_than, be_less_than_equal_to,
    };
    use crate::matchers::Matcher;

    #[test]
    fn should_be_greater_than() {
        let value = 100;
        let matcher = be_greater_than(90);
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_greater_than_but_was_not() {
        let value = 80;
        let matcher = be_greater_than(90);
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    fn should_be_greater_than_equal_to() {
        let value = 100;
        let matcher = be_greater_than_equal_to(100);
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_greater_than_equal_to_but_was_not() {
        let value = 80;
        let matcher = be_greater_than_equal_to(90);
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    fn should_be_less_than() {
        let value = 80;
        let matcher = be_less_than(90);
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_less_than_but_was_not() {
        let value = 100;
        let matcher = be_less_than(90);
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    fn should_be_less_than_equal_to() {
        let value = 100;
        let matcher = be_less_than_equal_to(100);
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_less_than_equal_to_but_was_not() {
        let value = 100;
        let matcher = be_less_than_equal_to(90);
        matcher.test(&value).passed.should_be_true();
    }
}