yarnspinner_internal_shared 0.1.0

Shared internals for Yarn Spinner for Rust, the friendly tool for writing game dialogue
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

use core::fmt::{Arguments, Debug};

#[macro_export]
macro_rules! bug {
    ($message:literal) => {
        $crate::bug!($message,)
    };

    ($message:literal, $($arg:tt)*) => {
        panic!("{}\n{}", format_args!($message, $($arg)*), $crate::bug::BUG_MESSAGE)
    };
}

#[macro_export]
macro_rules! assert_or_bug {
    ($cond:expr $(,)?) => {
        $crate::assert_or_bug!($cond, "Assertion failed: {}", stringify!($cond))
    };

    ($cond:expr, $($arg:tt)+) => {
        if !($cond) {
            $crate::bug!($($arg)*)
        }
    };
}

/// Contains unwrapping methods that include a link to open a github issue in the panic message
pub trait UnwrapExt: Sized {
    type Output;

    #[doc(hidden)]
    #[track_caller]
    fn unwrap_impl(self, arguments: Arguments) -> Self::Output;

    #[track_caller]
    #[inline]
    fn unwrap_or_bug(self) -> Self::Output {
        self.expect_or_bug("Tried to unwrap a missing or invalid value.")
    }

    #[track_caller]
    #[inline]
    fn expect_or_bug(self, message: &str) -> Self::Output {
        self.unwrap_impl(format_args!("{message}\n{BUG_MESSAGE}"))
    }

    #[track_caller]
    #[inline]
    fn expect_or_bug_with(self, arguments: Arguments) -> Self::Output {
        self.unwrap_impl(format_args!("{arguments}\n{BUG_MESSAGE}"))
    }
}

impl<T> UnwrapExt for Option<T> {
    type Output = T;

    #[inline]
    fn unwrap_impl(self, arguments: Arguments) -> Self::Output {
        self.unwrap_or_else(|| bug!("{arguments}"))
    }
}

impl<T, E: Debug> UnwrapExt for Result<T, E> {
    type Output = T;

    #[inline]
    fn unwrap_impl(self, arguments: Arguments) -> Self::Output {
        self.unwrap_or_else(|err| bug!("{arguments}\n  Caused by: {err:?}"))
    }
}

pub const BUG_MESSAGE: &str = "This is a bug. Please report it at https://github.com/YarnSpinnerTool/YarnSpinner-Rust/issues/new";

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

    use super::*;

    #[test]
    #[should_panic]
    fn bug_macro_panics() {
        bug!("")
    }

    #[test]
    fn bug_macro_with_str_message() {
        let message = *panic::catch_unwind(|| bug!("This is a str message."))
            .unwrap_err()
            .downcast::<String>()
            .unwrap();

        assert_eq!(message, format!("This is a str message.\n{BUG_MESSAGE}"));
    }

    #[test]
    fn bug_macro_with_formatted_message() {
        let message = *panic::catch_unwind(|| bug!("Hello {}", "world."))
            .unwrap_err()
            .downcast::<String>()
            .unwrap();

        assert_eq!(message, format!("Hello world.\n{BUG_MESSAGE}"));
    }
}