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

//! Procedural macros for [`mimicry`].
//!
//! See [`mimicry`] docs for examples of usage.
//!
//! [`mimicry`]: https://docs.rs/mimicry/

#![recursion_limit = "128"]
// Documentation settings.
#![doc(html_root_url = "https://docs.rs/mimicry-derive/0.1.0")]
// Linter settings.
#![warn(missing_debug_implementations, missing_docs, bare_trait_objects)]
#![warn(clippy::all, clippy::pedantic)]
#![allow(clippy::must_use_candidate, clippy::module_name_repetitions)]

extern crate proc_macro;

mod call_real_impl;
mod function;
mod mock_impl;
mod utils;

use proc_macro::TokenStream;

/// Derives the `Mock` trait for a type, allowing to use it as a state for mocking.
///
/// # Container attributes
///
/// Container attributes are placed in a `#[mock(...)]` attribute on a struct / enum.
///
/// ## `shared`
///
/// Signals to use the [`Shared`] wrapper for the mock state; by default,
/// the [`ThreadLocal`] wrapper is used. Can be specified as `#[mock(shared)]` or
/// `#[mock(shared = true)]`.
///
/// ## `mut`
///
/// Signals to use the [`Mut`] wrapper for the mock state. With this flag set, mock methods
/// will receive `&Mut<Self>` as the first arg instead of `&self`.
///
/// # Examples
///
/// See [`ThreadLocal`] and [`Shared`] docs for examples of usage.
///
/// [`Shared`]: https://docs.rs/mimicry/latest/mimicry/struct.Shared.html
/// [`ThreadLocal`]: https://docs.rs/mimicry/latest/mimicry/struct.ThreadLocal.html
/// [`Mut`]: https://docs.rs/mimicry/latest/mimicry/struct.Mut.html
#[proc_macro_derive(Mock, attributes(mock))]
pub fn mock_derive(input: TokenStream) -> TokenStream {
    mock_impl::impl_mock(input)
}

/// Derives the `CallReal` trait for a struct allowing to switch to real implementations
/// for partial mocking or spying.
///
/// # Field attributes
///
/// Field attributes are placed in a `#[mock(...)]` attribute on a struct / enum.
///
/// ## `switch`
///
/// Indicates that a field is a [`RealCallSwitch`]. This is usually detected automatically
/// by the field type, so an explicit declaration is reserved for extraordinary cases.
/// Specified as `#[mock(switch)]`.
///
/// [`RealCallSwitch`]: https://docs.rs/mimicry/latest/mimicry/struct.RealCallSwitch.html
#[proc_macro_derive(CallReal, attributes(mock))]
pub fn call_real_derive(input: TokenStream) -> TokenStream {
    call_real_impl::impl_call_real(input)
}

/// Injects mocking logic into a function / method.
///
/// You may want to use this attribute conditionally, e.g.,
/// behind a `#[cfg_attr(test, _)]` wrapper.
///
/// # Attributes
///
/// Attributes are specified according to standard Rust conventions:
/// `#[mock(attr1 = "value1", ...)]`.
///
/// ## `using`
///
/// Specifies a [path] string to the mock state. The path can point to the type of the mock state
/// (e.g., `"mocks::State"`); in this case, the mock impl is an inherent function of the state
/// with the same name as the mocked function / method. Alternatively, a path can specify
/// the function name as well (e.g., `"mocks::State::mock_something"`); this is useful in case
/// of name collision. The choice of these 2 options is auto-detected based on the last segment
/// in the path: if it starts with an uppercase letter, it is considered a mock state type;
/// otherwise, it is considered a type + function.
///
/// ## `rename`
///
/// Specifies a pattern to use when accessing mock impl methods. A pattern is a string with `{}`
/// denoting a placeholder for the mocked function name. For example, `mock_{}` pattern will
/// rename `len` to `mock_len`.
///
/// This attribute is mostly useful for impl blocks.
///
/// # Supported items
///
/// The `mock` attribute can be used on functions / methods. Pretty much all signatures
/// are supported, e.g., generic functions, non-`'static` args, return types
/// with dependent / elided lifetime, etc. `const` functions are not supported.
///
/// The `mock` attribute can also be placed on an impl block (including a trait implementation).
/// In this case, it will apply to all methods in the block. If necessary, mocking options can
/// be overridden for separate methods in the block by adding a `mock` attribute on them.
///
/// # Examples
///
/// See [`mimicry`] docs for examples of usage.
///
/// [path]: https://docs.rs/syn/latest/syn/struct.Path.html
/// [`mimicry`]: https://docs.rs/mimicry/
#[proc_macro_attribute]
pub fn mock(attr: TokenStream, item: TokenStream) -> TokenStream {
    function::wrap(attr, item)
}