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

use crate::matchers::bool::{be_false, be_true};
use crate::matchers::Should;

/// TrueFalseAssertion enables assertions about whether a boolean evaluates to true or false.
pub trait TrueFalseAssertion {
    /// - Asserts that the boolean evaluates to true.
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use clearcheck::assertions::bool::TrueFalseAssertion;
    ///
    /// let value = true;
    /// value.should_be_true();
    /// ```
    fn should_be_true(&self) -> &Self;

    /// - Asserts that the boolean evaluates to false.
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use clearcheck::assertions::bool::TrueFalseAssertion;
    ///
    /// let value = false;
    /// value.should_be_false();
    /// ```
    fn should_be_false(&self) -> &Self;
}

impl TrueFalseAssertion for bool {
    fn should_be_true(&self) -> &Self {
        self.should(&be_true());
        self
    }

    fn should_be_false(&self) -> &Self {
        self.should(&be_false());
        self
    }
}

#[cfg(test)]
mod tests {
    use crate::assertions::bool::TrueFalseAssertion;

    #[test]
    fn should_be_true() {
        let value = true;
        value.should_be_true();
    }

    #[test]
    #[should_panic]
    fn should_be_true_but_was_not() {
        let value = false;
        value.should_be_true();
    }

    #[test]
    fn should_be_false() {
        let value = false;
        value.should_be_false();
    }

    #[test]
    #[should_panic]
    fn should_be_false_but_was_not() {
        let value = true;
        value.should_be_false();
    }
}