doido-generators 0.0.13

Doido code generators plus the unified CLI (server, console, db, worker, generate, new, credentials).
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
527
528
529
530
531
532
533
use doido_generators::{
    default_registry, ChannelGenerator, ControllerGenerator, Generator, JobGenerator,
    MailerGenerator, MigrationGenerator, ModelGenerator, ScaffoldGenerator,
};

#[test]
fn test_controller_generator_produces_correct_file() {
    let files = ControllerGenerator.generate(&["Posts"]).unwrap();
    let ctrl = files
        .iter()
        .find(|f| f.path == "src/controllers/posts_controller.rs")
        .unwrap();
    assert!(ctrl.content.contains("PostsController"));
    assert!(ctrl.content.contains("#[controller]"));
    // A TODO test stub is emitted alongside it.
    let test = files
        .iter()
        .find(|f| f.path == "tests/posts_controller_test.rs")
        .expect("controller test stub emitted");
    assert!(test.content.contains("fn posts_controller_todo()"));
}

#[test]
fn test_model_generator_produces_model_migration_and_updates_lib() {
    let files = ModelGenerator.generate(&["User"]).unwrap();
    let paths: Vec<&str> = files.iter().map(|f| f.path.as_str()).collect();

    // Model file in app/models/.
    assert!(paths.contains(&"app/models/user.rs"));
    let model = files
        .iter()
        .find(|f| f.path == "app/models/user.rs")
        .unwrap();
    assert!(model.content.contains("DeriveEntityModel"));
    assert!(model.content.contains("table_name = \"users\""));

    // Migration file in db/migration/src/.
    assert!(paths
        .iter()
        .any(|p| p.starts_with("db/migration/src/m") && p.ends_with("_create_users_table.rs")));

    // Migration crate lib.rs is updated to register the new migration.
    let lib = files
        .iter()
        .find(|f| f.path == "db/migration/src/lib.rs")
        .unwrap();
    assert!(lib.content.contains("mod m"));
    assert!(lib.content.contains("_create_users_table;"));
    assert!(lib.content.contains("Box::new(m"));
    assert!(lib.content.contains("_create_users_table::Migration),"));
}

#[test]
fn test_model_generator_pluralizes_irregular_table_name() {
    // Proves the model generator uses the inflector (Person -> people), not a
    // naive `name + "s"` ("persons").
    let files = ModelGenerator.generate(&["Person"]).unwrap();
    let paths: Vec<&str> = files.iter().map(|f| f.path.as_str()).collect();

    assert!(paths.contains(&"app/models/person.rs"));
    let model = files
        .iter()
        .find(|f| f.path == "app/models/person.rs")
        .unwrap();
    assert!(model.content.contains("table_name = \"people\""));
    assert!(paths.iter().any(|p| p.ends_with("_create_people_table.rs")));
}

#[test]
fn test_model_generator_emits_columns_from_field_specs() {
    let files = ModelGenerator
        .generate(&[
            "Post",
            "title:string:not_null",
            "body:text",
            "author:references",
            "slug:string:unique",
            "views:integer:index",
        ])
        .unwrap();

    // Model struct carries one field per column with correct nullability.
    let model = files
        .iter()
        .find(|f| f.path == "app/models/post.rs")
        .unwrap();
    assert!(model.content.contains("pub title: String,"));
    assert!(model.content.contains("pub body: Option<String>,"));
    assert!(model.content.contains("pub author_id: i64,"));
    assert!(model.content.contains("pub slug: Option<String>,"));
    assert!(model.content.contains("pub views: Option<i32>,"));

    // Migration builds the columns and an index for the `:index` field.
    let migration = files
        .iter()
        .find(|f| f.path.ends_with("_create_posts_table.rs"))
        .unwrap();
    assert!(migration
        .content
        .contains("t.string(\"title\").not_null();"));
    assert!(migration.content.contains("t.text(\"body\");"));
    assert!(migration.content.contains("t.references(\"author\");"));
    assert!(migration
        .content
        .contains("t.string(\"slug\").unique_key();"));
    assert!(migration.content.contains("t.integer(\"views\");"));
    assert!(migration
        .content
        .contains("use doido_model::migration::{add_index, create_table, drop_table};"));
    assert!(migration
        .content
        .contains("add_index(manager, \"posts\", &[\"views\"]).await?;"));
}

#[test]
fn test_model_generator_without_fields_emits_empty_table() {
    let files = ModelGenerator.generate(&["User"]).unwrap();
    let migration = files
        .iter()
        .find(|f| f.path.ends_with("_create_users_table.rs"))
        .unwrap();
    // Falls back to the no-column closure (and no unused `add_index` import).
    assert!(migration.content.contains("|_t| {}).await"));
    assert!(migration
        .content
        .contains("use doido_model::migration::{create_table, drop_table};"));
    assert!(!migration.content.contains("add_index"));
}

#[test]
fn test_model_generator_rejects_bad_field_type() {
    assert!(ModelGenerator.generate(&["User", "age:notatype"]).is_err());
}

#[test]
fn test_model_generator_emits_test_stub() {
    let files = ModelGenerator.generate(&["User"]).unwrap();
    let test = files
        .iter()
        .find(|f| f.path == "tests/user_model_test.rs")
        .expect("model test stub emitted");
    assert!(test.content.contains("TODO"));
    assert!(test.content.contains("fn user_model_todo()"));
}

#[test]
fn test_scaffold_emits_model_test_and_controller_request_tests() {
    let files = ScaffoldGenerator
        .generate(&["Post", "title:string"])
        .unwrap();
    let paths: Vec<&str> = files.iter().map(|f| f.path.as_str()).collect();

    // Model test stub is emitted alongside the model.
    assert!(paths.contains(&"tests/post_model_test.rs"));

    // The controller file itself no longer carries an in-file test module.
    let ctrl = files
        .iter()
        .find(|f| f.path == "app/controllers/posts_controller.rs")
        .unwrap();
    assert!(!ctrl.content.contains("#[cfg(test)]"));

    // A separate tests/ file holds one test per controller action.
    let test = files
        .iter()
        .find(|f| f.path == "tests/posts_controller_test.rs")
        .expect("controller test file emitted");
    assert!(test.content.contains("#[path = \"../config/routes.rs\"]")); // builds the router
    assert!(test.content.contains("pool::test_lock()")); // serialized via shared lock
    assert!(test.content.contains("title=Test")); // sample form body
    for action in [
        "index_request",
        "new_request",
        "create_request",
        "show_request",
        "edit_request",
        "update_request",
        "destroy_request",
    ] {
        assert!(
            test.content.contains(&format!("async fn {action}()")),
            "missing per-action test {action}"
        );
    }
    assert!(test.content.contains("StatusCode::OK"));
    assert!(test.content.contains("StatusCode::FOUND"));
}

#[test]
fn test_migration_generator_create_pattern_uses_doido_model() {
    let files = MigrationGenerator
        .generate(&["create_users", "email:string:unique"])
        .unwrap();
    // Written into the migration crate (not the old `db/migrations/` dir).
    let mig = files
        .iter()
        .find(|f| f.path.starts_with("db/migration/src/") && f.path.ends_with("_create_users.rs"))
        .unwrap();
    // Uses the doido-model builders, not raw sea-orm.
    assert!(mig
        .content
        .contains("create_table(manager, \"users\", |t| {"));
    assert!(mig.content.contains("t.string(\"email\").unique_key();"));
    assert!(mig.content.contains("drop_table(manager, \"users\").await"));
    assert!(mig
        .content
        .contains("use doido_model::migration::{create_table, drop_table};"));
    assert!(!mig.content.contains("Table::create()"));
    assert!(!mig.content.contains("ColumnDef"));
    // Registered in the Migrator's lib.rs, and a test stub is scaffolded.
    let lib = files
        .iter()
        .find(|f| f.path == "db/migration/src/lib.rs")
        .unwrap();
    assert!(lib.content.contains("_create_users::Migration)"));
    assert!(files
        .iter()
        .any(|f| f.path == "tests/create_users_migration_test.rs"));
}

#[test]
fn test_migration_generator_add_columns_pattern() {
    let files = MigrationGenerator
        .generate(&["add_slug_to_posts", "slug:string:unique"])
        .unwrap();
    let mig = files
        .iter()
        .find(|f| f.path.ends_with("_add_slug_to_posts.rs"))
        .unwrap();
    assert!(mig
        .content
        .contains("use doido_model::migration::alter_table;"));
    assert!(mig
        .content
        .contains("alter_table(manager, \"posts\", |t| {"));
    assert!(mig
        .content
        .contains("t.add_column(\"slug\", |c| { c.string().unique_key(); });"));
    // `down` reverses the change by dropping the column.
    assert!(mig.content.contains("t.drop_column(\"slug\");"));
}

#[test]
fn test_migration_generator_remove_columns_pattern() {
    let files = MigrationGenerator
        .generate(&["remove_slug_from_posts", "slug:string"])
        .unwrap();
    let mig = files
        .iter()
        .find(|f| f.path.ends_with("_remove_slug_from_posts.rs"))
        .unwrap();
    // up drops, down re-adds.
    assert!(mig.content.contains("t.drop_column(\"slug\");"));
    assert!(mig
        .content
        .contains("t.add_column(\"slug\", |c| { c.string(); });"));
}

#[test]
fn test_migration_generator_generic_name_uses_doido_model_skeleton() {
    let files = MigrationGenerator.generate(&["backfill_stuff"]).unwrap();
    let mig = files
        .iter()
        .find(|f| f.path.ends_with("_backfill_stuff.rs"))
        .unwrap();
    assert!(mig
        .content
        .contains("create_table(manager, \"backfill_stuff\", |_t| {})"));
    assert!(!mig.content.contains("Table::create()"));
    assert!(!mig.content.contains("ColumnDef"));
    assert!(!mig.content.contains("Alias::new"));
}

#[test]
fn test_job_generator_produces_correct_file() {
    let files = JobGenerator.generate(&["SendEmail"]).unwrap();
    let job = files
        .iter()
        .find(|f| f.path == "app/jobs/send_email_job.rs")
        .unwrap();
    assert!(job.content.contains("#[job"));
    // The context the engine carries is the job's first parameter, followed by a
    // typed payload.
    assert!(job
        .content
        .contains("async fn send_email_job(ctx: &JobContext, payload: SendEmailPayload)"));
    // The payload type is (de)serializable so the queue can persist it as JSON.
    assert!(job.content.contains("pub struct SendEmailPayload"));
    assert!(job.content.contains("Serialize"));
    assert!(job.content.contains("Deserialize"));
    let test = files
        .iter()
        .find(|f| f.path == "tests/send_email_job_test.rs")
        .expect("job test stub emitted");
    assert!(test.content.contains("fn send_email_job_todo()"));
}

#[test]
fn test_mailer_generator_produces_correct_file() {
    let files = MailerGenerator.generate(&["Welcome"]).unwrap();
    let mailer = files
        .iter()
        .find(|f| f.path == "app/mailers/welcome_mailer.rs")
        .unwrap();
    assert!(mailer.content.contains("WelcomeMailer"));
    assert!(files
        .iter()
        .any(|f| f.path == "tests/welcome_mailer_test.rs"));
}

#[test]
fn test_channel_generator_produces_correct_file() {
    let files = ChannelGenerator.generate(&["Chat"]).unwrap();
    let channel = files
        .iter()
        .find(|f| f.path == "app/channels/chat_channel.rs")
        .unwrap();
    assert!(channel.content.contains("ChatChannel"));
    assert!(files.iter().any(|f| f.path == "tests/chat_channel_test.rs"));
}

#[test]
fn test_scaffold_generator_produces_multiple_files() {
    let files = ScaffoldGenerator
        .generate(&["Post", "title:string:not_null", "body:text"])
        .unwrap();
    let paths: Vec<&str> = files.iter().map(|f| f.path.as_str()).collect();

    // Model + migration + controller + 5 views + routes + both mod.rs registries.
    assert!(paths.contains(&"app/models/post.rs"));
    assert!(paths.contains(&"app/controllers/posts_controller.rs"));
    assert!(paths.iter().any(|p| p.ends_with("_create_posts_table.rs")));
    assert!(paths.contains(&"app/views/posts/index.html.tera"));
    assert!(paths.contains(&"app/views/posts/show.html.tera"));
    assert!(paths.contains(&"app/views/posts/new.html.tera"));
    assert!(paths.contains(&"app/views/posts/edit.html.tera"));
    assert!(paths.contains(&"app/views/posts/_form.html.tera"));
    assert!(paths.contains(&"config/routes.rs"));

    // Controller has all 7 RESTful actions and a strong-params struct.
    let ctrl = files
        .iter()
        .find(|f| f.path == "app/controllers/posts_controller.rs")
        .unwrap();
    for action in [
        "index", "show", "new", "create", "edit", "update", "destroy",
    ] {
        assert!(
            ctrl.content.contains(&format!("fn {action}(")),
            "missing action {action}"
        );
    }
    assert!(ctrl.content.contains("pub struct PostsController;"));
    assert!(ctrl.content.contains("pub struct PostForm"));
    assert!(ctrl.content.contains("pub title: String,"));
    assert!(ctrl.content.contains("title: Set(form.title),"));
    assert!(ctrl.content.contains("ctx.render(\"posts/index\""));

    // Route injection (plural + controller), preserving the existing route.
    let routes = files.iter().find(|f| f.path == "config/routes.rs").unwrap();
    assert!(routes
        .content
        .contains("resources!(posts, PostsController);"));
    assert!(routes
        .content
        .contains("use crate::controllers::PostsController;"));
    assert!(routes.content.contains("HelloController::index")); // preserved

    // Controller registered in app/controllers/mod.rs.
    let cmod = files
        .iter()
        .find(|f| f.path == "app/controllers/mod.rs")
        .unwrap();
    assert!(cmod.content.contains("mod posts_controller;"));
    assert!(cmod
        .content
        .contains("pub use posts_controller::PostsController;"));

    // Views are field-driven.
    let index = files
        .iter()
        .find(|f| f.path == "app/views/posts/index.html.tera")
        .unwrap();
    assert!(index.content.contains("<th>title</th>"));
    assert!(index.content.contains("{% for post in posts %}"));
    assert!(index.content.contains("{{ post.title }}"));
    // Delete button issues a DELETE to the destroy route for each row.
    assert!(index.content.contains(">Delete</button>"));
    assert!(index
        .content
        .contains("fetch('/posts/{{ post.id }}', { method: 'DELETE' })"));
}

#[test]
fn test_scaffold_api_emits_json_controller_and_no_views() {
    let files = ScaffoldGenerator
        .generate(&["Post", "title:string", "--api"])
        .unwrap();
    let paths: Vec<&str> = files.iter().map(|f| f.path.as_str()).collect();

    // No view templates in API mode.
    assert!(!paths.iter().any(|p| p.contains("app/views/")));

    let ctrl = files
        .iter()
        .find(|f| f.path == "app/controllers/posts_controller.rs")
        .unwrap();
    assert!(ctrl.content.contains("ctx.json("));
    assert!(ctrl.content.contains("ctx.body_json()"));
    assert!(!ctrl.content.contains("ctx.render("));

    // API controllers have no new/edit form actions, so the injected route must
    // exclude them — otherwise `resources!` references methods that don't exist.
    let routes = files.iter().find(|f| f.path == "config/routes.rs").unwrap();
    assert!(routes
        .content
        .contains("resources!(posts, PostsController, except: [new, edit]);"));
}

#[test]
fn test_default_registry_has_all_generators() {
    let reg = default_registry();
    let names = reg.list();
    assert!(names.contains(&"controller"));
    assert!(names.contains(&"model"));
    assert!(names.contains(&"migration"));
    assert!(names.contains(&"job"));
    assert!(names.contains(&"mailer"));
    assert!(names.contains(&"channel"));
    assert!(names.contains(&"scaffold"));
}

#[test]
fn test_registry_runs_generator_by_name() {
    let reg = default_registry();
    let files = reg.run("controller", &["Admin"]).unwrap();
    assert_eq!(files[0].path, "src/controllers/admin_controller.rs");
}

#[test]
fn test_generator_missing_arg_returns_error() {
    let result = ControllerGenerator.generate(&[]);
    assert!(result.is_err());
}

#[test]
fn test_registry_unknown_generator_returns_error() {
    let reg = default_registry();
    assert!(reg.run("nonexistent", &[]).is_err());
}

// --- Template overrides + project generators ---

use doido_generators::{project_generator, templates, GeneratorGenerator, TemplatesGenerator};
use std::fs;
use tempfile::tempdir;

#[test]
fn test_resolve_prefers_project_override() {
    let dir = tempdir().unwrap();
    let rel = "controller/controller.rs.template";
    // No override file yet → built-in default is returned.
    let default = templates::get_with_root(dir.path(), rel);
    assert!(default.contains("{pascal}Controller"));

    // Write a project override; now it wins.
    fs::create_dir_all(dir.path().join("controller")).unwrap();
    fs::write(dir.path().join(rel), "OVERRIDDEN {pascal}").unwrap();
    let overridden = templates::get_with_root(dir.path(), rel);
    assert_eq!(overridden, "OVERRIDDEN {pascal}");
}

#[test]
fn test_templates_generator_ejects_all_and_filtered() {
    // No arg → ejects everything under templates/.
    let all = TemplatesGenerator.generate(&[]).unwrap();
    assert!(all
        .iter()
        .any(|f| f.path == "templates/scaffold/views/index.html.tera"));
    assert!(all
        .iter()
        .any(|f| f.path == "templates/controller/controller.rs.template"));

    // Filtered by generator name → only that prefix.
    let scaffold = TemplatesGenerator.generate(&["scaffold"]).unwrap();
    assert!(scaffold
        .iter()
        .all(|f| f.path.starts_with("templates/scaffold/")));
    assert!(scaffold.len() < all.len());

    // Unknown generator name errors.
    assert!(TemplatesGenerator.generate(&["bogus"]).is_err());
}

#[test]
fn test_generator_generator_scaffolds_project_generator() {
    let files = GeneratorGenerator.generate(&["Widget"]).unwrap();
    assert!(files
        .iter()
        .any(|f| f.path == "lib/generators/widget/app/widgets/{snake}.rs.template"));
    assert!(files
        .iter()
        .any(|f| f.path == "lib/generators/widget/README.md"));
}

#[test]
fn test_project_generator_substitutes_path_and_content() {
    let root = tempdir().unwrap();
    let gen_dir = root.path().join("widget");
    fs::create_dir_all(gen_dir.join("app/{plural}")).unwrap();
    fs::write(
        gen_dir.join("app/{plural}/{snake}.rs.template"),
        "pub struct {pascal}; // {plural}\n",
    )
    .unwrap();
    fs::write(gen_dir.join("README.md"), "ignored").unwrap();

    // Listing finds the generator directory (and ignores stray files).
    fs::write(root.path().join("notes.txt"), "x").unwrap();
    assert_eq!(
        project_generator::list_in(root.path()),
        vec!["widget".to_string()]
    );

    // Discovered under the root, then processed with a name argument.
    let dir = project_generator::find_in(root.path(), "widget").unwrap();
    let files = project_generator::run(&dir, &["BlogPost"]).unwrap();

    assert_eq!(files.len(), 1); // README.md skipped
    let f = &files[0];
    assert_eq!(f.path, "app/blog_posts/blog_post.rs"); // tokens + .template stripped
    assert_eq!(f.content, "pub struct BlogPost; // blog_posts\n");
}