assertr 0.5.6

Fluent assertions for the Rust programming language.
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192

use crate::AssertThat;
use crate::mode::Mode;
use crate::tracking::AssertionTracking;
use indoc::writedoc;
use jiff::Span;
use std::fmt::Write;

#[allow(clippy::return_self_not_must_use)]
#[cfg_attr(feature = "fluent", assertr_derive::fluent_aliases)]
pub trait SpanAssertions {
    fn is_zero(self) -> Self;

    fn is_negative(self) -> Self;

    /// Unlike the `is_positive` assertions on numerics, this fails for a span of 0!
    fn is_positive(self) -> Self;
}

impl<M: Mode> SpanAssertions for AssertThat<'_, Span, M> {
    #[track_caller]
    fn is_zero(self) -> Self {
        self.track_assertion();

        if !self.actual().is_zero() {
            self.add_detail_message("Actual was not zero.");

            let expected = Span::new();
            self.fail(|w: &mut String| {
                writedoc! {w, r"
                    Expected: {expected:#?}

                      Actual: {actual:#?}
                ", actual = self.actual()}
            });
        }

        self
    }

    #[track_caller]
    fn is_negative(self) -> Self {
        self.track_assertion();

        if !self.actual().is_negative() {
            self.fail(|w: &mut String| {
                writedoc! {w, r"
                    Expected value to be negative. But was

                      Actual: {actual:#?}
                ", actual = self.actual()}
            });
        }

        self
    }

    #[track_caller]
    fn is_positive(self) -> Self {
        self.track_assertion();

        if !self.actual().is_positive() {
            self.fail(|w: &mut String| {
                writedoc! {w, r"
                    Expected value to be positive. But was

                      Actual: {actual} ({actual:#?})
                ", actual = self.actual()}
            });
        }

        self
    }
}

#[cfg(test)]
mod tests {
    mod is_zero {
        use crate::prelude::*;
        use indoc::formatdoc;
        use jiff::{Span, ToSpan};

        #[test]
        fn succeeds_when_zero() {
            assert_that!(Span::new()).is_zero();
        }

        #[test]
        fn panics_when_not_zero() {
            let duration: Span = 2.hours().minutes(30);

            assert_that_panic_by(|| assert_that!(duration).with_location(false).is_zero())
                .has_type::<String>()
                .is_equal_to(formatdoc! {r#"
                    -------- assertr --------
                    Expected: 0s

                      Actual: 2h 30m

                    Details: [
                        Actual was not zero.,
                    ]
                    -------- assertr --------
                "#});
        }
    }

    mod is_negative {
        use crate::prelude::*;
        use indoc::formatdoc;
        use jiff::ToSpan;

        #[test]
        fn succeeds_when_zero() {
            assert_that!((-2).hours().minutes(30)).is_negative();
        }

        #[test]
        fn panics_when_zero() {
            assert_that_panic_by(|| {
                assert_that!(0.seconds()).with_location(false).is_negative();
            })
            .has_type::<String>()
            .is_equal_to(formatdoc! {r#"
                    -------- assertr --------
                    Expected value to be negative. But was

                      Actual: 0s
                    -------- assertr --------
                "#});
        }

        #[test]
        fn panics_when_positive() {
            assert_that_panic_by(|| {
                assert_that!(2.hours().minutes(30))
                    .with_location(false)
                    .is_negative();
            })
            .has_type::<String>()
            .is_equal_to(formatdoc! {r#"
                    -------- assertr --------
                    Expected value to be negative. But was

                      Actual: 2h 30m
                    -------- assertr --------
                "#});
        }
    }

    mod is_positive {
        use crate::prelude::*;
        use indoc::formatdoc;
        use jiff::ToSpan;

        #[test]
        fn succeeds_when_positive() {
            assert_that!(2.hours().minutes(30)).is_positive();
        }

        #[test]
        fn panics_when_zero() {
            assert_that_panic_by(|| {
                assert_that!(0.seconds()).with_location(false).is_positive();
            })
            .has_type::<String>()
            .is_equal_to(formatdoc! {r#"
                    -------- assertr --------
                    Expected value to be positive. But was

                      Actual: PT0S (0s)
                    -------- assertr --------
                "#});
        }

        #[test]
        fn panics_when_negative() {
            assert_that_panic_by(|| {
                assert_that!((-2).hours().minutes(30))
                    .with_location(false)
                    .is_positive();
            })
            .has_type::<String>()
            .is_equal_to(formatdoc! {r#"
                    -------- assertr --------
                    Expected value to be positive. But was

                      Actual: -PT2H30M (2h 30m ago)
                    -------- assertr --------
                "#});
        }
    }
}