type-bridge-orm-derive 1.5.4

Derive macros for type-bridge-orm: TypeBridgeEntity, TypeBridgeAttribute, TypeBridgeRelation
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
//! Implementation of `#[derive(TypeBridgeEntity)]`.

use proc_macro2::TokenStream;
use quote::quote;
use syn::{DeriveInput, Fields, LitStr};

pub fn derive(input: TokenStream) -> syn::Result<TokenStream> {
    let input: DeriveInput = syn::parse2(input)?;
    let name = &input.ident;

    let fields = match &input.data {
        syn::Data::Struct(s) => match &s.fields {
            Fields::Named(named) => &named.named,
            _ => {
                return Err(syn::Error::new_spanned(
                    &input,
                    "TypeBridgeEntity requires a struct with named fields",
                ));
            }
        },
        _ => {
            return Err(syn::Error::new_spanned(
                &input,
                "TypeBridgeEntity can only be derived for structs",
            ));
        }
    };

    // Parse #[entity(name = "...", abstract, extends = "...")]
    let entity_attrs = parse_entity_attrs(&input.attrs)?;
    let type_name = entity_attrs.name;
    let is_abstract = entity_attrs.is_abstract;
    let parent_type = entity_attrs.parent_type;

    // Separate iid field from attribute fields
    let mut has_iid = false;
    let mut attr_fields: Vec<EntityField> = Vec::new();

    for field in fields {
        let ident = field
            .ident
            .as_ref()
            .ok_or_else(|| syn::Error::new_spanned(field, "Expected named field"))?;

        if ident == "iid" {
            has_iid = true;
            continue;
        }

        let field_attrs = parse_field_attrs(&field.attrs)?;
        let (is_optional, inner_ty) = unwrap_option_type(&field.ty);

        attr_fields.push(EntityField {
            ident: ident.clone(),
            inner_ty: inner_ty.clone(),
            is_optional,
            is_key: field_attrs.is_key,
            is_unique: field_attrs.is_unique,
            card_min: field_attrs.card_min,
            card_max: field_attrs.card_max,
            _custom_name: field_attrs.custom_name,
        });
    }

    if !has_iid {
        return Err(syn::Error::new_spanned(
            &input,
            "TypeBridgeEntity requires a field `iid: Option<String>`",
        ));
    }

    // Generate owned_attributes()
    let owned_attrs = attr_fields.iter().map(|f| {
        let ty = &f.inner_ty;
        let annots_tokens = build_annotations(f.is_key, f.is_unique, f.card_min, f.card_max);
        quote! {
            type_bridge_orm::OwnedAttributeInfo {
                attr_name: <#ty as type_bridge_orm::TypeBridgeAttribute>::ATTR_NAME,
                value_type: <#ty as type_bridge_orm::TypeBridgeAttribute>::VALUE_TYPE_ENUM,
                annotations: #annots_tokens,
            }
        }
    });
    let n_attrs = attr_fields.len();

    // Generate to_attribute_values()
    let to_values = attr_fields.iter().map(|f| {
        let ident = &f.ident;
        let ty = &f.inner_ty;
        if f.is_optional {
            quote! {
                if let Some(ref val) = self.#ident {
                    values.push((
                        <#ty as type_bridge_orm::TypeBridgeAttribute>::ATTR_NAME,
                        <#ty as type_bridge_orm::TypeBridgeAttribute>::to_value(val),
                    ));
                }
            }
        } else {
            quote! {
                values.push((
                    <#ty as type_bridge_orm::TypeBridgeAttribute>::ATTR_NAME,
                    <#ty as type_bridge_orm::TypeBridgeAttribute>::to_value(&self.#ident),
                ));
            }
        }
    });

    // Generate from_document()
    let from_doc_fields = attr_fields.iter().map(|f| {
        let ident = &f.ident;
        let ty = &f.inner_ty;
        let type_name_str = &type_name;

        if f.is_optional {
            quote! {
                let #ident = {
                    let attr_name = <#ty as type_bridge_orm::TypeBridgeAttribute>::ATTR_NAME;
                    let value_type = <#ty as type_bridge_orm::TypeBridgeAttribute>::VALUE_TYPE;
                    match doc.get(attr_name) {
                        Some(json_val) => {
                            let attr_val = type_bridge_orm::AttributeValue::from_json(json_val, value_type)
                                .ok_or_else(|| type_bridge_orm::OrmError::Hydration {
                                    type_name: #type_name_str.to_string(),
                                    message: format!("cannot parse attribute '{}' as {}", attr_name, value_type),
                                })?;
                            Some(<#ty as type_bridge_orm::TypeBridgeAttribute>::from_value(&attr_val)
                                .ok_or_else(|| type_bridge_orm::OrmError::Hydration {
                                    type_name: #type_name_str.to_string(),
                                    message: format!("type mismatch for attribute '{}'", attr_name),
                                })?)
                        }
                        None => None,
                    }
                };
            }
        } else {
            quote! {
                let #ident = {
                    let attr_name = <#ty as type_bridge_orm::TypeBridgeAttribute>::ATTR_NAME;
                    let value_type = <#ty as type_bridge_orm::TypeBridgeAttribute>::VALUE_TYPE;
                    let json_val = doc.get(attr_name).ok_or_else(|| {
                        type_bridge_orm::OrmError::Hydration {
                            type_name: #type_name_str.to_string(),
                            message: format!("missing required attribute '{}'", attr_name),
                        }
                    })?;
                    let attr_val = type_bridge_orm::AttributeValue::from_json(json_val, value_type)
                        .ok_or_else(|| type_bridge_orm::OrmError::Hydration {
                            type_name: #type_name_str.to_string(),
                            message: format!("cannot parse attribute '{}' as {}", attr_name, value_type),
                        })?;
                    <#ty as type_bridge_orm::TypeBridgeAttribute>::from_value(&attr_val)
                        .ok_or_else(|| type_bridge_orm::OrmError::Hydration {
                            type_name: #type_name_str.to_string(),
                            message: format!("type mismatch for attribute '{}'", attr_name),
                        })?
                };
            }
        }
    });

    let field_idents: Vec<_> = attr_fields.iter().map(|f| &f.ident).collect();

    let is_abstract_tokens = if is_abstract {
        quote! { const IS_ABSTRACT: bool = true; }
    } else {
        quote! {}
    };

    let parent_type_tokens = match &parent_type {
        Some(p) => quote! { const PARENT_TYPE: Option<&'static str> = Some(#p); },
        None => quote! {},
    };

    // Generate XxxFields struct for type-safe field references
    let fields_struct_name = syn::Ident::new(&format!("{}Fields", name), name.span());
    let fields_struct_fields = attr_fields.iter().map(|f| {
        let ident = &f.ident;
        let ty = &f.inner_ty;
        quote! {
            pub #ident: type_bridge_orm::FieldRef<#ty>
        }
    });
    let fields_struct_init = attr_fields.iter().map(|f| {
        let ident = &f.ident;
        let ty = &f.inner_ty;
        quote! {
            #ident: type_bridge_orm::FieldRef::<#ty>::new(
                <#ty as type_bridge_orm::TypeBridgeAttribute>::ATTR_NAME
            )
        }
    });

    Ok(quote! {
        /// Type-safe field references for [`#name`].
        pub struct #fields_struct_name {
            #(#fields_struct_fields),*
        }

        impl #name {
            /// Get type-safe field references for building expressions.
            pub fn fields() -> #fields_struct_name {
                #fields_struct_name {
                    #(#fields_struct_init),*
                }
            }
        }

        impl type_bridge_orm::TypeBridgeEntity for #name {
            const TYPE_NAME: &'static str = #type_name;
            #is_abstract_tokens
            #parent_type_tokens

            fn owned_attributes() -> &'static [type_bridge_orm::OwnedAttributeInfo] {
                static ATTRS: [type_bridge_orm::OwnedAttributeInfo; #n_attrs] = [
                    #(#owned_attrs),*
                ];
                &ATTRS
            }

            fn iid(&self) -> Option<&str> {
                self.iid.as_deref()
            }

            fn set_iid(&mut self, iid: String) {
                self.iid = Some(iid);
            }

            fn to_attribute_values(&self) -> Vec<(&'static str, type_bridge_orm::AttributeValue)> {
                let mut values = Vec::new();
                #(#to_values)*
                values
            }

            fn from_document(
                doc: &serde_json::Map<String, serde_json::Value>,
            ) -> type_bridge_orm::Result<Self> {
                #(#from_doc_fields)*
                Ok(Self {
                    iid: None,
                    #(#field_idents),*
                })
            }
        }
    })
}

struct EntityField {
    ident: syn::Ident,
    inner_ty: syn::Type,
    is_optional: bool,
    is_key: bool,
    is_unique: bool,
    card_min: Option<u32>,
    card_max: Option<Option<u32>>,
    _custom_name: Option<String>,
}

struct FieldAttrs {
    is_key: bool,
    is_unique: bool,
    card_min: Option<u32>,
    card_max: Option<Option<u32>>,
    custom_name: Option<String>,
}

struct EntityAttrs {
    name: String,
    is_abstract: bool,
    parent_type: Option<String>,
}

/// Parse `#[entity(name = "...", abstract, extends = "...")]` from struct attributes.
fn parse_entity_attrs(attrs: &[syn::Attribute]) -> syn::Result<EntityAttrs> {
    for attr in attrs {
        if !attr.path().is_ident("entity") {
            continue;
        }
        let mut entity_name: Option<String> = None;
        let mut is_abstract = false;
        let mut parent_type: Option<String> = None;

        attr.parse_nested_meta(|meta| {
            if meta.path.is_ident("name") {
                let value: LitStr = meta.value()?.parse()?;
                entity_name = Some(value.value());
                Ok(())
            } else if meta.path.is_ident("r#abstract") || meta.path.is_ident("abstract") {
                is_abstract = true;
                Ok(())
            } else if meta.path.is_ident("extends") {
                let value: LitStr = meta.value()?.parse()?;
                parent_type = Some(value.value());
                Ok(())
            } else {
                Err(meta.error("expected `name`, `abstract`, or `extends`"))
            }
        })?;

        if let Some(name) = entity_name {
            return Ok(EntityAttrs {
                name,
                is_abstract,
                parent_type,
            });
        }
    }
    Err(syn::Error::new(
        proc_macro2::Span::call_site(),
        "Missing `#[entity(name = \"...\")]`",
    ))
}

/// Parse field-level attributes: `#[field(key)]`, `#[field(unique)]`,
/// `#[field(name = "...")]`, `#[field(card_min = N)]`, `#[field(card_max = M)]`
fn parse_field_attrs(attrs: &[syn::Attribute]) -> syn::Result<FieldAttrs> {
    let mut is_key = false;
    let mut is_unique = false;
    let mut card_min: Option<u32> = None;
    let mut card_max: Option<Option<u32>> = None;
    let mut custom_name: Option<String> = None;

    for attr in attrs {
        if !attr.path().is_ident("field") {
            continue;
        }
        attr.parse_nested_meta(|meta| {
            if meta.path.is_ident("key") {
                is_key = true;
                Ok(())
            } else if meta.path.is_ident("unique") {
                is_unique = true;
                Ok(())
            } else if meta.path.is_ident("name") {
                let value: LitStr = meta.value()?.parse()?;
                custom_name = Some(value.value());
                Ok(())
            } else if meta.path.is_ident("card_min") {
                let value: syn::LitInt = meta.value()?.parse()?;
                card_min = Some(value.base10_parse()?);
                Ok(())
            } else if meta.path.is_ident("card_max") {
                let value: syn::LitInt = meta.value()?.parse()?;
                card_max = Some(Some(value.base10_parse()?));
                Ok(())
            } else {
                Err(meta.error("expected `key`, `unique`, `name`, `card_min`, or `card_max`"))
            }
        })?;
    }

    // If card_min is set but card_max is not, default to unbounded
    if card_min.is_some() && card_max.is_none() {
        card_max = Some(None);
    }

    Ok(FieldAttrs {
        is_key,
        is_unique,
        card_min,
        card_max,
        custom_name,
    })
}

/// Build annotation tokens from field flags.
fn build_annotations(
    is_key: bool,
    is_unique: bool,
    card_min: Option<u32>,
    card_max: Option<Option<u32>>,
) -> proc_macro2::TokenStream {
    let mut annots = Vec::new();
    if is_key {
        annots.push(quote! { type_bridge_orm::Annotation::Key });
    }
    if is_unique {
        annots.push(quote! { type_bridge_orm::Annotation::Unique });
    }
    if let Some(min) = card_min {
        let max_tokens = match card_max {
            Some(Some(m)) => quote! { Some(#m) },
            _ => quote! { None },
        };
        annots.push(quote! { type_bridge_orm::Annotation::Card(#min, #max_tokens) });
    }
    if annots.is_empty() {
        quote! { &[] }
    } else {
        quote! { &[#(#annots),*] }
    }
}

/// Check if a type is `Option<T>` and return the inner type.
fn unwrap_option_type(ty: &syn::Type) -> (bool, &syn::Type) {
    if let syn::Type::Path(type_path) = ty
        && let Some(last) = type_path.path.segments.last()
        && last.ident == "Option"
        && let syn::PathArguments::AngleBracketed(args) = &last.arguments
        && let Some(syn::GenericArgument::Type(inner)) = args.args.first()
    {
        return (true, inner);
    }
    (false, ty)
}