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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201

use std::fmt::Debug;

use crate::matchers::{Should, ShouldNot};
use crate::matchers::collection::predicate::{satisfy_for_all, satisfy_for_any};

/// PredicateAssertion enables assertions about whether the elements in a collection satisfy the given predicate.
pub trait PredicateAssertion<T>
    where
        T: Eq
{
    /// - Asserts that all the elements in the collection satisfy the given predicate.
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use clearcheck::assertions::collection::predicate::PredicateAssertion;
    ///
    /// let collection = vec!["clearcheck-1", "junit-2", "assert-3"];
    /// collection.should_satisfy_for_all(|element| element.chars().any(|ch| ch.is_numeric()));
    /// ```
    fn should_satisfy_for_all<F>(&self, predicate: F) -> &Self
        where
            F: Fn(&T) -> bool;

    /// - Asserts that not all the elements in the collection satisfy the given predicate.
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use clearcheck::assertions::collection::predicate::PredicateAssertion;
    ///
    /// let collection = vec!["clearcheck", "junit-2", "assert-3"];
    /// collection.should_not_satisfy_for_all(|element| element.chars().any(|ch| ch.is_numeric()));
    /// ```
    fn should_not_satisfy_for_all<F>(&self, predicate: F) -> &Self
        where
            F: Fn(&T) -> bool;

    /// - Asserts that any of the elements in the collection satisfy the given predicate.
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use clearcheck::assertions::collection::predicate::PredicateAssertion;
    ///
    /// let collection = vec!["clearcheck", "junit-1", "assert"];
    /// collection.should_satisfy_for_any(|element| element.chars().any(|ch| ch.is_numeric()));
    /// ```
    fn should_satisfy_for_any<F>(&self, predicate: F) -> &Self
        where
            F: Fn(&T) -> bool;

    /// - Asserts that none of the elements in the collection satisfy the given predicate.
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use clearcheck::assertions::collection::predicate::PredicateAssertion;
    ///
    /// let collection = vec!["clearcheck", "junit", "assert"];
    /// collection.should_not_satisfy_for_any(|element| element.chars().any(|ch| ch.is_numeric()));
    /// ```
    fn should_not_satisfy_for_any<F>(&self, predicate: F) -> &Self
        where
            F: Fn(&T) -> bool;
}

impl<T> PredicateAssertion<T> for Vec<T>
    where
        T: Debug,
        T: Eq,
{
    fn should_satisfy_for_all<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        (self as &[T]).should_satisfy_for_all(predicate);
        self
    }

    fn should_not_satisfy_for_all<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        (self as &[T]).should_not_satisfy_for_all(predicate);
        self
    }

    fn should_satisfy_for_any<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        (self as &[T]).should_satisfy_for_any(predicate);
        self
    }

    fn should_not_satisfy_for_any<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        (self as &[T]).should_not_satisfy_for_any(predicate);
        self
    }
}

impl<T, const N: usize> PredicateAssertion<T> for [T; N]
    where
        T: Debug,
        T: Eq,
{
    fn should_satisfy_for_all<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        (self as &[T]).should_satisfy_for_all(predicate);
        self
    }

    fn should_not_satisfy_for_all<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        (self as &[T]).should_not_satisfy_for_all(predicate);
        self
    }

    fn should_satisfy_for_any<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        (self as &[T]).should_satisfy_for_any(predicate);
        self
    }

    fn should_not_satisfy_for_any<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        (self as &[T]).should_not_satisfy_for_any(predicate);
        self
    }
}

impl<T> PredicateAssertion<T> for [T]
    where
        T: Debug,
        T: Eq,
{
    fn should_satisfy_for_all<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        self.should(&satisfy_for_all(predicate));
        self
    }

    fn should_not_satisfy_for_all<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        self.should_not(&satisfy_for_all(predicate));
        self
    }

    fn should_satisfy_for_any<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        self.should(&satisfy_for_any(predicate));
        self
    }

    fn should_not_satisfy_for_any<F>(&self, predicate: F) -> &Self where F: Fn(&T) -> bool {
        self.should_not(&satisfy_for_any(predicate));
        self
    }
}

#[cfg(test)]
mod tests {
    use crate::assertions::collection::predicate::PredicateAssertion;

    #[test]
    fn should_satisfy_for_all_a_character_must_be_numeric() {
        let collection = vec!["clearcheck-1", "junit-2", "assert-3"];
        collection.should_satisfy_for_all(|element| element.chars().any(|ch| ch.is_numeric()));
    }

    #[test]
    #[should_panic]
    fn should_satisfy_for_all_a_character_must_be_numeric_but_it_did_not() {
        let collection = vec!["clearcheck", "junit-2", "assert-3"];
        collection.should_satisfy_for_all(|element| element.chars().any(|ch| ch.is_numeric()));
    }

    #[test]
    fn should_not_satisfy_for_all_a_character_must_be_numeric() {
        let collection = vec!["clearcheck", "junit-2", "assert-3"];
        collection.should_not_satisfy_for_all(|element| element.chars().any(|ch| ch.is_numeric()));
    }

    #[test]
    #[should_panic]
    fn should_not_satisfy_for_all_a_character_must_be_numeric_but_it_did() {
        let collection = vec!["clearcheck-1", "junit-2", "assert-3"];
        collection.should_not_satisfy_for_all(|element| element.chars().any(|ch| ch.is_numeric()));
    }

    #[test]
    fn should_satisfy_for_any_a_character_must_be_numeric() {
        let collection = vec!["clearcheck-1", "junit", "assert-3"];
        collection.should_satisfy_for_any(|element| element.chars().any(|ch| ch.is_numeric()));
    }

    #[test]
    #[should_panic]
    fn should_satisfy_for_any_a_character_must_be_numeric_but_it_did_not() {
        let collection = vec!["clearcheck", "junit", "assert"];
        collection.should_satisfy_for_any(|element| element.chars().any(|ch| ch.is_numeric()));
    }

    #[test]
    fn should_not_satisfy_for_any_a_character_must_be_numeric() {
        let collection = vec!["clearcheck", "junit", "assert"];
        collection.should_not_satisfy_for_any(|element| element.chars().any(|ch| ch.is_numeric()));
    }

    #[test]
    #[should_panic]
    fn should_not_satisfy_for_any_a_character_must_be_numeric_but_it_did() {
        let collection = vec!["clearcheck", "junit-2", "assert"];
        collection.should_not_satisfy_for_any(|element| element.chars().any(|ch| ch.is_numeric()));
    }
}