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

pub mod predicate;

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

/// OkErrMatcher provides a way to assert whether [`Result`] values evaluate to Ok or Err.
///
/// # Example
///```
/// use clearcheck::matchers::Matcher;
/// use clearcheck::matchers::result::be_ok;
///
/// let matcher = be_ok();
/// let value: Result<i32, &str> = Ok(100);
///
/// assert!(matcher.test(&value).passed());
/// ```
pub enum OkErrMatcher {
    Ok,
    Err,
}

impl<T, E> Matcher<Result<T, E>> for OkErrMatcher {
    fn test(&self, value: &Result<T, E>) -> MatcherResult {
        match self {
            OkErrMatcher::Ok => MatcherResult::new(
                value.is_ok(),
                "Value should be Ok",
                "Value should not be Ok",
            ),
            OkErrMatcher::Err => MatcherResult::new(
                value.is_err(),
                "Value should be Err",
                "Value should not be Err",
            ),
        }
    }
}

/// Creates an OkErrMatcher::Ok instance for asserting that a result value evaluates to Ok.
pub fn be_ok() -> OkErrMatcher {
    OkErrMatcher::Ok
}

/// Creates an OkErrMatcher::Err instance for asserting that a result value evaluates to Err.
pub fn be_err() -> OkErrMatcher {
    OkErrMatcher::Err
}

#[cfg(test)]
mod tests {
    use crate::assertions::bool::TrueFalseAssertion;
    use crate::matchers::result::{be_err, be_ok};
    use crate::matchers::Matcher;

    #[test]
    fn should_be_ok() {
        let matcher = be_ok();
        matcher.test(&Ok::<i32, String>(12)).passed.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_ok_but_was_not() {
        let matcher = be_ok();
        matcher
            .test(&Err::<i32, &str>("test error"))
            .passed
            .should_be_true();
    }

    #[test]
    fn should_be_err() {
        let matcher = be_err();
        matcher
            .test(&Err::<i32, &str>("test error"))
            .passed
            .should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_err_but_was_not() {
        let matcher = be_err();
        matcher.test(&Ok::<i32, String>(12)).passed.should_be_true();
    }
}