assertor 0.0.4

Fluent assertion library with readable failure messages.
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

// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

pub use crate::assertions::testing::CheckThatResultAssertion;
pub use crate::{assert_that, check_that, Fact};
use crate::{AssertionResult, AssertionStrategy};

/// *Only for library developers.* An assertion macro to get the result of assertion without
/// throwing panic. Expected to be used for testing assertion library.
///
/// # Example
///
/// ```ignore
/// use assertor::*;
/// use assertor::testing::*;
///
/// assert_that!(check_that!("actual_string").is_same_string_to("expected_string")).facts_are(vec![
///     Fact::new("expected", "expected_string"),
///     Fact::new("actual", "actual_string"),
/// ]);
/// ```
#[macro_export]
macro_rules! check_that {
    ($actual:expr) => {
        $crate::Subject::new(
            &$actual,
            stringify!($actual).to_string(),
            /* description= */ None,
            /* option= */ (),
            Some($crate::Location::new(
                file!().to_string(),
                line!(),
                column!(),
            )),
            std::marker::PhantomData::<$crate::testing::CheckThatResult>,
        )
    };
}

/// Data structure that contains assertion result and messages.
pub struct CheckThatResult(Result<(), AssertionResult>);

impl AssertionStrategy<CheckThatResult> for AssertionResult {
    fn do_fail(self) -> CheckThatResult {
        CheckThatResult(Err(self))
    }

    fn do_ok(self) -> CheckThatResult {
        // XXX: Unnecessary AssertionResult instantiation for ok cases.
        CheckThatResult(Ok(()))
    }
}

impl AsRef<Result<(), AssertionResult>> for CheckThatResult {
    fn as_ref(&self) -> &Result<(), AssertionResult> {
        &self.0
    }
}