Skip to main content

doido_generators/generators/
scaffold.rs

1use crate::generator::{GeneratedFile, Generator};
2use crate::generators::controller::{
3    read_controllers_mod, register_controller_in_mod, CONTROLLERS_MOD_PATH,
4};
5use crate::generators::field::Field;
6use crate::generators::helper::{
7    helper_names, helpers_mod_path, read_helpers_mod, register_helper_in_mod, render_helper_content,
8};
9use crate::generators::model::ModelGenerator;
10use crate::generators::{to_pascal, to_snake, to_table_name};
11use doido_core::Result;
12
13/// Fallback used when the app doesn't have `config/routes.rs` on disk yet.
14const ROUTES_BASE: &str = include_str!("../../templates/new/config/routes.rs");
15
16const ROUTES_PATH: &str = "config/routes.rs";
17
18pub struct ScaffoldGenerator;
19
20impl Generator for ScaffoldGenerator {
21    fn name(&self) -> &str {
22        "scaffold"
23    }
24
25    fn generate(&self, args: &[&str]) -> Result<Vec<GeneratedFile>> {
26        let api = args.contains(&"--api");
27        // Positional args (name + field specs); flags filtered out.
28        let positional: Vec<&str> = args
29            .iter()
30            .copied()
31            .filter(|a| !a.starts_with("--"))
32            .collect();
33        let name = positional.first().copied().ok_or_else(|| {
34            doido_core::anyhow::anyhow!("scaffold generator requires a name argument")
35        })?;
36        let fields = Field::parse_all(&positional[1..])?;
37
38        let singular = to_snake(name); // post
39        let plural = to_table_name(name); // posts
40        let model = to_pascal(name); // Post
41        let controller = format!("{}Controller", to_pascal(&plural)); // PostsController
42        let helper = format!("{}Helper", to_pascal(&plural)); // PostsHelper
43
44        let mut files = Vec::new();
45
46        // Model + migration + migration lib.rs + app/models/mod.rs.
47        files.extend(ModelGenerator.generate(&positional)?);
48
49        // Controller (HTML or API variant).
50        let controller_template = if api {
51            crate::templates::get("scaffold/controller_api.rs.template")
52        } else {
53            crate::templates::get("scaffold/controller_html.rs.template")
54        };
55        files.push(GeneratedFile {
56            path: format!("app/controllers/{plural}_controller.rs"),
57            content: render_controller(
58                &controller_template,
59                &singular,
60                &plural,
61                &model,
62                &controller,
63                &helper,
64                &fields,
65            ),
66        });
67
68        // Helper for shared controller logic.
69        let (helper_snake, _) = helper_names(&plural);
70        files.push(GeneratedFile {
71            path: format!("app/helpers/{helper_snake}.rs"),
72            content: render_helper_content(&plural, &plural),
73        });
74        files.push(GeneratedFile {
75            path: helpers_mod_path().to_string(),
76            content: register_helper_in_mod(&read_helpers_mod(), &plural),
77        });
78
79        // Register the controller module in app/controllers/mod.rs.
80        files.push(GeneratedFile {
81            path: CONTROLLERS_MOD_PATH.to_string(),
82            content: register_controller_in_mod(&read_controllers_mod(), &plural, &controller),
83        });
84
85        // Views (HTML mode only).
86        if !api {
87            for (file, rel) in [
88                ("index", "scaffold/views/index.html.tera"),
89                ("show", "scaffold/views/show.html.tera"),
90                ("new", "scaffold/views/new.html.tera"),
91                ("edit", "scaffold/views/edit.html.tera"),
92                ("_form", "scaffold/views/_form.html.tera"),
93            ] {
94                let template = crate::templates::get(rel);
95                files.push(GeneratedFile {
96                    path: format!("app/views/{plural}/{file}.html.tera"),
97                    content: render_view(&template, &singular, &plural, &model, &fields),
98                });
99            }
100
101            // Controller request tests — one per action (HTML mode only).
102            let test_template = crate::templates::get("scaffold/controller_test.rs.template");
103            files.push(GeneratedFile {
104                path: format!("tests/{plural}_controller_test.rs"),
105                content: render_controller(
106                    &test_template,
107                    &singular,
108                    &plural,
109                    &model,
110                    &controller,
111                    &helper,
112                    &fields,
113                ),
114            });
115        }
116
117        // Inject the RESTful routes into config/routes.rs.
118        let routes_existing =
119            std::fs::read_to_string(ROUTES_PATH).unwrap_or_else(|_| ROUTES_BASE.to_string());
120        files.push(GeneratedFile {
121            path: ROUTES_PATH.to_string(),
122            content: inject_route(&routes_existing, &plural, &controller, api),
123        });
124
125        Ok(files)
126    }
127}
128
129/// Fills the controller template's field-driven fragments and names.
130fn render_controller(
131    template: &str,
132    singular: &str,
133    plural: &str,
134    model: &str,
135    controller: &str,
136    helper: &str,
137    fields: &[Field],
138) -> String {
139    let params_fields: String = fields
140        .iter()
141        .map(|f| format!("    {}\n", f.params_struct_field()))
142        .collect();
143    let active_model_sets: String = fields
144        .iter()
145        .map(|f| format!("            {}\n", f.active_model_set()))
146        .collect();
147    let active_model_assigns: String = fields
148        .iter()
149        .map(|f| format!("            {}\n", f.active_model_assign()))
150        .collect();
151    // Sample urlencoded body for create/update request tests.
152    let form_body: String = fields
153        .iter()
154        .filter_map(Field::sample_form_pair)
155        .collect::<Vec<_>>()
156        .join("&");
157
158    template
159        .replace("{params_fields}", &params_fields)
160        .replace("{active_model_sets}", &active_model_sets)
161        .replace("{active_model_assigns}", &active_model_assigns)
162        .replace("{form_body}", &form_body)
163        .replace("{Controller}", controller)
164        .replace("{Helper}", helper)
165        .replace("{Model}", model)
166        .replace("{singular}", singular)
167        .replace("{plural}", plural)
168}
169
170/// Fills a view template's field-driven fragments and names.
171fn render_view(
172    template: &str,
173    singular: &str,
174    plural: &str,
175    model: &str,
176    fields: &[Field],
177) -> String {
178    let table_headers: String = fields
179        .iter()
180        .map(|f| format!("      <th>{}</th>\n", f.column_name()))
181        .collect();
182    let table_cells: String = fields
183        .iter()
184        .map(|f| format!("      <td>{{{{ {singular}.{} }}}}</td>\n", f.column_name()))
185        .collect();
186    let show_fields: String = fields
187        .iter()
188        .map(|f| {
189            let col = f.column_name();
190            format!("<p><strong>{col}:</strong> {{{{ {singular}.{col} }}}}</p>\n")
191        })
192        .collect();
193    let form_fields: String = fields.iter().map(form_field).collect();
194
195    template
196        .replace("{table_headers}", &table_headers)
197        .replace("{table_cells}", &table_cells)
198        .replace("{show_fields}", &show_fields)
199        .replace("{form_fields}", &form_fields)
200        .replace("{Model}", model)
201        .replace("{singular}", singular)
202        .replace("{plural}", plural)
203}
204
205/// One form control for a field, varying by HTML input type.
206fn form_field(f: &Field) -> String {
207    let col = f.column_name();
208    match f.html_input_type() {
209        "textarea" => {
210            format!("  <p><label>{col}</label> <textarea name=\"{col}\"></textarea></p>\n")
211        }
212        "checkbox" => {
213            format!("  <p><label>{col}</label> <input type=\"checkbox\" name=\"{col}\"></p>\n")
214        }
215        input => format!("  <p><label>{col}</label> <input type=\"{input}\" name=\"{col}\"></p>\n"),
216    }
217}
218
219/// Injects `use crate::controllers::<Controller>;` and a
220/// `resources!(<plural>, <Controller>);` line into `config/routes.rs`,
221/// preserving existing routes. Idempotent on the resources line.
222///
223/// API scaffolds omit the `new`/`edit` form actions (their controller has no
224/// such methods), so the injected route excludes them — mirroring Rails, where
225/// an API-only resource routes to only index/create/show/update/destroy.
226fn inject_route(routes: &str, plural: &str, controller: &str, api: bool) -> String {
227    let resources = if api {
228        format!("resources!({plural}, {controller}, except: [new, edit]);")
229    } else {
230        format!("resources!({plural}, {controller});")
231    };
232    if routes.contains(&resources) {
233        return routes.to_string();
234    }
235
236    let use_line = format!("use crate::controllers::{controller};");
237    let mut lines: Vec<String> = routes.lines().map(String::from).collect();
238
239    // Add the controller import after the last existing `use crate::controllers`
240    // line, or at the top otherwise.
241    if !routes.contains(&use_line) {
242        let pos = lines
243            .iter()
244            .rposition(|l| l.contains("use crate::controllers"))
245            .map(|i| i + 1)
246            .unwrap_or(0);
247        lines.insert(pos, use_line);
248    }
249
250    // Insert the resources! call as the last statement inside `routes! { … }`.
251    if let Some(open) = lines.iter().position(|l| l.contains("routes!")) {
252        // Find the matching closing brace of the routes! block.
253        if let Some(close_rel) = lines[open..].iter().position(|l| l.trim() == "}") {
254            let close = open + close_rel;
255            lines.insert(close, format!("        {resources}"));
256        }
257    }
258
259    let mut out = lines.join("\n");
260    out.push('\n');
261    out
262}