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

use std::fmt::Debug;
use std::ops::{Range, RangeInclusive};

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

/// RangeMatcher offers a flexible way to assert whether a value falls within a specified range.
///
/// Supports both closed ranges (inclusive of endpoints) and half-open ranges (exclusive of the upper endpoint).
///
/// Works with any data type that implements the Debug and PartialOrd traits.
///
/// # Example
///```
/// use clearcheck::matchers::Matcher;
/// use clearcheck::matchers::range::be_in_inclusive_range;
///
/// let matcher = be_in_inclusive_range(1..=4);
/// assert!(matcher.test(&2).passed());
/// ```
pub enum RangeMatcher<T: PartialOrd> {
    Closed(&'static str, RangeInclusive<T>),
    HalfOpen(&'static str, Range<T>),
}

impl<T> Matcher<T> for RangeMatcher<T>
where
    T: PartialOrd<T> + Debug,
{
    fn test(&self, value: &T) -> MatcherResult {
        match self {
            RangeMatcher::Closed(message_prefix, range) => MatcherResult::formatted(
                range.contains(value),
                format!(
                    "{:?} {:?} should fall in the range {:?}",
                    message_prefix, value, range
                ),
                format!(
                    "{:?} {:?} should not fall in the range {:?}",
                    message_prefix, value, range
                ),
            ),
            RangeMatcher::HalfOpen(message_prefix, range) => MatcherResult::formatted(
                range.contains(value),
                format!(
                    "{:?} {:?} should fall in the range {:?}",
                    message_prefix, value, range
                ),
                format!(
                    "{:?} {:?} should not fall in the range {:?}",
                    message_prefix, value, range
                ),
            ),
        }
    }
}

/// Creates a RangeMatcher that asserts whether a value falls within the given inclusive range.
pub fn be_in_inclusive_range<T: PartialOrd + Debug>(range: RangeInclusive<T>) -> RangeMatcher<T> {
    RangeMatcher::Closed("Value", range)
}

/// Creates a RangeMatcher that asserts whether a value falls within the given exclusive range.
pub fn be_in_exclusive_range<T: PartialOrd + Debug>(range: Range<T>) -> RangeMatcher<T> {
    RangeMatcher::HalfOpen("Value", range)
}

/// Creates a RangeMatcher that asserts whether the length (of collection, hashmap, string) falls within the given inclusive range.
pub fn have_length_in_inclusive_range(range: RangeInclusive<usize>) -> RangeMatcher<usize> {
    RangeMatcher::Closed("Length", range)
}

/// Creates a RangeMatcher that asserts whether the length (of collection, hashmap, string) falls within the given exclusive range.
pub fn have_length_in_exclusive_range(range: Range<usize>) -> RangeMatcher<usize> {
    RangeMatcher::HalfOpen("Length", range)
}

#[cfg(test)]
mod tests {
    use crate::assertions::bool::TrueFalseAssertion;
    use crate::matchers::range::{be_in_exclusive_range, be_in_inclusive_range};
    use crate::matchers::Matcher;

    #[test]
    fn should_be_in_inclusive_range() {
        let matcher = be_in_inclusive_range(1..=4);
        matcher.test(&2).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_in_inclusive_range_but_was_not() {
        let matcher = be_in_inclusive_range(1..=4);
        matcher.test(&5).passed.should_be_true();
    }

    #[test]
    fn should_be_in_exclusive_range() {
        let matcher = be_in_exclusive_range(1..4);
        matcher.test(&2).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_in_exclusive_range_but_was_not() {
        let matcher = be_in_exclusive_range(1..4);
        matcher.test(&4).passed.should_be_true();
    }
}