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

use std::collections::HashMap;
use std::hash::Hash;

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

/// MapLengthMatcher offers a flexible way to assert various length properties of HashMap.
///
/// # Example
///```
/// use std::collections::HashMap;
/// use clearcheck::matchers::map::length::have_atleast_same_length;
/// use clearcheck::matchers::Matcher;
///
/// let mut key_value = HashMap::new();
/// key_value.insert("rust", "clearcheck");
/// key_value.insert("java", "junit");
///
/// let matcher = have_atleast_same_length(2);
///
/// assert!(matcher.test(&key_value).passed());
/// ```
pub enum MapLengthMatcher {
    Same(usize),
    Atleast(usize),
    Atmost(usize),
}

impl<K: Hash + Eq, V> Matcher<HashMap<K, V>> for MapLengthMatcher {
    fn test(&self, collection: &HashMap<K, V>) -> MatcherResult {
        self.test_length(collection.len())
    }
}

impl MapLengthMatcher {
    fn test_length(&self, input_length: usize) -> MatcherResult {
        let message_prefix = "Map";
        match self {
            MapLengthMatcher::Same(length) => MatcherResult::formatted(
                input_length == *length,
                format!(
                    "{:?} length {:?} should be {:?}",
                    message_prefix, input_length, length
                ),
                format!(
                    "{:?} length {:?} should not be {:?}",
                    message_prefix, input_length, length
                ),
            ),
            MapLengthMatcher::Atleast(length) => MatcherResult::formatted(
                input_length >= *length,
                format!(
                    "{:?} length {:?} should be atleast {:?}",
                    message_prefix, input_length, length
                ),
                format!(
                    "{:?} length {:?} should not be atleast {:?}",
                    message_prefix, input_length, length
                ),
            ),
            MapLengthMatcher::Atmost(length) => MatcherResult::formatted(
                input_length <= *length,
                format!(
                    "{:?} length {:?} should be atmost {:?}",
                    message_prefix, input_length, length
                ),
                format!(
                    "{:?} length {:?} should not be atmost {:?}",
                    message_prefix, input_length, length
                ),
            ),
        }
    }
}

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

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

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

#[cfg(test)]
mod tests {
    use std::collections::HashMap;

    use crate::assertions::bool::TrueFalseAssertion;
    use crate::matchers::map::length::{have_atleast_same_length, have_atmost_same_length, have_same_length};
    use crate::matchers::Matcher;

    #[test]
    fn should_have_same_length() {
        let mut key_value = HashMap::new();
        key_value.insert(1, 10);
        key_value.insert(2, 20);

        let matcher = have_same_length(2);
        matcher.test(&key_value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_have_same_length_but_was_not() {
        let mut key_value = HashMap::new();
        key_value.insert(1, 10);
        key_value.insert(2, 20);

        let matcher = have_same_length(5);
        matcher.test(&key_value).passed.should_be_true();
    }

    #[test]
    fn should_have_atleast_same_length() {
        let mut key_value = HashMap::new();
        key_value.insert(1, 10);
        key_value.insert(2, 20);

        let matcher = have_atleast_same_length(2);
        matcher.test(&key_value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_have_atleast_same_length_but_was_not() {
        let mut key_value = HashMap::new();
        key_value.insert(1, 10);
        key_value.insert(2, 20);

        let matcher = have_atleast_same_length(6);
        matcher.test(&key_value).passed.should_be_true();
    }

    #[test]
    fn should_have_atmost_length() {
        let mut key_value = HashMap::new();
        key_value.insert(1, 10);
        key_value.insert(2, 20);

        let matcher = have_atmost_same_length(2);
        matcher.test(&key_value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_have_atmost_length_but_was_not() {
        let mut key_value = HashMap::new();
        key_value.insert(1, 10);
        key_value.insert(2, 20);

        let matcher = have_atmost_same_length(1);
        matcher.test(&key_value).passed.should_be_true();
    }
}