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

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

pub mod predicate;

/// SomeNoneMatcher provides a way to assert whether [`Option`] values evaluate to Some or None.
///
/// # Example
///```
/// use clearcheck::matchers::Matcher;
/// use clearcheck::matchers::option::be_some;
///
/// let matcher = be_some();
/// assert!(matcher.test(&Some("clearcheck")).passed());
/// ```
pub enum SomeNoneMatcher {
    Some,
    None,
}

impl<T> Matcher<Option<T>> for SomeNoneMatcher {
    fn test(&self, value: &Option<T>) -> MatcherResult {
        match self {
            SomeNoneMatcher::Some => MatcherResult::new(
                value.is_some(),
                "Value should be Some",
                "Value should not be Some",
            ),
            SomeNoneMatcher::None => MatcherResult::new(
                value.is_none(),
                "Value should be None",
                "Value should not be None",
            ),
        }
    }
}

/// Creates a SomeNoneMatcher::Some instance for asserting that an option value evaluates to Some.
pub fn be_some() -> SomeNoneMatcher {
    SomeNoneMatcher::Some
}

/// Creates a SomeNoneMatcher::None instance for asserting that an option value evaluates to None.
pub fn be_none() -> SomeNoneMatcher {
    SomeNoneMatcher::None
}

#[cfg(test)]
mod tests {
    use crate::assertions::bool::TrueFalseAssertion;
    use crate::matchers::option::{be_none, be_some};
    use crate::matchers::Matcher;

    #[test]
    fn should_be_some() {
        let matcher = be_some();
        matcher.test(&Some(10)).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_some_but_was_not() {
        let matcher = be_some();
        matcher.test(&None::<()>).passed.should_be_true();
    }

    #[test]
    fn should_be_none() {
        let matcher = be_none();
        matcher.test(&None::<()>).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_none_but_was_not() {
        let matcher = be_none();
        matcher.test(&Some(10)).passed.should_be_true();
    }
}