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

use crate::matchers::{Should, ShouldNot};
use crate::matchers::result::predicate::satisfy;
use crate::matchers::result::be_ok;

/// OkPredicateAssertion enables assertions about whether the Result value is both Ok and that the contained value meets or doesn't meet certain conditions defined by a predicate.
pub trait OkPredicateAssertion<T> {
    /// - Asserts that the Result value is Ok and satisfies the given predicate.
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use clearcheck::assertions::result::predicate::OkPredicateAssertion;
    ///
    /// let value: Result<i32, &str> = Ok(1000);
    /// value.should_be_ok_and_satisfy(|value| value > &50);
    /// ```
    fn should_be_ok_and_satisfy<F: Fn(&T) -> bool>(&self, predicate: F) -> &Self;

    /// - Asserts that the Result value is Ok and does not satisfy the given predicate.
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use clearcheck::assertions::result::predicate::OkPredicateAssertion;
    ///
    /// let value: Result<i32, &str> = Ok(100);
    /// value.should_be_ok_and_not_satisfy(|value| value > &500);
    /// ```
    fn should_be_ok_and_not_satisfy<F: Fn(&T) -> bool>(&self, predicate: F) -> &Self;
}

impl<T, E> OkPredicateAssertion<T> for Result<T, E> {
    fn should_be_ok_and_satisfy<F: Fn(&T) -> bool>(&self, predicate: F) -> &Self {
        self.should(&be_ok());
        self.should(&satisfy(predicate));
        self
    }

    fn should_be_ok_and_not_satisfy<F: Fn(&T) -> bool>(&self, predicate: F) -> &Self {
        self.should(&be_ok());
        self.should_not(&satisfy(predicate));
        self
    }
}

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

    #[test]
    fn should_be_ok_and_satisfy_predicate() {
        let value: Result<i32, &str> = Ok(1000);
        value.should_be_ok_and_satisfy(|value| value > &50);
    }

    #[test]
    #[should_panic]
    fn should_be_ok_and_satisfy_predicate_but_it_did_not() {
        let value: Result<i32, &str> = Ok(10);
        value.should_be_ok_and_satisfy(|value| value > &100);
    }

    #[test]
    #[should_panic]
    fn should_be_ok_and_satisfy_predicate_but_it_was_err() {
        let value: Result<i32, &str> = Err("test error");
        value.should_be_ok_and_satisfy(|value| value > &100);
    }

    #[test]
    fn should_be_ok_and_not_satisfy_predicate() {
        let value: Result<i32, &str> = Ok(100);
        value.should_be_ok_and_not_satisfy(|value| value > &500);
    }

    #[test]
    #[should_panic]
    fn should_be_ok_and_not_satisfy_predicate_but_it_did() {
        let value: Result<i32, &str> = Ok(100);
        value.should_be_ok_and_not_satisfy(|value| value > &50);
    }

    #[test]
    #[should_panic]
    fn should_be_ok_and_not_satisfy_predicate_but_it_was_err() {
        let value: Result<i32, &str> = Err("test error");
        value.should_be_ok_and_not_satisfy(|value| value > &100);
    }
}