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

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

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

/// MapEmptyMatcher offers a flexible way to assert whether a HashMap is empty.
///
/// # Example
///```
/// use std::collections::HashMap;
/// use clearcheck::matchers::map::empty::be_empty;
/// use clearcheck::matchers::Matcher;
///
/// let key_value: HashMap<i32, i32> = HashMap::new();
/// let matcher = be_empty();
///
/// assert!(matcher.test(&key_value).passed());
/// ```
pub enum MapEmptyMatcher {
    Empty,
    NotEmpty,
}

impl<K: Hash + Eq, V> Matcher<HashMap<K, V>> for MapEmptyMatcher {
    fn test(&self, collection: &HashMap<K, V>) -> MatcherResult {
        match self {
            MapEmptyMatcher::Empty => MatcherResult::new(
                collection.is_empty(),
                "Map should be empty",
                "Map should not be empty",
            ),
            MapEmptyMatcher::NotEmpty => MatcherResult::new(
                !collection.is_empty(),
                "Map should not be empty",
                "Map should be empty",
            ),
        }
    }
}

/// Creates a MapEmptyMatcher that asserts whether a HashMap is empty.
pub fn be_empty() -> MapEmptyMatcher {
    MapEmptyMatcher::Empty
}

/// Creates a MapEmptyMatcher that asserts whether a HashMap is not empty.
pub fn not_be_empty() -> MapEmptyMatcher {
    MapEmptyMatcher::NotEmpty
}

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

    use crate::assertions::bool::TrueFalseAssertion;
    use crate::matchers::map::empty::{be_empty, not_be_empty};
    use crate::matchers::Matcher;

    #[test]
    fn should_be_empty() {
        let key_value: HashMap<i32, i32> = HashMap::new();
        let matcher = be_empty();
        matcher.test(&key_value).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_empty_but_was_not() {
        let mut key_value: HashMap<&str, &str> = HashMap::new();
        key_value.insert("java", "junit");

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

    #[test]
    fn should_not_be_empty() {
        let mut key_value: HashMap<&str, &str> = HashMap::new();
        key_value.insert("java", "junit");

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

    #[test]
    #[should_panic]
    fn should_not_be_empty_but_was() {
        let key_value: HashMap<&str, &str> = HashMap::new();

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