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
165

use std::fmt::Debug;

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

/// MembershipMatcher offers a flexible way to assert the presence or absence of specific elements within collections.
///
/// Works with any data type that implements the Eq and Debug trait.
///
/// clearcheck implements MembershipMatcher for collection types including vector, arrays and reference to slices.
///
/// # Example
///```
/// use clearcheck::matchers::collection::membership::contain_all;
/// use clearcheck::matchers::Matcher;
///
/// let collection = vec!["clearcheck", "testify", "assert4j", "xunit"];
/// let all_to_be_contained = vec!["testify", "assert4j", "xunit"];
///
/// let matcher = contain_all(all_to_be_contained);
///
/// assert!(matcher.test(&collection).passed());
/// ```
pub enum MembershipMatcher<T: Eq> {
    Contain(T),
    ContainAll(Vec<T>),
    ContainAny(Vec<T>),
}

impl<T: Eq + Debug> MembershipMatcher<T> {
    fn test(&self, collection: &[T]) -> MatcherResult {
        match self {
            MembershipMatcher::Contain(element) => MatcherResult::formatted(
                collection.contains(element),
                format!("{:?} should contain {:?}", collection, element),
                format!("{:?} should not contain {:?}", collection, element),
            ),
            MembershipMatcher::ContainAll(target) => {
                let missing = target
                    .iter()
                    .filter(|element| !collection.contains(element))
                    .collect::<Vec<_>>();

                MatcherResult::formatted(
                    missing.is_empty(),
                    format!(
                        "{:?} should contain {:?} but was missing {:?}",
                        collection, target, missing
                    ),
                    format!("{:?} should not contain {:?}", collection, target),
                )
            }
            MembershipMatcher::ContainAny(target) => MatcherResult::formatted(
                target.iter().any(|source| collection.contains(source)),
                format!("{:?} should contain any of {:?}", collection, target),
                format!("{:?} should not contain any of {:?}", collection, target),
            ),
        }
    }
}

impl<T> Matcher<Vec<T>> for MembershipMatcher<T>
    where
        T: Eq + Debug,
{
    fn test(&self, collection: &Vec<T>) -> MatcherResult {
        self.test(collection)
    }
}

impl<T, const N: usize> Matcher<[T; N]> for MembershipMatcher<T>
    where
        T: Eq + Debug,
{
    fn test(&self, collection: &[T; N]) -> MatcherResult {
        self.test(collection as &[T])
    }
}

impl<T> Matcher<&[T]> for MembershipMatcher<T>
    where
        T: Eq + Debug,
{
    fn test(&self, collection: &&[T]) -> MatcherResult {
        self.test(collection)
    }
}

/// Creates a MembershipMatcher that asserts whether a collection contains the given element.
pub fn contain<T>(element: T) -> MembershipMatcher<T>
    where
        T: Eq + Debug,
{
    MembershipMatcher::Contain(element)
}

/// Creates a MembershipMatcher that asserts whether a collection contains all the given elements.
pub fn contain_all<T>(elements: Vec<T>) -> MembershipMatcher<T>
    where
        T: Eq + Debug,
{
    MembershipMatcher::ContainAll(elements)
}

/// Creates a MembershipMatcher that asserts whether a collection contains any of the given elements.
pub fn contain_any<T>(elements: Vec<T>) -> MembershipMatcher<T>
    where
        T: Eq + Debug,
{
    MembershipMatcher::ContainAny(elements)
}

#[cfg(test)]
mod tests {
    use crate::assertions::bool::TrueFalseAssertion;
    use crate::matchers::collection::membership::{contain, contain_all, contain_any};

    #[test]
    fn should_contain() {
        let collection = vec!["junit", "testify"];
        let matcher = contain("junit");
        matcher.test(&collection).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_contain_but_id_did_not() {
        let collection = vec!["unit4j", "testify"];
        let matcher = contain("junit");
        matcher.test(&collection).passed.should_be_true();
    }

    #[test]
    fn should_contain_all_elements() {
        let collection = vec!["junit", "testify", "assert4j", "xunit"];
        let all_to_be_contained = vec!["testify", "assert4j", "xunit"];
        let matcher = contain_all(all_to_be_contained);
        matcher.test(&collection).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_contain_all_elements_but_it_did_not() {
        let collection = vec!["junit", "testify", "assert4j", "xunit"];
        let all_to_be_contained = vec!["testify", "assert", "xunit"];
        let matcher = contain_all(all_to_be_contained);
        matcher.test(&collection).passed.should_be_true();
    }

    #[test]
    fn should_contain_any_of_elements() {
        let collection = vec!["junit", "testify", "assert4j", "xunit"];
        let to_be_contained = vec!["testify", "catch", "xunit"];
        let matcher = contain_any(to_be_contained);
        matcher.test(&collection).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_contain_any_of_elements_but_it_did_not() {
        let collection = vec!["junit", "testify", "assert4j", "xunit"];
        let to_be_contained = vec!["catch", "catch2"];
        let matcher = contain_any(to_be_contained);
        matcher.test(&collection).passed.should_be_true();
    }
}