smoothy 0.10.0

Write smooth assertions in a fluent and human readable way
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

use crate::{implementation, private, Asserter};
use std::fmt::Debug;

/// Specifies various assertions on [`Option`]. Implemented on [`Asserter`]
///
/// This trait is sealed and cannot be implemented outside Smoothy.
pub trait OptionAssertion<OptionValue>: private::Sealed {
    /// Asserts that the [Option] is [Some].
    ///
    /// Allows the usage of chained assertions on an option-type (see [`SomeAsserter`]).
    ///
    /// # Examples
    /// ```
    /// # use smoothy::prelude::*;
    /// #
    /// let option: Option<String> = Some(String::new());
    ///
    /// assert_that(option).is_some();
    /// ```
    ///
    /// # Panics
    /// When the [Option] is [None]
    #[track_caller]
    #[allow(clippy::wrong_self_convention)]
    fn is_some(self) -> SomeAsserter<OptionValue>
    where
        OptionValue: Debug;

    /// Asserts that the [Option] is [None].
    ///
    /// # Examples
    /// ```
    /// # use smoothy::prelude::*;
    /// #
    /// let option: Option<String> = None;
    ///
    /// assert_that(option).is_none();
    /// ```
    ///
    /// # Panics
    /// When the [Option] is [Some]
    #[track_caller]
    #[allow(clippy::wrong_self_convention)]
    fn is_none(self)
    where
        OptionValue: Debug;
}

impl<OptionValue> OptionAssertion<OptionValue> for Asserter<Option<OptionValue>> {
    fn is_some(self) -> SomeAsserter<OptionValue>
    where
        OptionValue: Debug,
    {
        implementation::assert_no_expected(self.value.is_some(), &self.value, "to be Some");

        #[allow(clippy::unwrap_used)]
        let value = self.value.unwrap();

        SomeAsserter { value }
    }

    fn is_none(self)
    where
        OptionValue: Debug,
    {
        implementation::assert_no_expected(self.value.is_none(), &self.value, "to be None");
    }
}

/// Enables various assertions on [Some]-values
pub struct SomeAsserter<SomeValue> {
    value: SomeValue,
}

impl<SomeValue> SomeAsserter<SomeValue> {
    /// Prepares the [Some] value for further assertions.
    ///
    /// # Examples
    /// ```
    /// # use smoothy::prelude::*;
    /// #
    /// let option: Option<String> = Some(String::from("Hello World!"));
    ///
    /// let asserter = assert_that(option).is_some().and_value();
    /// // further assertions
    /// asserter.equals("Hello World!");
    /// ```
    #[track_caller]
    #[must_use = "Transforming the asserted value does not assert anything"]
    pub fn and_value(self) -> Asserter<SomeValue> {
        Asserter { value: self.value }
    }
}