murf-macros 0.2.0

Murf's proc macros
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

#![warn(
    clippy::pedantic,
    future_incompatible,
    missing_debug_implementations,
    missing_docs,
    nonstandard_style,
    rust_2018_idioms,
    rust_2021_compatibility,
    unused
)]
#![allow(
    clippy::module_name_repetitions,
    clippy::no_effect_underscore_binding,
    clippy::similar_names
)]
#![doc = include_str!("../README.md")]
#![cfg_attr(feature = "debug-to-file", feature(proc_macro_span))]

use expect_call::CallMode;
use proc_macro::TokenStream;

mod expect_call;
mod misc;
mod mock;

/// Macro to generate a mockable version of a type or trait.
///
/// # Example
///
/// The following example will generate a mocked version of `MyStruct` that
/// implements the `Fuu`  trait.
///
/// ```
/// trait Fuu {
///     fn fuu(&self) -> usize;
/// }
///
/// mock! {
///     #[derive(Default)]
///     pub struct MyStruct;
///
///     impl Fuu for MyStruct {
///         fn fuu(&self) -> usize;
///     }
/// }
///
/// let (handle, mock) = MyStruct::mock_with_handle();
///
/// expect_method_call!(handle as Fuu, fuu()).will_once(Return(1));
///
/// assert_eq!(1, mock.fuu());
/// ```
#[proc_macro]
#[cfg(not(doctest))]
pub fn mock(input: TokenStream) -> TokenStream {
    mock::exec(input.into()).into()
}

/// Helper macro to define an call expectation of a specific function.
///
/// # Example
///
/// ```
/// let (handle, mock) = MyStruct::mock_with_handle();
///
/// expect_call!(handle as Fuu, fuu(_)).will_once(Return(1));
/// ```
#[proc_macro]
#[cfg(not(doctest))]
pub fn expect_call(input: TokenStream) -> TokenStream {
    expect_call::exec(input.into(), CallMode::Static).into()
}

/// Helper macro to define an call expectation of a specific method. Same as
/// [`expect_call!`] but will automatically add a `any` matcher for the `self`
/// argument.
///
/// # Example
///
/// ```
/// let (handle, mock) = MyStruct::mock_with_handle();
///
/// expect_method_call!(handle as Fuu, fuu()).will_once(Return(1));
/// ```
#[proc_macro]
#[cfg(not(doctest))]
pub fn expect_method_call(input: TokenStream) -> TokenStream {
    expect_call::exec(input.into(), CallMode::Method).into()
}