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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

use crate::matchers::collection::sort::{be_sorted_ascending, be_sorted_descending};
use crate::matchers::Should;

/// SortAssertion enables assertions about whether a collection's elements are sorted in a specific order.
pub trait SortAssertion<T>
where
    T: PartialOrd,
{
    /// - Asserts that the elements of the collection are in ascending order (non-decreasing, allowing duplicates).
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use clearcheck::assertions::collection::sort::SortAssertion;
    ///
    /// let collection = vec![1, 2, 3, 3, 5];
    /// collection.should_be_sorted_ascending();
    /// ```
    fn should_be_sorted_ascending(&self) -> &Self;

    /// - Asserts that the elements of the collection are in descending order (non-increasing, allowing duplicates).
    /// - Returns a reference to self for fluent chaining.
    /// - Panics if the assertion fails.
    /// # Example
    /// ```
    /// use clearcheck::assertions::collection::sort::SortAssertion;
    ///
    /// let collection = vec![5, 4, 3, 3, 2, 1];
    /// collection.should_be_sorted_descending();
    /// ```
    fn should_be_sorted_descending(&self) -> &Self;
}

impl<T> SortAssertion<T> for Vec<T>
where
    T: std::fmt::Debug + PartialOrd,
{
    fn should_be_sorted_ascending(&self) -> &Self {
        (self as &[T]).should_be_sorted_ascending();
        self
    }

    fn should_be_sorted_descending(&self) -> &Self {
        (self as &[T]).should_be_sorted_descending();
        self
    }
}

impl<T, const N: usize> SortAssertion<T> for [T; N]
where
    T: std::fmt::Debug + PartialOrd,
{
    fn should_be_sorted_ascending(&self) -> &Self {
        (self as &[T]).should_be_sorted_ascending();
        self
    }

    fn should_be_sorted_descending(&self) -> &Self {
        (self as &[T]).should_be_sorted_descending();
        self
    }
}

impl<T> SortAssertion<T> for [T]
where
    T: std::fmt::Debug + PartialOrd,
{
    fn should_be_sorted_ascending(&self) -> &Self {
        self.should(&be_sorted_ascending());
        self
    }

    fn should_be_sorted_descending(&self) -> &Self {
        self.should(&be_sorted_descending());
        self
    }
}

#[cfg(test)]
mod tests {
    use crate::assertions::collection::sort::SortAssertion;

    #[test]
    fn should_be_sorted_in_ascending_order() {
        let collection = vec!["actual", "assert", "catch", "testify"];
        collection.should_be_sorted_ascending();
    }

    #[test]
    #[should_panic]
    fn should_be_sorted_in_ascending_order_but_was_not() {
        let collection = vec!["actual", "testify", "catch"];
        collection.should_be_sorted_ascending();
    }

    #[test]
    fn should_be_sorted_in_descending_order() {
        let collection = vec!["testify", "catch", "assert", "actual"];
        collection.should_be_sorted_descending();
    }

    #[test]
    #[should_panic]
    fn should_be_sorted_in_descending_order_but_was_not() {
        let collection = vec!["actual", "testify", "catch"];
        collection.should_be_sorted_descending();
    }
}

#[cfg(test)]
mod array_tests {
    use crate::assertions::collection::sort::SortAssertion;

    #[test]
    fn should_be_sorted_in_ascending_order() {
        let collection = ["actual", "assert", "catch", "testify"];
        collection.should_be_sorted_ascending();
    }

    #[test]
    #[should_panic]
    fn should_be_sorted_in_ascending_order_but_was_not() {
        let collection = ["actual", "testify", "catch"];
        collection.should_be_sorted_ascending();
    }

    #[test]
    fn should_be_sorted_in_descending_order() {
        let collection = ["testify", "catch", "assert", "actual"];
        collection.should_be_sorted_descending();
    }

    #[test]
    #[should_panic]
    fn should_be_sorted_in_descending_order_but_was_not() {
        let collection = ["actual", "testify", "catch"];
        collection.should_be_sorted_descending();
    }
}