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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222

/// Macro to define different actual variables for `debug` and `release`
///
/// This is useful when testing logic with differing actual variable definitions based on build.
///
/// Basically erogonomifies the following ...
///
/// ```rust
/// # use cfg_if::cfg_if;
/// cfg_if! {
///    if #[cfg(not(debug_assertions))] {
///        let expected = Default::default();
///    } else {
///        let expected = 42;
///    }
/// }
/// cfg_if! {
///    if #[cfg(not(debug_assertions))] {
///        let actual: usize = Default::default();
///    } else {
///        let actual: usize;
///    }
/// }
///
/// #[cfg(debug_assertions)]
/// { actual = sut(); }
///
/// assert_eq!(expected, actual);
/// # #[cfg(debug_assertions)]
/// # fn sut() -> usize { 42 }
/// ```
/// with ..
/// ```rust
/// # use test_toolbox::actual;
/// # use test_toolbox::expect;
/// expect! { expected = Default::default(), 42 }
/// actual! { @dbg actual: usize }
///
/// #[cfg(debug_assertions)]
/// { actual = sut(); }
///
/// assert_eq!(expected, actual);
/// # #[cfg(debug_assertions)]
/// # fn sut() -> usize { 42 }
/// ```
///
/// # Features
///
/// *
/// *
///
/// # Examples
///
/// * debug; uninitialized actual variable
///   release; actual variable initialized to default
///
/// ```rust
/// # use test_toolbox::actual;
/// # use test_toolbox::expect;
/// expect! { expected: usize = Default::default(), 42 }
/// actual! { @dbg actual: usize }
///
/// #[cfg(debug_assertions)]
/// { actual = sut(); }
///
/// assert_eq!(expected, actual);
/// # #[cfg(debug_assertions)]
/// # fn sut() -> usize { 42 }
/// ```
///
/// * release; uninitialized actual variable
///   debug; actual variable initialized to default
///
/// ```rust
/// # use test_toolbox::actual;
/// # use test_toolbox::expect;
/// expect! { expected: usize = 42, Default::default() }
/// actual! { @rls actual: usize }
///
/// #[cfg(not(debug_assertions))]
/// { actual = sut(); }
///
/// assert_eq!(expected, actual);
/// # #[cfg(not(debug_assertions))]
/// # fn sut() -> usize { 42 }
/// ```
///
///  * debug; uninitialized actual variable
///    release; actual variable initialized to a value
///
/// ```rust
/// # use test_toolbox::actual;
/// # use test_toolbox::expect;
/// expect! { expected: usize = 2, 42 }
/// actual! { @dbg actual: usize; 2 }
///
/// #[cfg(debug_assertions)]
/// { actual = sut(); }
///
/// assert_eq!(expected, actual);
/// # #[cfg(debug_assertions)]
/// # fn sut() -> usize { 42 }
/// ```
///
/// * release; uninitialized actual variable
///   debug; actual variable initialized to a value
///
/// ```rust
/// # use test_toolbox::actual;
/// # use test_toolbox::expect;
/// expect! { expected: usize = 42, 2 }
/// actual! { @rls actual: usize; 2 }
///
/// #[cfg(not(debug_assertions))]
/// { actual = sut(); }
///
/// assert_eq!(expected, actual);
/// # #[cfg(not(debug_assertions))]
/// # fn sut() -> usize { 42 }
/// ```
///
/// * debug; mutable actual variable initialized to a value
///   release; immutable actual variable initialized to a value
///
/// ```rust
/// # use test_toolbox::actual;
/// # use test_toolbox::expect;
/// expect! { expected = "", "Forty Two" }
/// actual! { @dbg mut actual: String; String::new() }
///
/// #[cfg(debug_assertions)]
/// { actual.push_str(&sut()); }
///
/// assert_eq!(expected, &actual);
/// # #[cfg(debug_assertions)]
/// # fn sut() -> String { String::from("Forty Two") }
/// ```
///
/// * release; mutable actual variable initialized to a value
///   debug; immutable actual variable initialized to a value
///
/// ```rust
/// # use test_toolbox::actual;
/// # use test_toolbox::expect;
/// expect! { expected = "Forty Two", "" }
/// actual! { @rls mut actual: String; String::new() }
///
/// #[cfg(not(debug_assertions))]
/// { actual.push_str(&sut()); }
///
/// assert_eq!(expected, &actual);
/// # #[cfg(not(debug_assertions))]
/// # fn sut() -> String { String::from("Forty Two") }
/// ```
#[macro_export]
macro_rules! actual {
    // debug; uninitialized actual variable
    // release; actual variable initialized to default
    (@dbg $var:ident: $typ:ty) => {
        cfg_if::cfg_if! {
            if #[cfg(not(debug_assertions))] {
                let $var: $typ = Default::default();
            } else {
                let $var: $typ;
            }
        }
    };
    // release; uninitialized actual variable
    // debug; actual variable initialized to default
    (@rls $var:ident: $typ:ty) => {
        cfg_if::cfg_if! {
            if #[cfg(not(debug_assertions))] {
                let $var: $typ;
            } else {
                let $var: $typ = Default::default();
            }
        }
    };
    // debug; uninitialized actual variable
    // release; actual variable initialized to a value
    (@dbg $var:ident: $typ:ty; $val:expr) => {
        cfg_if::cfg_if! {
            if #[cfg(not(debug_assertions))] {
                let $var: $typ = $val;
            } else {
                let $var: $typ;
            }
        }
    };
    // release; uninitialized actual variable
    // debug; actual variable initialized to a value
    (@rls $var:ident: $typ:ty; $val:expr) => {
        cfg_if::cfg_if! {
            if #[cfg(not(debug_assertions))] {
                let $var: $typ;
            } else {
                let $var: $typ = $val;
            }
        }
    };
    // debug; mutable actual variable initialized to a value
    // release; immutable actual variable initialized to a value
    (@dbg mut $var:ident: $typ:ty; $exp:expr) => {
        cfg_if::cfg_if! {
            if #[cfg(not(debug_assertions))] {
                let $var = $exp;
            } else {
                let mut $var = $exp;
            }
        }
    };
    // release; mutable actual variable initialized to a value
    // debug; immutable actual variable initialized to a value
    (@rls mut $var:ident: $typ:ty; $exp:expr) => {
        cfg_if::cfg_if! {
            if #[cfg(not(debug_assertions))] {
                let mut $var = $exp;
            } else {
                let $var = $exp;
            }
        }
    };
}