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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164

use std::fmt::Debug;

use num::Integer;

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

/// IntMatcher offers a flexible way to make assertions about specific integer attributes.
///
/// # Example
///```
/// use clearcheck::matchers::int::be_positive;
/// use clearcheck::matchers::Matcher;
///
/// let value = 10;
/// let matcher = be_positive();
///
/// assert!(matcher.test(&value).passed());
/// ```
pub enum IntMatcher {
    Positive,
    Negative,
    Even,
    Odd,
    Zero,
}

impl<T: Integer + Debug + PartialEq + Default> Matcher<T> for IntMatcher {
    fn test(&self, value: &T) -> MatcherResult {
        match self {
            IntMatcher::Positive => MatcherResult::formatted(
                *value > T::default(),
                format!("{:?} should be positive", value),
                format!("{:?} should not be positive", value),
            ),
            IntMatcher::Negative => MatcherResult::formatted(
                *value < T::default(),
                format!("{:?} should be negative", value),
                format!("{:?} should not be negative", value),
            ),
            IntMatcher::Even => MatcherResult::formatted(
                value.is_even(),
                format!("{:?} should be even", value),
                format!("{:?} should not be even", value),
            ),
            IntMatcher::Odd => MatcherResult::formatted(
                value.is_odd(),
                format!("{:?} should be odd", value),
                format!("{:?} should not be odd", value),
            ),
            IntMatcher::Zero => MatcherResult::formatted(
                *value == T::default(),
                format!("{:?} should be zero", value),
                format!("{:?} should not be zero", value),
            ),
        }
    }
}

/// Creates an IntMatcher that asserts whether an integer value is positive.
pub fn be_positive() -> IntMatcher {
    IntMatcher::Positive
}

/// Creates an IntMatcher that asserts whether an integer value is negative.
pub fn be_negative() -> IntMatcher {
    IntMatcher::Negative
}

/// Creates an IntMatcher that asserts whether an integer value is even.
pub fn be_even() -> IntMatcher {
    IntMatcher::Even
}

/// Creates an IntMatcher that asserts whether an integer value is odd.
pub fn be_odd() -> IntMatcher {
    IntMatcher::Odd
}

/// Creates an IntMatcher that asserts whether an integer value is zero.
pub fn be_zero() -> IntMatcher {
    IntMatcher::Zero
}

#[cfg(all(test, feature = "num"))]
mod tests {
    use crate::assertions::bool::TrueFalseAssertion;
    use crate::matchers::int::{be_even, be_negative, be_odd, be_positive, be_zero};
    use crate::matchers::Matcher;

    #[test]
    fn should_be_positive() {
        let value = 10;
        let matcher = be_positive();
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_positive_but_was_not() {
        let value = -1;
        let matcher = be_positive();
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    fn should_be_negative() {
        let value = -10;
        let matcher = be_negative();
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_negative_but_was_not() {
        let value = 1;
        let matcher = be_negative();
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    fn should_be_even() {
        let value = -10;
        let matcher = be_even();
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_even_but_was_not() {
        let value = -1;
        let matcher = be_even();
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    fn should_be_odd() {
        let value = -11;
        let matcher = be_odd();
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_odd_but_was_not() {
        let value = -10;
        let matcher = be_odd();
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    fn should_be_zero() {
        let value = 0;
        let matcher = be_zero();
        matcher.test(&value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_zero_but_was_not() {
        let value = -10;
        let matcher = be_zero();
        matcher.test(&value).passed.should_be_true();
    }
}