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

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

/// CollectionLengthMatcher offers a flexible way to assert various length properties of collections.
///
/// clearcheck implements CollectionLengthMatcher for collection types including vector, arrays and reference to slices.
///
/// # Example
///```
/// use clearcheck::matchers::collection::length::have_atleast_same_length;
/// use clearcheck::matchers::Matcher;
///
/// let matcher = have_atleast_same_length(3);
/// let collection = vec![1, 2, 3, 4];
///
/// assert!(matcher.test(&collection).passed());
/// ```
pub enum CollectionLengthMatcher {
    Same(usize),
    Atleast(usize),
    Atmost(usize),
}

impl<T> Matcher<Vec<T>> for CollectionLengthMatcher {
    fn test(&self, collection: &Vec<T>) -> MatcherResult {
        self.test_length(collection.len())
    }
}

impl<T, const N: usize> Matcher<[T; N]> for CollectionLengthMatcher {
    fn test(&self, collection: &[T; N]) -> MatcherResult {
        self.test_length(collection.len())
    }
}

impl<T> Matcher<&[T]> for CollectionLengthMatcher {
    fn test(&self, collection: &&[T]) -> MatcherResult {
        self.test_length(collection.len())
    }
}

impl CollectionLengthMatcher {
    fn test_length(&self, input_length: usize) -> MatcherResult {
        let message_prefix = "Collection";
        match self {
            CollectionLengthMatcher::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
                ),
            ),
            CollectionLengthMatcher::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
                ),
            ),
            CollectionLengthMatcher::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 CollectionLengthMatcher that asserts whether the length of a collection is same as the given length.
pub fn have_same_length(length: usize) -> CollectionLengthMatcher {
    CollectionLengthMatcher::Same(length)
}

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

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

#[cfg(test)]
mod tests {
    use crate::assertions::bool::TrueFalseAssertion;
    use crate::matchers::collection::length::{have_atleast_same_length, have_atmost_same_length, have_same_length};
    use crate::matchers::Matcher;

    #[test]
    fn should_have_same_length() {
        let matcher = have_same_length(4);
        matcher.test(&vec![1, 2, 3, 4]).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_have_same_length_but_was_not() {
        let matcher = have_same_length(5);
        matcher.test(&vec![1, 2, 3, 4]).passed.should_be_true();
    }

    #[test]
    fn should_have_atleast_same_length() {
        let matcher = have_atleast_same_length(3);
        matcher.test(&vec![1, 2, 3, 4]).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_have_atleast_same_length_but_was_not() {
        let matcher = have_atleast_same_length(6);
        matcher.test(&vec![1, 2, 3, 4]).passed.should_be_true();
    }

    #[test]
    fn should_have_atmost_length() {
        let matcher = have_atmost_same_length(4);
        matcher.test(&vec![1, 2, 3, 4]).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_have_atmost_length_but_was_not() {
        let matcher = have_atmost_same_length(3);
        matcher.test(&vec![1, 2, 3, 4]).passed.should_be_true();
    }
}