prax-codegen 0.9.4

Procedural macros for code generation in the Prax ORM
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
//! Code generation for Prax views.

use proc_macro2::TokenStream;
use quote::quote;

use prax_schema::ast::View;

use super::{generate_doc_comment, pascal_ident, snake_ident};
use crate::types::field_type_to_rust;

/// Generate the module for a view definition.
pub fn generate_view_module(view_def: &View) -> Result<TokenStream, syn::Error> {
    let view_name = pascal_ident(view_def.name());
    let module_name = snake_ident(view_def.name());

    let doc = generate_doc_comment(view_def.documentation.as_ref().map(|d| d.text.as_str()));

    // Get the database view name from @@map or use the view name
    let db_view_name = view_def
        .attributes
        .iter()
        .find(|a| a.name() == "map")
        .and_then(|a| a.first_arg())
        .and_then(|v| v.as_string())
        .map(|s| s.to_string())
        .unwrap_or_else(|| view_def.name().to_string());

    // Generate struct fields
    let fields: Vec<_> = view_def
        .fields
        .values()
        .map(|field| {
            let field_name = snake_ident(field.name());
            let field_type = field_type_to_rust(&field.field_type, &field.modifier);
            let field_doc =
                generate_doc_comment(field.documentation.as_ref().map(|d| d.text.as_str()));

            // Check for @map attribute for column name
            let serde_rename = field
                .attributes
                .iter()
                .find(|a| a.name() == "map")
                .and_then(|a| a.first_arg())
                .and_then(|v| v.as_string())
                .map(|name| quote! { #[serde(rename = #name)] })
                .unwrap_or_default();

            quote! {
                #field_doc
                #serde_rename
                pub #field_name: #field_type
            }
        })
        .collect();

    // Generate field modules for filtering/selecting
    let field_modules: Vec<_> = view_def
        .fields
        .values()
        .map(|field| {
            let field_mod_name = snake_ident(field.name());
            let field_name_str = field
                .attributes
                .iter()
                .find(|a| a.name() == "map")
                .and_then(|a| a.first_arg())
                .and_then(|v| v.as_string())
                .map(|s| s.to_string())
                .unwrap_or_else(|| field.name().to_string());

            quote! {
                /// Field operations for `#field_name_str`.
                pub mod #field_mod_name {
                    /// Column name in the database.
                    pub const COLUMN: &str = #field_name_str;
                }
            }
        })
        .collect();

    Ok(quote! {
        #doc
        pub mod #module_name {
            use serde::{Deserialize, Serialize};

            /// The database view name.
            pub const VIEW_NAME: &str = #db_view_name;

            #doc
            /// This is a read-only view - no insert/update/delete operations are available.
            #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
            pub struct #view_name {
                #(#fields,)*
            }

            /// Field definitions for the view.
            pub mod fields {
                #(#field_modules)*
            }

            // Re-export common types
            pub use fields::*;

            /// Query builder for this view.
            #[derive(Debug, Default)]
            pub struct Query {
                /// Selected fields (empty = all).
                pub select: Vec<&'static str>,
                /// Where conditions.
                pub where_conditions: Vec<String>,
                /// Order by clauses.
                pub order_by: Vec<(&'static str, ::prax_orm::_prax_prelude::SortOrder)>,
                /// Maximum results.
                pub take: Option<usize>,
                /// Results to skip.
                pub skip: Option<usize>,
            }

            impl Query {
                /// Create a new query builder.
                pub fn new() -> Self {
                    Self::default()
                }

                /// Add a select clause.
                pub fn select(mut self, field: &'static str) -> Self {
                    self.select.push(field);
                    self
                }

                /// Set the maximum number of results.
                pub fn take(mut self, n: usize) -> Self {
                    self.take = Some(n);
                    self
                }

                /// Set the number of results to skip.
                pub fn skip(mut self, n: usize) -> Self {
                    self.skip = Some(n);
                    self
                }

                /// Generate the SQL query string.
                pub fn to_sql(&self) -> String {
                    let columns = if self.select.is_empty() {
                        "*".to_string()
                    } else {
                        self.select.join(", ")
                    };

                    let mut sql = format!("SELECT {} FROM {}", columns, VIEW_NAME);

                    if !self.where_conditions.is_empty() {
                        sql.push_str(" WHERE ");
                        sql.push_str(&self.where_conditions.join(" AND "));
                    }

                    if !self.order_by.is_empty() {
                        sql.push_str(" ORDER BY ");
                        let order_parts: Vec<_> = self.order_by.iter().map(|(col, dir)| {
                            let dir_str = match dir {
                                ::prax_orm::_prax_prelude::SortOrder::Asc => "ASC",
                                ::prax_orm::_prax_prelude::SortOrder::Desc => "DESC",
                            };
                            format!("{} {}", col, dir_str)
                        }).collect();
                        sql.push_str(&order_parts.join(", "));
                    }

                    if let Some(take) = self.take {
                        sql.push_str(&format!(" LIMIT {}", take));
                    }

                    if let Some(skip) = self.skip {
                        sql.push_str(&format!(" OFFSET {}", skip));
                    }

                    sql
                }
            }
        }

        // Re-export the view type at the parent level
        pub use #module_name::#view_name;
    })
}

#[cfg(test)]
mod tests {
    use super::*;
    use prax_schema::ast::{
        Attribute, AttributeArg, AttributeValue, Field, FieldType, Ident, ScalarType, Span,
        TypeModifier,
    };

    fn make_span() -> Span {
        Span::new(0, 0)
    }

    fn make_ident(name: &str) -> Ident {
        Ident::new(name, make_span())
    }

    fn make_map_attribute(value: &str) -> Attribute {
        Attribute::new(
            make_ident("map"),
            vec![AttributeArg::positional(
                AttributeValue::String(value.into()),
                make_span(),
            )],
            make_span(),
        )
    }

    #[test]
    fn test_generate_simple_view() {
        let mut view_def = View::new(make_ident("UserStats"), make_span());
        view_def.add_field(Field::new(
            make_ident("userId"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));
        view_def.add_field(Field::new(
            make_ident("postCount"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        assert!(code.contains("pub mod user_stats"));
        assert!(code.contains("pub struct UserStats"));
        assert!(code.contains("read-only view"));
    }

    #[test]
    fn test_view_module_contains_view_name_const() {
        let mut view_def = View::new(make_ident("ActivityLog"), make_span());
        view_def.add_field(Field::new(
            make_ident("id"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        assert!(code.contains("VIEW_NAME"));
        assert!(code.contains("ActivityLog"));
    }

    #[test]
    fn test_view_with_map_attribute() {
        let mut view_def = View::new(make_ident("UserStats"), make_span());
        view_def
            .attributes
            .push(make_map_attribute("vw_user_stats"));
        view_def.add_field(Field::new(
            make_ident("userId"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        assert!(code.contains("vw_user_stats"));
    }

    #[test]
    fn test_view_field_with_map_attribute() {
        let mut view_def = View::new(make_ident("UserStats"), make_span());
        view_def.add_field(Field::new(
            make_ident("userId"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![make_map_attribute("user_id")],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        // The map attribute affects the COLUMN constant value in fields module
        assert!(code.contains("user_id"));
        // Since we use @map on field, the serde rename is generated
        // Note: The generated code uses # [serde (rename = "user_id")] format
        assert!(code.contains("serde") || code.contains("COLUMN"));
    }

    #[test]
    fn test_view_with_optional_field() {
        let mut view_def = View::new(make_ident("UserStats"), make_span());
        view_def.add_field(Field::new(
            make_ident("lastActivity"),
            FieldType::Scalar(ScalarType::DateTime),
            TypeModifier::Optional,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        assert!(code.contains("Option"));
    }

    #[test]
    fn test_view_generates_query_builder() {
        let mut view_def = View::new(make_ident("UserStats"), make_span());
        view_def.add_field(Field::new(
            make_ident("userId"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        assert!(code.contains("pub struct Query"));
        assert!(code.contains("fn new"));
        assert!(code.contains("fn select"));
        assert!(code.contains("fn take"));
        assert!(code.contains("fn skip"));
        assert!(code.contains("fn to_sql"));
    }

    #[test]
    fn test_view_generates_field_modules() {
        let mut view_def = View::new(make_ident("UserStats"), make_span());
        view_def.add_field(Field::new(
            make_ident("userId"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));
        view_def.add_field(Field::new(
            make_ident("postCount"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        assert!(code.contains("pub mod fields"));
        assert!(code.contains("pub mod user_id"));
        assert!(code.contains("pub mod post_count"));
        assert!(code.contains("COLUMN"));
    }

    #[test]
    fn test_view_with_different_scalar_types() {
        let mut view_def = View::new(make_ident("MixedView"), make_span());
        view_def.add_field(Field::new(
            make_ident("id"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));
        view_def.add_field(Field::new(
            make_ident("name"),
            FieldType::Scalar(ScalarType::String),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));
        view_def.add_field(Field::new(
            make_ident("score"),
            FieldType::Scalar(ScalarType::Float),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));
        view_def.add_field(Field::new(
            make_ident("active"),
            FieldType::Scalar(ScalarType::Boolean),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        assert!(code.contains("i32"));
        assert!(code.contains("String"));
        assert!(code.contains("f64"));
        assert!(code.contains("bool"));
    }

    #[test]
    fn test_view_derives_serde() {
        let mut view_def = View::new(make_ident("TestView"), make_span());
        view_def.add_field(Field::new(
            make_ident("id"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        assert!(code.contains("Serialize"));
        assert!(code.contains("Deserialize"));
    }

    #[test]
    fn test_view_reexports_type() {
        let mut view_def = View::new(make_ident("MyView"), make_span());
        view_def.add_field(Field::new(
            make_ident("id"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        // Should have a re-export at the parent level
        assert!(code.contains("pub use my_view :: MyView"));
    }

    #[test]
    fn test_view_query_builder_members() {
        let mut view_def = View::new(make_ident("TestView"), make_span());
        view_def.add_field(Field::new(
            make_ident("id"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        assert!(code.contains("pub select"));
        assert!(code.contains("pub where_conditions"));
        assert!(code.contains("pub order_by"));
        assert!(code.contains("pub take"));
        assert!(code.contains("pub skip"));
    }

    #[test]
    fn test_view_with_list_field() {
        let mut view_def = View::new(make_ident("TagView"), make_span());
        view_def.add_field(Field::new(
            make_ident("tags"),
            FieldType::Scalar(ScalarType::String),
            TypeModifier::List,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        assert!(code.contains("Vec < String >"));
    }

    #[test]
    fn test_view_derives_debug_clone_partialeq() {
        let mut view_def = View::new(make_ident("TestView"), make_span());
        view_def.add_field(Field::new(
            make_ident("id"),
            FieldType::Scalar(ScalarType::Int),
            TypeModifier::Required,
            vec![],
            make_span(),
        ));

        let result = generate_view_module(&view_def);
        assert!(result.is_ok());

        let code = result.unwrap().to_string();
        assert!(code.contains("Debug"));
        assert!(code.contains("Clone"));
        assert!(code.contains("PartialEq"));
    }
}