eventide-macros 0.1.1

Procedural macros for the eventide DDD/CQRS toolkit: derive entities, entity ids, value objects and domain events with a single attribute.
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
404
405
406
407
408
409
410
411
412
413
414
use std::collections::HashMap;

use proc_macro::TokenStream;
use quote::{ToTokens, quote};
use syn::{
    Expr, Ident, Item, Result, Token, Type,
    parse::{Parse, ParseStream},
    parse_macro_input,
    punctuated::Punctuated,
    spanned::Spanned,
};

use crate::utils::{
    apply_derives, ensure_required_fields, eventide_domain_path, serde_crate_attr, serde_path,
};

/// #[domain_event] 宏实现
/// - 支持三种变体类型:命名字段 `Variant { .. }`、单元 `Variant`、元组 `Variant(T)`
/// - 单元变体和元组变体自动转换为命名字段变体
/// - 确保每个变体具备字段:`id: IdType`, `aggregate_version: Version`
/// - 生成 `::eventide_domain::domain_event::DomainEvent` 实现(event_id/type/version/aggregate_version)
/// - 支持:`#[event(id = IdType, version = N)]`(枚举级默认值)
/// - 变体可覆写:`#[event(event_type = "...", event_version = N)]`
pub(crate) fn expand(attr: TokenStream, item: TokenStream) -> TokenStream {
    let cfg = parse_macro_input!(attr as EventAttrConfig);
    let mut input = parse_macro_input!(item as Item);

    let enum_item = match &mut input {
        Item::Enum(e) => e,
        other => {
            return syn::Error::new(
                other.span(),
                "#[domain_event] can only be used on enum types",
            )
            .to_compile_error()
            .into();
        }
    };

    let id_type = cfg.id_ty.unwrap_or_else(|| syn::parse_quote! { String });
    let version_lit = cfg.version.unwrap_or_else(|| syn::parse_quote! { 1 });
    let domain = eventide_domain_path();
    let serde = serde_path();

    // 合并/追加默认派生:Debug, Clone, PartialEq, Serialize, Deserialize
    let required: Vec<syn::Path> = vec![
        syn::parse_quote!(Debug),
        syn::parse_quote!(Clone),
        syn::parse_quote!(PartialEq),
        syn::parse_quote!(#serde::Serialize),
        syn::parse_quote!(#serde::Deserialize),
    ];
    apply_derives(&mut enum_item.attrs, required, vec![serde_crate_attr()]);

    let mut variant_types: HashMap<String, syn::LitStr> = HashMap::new();
    let mut variant_versions: HashMap<String, syn::LitInt> = HashMap::new();

    for v in &mut enum_item.variants {
        // 先处理变体属性(所有变体类型通用)
        let mut retained_attrs = Vec::new();
        let mut type_lit: Option<syn::LitStr> = None;
        let mut version_lit_local: Option<syn::LitInt> = None;

        for attr in v.attrs.iter() {
            if attr.path().is_ident("event") {
                match parse_variant_event_attr(attr) {
                    Ok(vc) => {
                        if let Some(lit) = vc.ty {
                            if type_lit.is_some() {
                                return syn::Error::new(
                                    attr.span(),
                                    "duplicate 'event_type' specified for this variant",
                                )
                                .to_compile_error()
                                .into();
                            }
                            type_lit = Some(lit);
                        }
                        if let Some(lit) = vc.version {
                            if version_lit_local.is_some() {
                                return syn::Error::new(
                                    attr.span(),
                                    "duplicate 'event_version' specified for this variant",
                                )
                                .to_compile_error()
                                .into();
                            }
                            version_lit_local = Some(lit);
                        }
                    }
                    Err(err) => {
                        return err.to_compile_error().into();
                    }
                }
            } else if attr.path().is_ident("event_type") || attr.path().is_ident("event_version") {
                return syn::Error::new(
                    attr.span(),
                    "legacy #[event_type]/#[event_version] syntax is no longer supported; use \
                     #[event(event_type = ..., event_version = ...)]",
                )
                .to_compile_error()
                .into();
            } else {
                retained_attrs.push(attr.clone());
            }
        }

        v.attrs = retained_attrs;
        if let Some(lit) = type_lit {
            variant_types.insert(v.ident.to_string(), lit);
        }
        if let Some(lit) = version_lit_local {
            variant_versions.insert(v.ident.to_string(), lit);
        }

        // 处理字段转换
        match &mut v.fields {
            syn::Fields::Named(fields_named) => {
                let version_ty: Type = syn::parse_quote! { #domain::value_object::Version };
                ensure_required_fields(
                    fields_named,
                    &[("id", &id_type), ("aggregate_version", &version_ty)],
                    // reposition_existing
                    false,
                );
            }
            syn::Fields::Unit => {
                // 单元变体转换为命名字段变体: Variant => Variant { id, aggregate_version }
                v.fields = syn::Fields::Named(create_required_fields_only(&id_type, &domain));
            }
            syn::Fields::Unnamed(fields_unnamed) => {
                // 元组变体转换为命名字段变体: Variant(T) => Variant { value: T, id,
                // aggregate_version }
                v.fields =
                    syn::Fields::Named(convert_tuple_to_named(fields_unnamed, &id_type, &domain));
            }
        }
    }

    // 生成 DomainEvent 实现
    let enum_ident = &enum_item.ident;
    let enum_name_string = enum_ident.to_string();

    let type_match_arms = enum_item.variants.iter().map(|v| {
        let v_ident = &v.ident;
        let key = v_ident.to_string();
        if let Some(lit) = variant_types.get(&key) {
            quote! { Self::#v_ident { .. } => #lit }
        } else {
            let combined = format!("{}.{}", enum_name_string, key);
            let lit = syn::LitStr::new(&combined, v_ident.span());
            quote! { Self::#v_ident { .. } => #lit }
        }
    });

    let id_match_arms = enum_item.variants.iter().map(|v| {
        let v_ident = &v.ident;
        quote! { Self::#v_ident { id, .. } => id.as_str() }
    });

    let ver_match_arms = enum_item.variants.iter().map(|v| {
        let v_ident = &v.ident;
        let key = v_ident.to_string();
        if let Some(lit) = variant_versions.get(&key) {
            quote! { Self::#v_ident { .. } => #lit }
        } else {
            quote! { Self::#v_ident { .. } => #version_lit }
        }
    });

    let agg_ver_match_arms = enum_item.variants.iter().map(|v| {
        let v_ident = &v.ident;
        quote! { Self::#v_ident { aggregate_version, .. } => *aggregate_version }
    });

    let out = quote! {
        #enum_item

        impl #domain::domain_event::DomainEvent for #enum_ident {
            fn event_id(&self) -> &str { match self { #( #id_match_arms, )* } }
            fn event_type(&self) -> &str { match self { #( #type_match_arms, )* } }
            fn event_version(&self) -> usize { match self { #( #ver_match_arms, )* } }
            fn aggregate_version(&self) -> #domain::value_object::Version { match self { #( #agg_ver_match_arms, )* } }
        }
    };

    TokenStream::from(out)
}

// -------- utils & parsing --------

struct VariantEventAttrConfig {
    ty: Option<syn::LitStr>,
    version: Option<syn::LitInt>,
}

fn parse_variant_event_attr(attr: &syn::Attribute) -> Result<VariantEventAttrConfig> {
    match &attr.meta {
        syn::Meta::List(_) => {
            let mut ty: Option<syn::LitStr> = None;
            let mut version: Option<syn::LitInt> = None;
            let pairs: Punctuated<VariantEventAttrKv, Token![,]> = attr
                .parse_args_with(Punctuated::<VariantEventAttrKv, Token![,]>::parse_terminated)?;

            for kv in pairs {
                match kv.key.to_string().as_str() {
                    "event_type" => {
                        if ty.is_some() {
                            return Err(syn::Error::new(
                                kv.key.span(),
                                "duplicate key 'event_type' in attribute",
                            ));
                        }
                        let lit = match kv.value {
                            Expr::Lit(syn::ExprLit {
                                lit: syn::Lit::Str(lit),
                                ..
                            }) => lit,
                            other => {
                                return Err(syn::Error::new(
                                    other.span(),
                                    "expected string literal for 'event_type'",
                                ));
                            }
                        };
                        ty = Some(lit);
                    }
                    "event_version" => {
                        if version.is_some() {
                            return Err(syn::Error::new(
                                kv.key.span(),
                                "duplicate key 'event_version' in attribute",
                            ));
                        }
                        let lit = match kv.value {
                            Expr::Lit(syn::ExprLit {
                                lit: syn::Lit::Int(lit),
                                ..
                            }) => lit,
                            other => {
                                return Err(syn::Error::new(
                                    other.span(),
                                    "expected integer literal for 'event_version'",
                                ));
                            }
                        };
                        version = Some(lit);
                    }
                    _ => {
                        return Err(syn::Error::new(
                            kv.key.span(),
                            "unknown key; expected 'event_type' | 'event_version'",
                        ));
                    }
                }
            }

            Ok(VariantEventAttrConfig { ty, version })
        }
        other => Err(syn::Error::new(other.span(), "expected #[event(...)]")),
    }
}

struct VariantEventAttrKv {
    key: Ident,
    #[allow(dead_code)]
    eq: Token![=],
    value: Expr,
}

impl Parse for VariantEventAttrKv {
    fn parse(input: ParseStream) -> Result<Self> {
        Ok(Self {
            key: input.parse()?,
            eq: input.parse()?,
            value: input.parse()?,
        })
    }
}

/// 创建只包含 id 和 aggregate_version 的命名字段集(用于单元变体转换)
fn create_required_fields_only(
    id_type: &Type,
    domain: &proc_macro2::TokenStream,
) -> syn::FieldsNamed {
    let version_ty: Type = syn::parse_quote! { #domain::value_object::Version };
    syn::parse_quote! {
        {
            id: #id_type,
            aggregate_version: #version_ty
        }
    }
}

/// 将元组变体字段转换为命名字段,并添加必需字段
/// - 单字段: `Variant(T)` => `Variant { value: T, id, aggregate_version }`
/// - 多字段: `Variant(T, U)` => `Variant { value_0: T, value_1: U, id, aggregate_version }`
fn convert_tuple_to_named(
    fields_unnamed: &syn::FieldsUnnamed,
    id_type: &Type,
    domain: &proc_macro2::TokenStream,
) -> syn::FieldsNamed {
    let version_ty: Type = syn::parse_quote! { #domain::value_object::Version };
    let unnamed_fields = &fields_unnamed.unnamed;

    let named_fields: Vec<syn::Field> = if unnamed_fields.len() == 1 {
        // 单字段:使用 value 作为字段名
        let field = &unnamed_fields[0];
        let ty = &field.ty;
        vec![syn::Field {
            attrs: field.attrs.clone(),
            vis: field.vis.clone(),
            mutability: syn::FieldMutability::None,
            ident: Some(syn::Ident::new("value", proc_macro2::Span::call_site())),
            colon_token: Some(Default::default()),
            ty: ty.clone(),
        }]
    } else {
        // 多字段:使用 value_0, value_1, ... 作为字段名
        unnamed_fields
            .iter()
            .enumerate()
            .map(|(i, field)| {
                let ty = &field.ty;
                syn::Field {
                    attrs: field.attrs.clone(),
                    vis: field.vis.clone(),
                    mutability: syn::FieldMutability::None,
                    ident: Some(syn::Ident::new(
                        &format!("value_{}", i),
                        proc_macro2::Span::call_site(),
                    )),
                    colon_token: Some(Default::default()),
                    ty: ty.clone(),
                }
            })
            .collect()
    };

    // 添加必需字段
    let id_field: syn::Field = syn::parse_quote! { id: #id_type };
    let version_field: syn::Field = syn::parse_quote! { aggregate_version: #version_ty };

    let mut all_fields: Punctuated<syn::Field, Token![,]> = Punctuated::new();
    for f in named_fields {
        all_fields.push(f);
    }
    all_fields.push(id_field);
    all_fields.push(version_field);

    syn::FieldsNamed {
        brace_token: Default::default(),
        named: all_fields,
    }
}

// 枚举级配置:id 类型、默认版本号
struct EventAttrConfig {
    id_ty: Option<Type>,
    version: Option<syn::LitInt>,
}

impl Parse for EventAttrConfig {
    fn parse(input: ParseStream) -> Result<Self> {
        let mut id_ty: Option<Type> = None;
        let mut version: Option<syn::LitInt> = None;

        if input.is_empty() {
            return Ok(Self { id_ty, version });
        }

        let pairs: Punctuated<syn::ExprAssign, Token![,]> =
            Punctuated::<syn::ExprAssign, Token![,]>::parse_terminated(input)?;

        for assign in pairs.into_iter() {
            let key_ident = match *assign.left {
                syn::Expr::Path(p) if p.path.segments.len() == 1 => {
                    p.path.segments[0].ident.clone()
                }
                other => return Err(syn::Error::new(other.span(), "invalid attribute key")),
            };
            match key_ident.to_string().as_str() {
                "id" => {
                    if id_ty.is_some() {
                        return Err(syn::Error::new(
                            key_ident.span(),
                            "duplicate key 'id' in attribute",
                        ));
                    }
                    let ty_parsed: Type = syn::parse2(assign.right.to_token_stream())?;
                    id_ty = Some(ty_parsed);
                }
                "version" => {
                    if version.is_some() {
                        return Err(syn::Error::new(
                            key_ident.span(),
                            "duplicate key 'version' in attribute",
                        ));
                    }
                    let lit: syn::LitInt = syn::parse2(assign.right.to_token_stream())?;
                    version = Some(lit);
                }
                _ => {
                    return Err(syn::Error::new(
                        key_ident.span(),
                        "unknown key; expected 'id' | 'version'",
                    ));
                }
            }
        }

        Ok(Self { id_ty, version })
    }
}