cargo-reef 0.2.2

CLI scaffolder + tooling for Reef apps. `cargo reef new my-app` to scaffold; `cargo reef dev` to run; `cargo reef migrate` for DB migrations.
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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
//! `syn`-based schema.rs parser.
//!
//! Reads the file, walks top-level items, picks out structs marked with
//! `#[reef::table]` (or `#[table]` after `use reef::table`), and turns each
//! into a [`Table`] in the [`Schema`] IR.

use std::path::Path;

use anyhow::{anyhow, bail, Context, Result};
use quote::ToTokens;
use syn::{
    spanned::Spanned, Attribute, Expr, ExprArray, ExprLit, Field, Item, ItemStruct, Lit, LitStr,
    Meta,
};

use super::cfg::{item_is_active, FeatureSet};
use super::ir::{
    Column, ColumnFk, FkAction, Generated, GeneratedKind, Index, Schema, Table, TableCheck,
    TableForeignKey, TablePrimaryKey,
};
use super::types::map_field_type;

pub fn parse_file(path: &Path, features: &FeatureSet) -> Result<Schema> {
    let src = std::fs::read_to_string(path)
        .with_context(|| format!("reading {}", path.display()))?;
    let file = syn::parse_file(&src)
        .with_context(|| format!("parsing {} as Rust", path.display()))?;

    let mut tables = Vec::new();
    for item in &file.items {
        if let Item::Struct(s) = item {
            if !has_marker(&s.attrs, "table") {
                continue;
            }
            // Respect cfg-gating so multi-deployment projects (one schema.rs,
            // different binaries via features) get the right schema view.
            if !item_is_active(&s.attrs, features).with_context(|| {
                format!("evaluating cfg on struct `{}`", s.ident)
            })? {
                continue;
            }
            let table = parse_table(s).with_context(|| {
                format!("parsing struct `{}` as a #[reef::table]", s.ident)
            })?;
            tables.push(table);
        }
    }

    let schema = Schema { tables };
    validate_cross_refs(&schema)?;
    Ok(schema)
}

/// Cross-table validation pass — ensures every FK reference points at a
/// table and column(s) that actually exist in the schema. Catches typos
/// like leftover plural names after renaming a struct.
fn validate_cross_refs(schema: &Schema) -> Result<()> {
    use std::collections::HashMap;

    let table_cols: HashMap<&str, std::collections::HashSet<&str>> = schema
        .tables
        .iter()
        .map(|t| {
            (
                t.name.as_str(),
                t.columns.iter().map(|c| c.name.as_str()).collect(),
            )
        })
        .collect();

    let table_names: Vec<&str> = table_cols.keys().copied().collect();

    for t in &schema.tables {
        for col in &t.columns {
            if let Some(fk) = &col.references {
                check_fk_target(
                    &table_cols,
                    &table_names,
                    &fk.table,
                    std::slice::from_ref(&fk.column),
                    &format!("{}.{} `references = \"{}({})\"`", t.rust_name, col.name, fk.table, fk.column),
                )?;
            }
        }
        for fk in &t.foreign_keys {
            check_fk_target(
                &table_cols,
                &table_names,
                &fk.references_table,
                &fk.references_columns,
                &format!(
                    "{} `#[foreign_key(columns = [{}], references = \"{}({})\")]`",
                    t.rust_name,
                    fk.columns.join(", "),
                    fk.references_table,
                    fk.references_columns.join(", ")
                ),
            )?;
        }
    }
    Ok(())
}

fn check_fk_target(
    table_cols: &std::collections::HashMap<&str, std::collections::HashSet<&str>>,
    table_names: &[&str],
    target_table: &str,
    target_columns: &[String],
    context: &str,
) -> Result<()> {
    let Some(cols) = table_cols.get(target_table) else {
        let suggestion = closest_match(target_table, table_names)
            .map(|m| format!(" (did you mean `{m}`?)"))
            .unwrap_or_default();
        bail!(
            "{context}: target table `{target_table}` does not exist in this schema{suggestion}"
        );
    };
    for c in target_columns {
        if !cols.contains(c.as_str()) {
            let known: Vec<&str> = cols.iter().copied().collect();
            let suggestion = closest_match(c, &known)
                .map(|m| format!(" (did you mean `{m}`?)"))
                .unwrap_or_default();
            bail!(
                "{context}: column `{c}` does not exist on table `{target_table}`{suggestion}"
            );
        }
    }
    Ok(())
}

/// Tiny edit-distance suggester. Returns Some(name) if any candidate is
/// within 2 character edits — enough to catch the common rename misses
/// (`users` vs `user`, `id` vs `ids`) without false positives.
fn closest_match<'a>(target: &str, candidates: &[&'a str]) -> Option<&'a str> {
    let mut best: Option<(usize, &'a str)> = None;
    for c in candidates {
        let d = edit_distance(target, c);
        if d <= 2 && best.map_or(true, |(bd, _)| d < bd) {
            best = Some((d, c));
        }
    }
    best.map(|(_, c)| c)
}

fn edit_distance(a: &str, b: &str) -> usize {
    let a: Vec<char> = a.chars().collect();
    let b: Vec<char> = b.chars().collect();
    let mut prev: Vec<usize> = (0..=b.len()).collect();
    let mut cur = vec![0usize; b.len() + 1];
    for (i, ca) in a.iter().enumerate() {
        cur[0] = i + 1;
        for (j, cb) in b.iter().enumerate() {
            let cost = if ca == cb { 0 } else { 1 };
            cur[j + 1] = (cur[j] + 1)
                .min(prev[j + 1] + 1)
                .min(prev[j] + cost);
        }
        std::mem::swap(&mut prev, &mut cur);
    }
    prev[b.len()]
}

fn parse_table(s: &ItemStruct) -> Result<Table> {
    let rust_name = s.ident.to_string();
    let mut name = snake_case(&rust_name);
    let mut strict = false;
    let mut without_rowid = false;

    // #[reef::table(name = "...", strict, without_rowid)] args
    for attr in s.attrs.iter().filter(|a| is_marker_attr(a, "table")) {
        if matches!(attr.meta, Meta::Path(_)) {
            continue; // bare `#[reef::table]` with no args
        }
        attr.parse_nested_meta(|meta| {
            let key = meta
                .path
                .get_ident()
                .map(|i| i.to_string())
                .unwrap_or_default();
            match key.as_str() {
                "name" => {
                    let v: LitStr = meta.value()?.parse()?;
                    name = v.value();
                }
                "strict" => strict = true,
                "without_rowid" => without_rowid = true,
                other => return Err(meta.error(format!("unknown table arg `{other}`"))),
            }
            Ok(())
        })?;
    }

    // Field-level columns
    let mut columns = Vec::new();
    let syn::Fields::Named(named) = &s.fields else {
        bail!("`#[reef::table]` requires a struct with named fields");
    };
    for field in &named.named {
        columns.push(parse_column(field).with_context(|| {
            format!(
                "field `{}`",
                field.ident.as_ref().map(|i| i.to_string()).unwrap_or_default()
            )
        })?);
    }
    if columns.is_empty() {
        bail!("`#[reef::table]` requires at least one field");
    }

    // Struct-level helper attrs
    let mut primary_key = None;
    let mut indexes = Vec::new();
    let mut foreign_keys = Vec::new();
    let mut checks = Vec::new();

    for attr in &s.attrs {
        if is_marker_attr(attr, "primary_key") {
            if primary_key.is_some() {
                bail!("multiple `#[primary_key(...)]` attributes — only one composite PK is allowed");
            }
            primary_key = Some(parse_primary_key(attr)?);
        } else if is_marker_attr(attr, "index") {
            indexes.push(parse_index(attr)?);
        } else if is_marker_attr(attr, "foreign_key") {
            foreign_keys.push(parse_foreign_key(attr)?);
        } else if is_marker_attr(attr, "check") {
            checks.push(parse_check(attr)?);
        }
    }

    Ok(Table {
        name,
        rust_name,
        strict,
        without_rowid,
        columns,
        primary_key,
        indexes,
        foreign_keys,
        checks,
    })
}

fn parse_column(field: &Field) -> Result<Column> {
    let name = field
        .ident
        .as_ref()
        .ok_or_else(|| anyhow!("tuple-struct fields are not supported"))?
        .to_string();

    let info = map_field_type(&field.ty)?;

    let mut col = Column {
        name,
        ty: info.column_type,
        nullable: info.nullable,
        primary_key: false,
        auto_increment: false,
        unique: false,
        default: None,
        check: None,
        references: None,
        generated: None,
    };

    let mut on_delete: Option<FkAction> = None;
    let mut on_update: Option<FkAction> = None;
    let mut generated_expr: Option<String> = None;
    let mut generated_kind: Option<GeneratedKind> = None;

    for attr in field.attrs.iter().filter(|a| is_marker_attr(a, "column")) {
        attr.parse_nested_meta(|meta| {
            let key = meta
                .path
                .get_ident()
                .map(|i| i.to_string())
                .unwrap_or_default();
            match key.as_str() {
                "primary_key" => col.primary_key = true,
                "auto_increment" => col.auto_increment = true,
                "unique" => col.unique = true,
                "default" => {
                    if col.default.is_some() {
                        return Err(meta.error("`default` and `default_sql` are mutually exclusive"));
                    }
                    let v: Expr = meta.value()?.parse()?;
                    col.default = Some(expr_to_sql_literal(&v));
                }
                "default_sql" => {
                    if col.default.is_some() {
                        return Err(meta.error("`default` and `default_sql` are mutually exclusive"));
                    }
                    // Verbatim SQL — for function defaults like
                    // `datetime('now')` that aren't expressible as Rust
                    // literals. We wrap in parens so SQLite parses it as
                    // an expression rather than a literal.
                    let v: LitStr = meta.value()?.parse()?;
                    col.default = Some(format!("({})", v.value()));
                }
                "check" => {
                    let v: LitStr = meta.value()?.parse()?;
                    col.check = Some(v.value());
                }
                "references" => {
                    let v: LitStr = meta.value()?.parse()?;
                    let (table, column) = parse_single_fk_target(&v.value())
                        .map_err(|e| meta.error(e.to_string()))?;
                    col.references = Some(ColumnFk {
                        table,
                        column,
                        on_delete: None,
                        on_update: None,
                    });
                }
                "on_delete" => {
                    let v: LitStr = meta.value()?.parse()?;
                    on_delete = Some(
                        FkAction::parse(&v.value())
                            .ok_or_else(|| meta.error("invalid on_delete value"))?,
                    );
                }
                "on_update" => {
                    let v: LitStr = meta.value()?.parse()?;
                    on_update = Some(
                        FkAction::parse(&v.value())
                            .ok_or_else(|| meta.error("invalid on_update value"))?,
                    );
                }
                "generated" => {
                    let v: LitStr = meta.value()?.parse()?;
                    generated_expr = Some(v.value());
                }
                "generated_kind" => {
                    let v: LitStr = meta.value()?.parse()?;
                    generated_kind = Some(match v.value().as_str() {
                        "stored" => GeneratedKind::Stored,
                        "virtual" => GeneratedKind::Virtual,
                        _ => return Err(meta.error("generated_kind must be 'stored' or 'virtual'")),
                    });
                }
                other => return Err(meta.error(format!("unknown column key `{other}`"))),
            }
            Ok(())
        })?;
    }

    if let Some(fk) = col.references.as_mut() {
        fk.on_delete = on_delete;
        fk.on_update = on_update;
    } else if on_delete.is_some() || on_update.is_some() {
        bail!("on_delete/on_update set without `references`");
    }

    if let Some(expr) = generated_expr {
        col.generated = Some(Generated {
            expr,
            kind: generated_kind.unwrap_or(GeneratedKind::Virtual),
        });
    } else if generated_kind.is_some() {
        bail!("`generated_kind` set without `generated`");
    }

    Ok(col)
}

fn parse_primary_key(attr: &Attribute) -> Result<TablePrimaryKey> {
    let mut columns = Vec::new();
    attr.parse_nested_meta(|meta| {
        match ident_str(&meta.path).as_deref() {
            Some("columns") => {
                columns = parse_string_array(&meta.value()?.parse::<Expr>()?)?;
                Ok(())
            }
            _ => Err(meta.error("only `columns = [...]` is allowed")),
        }
    })?;
    if columns.is_empty() {
        bail!("`#[primary_key]` requires `columns = [...]`");
    }
    Ok(TablePrimaryKey { columns })
}

fn parse_index(attr: &Attribute) -> Result<Index> {
    let mut name = None;
    let mut columns = Vec::new();
    let mut unique = false;
    attr.parse_nested_meta(|meta| {
        match ident_str(&meta.path).as_deref() {
            Some("name") => {
                let v: LitStr = meta.value()?.parse()?;
                name = Some(v.value());
            }
            Some("columns") => {
                columns = parse_string_array(&meta.value()?.parse::<Expr>()?)?;
            }
            Some("unique") => unique = true,
            _ => return Err(meta.error("unknown index key")),
        }
        Ok(())
    })?;
    if columns.is_empty() {
        bail!("`#[index]` requires `columns = [...]`");
    }
    Ok(Index {
        name,
        columns,
        unique,
    })
}

fn parse_foreign_key(attr: &Attribute) -> Result<TableForeignKey> {
    let mut columns = Vec::new();
    let mut references = String::new();
    let mut on_delete = None;
    let mut on_update = None;
    attr.parse_nested_meta(|meta| {
        match ident_str(&meta.path).as_deref() {
            Some("columns") => {
                columns = parse_string_array(&meta.value()?.parse::<Expr>()?)?;
            }
            Some("references") => {
                let v: LitStr = meta.value()?.parse()?;
                references = v.value();
            }
            Some("on_delete") => {
                let v: LitStr = meta.value()?.parse()?;
                on_delete = Some(
                    FkAction::parse(&v.value())
                        .ok_or_else(|| meta.error("invalid on_delete"))?,
                );
            }
            Some("on_update") => {
                let v: LitStr = meta.value()?.parse()?;
                on_update = Some(
                    FkAction::parse(&v.value())
                        .ok_or_else(|| meta.error("invalid on_update"))?,
                );
            }
            _ => return Err(meta.error("unknown foreign_key key")),
        }
        Ok(())
    })?;
    if columns.is_empty() {
        bail!("`#[foreign_key]` requires `columns = [...]`");
    }
    if references.is_empty() {
        bail!("`#[foreign_key]` requires `references = \"table(c1, c2)\"`");
    }
    let (references_table, references_columns) = parse_composite_fk_target(&references)?;
    if references_columns.len() != columns.len() {
        bail!(
            "foreign_key column count mismatch: {} local, {} referenced",
            columns.len(),
            references_columns.len()
        );
    }
    Ok(TableForeignKey {
        columns,
        references_table,
        references_columns,
        on_delete,
        on_update,
    })
}

fn parse_check(attr: &Attribute) -> Result<TableCheck> {
    let mut name = String::new();
    let mut expr = String::new();
    attr.parse_nested_meta(|meta| {
        match ident_str(&meta.path).as_deref() {
            Some("name") => {
                let v: LitStr = meta.value()?.parse()?;
                name = v.value();
            }
            Some("expr") => {
                let v: LitStr = meta.value()?.parse()?;
                expr = v.value();
            }
            _ => return Err(meta.error("unknown check key")),
        }
        Ok(())
    })?;
    if name.is_empty() || expr.is_empty() {
        bail!("`#[check]` requires both `name` and `expr`");
    }
    Ok(TableCheck { name, expr })
}

// ============================================================================
//  small helpers
// ============================================================================

fn has_marker(attrs: &[Attribute], name: &str) -> bool {
    attrs.iter().any(|a| is_marker_attr(a, name))
}

/// Match `#[<name>...]`, `#[reef::<name>...]`. Match by last path segment.
fn is_marker_attr(attr: &Attribute, name: &str) -> bool {
    attr.path()
        .segments
        .last()
        .is_some_and(|s| s.ident == name)
}

fn ident_str(p: &syn::Path) -> Option<String> {
    p.get_ident().map(|i| i.to_string())
}

fn parse_string_array(expr: &Expr) -> syn::Result<Vec<String>> {
    let Expr::Array(ExprArray { elems, .. }) = expr else {
        return Err(syn::Error::new(expr.span(), "expected `[...]` array"));
    };
    elems
        .iter()
        .map(|e| match e {
            Expr::Lit(ExprLit {
                lit: Lit::Str(s), ..
            }) => Ok(s.value()),
            _ => Err(syn::Error::new(e.span(), "expected a string literal")),
        })
        .collect()
}

/// Parse `"users(id)"` → `("users", "id")`.
fn parse_single_fk_target(s: &str) -> Result<(String, String)> {
    let (table, rest) = s
        .split_once('(')
        .ok_or_else(|| anyhow!("references must be `table(column)`, got `{s}`"))?;
    let column = rest
        .strip_suffix(')')
        .ok_or_else(|| anyhow!("references missing closing `)`"))?;
    let cols: Vec<&str> = column.split(',').map(str::trim).collect();
    if cols.len() != 1 {
        bail!("single-column FK on a column may only reference one column; use `#[foreign_key(...)]` for composite FKs");
    }
    Ok((table.trim().to_string(), cols[0].to_string()))
}

/// Parse `"users(id, tenant_id)"` → `("users", vec!["id", "tenant_id"])`.
fn parse_composite_fk_target(s: &str) -> Result<(String, Vec<String>)> {
    let (table, rest) = s
        .split_once('(')
        .ok_or_else(|| anyhow!("references must be `table(c1, c2)`, got `{s}`"))?;
    let cols = rest
        .strip_suffix(')')
        .ok_or_else(|| anyhow!("references missing closing `)`"))?;
    let columns: Vec<String> = cols.split(',').map(|c| c.trim().to_string()).collect();
    Ok((table.trim().to_string(), columns))
}

/// Render any expr as a SQL literal. String literals lose their Rust quotes
/// and become SQL `'...'` literals; numeric/bool/other exprs render as-is.
fn expr_to_sql_literal(e: &Expr) -> String {
    if let Expr::Lit(ExprLit {
        lit: Lit::Str(s), ..
    }) = e
    {
        format!("'{}'", s.value().replace('\'', "''"))
    } else {
        expr_string(e)
    }
}

fn expr_string(e: &Expr) -> String {
    e.to_token_stream().to_string()
}

/// Convert a Rust struct identifier to a SQL table name. PascalCase → snake_case.
/// Does NOT pluralize — `User` → `user`, `PostLike` → `post_like`. Users who
/// want plural names declare them explicitly via `#[reef::table(name = "users")]`.
/// Avoids the irregular-plural problem entirely (Box→boxes, Person→people, etc.)
/// without pulling in a pluralization dep.
fn snake_case(s: &str) -> String {
    let mut out = String::with_capacity(s.len() + 4);
    for (i, c) in s.chars().enumerate() {
        if c.is_ascii_uppercase() {
            if i > 0 {
                out.push('_');
            }
            out.push(c.to_ascii_lowercase());
        } else {
            out.push(c);
        }
    }
    out
}