xpct 0.5.1

An extensible test assertion library
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

use std::cmp::Ordering;
use std::fmt;
use std::marker::PhantomData;

use crate::core::Match;

use super::{Expectation, Mismatch};

/// Which inequality test to perform with [`OrdMatcher`].
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum Inequality {
    /// [`PartialOrd::lt`]
    Less,

    /// [`PartialOrd::le`]
    LessOrEqual,

    /// [`PartialOrd::gt`]
    Greater,

    /// [`PartialOrd::ge`]
    GreaterOrEqual,
}

/// The matcher for [`be_lt`], [`be_le`], [`be_gt`], and [`be_ge`].
///
/// [`be_lt`]: crate::be_lt
/// [`be_le`]: crate::be_le
/// [`be_gt`]: crate::be_gt
/// [`be_ge`]: crate::be_ge
#[derive(Debug)]
pub struct OrdMatcher<Expected> {
    expected: Expected,
    kind: Inequality,
}

impl<Expected> OrdMatcher<Expected> {
    /// Create a new [`OrdMatcher`].
    ///
    /// This accepts a `kind` which determines whether the behavior is `<`, `<=`, `>`, or `>=`.
    pub fn new(expected: Expected, kind: Inequality) -> Self {
        Self { expected, kind }
    }
}

impl<Expected, Actual> Match<Actual> for OrdMatcher<Expected>
where
    Actual: PartialOrd<Expected>,
{
    type Fail = Mismatch<Expected, Actual>;

    fn matches(&mut self, actual: &Actual) -> crate::Result<bool> {
        Ok(match self.kind {
            Inequality::Less => actual < &self.expected,
            Inequality::LessOrEqual => actual <= &self.expected,
            Inequality::Greater => actual > &self.expected,
            Inequality::GreaterOrEqual => actual >= &self.expected,
        })
    }

    fn fail(self, actual: Actual) -> Self::Fail {
        Mismatch {
            actual,
            expected: self.expected,
        }
    }
}

/// A sort order, either ascending or descending.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum SortOrder {
    #[allow(missing_docs)]
    Asc,

    #[allow(missing_docs)]
    Desc,
}

/// The matcher for [`be_sorted_asc`] and [`be_sorted_desc`].
///
/// [`be_sorted_asc`]: crate::be_sorted_asc
/// [`be_sorted_desc`]: crate::be_sorted_desc
#[derive(Debug)]
#[non_exhaustive]
pub struct BeSortedMatcher<T> {
    order: SortOrder,
    marker: PhantomData<T>,
}

impl<T> BeSortedMatcher<T> {
    /// Create a new [`BeSortedMatcher`] from the given sort order.
    pub fn new(order: SortOrder) -> Self {
        Self {
            order,
            marker: PhantomData,
        }
    }
}

impl<T, Actual> Match<Actual> for BeSortedMatcher<T>
where
    T: Ord,
    Actual: AsRef<[T]>,
{
    type Fail = Expectation<Actual>;

    fn matches(&mut self, actual: &Actual) -> crate::Result<bool> {
        Ok(actual.as_ref().windows(2).all(|window| match self.order {
            SortOrder::Asc => window[0] <= window[1],
            SortOrder::Desc => window[0] >= window[1],
        }))
    }

    fn fail(self, actual: Actual) -> Self::Fail {
        Expectation { actual }
    }
}

type BoxSortPredicate<'a, T> = Box<dyn Fn(&T, &T) -> Ordering + 'a>;

/// The matcher for [`be_sorted_by`].
///
/// [`be_sorted_by`]: crate::be_sorted_by
#[non_exhaustive]
pub struct BeSortedByMatcher<'a, T> {
    predicate: BoxSortPredicate<'a, T>,
    marker: PhantomData<T>,
}

impl<'a, T> fmt::Debug for BeSortedByMatcher<'a, T> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("BeSortedByMatcher").finish_non_exhaustive()
    }
}

impl<'a, T> BeSortedByMatcher<'a, T> {
    /// Create a new [`BeSortedByMatcher`] from the given sort predicate.
    pub fn new(predicate: impl Fn(&T, &T) -> Ordering + 'a) -> Self {
        Self {
            predicate: Box::new(predicate),
            marker: PhantomData,
        }
    }
}

impl<'a, T, Actual> Match<Actual> for BeSortedByMatcher<'a, T>
where
    T: Ord,
    Actual: AsRef<[T]>,
{
    type Fail = Expectation<Actual>;

    fn matches(&mut self, actual: &Actual) -> crate::Result<bool> {
        Ok(actual.as_ref().windows(2).all(|window| {
            let ordering = (self.predicate)(&window[0], &window[1]);
            ordering == Ordering::Less || ordering == Ordering::Equal
        }))
    }

    fn fail(self, actual: Actual) -> Self::Fail {
        Expectation { actual }
    }
}