assertables/assert_fn_ok/

assert_fn_ok_eq_x.rs

//! Assert a function Ok(…) is equal to an expression.
//!
//! Pseudocode:<br>
//! (a_function(a_param) ⇒ Ok(a) ⇒ a) = expr
//!
//! # Example
//!
//! ```rust
//! use assertables::*;
//! fn f(i: i8) -> Result<String, String> {
//!     match i {
//!         0..=9 => Ok(format!("{}", i)),
//!         _ => Err(format!("{:?} is out of range", i)),
//!     }
//! }
//!
//! let a: i8 = 1;
//! let b = String::from("1");
//! assert_fn_ok_eq_x!(f, a, b);
//! ```
//!
//! # Module macros
//!
//! * [`assert_fn_ok_eq_x`](macro@crate::assert_fn_ok_eq_x)
//! * [`assert_fn_ok_eq_x_as_result`](macro@crate::assert_fn_ok_eq_x_as_result)
//! * [`debug_assert_fn_ok_eq_x`](macro@crate::debug_assert_fn_ok_eq_x)

/// Assert a function Ok(…) is equal to an expression.
///
/// Pseudocode:<br>
/// (a_function(a_param) ⇒ Ok(a) ⇒ a) = expr
///
/// * If true, return Result `Ok(a)`.
///
/// * Otherwise, return Result `Err(message)`.
///
/// This macro is useful for runtime checks, such as checking parameters,
/// or sanitizing inputs, or handling different results in different ways.
///
/// # Module macros
///
/// * [`assert_fn_ok_eq_x`](macro@crate::assert_fn_ok_eq_x)
/// * [`assert_fn_ok_eq_x_as_result`](macro@crate::assert_fn_ok_eq_x_as_result)
/// * [`debug_assert_fn_ok_eq_x`](macro@crate::debug_assert_fn_ok_eq_x)
///
#[macro_export]
macro_rules! assert_fn_ok_eq_x_as_result {

    //// Arity 1

    ($a_function:path, $a_param:expr, $b_expr:expr $(,)?) => {
        match (&$a_function, &$a_param, &$b_expr) {
            (_a_function, a_param, b_expr) => {
                match ($a_function($a_param)) {
                    Ok(a) => {
                        if a == $b_expr {
                            Ok(a)
                        } else {
                            Err(
                                format!(
                                    concat!(
                                        "assertion failed: `assert_fn_ok_eq_x!(a_function, a_param, b_expr)`\n",
                                        "https://docs.rs/assertables/9.8.3/assertables/macro.assert_fn_ok_eq_x.html\n",
                                        " a_function label: `{}`,\n",
                                        "    a_param label: `{}`,\n",
                                        "    a_param debug: `{:?}`,\n",
                                        "     b_expr label: `{}`,\n",
                                        "     b_expr debug: `{:?}`,\n",
                                        "                a: `{:?}`,\n",
                                        "                b: `{:?}`",
                                    ),
                                    stringify!($a_function),
                                    stringify!($a_param),
                                    a_param,
                                    stringify!($b_expr),
                                    b_expr,
                                    a,
                                    $b_expr
                                )
                            )
                        }
                    },
                    Err(a) => {
                        Err(
                            format!(
                                concat!(
                                    "assertion failed: `assert_fn_ok_eq_x!(a_function, a_param, b_expr)`\n",
                                    "https://docs.rs/assertables/9.8.3/assertables/macro.assert_fn_ok_eq_x.html\n",
                                    " a_function label: `{}`,\n",
                                    "    a_param label: `{}`,\n",
                                    "    a_param debug: `{:?}`,\n",
                                    "     b_expr label: `{}`,\n",
                                    "     b_expr debug: `{:?}`,\n",
                                    "                a: `{:?}`",
                                ),
                                stringify!($a_function),
                                stringify!($a_param),
                                a_param,
                                stringify!($b_expr),
                                b_expr,
                                a
                            )
                        )
                    }
                }
            }
        }
    };

    //// Arity 0

    ($a_function:path, $b_expr:expr $(,)?) => {
        match (&$a_function, &$b_expr) {
            (_a_function, b_expr) => {
                match ($a_function()) {
                    Ok(a) => {
                        if a == $b_expr {
                            Ok(a)
                        } else {
                            Err(
                                format!(
                                    concat!(
                                        "assertion failed: `assert_fn_ok_eq_x!(a_function, b_expr)`\n",
                                        "https://docs.rs/assertables/9.8.3/assertables/macro.assert_fn_ok_eq_x.html\n",
                                        " a_function label: `{}`,\n",
                                        "     b_expr label: `{}`,\n",
                                        "     b_expr debug: `{:?}`,\n",
                                        "                a: `{:?}`,\n",
                                        "                b: `{:?}`",
                                    ),
                                    stringify!($a_function),
                                    stringify!($b_expr),
                                    b_expr,
                                    a,
                                    $b_expr
                                )
                            )
                        }
                    },
                    a => {
                        Err(
                            format!(
                                concat!(
                                    "assertion failed: `assert_fn_ok_eq_x!(a_function, b_expr)`\n",
                                    "https://docs.rs/assertables/9.8.3/assertables/macro.assert_fn_ok_eq_x.html\n",
                                    " a_function label: `{}`,\n",
                                    "     b_expr label: `{}`,\n",
                                    "     b_expr debug: `{:?}`,\n",
                                    "                a: `{:?}`",
                                ),
                                stringify!($a_function),
                                stringify!($b_expr),
                                b_expr,
                                a
                            )
                        )
                    }
                }
            }
        }
    };

}

#[cfg(test)]
mod test_assert_fn_ok_eq_x_as_result {
    // use std::sync::Once;

    mod arity_1 {

        fn f(i: i8) -> Result<i8, i8> {
            return Ok(i);
        }

        #[test]
        fn eq() {
            let a: i8 = 1;
            let b: i8 = 1;
            for _ in 0..1 {
                let actual = assert_fn_ok_eq_x_as_result!(f, a, b);
                assert_eq!(actual.unwrap(), 1);
            }
        }

        #[test]
        fn ne() {
            let a: i8 = 1;
            let b: i8 = 2;
            let actual = assert_fn_ok_eq_x_as_result!(f, a, b);
            let message = concat!(
                "assertion failed: `assert_fn_ok_eq_x!(a_function, a_param, b_expr)`\n",
                "https://docs.rs/assertables/9.8.3/assertables/macro.assert_fn_ok_eq_x.html\n",
                " a_function label: `f`,\n",
                "    a_param label: `a`,\n",
                "    a_param debug: `1`,\n",
                "     b_expr label: `b`,\n",
                "     b_expr debug: `2`,\n",
                "                a: `1`,\n",
                "                b: `2`"
            );
            assert_eq!(actual.unwrap_err(), message);
        }
    }

    mod arity_0 {

        fn f() -> Result<i8, i8> {
            return Ok(1);
        }

        #[test]
        fn eq() {
            let b: i8 = 1;
            for _ in 0..1 {
                let actual = assert_fn_ok_eq_x_as_result!(f, b);
                assert_eq!(actual.unwrap(), 1);
            }
        }

        #[test]
        fn ne() {
            let b: i8 = 2;
            let actual = assert_fn_ok_eq_x_as_result!(f, b);
            let message = concat!(
                "assertion failed: `assert_fn_ok_eq_x!(a_function, b_expr)`\n",
                "https://docs.rs/assertables/9.8.3/assertables/macro.assert_fn_ok_eq_x.html\n",
                " a_function label: `f`,\n",
                "     b_expr label: `b`,\n",
                "     b_expr debug: `2`,\n",
                "                a: `1`,\n",
                "                b: `2`"
            );
            assert_eq!(actual.unwrap_err(), message);
        }
    }
}

/// Assert a function Ok(…) is equal to an expression.
///
/// Pseudocode:<br>
/// (a_function(a_param) ⇒ Ok(a) ⇒ a) = expr
///
/// * If true, return `a`.
///
/// * Otherwise, call [`panic!`] with a message and the values of the
///   expressions with their debug representations.
///
/// # Examples
///
/// ```rust
/// use assertables::*;
/// # use std::panic;
/// fn f(i: i8) -> Result<String, String> {
///     match i {
///         0..=9 => Ok(format!("{}", i)),
///         _ => Err(format!("{:?} is out of range", i)),
///     }
/// }
///
/// # fn main() {
/// let a: i8 = 1;
/// let b = String::from("1");
/// assert_fn_ok_eq_x!(f, a, b);
///
/// # let result = panic::catch_unwind(|| {
/// // This will panic
/// let a: i8 = 1;
/// let b = String::from("2");
/// assert_fn_ok_eq_x!(f, a, b);
/// # });
/// // assertion failed: `assert_fn_ok_eq_x!(a_function, a_param, b_expr)`
/// // https://docs.rs/assertables/…/assertables/macro.assert_fn_ok_eq_x.html
/// //  a_function label: `f`,
/// //     a_param label: `a`,
/// //     a_param debug: `1`,
/// //      b_expr label: `b`,
/// //      b_expr debug: `\"2\"`,
/// //                 a: `\"1\"`,
/// //                 b: `\"2\"`
/// # let actual = result.unwrap_err().downcast::<String>().unwrap().to_string();
/// # let message = concat!(
/// #     "assertion failed: `assert_fn_ok_eq_x!(a_function, a_param, b_expr)`\n",
/// #     "https://docs.rs/assertables/9.8.3/assertables/macro.assert_fn_ok_eq_x.html\n",
/// #     " a_function label: `f`,\n",
/// #     "    a_param label: `a`,\n",
/// #     "    a_param debug: `1`,\n",
/// #     "     b_expr label: `b`,\n",
/// #     "     b_expr debug: `\"2\"`,\n",
/// #     "                a: `\"1\"`,\n",
/// #     "                b: `\"2\"`"
/// # );
/// # assert_eq!(actual, message);
/// # }
/// ```
///
/// # Module macros
///
/// * [`assert_fn_ok_eq_x`](macro@crate::assert_fn_ok_eq_x)
/// * [`assert_fn_ok_eq_x_as_result`](macro@crate::assert_fn_ok_eq_x_as_result)
/// * [`debug_assert_fn_ok_eq_x`](macro@crate::debug_assert_fn_ok_eq_x)
///
#[macro_export]
macro_rules! assert_fn_ok_eq_x {

    //// Arity 1

    ($a_function:path, $a_param:expr, $b_expr:expr $(,)?) => {
        match $crate::assert_fn_ok_eq_x_as_result!($a_function, $a_param, $b_expr) {
            Ok(x) => x,
            Err(err) => panic!("{}", err),
        }
    };

    ($a_function:path, $a_param:expr, $b_expr:expr, $($message:tt)+) => {
        match $crate::assert_fn_ok_eq_x_as_result!($a_function, $a_param, $b_expr) {
            Ok(x) => x,
            Err(err) => panic!("{}\n{}", format_args!($($message)+), err),
        }
    };

    //// Arity 0

    ($a_function:path, $b_expr:expr $(,)?) => {
        match $crate::assert_fn_ok_eq_x_as_result!($a_function, $b_expr) {
            Ok(x) => x,
            Err(err) => panic!("{}", err),
        }
    };

    ($a_function:path, $b_expr:expr, $($message:tt)+) => {
        match $crate::assert_fn_ok_eq_x_as_result!($a_function, $b_expr) {
            Ok(x) => x,
            Err(err) => panic!("{}\n{}", format_args!($($message)+), err),
        }
    };
}

#[cfg(test)]
mod test_assert_fn_ok_eq_x {
    use std::panic;

    mod arity_1 {
        use super::*;

        fn f(i: i8) -> Result<i8, i8> {
            return Ok(i);
        }

        #[test]
        fn eq() {
            let a: i8 = 1;
            let b: i8 = 1;
            for _ in 0..1 {
                let actual = assert_fn_ok_eq_x!(f, a, b);
                assert_eq!(actual, 1);
            }
        }

        #[test]
        fn ne() {
            let result = panic::catch_unwind(|| {
                let a: i8 = 1;
                let b: i8 = 2;
                let _actual = assert_fn_ok_eq_x!(f, a, b);
            });
            let message = concat!(
                "assertion failed: `assert_fn_ok_eq_x!(a_function, a_param, b_expr)`\n",
                "https://docs.rs/assertables/9.8.3/assertables/macro.assert_fn_ok_eq_x.html\n",
                " a_function label: `f`,\n",
                "    a_param label: `a`,\n",
                "    a_param debug: `1`,\n",
                "     b_expr label: `b`,\n",
                "     b_expr debug: `2`,\n",
                "                a: `1`,\n",
                "                b: `2`"
            );
            assert_eq!(
                result
                    .unwrap_err()
                    .downcast::<String>()
                    .unwrap()
                    .to_string(),
                message
            );
        }
    }

    mod arity_0 {
        use super::*;

        fn f() -> Result<i8, i8> {
            return Ok(1);
        }

        #[test]
        fn eq() {
            let b: i8 = 1;
            for _ in 0..1 {
                let actual = assert_fn_ok_eq_x!(f, b);
                assert_eq!(actual, 1);
            }
        }

        #[test]
        fn ne() {
            let result = panic::catch_unwind(|| {
                let b: i8 = 2;
                let _actual = assert_fn_ok_eq_x!(f, b);
            });
            let message = concat!(
                "assertion failed: `assert_fn_ok_eq_x!(a_function, b_expr)`\n",
                "https://docs.rs/assertables/9.8.3/assertables/macro.assert_fn_ok_eq_x.html\n",
                " a_function label: `f`,\n",
                "     b_expr label: `b`,\n",
                "     b_expr debug: `2`,\n",
                "                a: `1`,\n",
                "                b: `2`"
            );
            assert_eq!(
                result
                    .unwrap_err()
                    .downcast::<String>()
                    .unwrap()
                    .to_string(),
                message
            );
        }
    }
}

/// Assert a function Ok(…) is equal to an expression.
///
/// Pseudocode:<br>
/// (a_function(a_param) ⇒ Ok(a) ⇒ a) = expr
///
/// This macro provides the same statements as [`assert_fn_ok_eq_x`](macro.assert_fn_ok_eq_x.html),
/// except this macro's statements are only enabled in non-optimized
/// builds by default. An optimized build will not execute this macro's
/// statements unless `-C debug-assertions` is passed to the compiler.
///
/// This macro is useful for checks that are too expensive to be present
/// in a release build but may be helpful during development.
///
/// The result of expanding this macro is always type checked.
///
/// An unchecked assertion allows a program in an inconsistent state to
/// keep running, which might have unexpected consequences but does not
/// introduce unsafety as long as this only happens in safe code. The
/// performance cost of assertions, however, is not measurable in general.
/// Replacing `assert*!` with `debug_assert*!` is thus only encouraged
/// after thorough profiling, and more importantly, only in safe code!
///
/// This macro is intended to work in a similar way to
/// [`::std::debug_assert`](https://doc.rust-lang.org/std/macro.debug_assert.html).
///
/// # Module macros
///
/// * [`assert_fn_ok_eq_x`](macro@crate::assert_fn_ok_eq_x)
/// * [`assert_fn_ok_eq_x`](macro@crate::assert_fn_ok_eq_x)
/// * [`debug_assert_fn_ok_eq_x`](macro@crate::debug_assert_fn_ok_eq_x)
///
#[macro_export]
macro_rules! debug_assert_fn_ok_eq_x {
    ($($arg:tt)*) => {
        if $crate::cfg!(debug_assertions) {
            $crate::assert_fn_ok_eq_x!($($arg)*);
        }
    };
}