cot_codegen 0.6.0

The Rust web framework for lazy developers - code generation utils.
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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
use darling::{FromDeriveInput, FromField, FromMeta};
use heck::ToSnakeCase;
use syn::ext::IdentExt;
use syn::spanned::Spanned;

use crate::symbol_resolver::SymbolResolver;

#[expect(clippy::module_name_repetitions)]
#[derive(Debug, Default, FromMeta)]
pub struct ModelArgs {
    #[darling(default)]
    pub model_type: ModelType,
    pub table_name: Option<String>,
}

#[expect(clippy::module_name_repetitions)]
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, Default, FromMeta)]
pub enum ModelType {
    #[default]
    Application,
    Migration,
    Internal,
}

#[expect(clippy::module_name_repetitions)]
#[derive(Debug, Clone, FromDeriveInput)]
#[darling(forward_attrs(allow, doc, cfg), supports(struct_named))]
pub struct ModelOpts {
    pub ident: syn::Ident,
    pub vis: syn::Visibility,
    pub generics: syn::Generics,
    pub data: darling::ast::Data<darling::util::Ignored, FieldOpts>,
}

impl ModelOpts {
    pub fn new_from_derive_input(input: &syn::DeriveInput) -> Result<Self, darling::error::Error> {
        let opts = Self::from_derive_input(input)?;
        if !opts.generics.params.is_empty() {
            return Err(
                darling::Error::custom("generics in models are not supported")
                    .with_span(&opts.generics),
            );
        }
        Ok(opts)
    }

    /// Get the fields of the struct.
    ///
    /// # Panics
    ///
    /// Panics if the [`ModelOpts`] was not parsed from a struct.
    #[must_use]
    pub fn fields(&self) -> Vec<&FieldOpts> {
        self.data
            .as_ref()
            .take_struct()
            .expect("Only structs are supported")
            .fields
    }

    /// Convert the model options into a model.
    ///
    /// # Errors
    ///
    /// Returns an error if the model name does not start with an underscore
    /// when the model type is [`ModelType::Migration`].
    pub fn as_model(
        &self,
        args: &ModelArgs,
        symbol_resolver: &SymbolResolver,
    ) -> Result<Model, syn::Error> {
        let self_reference = self.ident.to_string();
        let as_field = |field: &&FieldOpts| field.as_field(symbol_resolver, Some(&self_reference));

        let fields = self
            .fields()
            .iter()
            .map(as_field)
            .collect::<Result<Vec<_>, _>>()?;

        let mut original_name = self.ident.unraw().to_string();
        if args.model_type == ModelType::Migration {
            original_name = original_name
                .strip_prefix("_")
                .ok_or_else(|| {
                    syn::Error::new(
                        self.ident.span(),
                        "migration model names must start with an underscore",
                    )
                })?
                .to_string();
        }
        let table_name = if let Some(table_name) = &args.table_name {
            table_name.clone()
        } else {
            original_name.to_snake_case()
        };

        let primary_key_field = self.get_primary_key_field(&fields)?;

        let ty = {
            let mut ty = syn::Type::Path(syn::TypePath {
                qself: None,
                path: syn::Path::from(self.ident.clone()),
            });
            symbol_resolver.resolve(&mut ty, Some(&original_name));
            ty
        };

        Ok(Model {
            name: self.ident.clone(),
            vis: self.vis.clone(),
            original_name,
            resolved_ty: ty,
            model_type: args.model_type,
            table_name,
            pk_field: primary_key_field.clone(),
            fields,
        })
    }

    fn get_primary_key_field<'a>(&self, fields: &'a [Field]) -> Result<&'a Field, syn::Error> {
        let pks: Vec<_> = fields.iter().filter(|field| field.primary_key).collect();
        if pks.is_empty() {
            return Err(syn::Error::new(
                self.ident.span(),
                "models must have a primary key field annotated with \
                the `#[model(primary_key)]` attribute",
            ));
        }
        if pks.len() > 1 {
            return Err(syn::Error::new(
                pks[1].name.span(),
                "composite primary keys are not supported; only one primary key field is allowed",
            ));
        }

        Ok(pks[0])
    }
}

#[derive(Debug, Clone, FromField)]
#[darling(attributes(model))]
pub struct FieldOpts {
    pub ident: Option<syn::Ident>,
    pub ty: syn::Type,
    pub primary_key: darling::util::Flag,
    pub unique: darling::util::Flag,
}

impl FieldOpts {
    fn find_type(&self, type_to_find: &str, symbol_resolver: &SymbolResolver) -> Option<syn::Type> {
        let mut ty = self.ty.clone();
        symbol_resolver.resolve(&mut ty, None);
        Self::find_type_resolved(&ty, type_to_find)
    }

    fn find_type_resolved(ty: &syn::Type, type_to_find: &str) -> Option<syn::Type> {
        if let syn::Type::Path(type_path) = ty {
            let name = type_path
                .path
                .segments
                .iter()
                .map(|s| s.ident.to_string())
                .collect::<Vec<_>>()
                .join("::");

            if name == type_to_find {
                return Some(ty.clone());
            }

            for arg in &type_path.path.segments {
                if let syn::PathArguments::AngleBracketed(arg) = &arg.arguments
                    && let Some(ty) = Self::find_type_in_generics(arg, type_to_find)
                {
                    return Some(ty);
                }
            }
        }

        None
    }

    fn find_type_in_generics(
        arg: &syn::AngleBracketedGenericArguments,
        type_to_find: &str,
    ) -> Option<syn::Type> {
        arg.args.iter().find_map(|arg| {
            if let syn::GenericArgument::Type(ty) = arg {
                Self::find_type_resolved(ty, type_to_find)
            } else {
                None
            }
        })
    }

    /// Convert the field options into a field.
    ///
    /// # Panics
    ///
    /// Panics if the field does not have an identifier (i.e. it is a tuple
    /// struct).
    pub fn as_field(
        &self,
        symbol_resolver: &SymbolResolver,
        self_reference: Option<&String>,
    ) -> Result<Field, syn::Error> {
        let name = self
            .ident
            .clone()
            .expect("Only named struct fields are supported");
        let column_name = name.unraw().to_string();

        let (auto_value, foreign_key) = (
            self.find_type("cot::db::Auto", symbol_resolver).is_some(),
            self.find_type("cot::db::ForeignKey", symbol_resolver)
                .map(ForeignKeySpec::try_from)
                .transpose()?,
        );
        let is_primary_key = self.primary_key.is_present();
        let mut resolved_ty = self.ty.clone();
        symbol_resolver.resolve(&mut resolved_ty, self_reference);
        Ok(Field {
            name: name.clone(),
            column_name,
            ty: resolved_ty,
            auto_value,
            primary_key: is_primary_key,
            foreign_key,
            unique: self.unique.is_present(),
        })
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Model {
    pub name: syn::Ident,
    pub vis: syn::Visibility,
    pub original_name: String,
    /// The type of the model resolved by symbol resolver.
    pub resolved_ty: syn::Type,
    #[expect(clippy::struct_field_names)] // `type` is not an allowed identifier in Rust
    pub model_type: ModelType,
    pub table_name: String,
    pub pk_field: Field,
    pub fields: Vec<Field>,
}

impl Model {
    #[must_use]
    pub fn field_count(&self) -> usize {
        self.fields.len()
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct Field {
    pub name: syn::Ident,
    pub column_name: String,
    pub ty: syn::Type,
    /// Whether the field is an auto field (e.g. `id`).
    pub auto_value: bool,
    pub primary_key: bool,
    /// [`Some`] if this field is a foreign key; [`None`] if this field is
    /// determined not to be a foreign key.
    pub foreign_key: Option<ForeignKeySpec>,
    pub unique: bool,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ForeignKeySpec {
    pub to_model: syn::Type,
}

impl TryFrom<syn::Type> for ForeignKeySpec {
    type Error = syn::Error;

    fn try_from(ty: syn::Type) -> Result<Self, Self::Error> {
        let syn::Type::Path(type_path) = &ty else {
            panic!("Expected a path type for a foreign key");
        };

        let syn::PathArguments::AngleBracketed(args) = &type_path
            .path
            .segments
            .last()
            .expect("type path must have at least one segment")
            .arguments
        else {
            return Err(syn::Error::new(
                ty.span(),
                "expected ForeignKey to have angle-bracketed generic arguments",
            ));
        };

        if args.args.len() != 1 {
            return Err(syn::Error::new(
                ty.span(),
                "expected ForeignKey to have only one generic parameter",
            ));
        }

        let inner = &args.args[0];
        if let syn::GenericArgument::Type(ty) = inner {
            Ok(Self {
                to_model: ty.clone(),
            })
        } else {
            Err(syn::Error::new(
                ty.span(),
                "expected ForeignKey to have a type generic argument",
            ))
        }
    }
}

#[cfg(test)]
mod tests {
    use syn::parse_quote;

    use super::*;
    use crate::symbol_resolver::{SymbolResolver, VisibleSymbol, VisibleSymbolKind};

    #[test]
    fn model_args_default() {
        let args: ModelArgs = ModelArgs::default();
        assert_eq!(args.model_type, ModelType::Application);
        assert!(args.table_name.is_none());
    }

    #[test]
    fn model_type_default() {
        let model_type: ModelType = ModelType::default();
        assert_eq!(model_type, ModelType::Application);
    }

    #[test]
    fn model_opts_fields() {
        let input: syn::DeriveInput = parse_quote! {
            struct TestModel {
                id: i32,
                name: String,
            }
        };
        let opts = ModelOpts::new_from_derive_input(&input).unwrap();
        let fields = opts.fields();
        assert_eq!(fields.len(), 2);
        assert_eq!(fields[0].ident.as_ref().unwrap().to_string(), "id");
        assert_eq!(fields[1].ident.as_ref().unwrap().to_string(), "name");
    }

    #[test]
    fn model_opts_as_model() {
        let input: syn::DeriveInput = parse_quote! {
            struct TestModel {
                #[model(primary_key)]
                id: i32,
                name: String,
            }
        };
        let opts = ModelOpts::new_from_derive_input(&input).unwrap();
        let args = ModelArgs::default();
        let model = opts.as_model(&args, &SymbolResolver::new(vec![])).unwrap();
        assert_eq!(model.name.to_string(), "TestModel");
        assert_eq!(model.table_name, "test_model");
        assert_eq!(model.fields.len(), 2);
        assert_eq!(model.field_count(), 2);
    }

    #[test]
    fn model_opts_raw_name() {
        let input: syn::DeriveInput = parse_quote! {
            struct r#abstract {
                #[model(primary_key)]
                id: i32,
                name: String,
            }
        };
        let opts = ModelOpts::new_from_derive_input(&input).unwrap();
        let model = opts
            .as_model(&ModelArgs::default(), &SymbolResolver::new(vec![]))
            .unwrap();
        assert_eq!(model.name.to_string(), "r#abstract");
        assert_eq!(model.table_name, "abstract");
    }

    #[test]
    fn model_opts_as_model_migration() {
        let input: syn::DeriveInput = parse_quote! {
            #[model(model_type = "migration")]
            struct TestModel {
                id: i32,
                name: String,
            }
        };
        let opts = ModelOpts::new_from_derive_input(&input).unwrap();
        let args = ModelArgs::from_meta(&input.attrs.first().unwrap().meta).unwrap();
        let err = opts
            .as_model(&args, &SymbolResolver::new(vec![]))
            .unwrap_err();
        assert_eq!(
            err.to_string(),
            "migration model names must start with an underscore"
        );
    }

    #[test]
    fn model_opts_as_model_pk_attr() {
        let input: syn::DeriveInput = parse_quote! {
            #[model]
            struct TestModel {
                #[model(primary_key)]
                name: i32,
            }
        };
        let opts = ModelOpts::new_from_derive_input(&input).unwrap();
        let args = ModelArgs::default();
        let model = opts.as_model(&args, &SymbolResolver::new(vec![])).unwrap();
        assert_eq!(model.fields.len(), 1);
        assert!(model.fields[0].primary_key);
    }

    #[test]
    fn model_opts_as_model_no_pk() {
        let input: syn::DeriveInput = parse_quote! {
            #[model]
            struct TestModel {
                name: String,
            }
        };
        let opts = ModelOpts::new_from_derive_input(&input).unwrap();
        let args = ModelArgs::default();
        let err = opts
            .as_model(&args, &SymbolResolver::new(vec![]))
            .unwrap_err();
        assert_eq!(
            err.to_string(),
            "models must have a primary key field annotated with \
            the `#[model(primary_key)]` attribute"
        );
    }

    #[test]
    fn model_opts_as_model_multiple_pks() {
        let input: syn::DeriveInput = parse_quote! {
            #[model]
            struct TestModel {
                #[model(primary_key)]
                id: i64,
                #[model(primary_key)]
                id_2: i64,
                name: String,
            }
        };
        let opts = ModelOpts::new_from_derive_input(&input).unwrap();
        let args = ModelArgs::default();
        let err = opts
            .as_model(&args, &SymbolResolver::new(vec![]))
            .unwrap_err();
        assert_eq!(
            err.to_string(),
            "composite primary keys are not supported; only one primary key field is allowed"
        );
    }

    #[test]
    fn field_opts_as_field() {
        let input: syn::Field = parse_quote! {
            #[model(unique)]
            name: String
        };
        let field_opts = FieldOpts::from_field(&input).unwrap();
        let field = field_opts
            .as_field(&SymbolResolver::new(vec![]), Some(&"TestModel".to_string()))
            .unwrap();
        assert_eq!(field.name.to_string(), "name");
        assert_eq!(field.column_name, "name");
        assert_eq!(field.ty, parse_quote!(String));
        assert!(field.unique);
    }

    #[test]
    fn field_opts_raw_name() {
        let input: syn::Field = parse_quote! {
            r#abstract: String
        };
        let field_opts = FieldOpts::from_field(&input).unwrap();
        let field = field_opts
            .as_field(&SymbolResolver::new(vec![]), Some(&"TestModel".to_string()))
            .unwrap();
        assert_eq!(field.name.to_string(), "r#abstract");
        assert_eq!(field.column_name, "abstract");
    }

    #[test]
    fn find_type_resolved() {
        let input: syn::Type =
            parse_quote! { ::my_crate::MyContainer<'a, Vec<std::string::String>> };
        assert!(FieldOpts::find_type_resolved(&input, "my_crate::MyContainer").is_some());
        assert!(FieldOpts::find_type_resolved(&input, "Vec").is_some());
        assert!(FieldOpts::find_type_resolved(&input, "std::string::String").is_some());
        assert!(FieldOpts::find_type_resolved(&input, "OtherType").is_none());
    }

    #[test]
    fn find_type() {
        let symbols = vec![VisibleSymbol::new(
            "MyContainer",
            "my_crate::MyContainer",
            VisibleSymbolKind::Use,
        )];
        let resolver = SymbolResolver::new(symbols);

        let opts = FieldOpts {
            ident: None,
            ty: parse_quote! { MyContainer<std::string::String> },
            primary_key: darling::util::Flag::default(),
            unique: darling::util::Flag::default(),
        };

        assert!(opts.find_type("my_crate::MyContainer", &resolver).is_some());
        assert!(opts.find_type("std::string::String", &resolver).is_some());
        assert!(opts.find_type("MyContainer", &resolver).is_none());
        assert!(opts.find_type("String", &resolver).is_none());
    }
}