todo_using 0.2.2

A super small crate only exporting a single macro to "use" parameters.
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

#![doc = include_str!("../README.md")]

#[doc(hidden)]
#[macro_export]
macro_rules! use_args {
    ($($using_ident: ident), *) => {
        {
            $(
                let __suppress_unused_warning = $using_ident;
            )*
        };
    };
}

/// A wrapper around [`core::todo!`]
/// that allows "using" variables to suppress 
/// `unused` warnings while mocking functions with [todo].
/// 
/// # Examples
/// 
/// Both kinds of arguments seperated:
/// ```should_panic
/// # use todo_using::*;
/// # let arg1 = 5;
/// # let arg2 = "some String";
/// # let format_arg = "IDK what to put here";
/// todo_using!(
///   using = [arg1, arg2],
///   unimplemented("Unimplemented Code {}", format_arg)
/// );
/// ```
/// Just special casing for formatting arguments to [core::todo]:
/// ```should_panic
/// # use todo_using::*;
/// # let arg1 = 5;
/// # let arg2 = "some String";
/// # let format_arg = "IDK what to put here";
/// todo_using!(
///   [arg1, arg2],
///   unimplemented("Unimplemented Code {}", format_arg)
/// );
/// ```
/// Just marking the using arguments:
/// ```should_panic
/// # use todo_using::*;
/// # let arg1 = 5;
/// # let arg2 = "some String";
/// # let format_arg = "IDK what to put here";
/// todo_using!(
///   using = [arg1, arg2],
///   "Unimplemented Code {}", format_arg
/// );
/// ```
/// No special casing for unused variables nor todo arguments:
/// ```should_panic
/// # use todo_using::*;
/// # let arg1 = 5;
/// # let arg2 = "some String";
/// # let format_arg = "IDK what to put here";
/// todo_using!(
///   [arg1, arg2],
///   "Unimplemented Code {}", format_arg
/// );
/// ```
/// Just passing unused variables:
/// ```should_panic
/// # use todo_using::*;
/// # let arg1 = 5;
/// # let arg2 = "some String";
/// # let format_arg = "IDK what to put here";
/// todo_using![arg1, arg2];
/// ```
/// Keeping syntax for unused variables:
/// ```should_panic
/// # use todo_using::*;
/// # let arg1 = 5;
/// # let arg2 = "some String";
/// # let format_arg = "IDK what to put here";
/// todo_using![[arg1, arg2]];
/// ```
#[macro_export]
macro_rules! todo_using {
    ($(using=)?[$($using_ident: ident),* $(,)?], unimplemented($($message_arg:tt)+)) => {
        $crate::use_args!($($using_ident), *);
        core::todo!($($message_arg)+);
    };
    ($(using=)?[$($using_ident: ident),* $(,)?], $($message_arg:tt)*) => {
        $crate::use_args!($($using_ident), *);
        core::todo!($($message_arg)*);
    };
    ($(using=)?[$($using_ident: ident),* $(,)?]) => {
        $crate::use_args!($($using_ident), *);
        core::todo!();
    };
    ($($using_ident: ident),* $(,)?) => {
        $crate::use_args!($($using_ident), *);
        core::todo!();
    };
}

#[cfg(test)]
mod tests {
    use std::{panic::UnwindSafe, fmt::Debug};

    use super::*;

    fn capture_panic_message<R: Debug>(panicking_closure: impl FnOnce() -> R + UnwindSafe) -> String {
        *std::panic::catch_unwind(panicking_closure).unwrap_err().downcast::<String>().unwrap()
    }

    #[test]
    fn panics_match() {
        #[allow(unused_variables)]
        let arg1 = 5;
        let arg2 = "some String";
        let format_arg = "IDK what to put here";
        assert_eq!(
            capture_panic_message(||{todo_using!(using = [arg1, arg2], unimplemented("Unimplemented Code {}", format_arg));}),
            capture_panic_message(||{todo_using!([arg1, arg2], "Unimplemented Code {}", format_arg);}),
        );
    }
}