gene_derive 0.7.2

Crate providing providing derive macros for gene-rs
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
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
use proc_macro::TokenStream;
use proc_macro2::Span;
use quote::{quote, quote_spanned};
use std::collections::HashMap;
use syn::{
    parse_macro_input, parse_quote, punctuated::Punctuated, spanned::Spanned, Attribute,
    DataStruct, DeriveInput, Expr, GenericParam, Generics, Lifetime, LifetimeParam, Meta,
    MetaNameValue, Token, TypeParam, WhereClause,
};

/// helper macro to get the expected syn::Lit enum variant from a syn::Expr
/// # Example
///
/// ```rust,ignore
/// let arg: syn::Expr = ... ;
/// expect_lit_variant!(arg, syn::Lit::Str)
/// ```
macro_rules! expect_lit_variant {
    ($expr: expr, $lit_variant:path) => {
        match $expr {
            syn::Expr::Lit(lit_expr) => match lit_expr.lit {
                $lit_variant(v) => Some(v),
                _ => None,
            },
            _ => None,
        }
    };
}

struct MetaParser {
    attr: syn::Attribute,
    metas: HashMap<String, Meta>,
}

impl MetaParser {
    fn parse_meta(attr: &Attribute) -> Result<Self, syn::Error> {
        let mut out = HashMap::new();

        let nested = attr
            .parse_args_with(Punctuated::<Meta, Token![,]>::parse_terminated)
            .map_err(|_| syn::Error::new_spanned(attr, "failed to parse attribute meta"))?;

        for meta in nested {
            out.insert(
                meta.path()
                    .get_ident()
                    .ok_or(syn::Error::new_spanned(
                        meta.clone(),
                        "failed to process meta",
                    ))?
                    .to_string(),
                meta,
            );
        }
        Ok(Self {
            attr: attr.clone(),
            metas: out,
        })
    }

    fn contains_key(&self, key: &str) -> bool {
        self.metas.contains_key(key)
    }

    fn get_key_value(&self, key: &str) -> Result<Option<&MetaNameValue>, syn::Error> {
        if let Some(meta) = self.metas.get(key) {
            match meta {
                Meta::NameValue(m) => return Ok(Some(m)),
                _ => {
                    return Err(syn::Error::new_spanned(
                        &self.attr,
                        format!("expecting a key value attribute: {key}"),
                    ))
                }
            }
        }
        Ok(None)
    }
}

struct EventDerive {
    input: DeriveInput,
    id: Option<Expr>,
    source: Option<Expr>,
}

impl EventDerive {
    fn event_lifetime() -> LifetimeParam {
        LifetimeParam::new(Lifetime::new("'event", Span::call_site()))
    }

    fn parse_event_derive(input: DeriveInput) -> Result<Self, syn::Error> {
        let attrs = &input.attrs;

        let event_attr =
            attrs
                .iter()
                .find(|a| a.path().is_ident("event"))
                .ok_or(syn::Error::new_spanned(
                    &input,
                    "attribute #[event(id = Expr, source = Expr)] missing",
                ))?;

        let meta_attrs = MetaParser::parse_meta(event_attr)?;

        let id = Some(
            meta_attrs
                .get_key_value("id")?
                .cloned()
                .map(|meta| meta.value)
                .ok_or(syn::Error::new_spanned(
                    event_attr.path(),
                    "id = Expr missing",
                ))?,
        );

        let source = Some(
            meta_attrs
                .get_key_value("source")?
                .cloned()
                .map(|meta| meta.value)
                .ok_or(syn::Error::new_spanned(
                    event_attr.path(),
                    "source = Expr missing",
                ))?,
        );

        Ok(EventDerive { input, id, source })
    }

    fn where_clause(generics: &Generics) -> Option<WhereClause> {
        //let generics = &self.input.generics;
        // the other predicates in where clause of the structure
        let predicates = generics
            .where_clause
            .as_ref()
            .map(|wc| wc.predicates.clone());
        let type_params = generics.type_params().cloned().collect::<Vec<TypeParam>>();
        let elt = Self::event_lifetime();

        if type_params.is_empty() {
            return None;
        }

        // we want any generic used in the structure to implement PartialEvent
        parse_quote! {
            where
                #(#type_params: FieldGetter<#elt>,)*
                #predicates
        }
    }

    fn expand_event(&self) -> proc_macro2::TokenStream {
        let struct_name = &self.input.ident;
        let mut trait_generics = self.input.generics.clone();
        let generics = &self.input.generics;
        let generic_trait_bound = Self::where_clause(generics);

        let elt = Self::event_lifetime();
        trait_generics
            .params
            .insert(0, GenericParam::Lifetime(elt.clone()));

        let impl_id = self
            .id
            .clone()
            .map(|id| {
                quote! {
                    #[inline(always)]
                    fn id(&self) -> i64 {
                        #id
                    }
                }
            })
            .unwrap_or_default();

        let impl_source = self
            .source
            .clone()
            .map(|source| {
                quote! {
                    #[inline(always)]
                    fn source(&self) -> std::borrow::Cow<'_,str> {
                        #source
                    }
                }
            })
            .unwrap_or_default();

        let expanded = quote! {
            impl #trait_generics Event<#elt> for #struct_name #generics #generic_trait_bound{

                #impl_id

                #impl_source
            }
        };

        expanded
    }
}

/// Derives [`Event`](/gene/trait.Event.html) trait. It is required to also implement [`FieldGetter`](/gene/trait.FieldGetter.html).
///
/// **NB:** `FieldGetter` can be derived with [`FieldGetter`] derive macro
///
/// # Structure Attributes
///
/// `#[event(id = expr, source = expr)]` both `id` and `source` are mandatory to respectively
/// implement the `fn id() -> i64` and `fn source() -> Cow<'_, str>` from trait
///
/// # Example
///
/// ```rust
/// use gene_derive::{Event, FieldGetter};
/// use gene::{Event, FieldGetter, FieldValue, FieldNameIterator};
/// use std::borrow::Cow;
///
/// #[derive(Event, FieldGetter)]
/// #[event(id = self.event_id, source = "whatever".into())]
/// struct LogEvent<T> {
///     name: String,
///     some_field: u32,
///     event_id: i64,
///     some_gen: T,
/// }
/// ```
#[proc_macro_derive(Event, attributes(event))]
pub fn event_derive(item: TokenStream) -> TokenStream {
    let input = parse_macro_input!(item as DeriveInput);
    match EventDerive::parse_event_derive(input)
        .map(|ed| ed.expand_event().into())
        .map_err(|e| e.to_compile_error().into())
    {
        Ok(ts) => ts,
        Err(ts) => ts,
    }
}

struct FieldGetterDerive {
    input: DeriveInput,
    use_serde_rename: bool,
    get_arms: Vec<proc_macro2::TokenStream>,
}

impl FieldGetterDerive {
    fn field_lifetime() -> LifetimeParam {
        LifetimeParam::new(Lifetime::new("'field", Span::call_site()))
    }

    fn build_match_arms(mut self, data_struct: &DataStruct) -> Result<Self, syn::Error> {
        let flt = Self::field_lifetime();

        // we iterate over the enum variants
        for field in data_struct.fields.iter() {
            // name of the variant
            let field_name = &field.ident;
            let field_type = &field.ty;
            let span = field_type.span();
            let mut fields = vec![quote!(stringify!(#field_name))];

            // we take serde(rename = "foo") into account if #[getter(use_serde_rename = true)]
            // is specified in structure
            if let Some(attr) = field.attrs.iter().find(|a| {
                a.path().is_ident("getter") || (a.path().is_ident("serde") && self.use_serde_rename)
            }) {
                let attrs = MetaParser::parse_meta(attr)?;

                // specific processing if event attribute
                if attr.path().is_ident("getter") && attrs.contains_key("skip") {
                    continue;
                }

                if let Some(arg) = attrs
                    .get_key_value("rename")?
                    .cloned()
                    .map(|meta| meta.value)
                {
                    let new_name = expect_lit_variant!(arg, syn::Lit::Str).ok_or(
                        syn::Error::new_spanned(attr, "rename expects literal string"),
                    )?;
                    fields.push(quote!(#new_name));
                }
            }

            self.get_arms.push(quote_spanned! {
            span =>
            #(#fields)|* => {
                #[allow(clippy::redundant_closure_call)]
                |x: &#flt dyn FieldGetter<#flt>, i: FieldNameIterator| -> Option<FieldValue<#flt>> {
                    x.get_from_iter(i)
                }(&self.#field_name, i)
            }});
        }
        Ok(self)
    }

    fn where_clause(generics: &Generics) -> Option<WhereClause> {
        //let generics = &self.input.generics;
        // the other predicates in where clause of the structure
        let predicates = generics
            .where_clause
            .as_ref()
            .map(|wc| wc.predicates.clone());
        let type_params = generics.type_params().cloned().collect::<Vec<TypeParam>>();

        if type_params.is_empty() {
            return None;
        }

        let flt = Self::field_lifetime();

        // we want any generic used in the structure to implement PartialEvent
        parse_quote! {
            where
                #(#type_params: FieldGetter<#flt>,)*
                #predicates
        }
    }

    fn parse_field_getter_derive(input: DeriveInput) -> Result<Self, syn::Error> {
        let mut use_serde_rename_flag = false;

        let data_struct = match &input.data {
            syn::Data::Struct(data_struct) => data_struct,
            _ => return Err(syn::Error::new_spanned(&input, "")),
        };

        if let Some(attr) = input
            .attrs
            .iter()
            .find(|attr| attr.path().is_ident("getter"))
        {
            let args = MetaParser::parse_meta(attr)?;
            use_serde_rename_flag = args.contains_key("use_serde_rename");
        }

        FieldGetterDerive {
            input: input.clone(),
            use_serde_rename: use_serde_rename_flag,
            get_arms: vec![],
        }
        .build_match_arms(data_struct)
    }

    fn expand_partial_event(&self) -> proc_macro2::TokenStream {
        let struct_name = &self.input.ident;
        let generics = &self.input.generics;
        let mut trait_generics = self.input.generics.clone();
        let arms = &self.get_arms;
        let generic_trait_bound = Self::where_clause(&self.input.generics);

        let flt = Self::field_lifetime();
        trait_generics
            .params
            .insert(0, GenericParam::Lifetime(flt.clone()));

        let expand = quote! {
            impl #trait_generics FieldGetter<#flt> for #struct_name #generics #generic_trait_bound{
                #[inline(always)]
                fn get_from_iter(&#flt self, mut i: FieldNameIterator) -> Option<FieldValue<#flt>> {

                    let field = match i.next_field_name() {
                        Some(s) => s,
                        None => return Some(FieldValue::Some),
                    };

                    match field {
                        #(#arms)*
                        _ => None,
                    }
                }
            }
        };

        expand
    }
}

/// Derives [`FieldGetter`](/gene/trait.FieldGetter.html) trait
///
/// # Structure Attributes
///
/// `#[getter(use_serde_rename)]` can be used to parse `#[serde(rename)]` instead of duplicating
/// attributes on every field with `#[getter(rename = "...")]`
///
/// # Field Attributes
///
/// `#[getter(rename = "new_name")]` can be used to apply a new name to the field
///
/// `#[getter(skip)]` skip the field from being implemented. It is important to know
/// that any access to a skipped field will return [None]
#[proc_macro_derive(FieldGetter, attributes(getter))]
pub fn field_getter_derive(item: TokenStream) -> TokenStream {
    let input = parse_macro_input!(item as DeriveInput);
    match FieldGetterDerive::parse_field_getter_derive(input)
        .map(|ed| ed.expand_partial_event().into())
        .map_err(|e| e.to_compile_error().into())
    {
        Ok(ts) => ts,
        Err(ts) => ts,
    }
}