puerto 0.11.0

Puerto — Rust full-stack DDD framework CLI. Scaffolds Clean Architecture projects with auto-wired DI, SQLx support, and zero manual wiring. Formerly puerto-framework.
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

use super::*;

// ── puerto generate use-case ──────────────────────────────────────────────

pub(super) fn setup_use_case_stubs(base: &Path) {
    fs::write(
        base.join("puerto.toml"),
        "[project]\nname = \"test-app\"\n\n[[entity]]\nname = \"Product\"\nuse_cases = [\"create_product\"]\n",
    )
    .unwrap();

    fs::create_dir_all(base.join("business/src/domain/product")).unwrap();
    fs::write(
        base.join("business/src/lib.rs"),
        "pub mod domain {\n    pub mod product {\n        pub mod errors;\n        pub mod model;\n        pub mod repository;\n        pub mod use_cases {\n            pub mod create_product;\n        }\n    }\n}\npub mod application {\n    pub mod product {\n        pub mod create_product;\n    }\n}\n",
    )
    .unwrap();

    fs::create_dir_all(base.join("business/src/application/product")).unwrap();
}

#[test]
fn use_case_creates_trait_file() {
    let dir = temp_dir("uc_trait");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    setup_use_case_stubs(&dir);
    scaffold::run_use_case("Product", "delete_product", &dir).unwrap();

    assert!(
        dir.join("business/src/domain/product/use_cases/delete_product.rs")
            .exists()
    );

    cleanup(&dir);
}

#[test]
fn use_case_creates_impl_file() {
    let dir = temp_dir("uc_impl");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    setup_use_case_stubs(&dir);
    scaffold::run_use_case("Product", "delete_product", &dir).unwrap();

    assert!(
        dir.join("business/src/application/product/delete_product.rs")
            .exists()
    );

    cleanup(&dir);
}

#[test]
fn use_case_trait_file_has_correct_content() {
    let dir = temp_dir("uc_trait_content");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    setup_use_case_stubs(&dir);
    scaffold::run_use_case("Product", "delete_product", &dir).unwrap();

    let content =
        fs::read_to_string(dir.join("business/src/domain/product/use_cases/delete_product.rs"))
            .unwrap();
    assert!(content.contains("DeleteProductParams"));
    assert!(content.contains("DeleteProductUseCaseTrait"));

    cleanup(&dir);
}

#[test]
fn use_case_impl_file_has_correct_content() {
    let dir = temp_dir("uc_impl_content");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    setup_use_case_stubs(&dir);
    scaffold::run_use_case("Product", "delete_product", &dir).unwrap();

    let content =
        fs::read_to_string(dir.join("business/src/application/product/delete_product.rs")).unwrap();
    assert!(content.contains("DeleteProductUseCaseImpl"));
    assert!(content.contains("ProductRepositoryTrait"));
    assert!(content.contains("DeleteProductUseCaseTrait"));

    cleanup(&dir);
}

#[test]
fn use_case_patches_business_lib_rs() {
    let dir = temp_dir("uc_patch_lib");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    setup_use_case_stubs(&dir);
    scaffold::run_use_case("Product", "delete_product", &dir).unwrap();

    let content = fs::read_to_string(dir.join("business/src/lib.rs")).unwrap();
    assert!(content.contains("pub mod delete_product;"));
    assert!(content.contains("pub mod create_product;")); // existing preserved
    assert_eq!(content.matches("pub mod delete_product;").count(), 2); // domain + application

    cleanup(&dir);
}

#[test]
fn use_case_updates_puerto_toml() {
    let dir = temp_dir("uc_puerto_toml");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    setup_use_case_stubs(&dir);
    scaffold::run_use_case("Product", "delete_product", &dir).unwrap();

    let content = fs::read_to_string(dir.join("puerto.toml")).unwrap();
    assert!(content.contains("delete_product"));
    assert!(content.contains("create_product")); // existing preserved

    cleanup(&dir);
}

#[test]
fn use_case_regenerates_bootstrap() {
    let dir = temp_dir("uc_bootstrap");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    setup_use_case_stubs(&dir);
    scaffold::run_use_case("Product", "delete_product", &dir).unwrap();

    let content = fs::read_to_string(dir.join("presentation/src/generated/bootstrap.rs")).unwrap();
    assert!(content.contains("DeleteProductUseCaseImpl"));
    assert!(content.contains("CreateProductUseCaseImpl"));

    cleanup(&dir);
}

#[test]
fn use_case_normalizes_entity_casing() {
    let dir = temp_dir("uc_normalize");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    setup_use_case_stubs(&dir);
    scaffold::run_use_case("product", "delete_product", &dir).unwrap();

    assert!(
        dir.join("business/src/domain/product/use_cases/delete_product.rs")
            .exists()
    );

    cleanup(&dir);
}

#[test]
fn use_case_errors_when_entity_not_in_puerto_toml() {
    let dir = temp_dir("uc_missing_entity");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    setup_use_case_stubs(&dir);

    let result = scaffold::run_use_case("NonExistent", "do_something", &dir);
    assert!(result.is_err());

    cleanup(&dir);
}

#[test]
fn use_case_rerun_is_refused_and_leaves_files_untouched() {
    // Running the same `generate use-case` twice used to rewrite both files with the `todo!()`
    // stub and still print "added" — silently discarding whatever had been implemented since.
    let dir = temp_dir("uc_rerun_refused");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    setup_use_case_stubs(&dir);
    scaffold::run_use_case("Product", "delete_product", &dir).unwrap();
    let impl_path = dir.join("business/src/application/product/delete_product.rs");
    fs::write(&impl_path, "// implemented by hand\n").unwrap();

    let result = scaffold::run_use_case("Product", "delete_product", &dir);

    assert!(result.is_err(), "a second run must be refused");
    assert!(result.unwrap_err().to_string().contains("already exists"));
    assert_eq!(
        fs::read_to_string(&impl_path).unwrap(),
        "// implemented by hand\n"
    );
    let toml = fs::read_to_string(dir.join("puerto.toml")).unwrap();
    assert_eq!(toml.matches("delete_product").count(), 1);

    cleanup(&dir);
}

// ── T-13: review fixes — generate use-case ────────────────────────────────

#[test]
fn use_case_rejects_an_action_that_is_not_snake_case() {
    let dir = temp_dir("uc_not_snake");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    setup_use_case_stubs(&dir);

    let result = scaffold::run_use_case("Product", "ArchiveProduct", &dir);

    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("snake_case"));
    assert!(
        !dir.join("business/src/application/product/ArchiveProduct.rs")
            .exists()
    );
    assert!(
        !fs::read_to_string(dir.join("puerto.toml"))
            .unwrap()
            .contains("ArchiveProduct")
    );

    cleanup(&dir);
}

#[test]
fn use_case_refuses_to_replace_a_scaffolded_crud_use_case() {
    // `generate use-case Item create_item` replaced the working CRUD impl with a `todo!()` stub.
    let dir = temp_dir("uc_crud_clash");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    let output = generate_project("uc-crud-clash", &dir).unwrap();
    scaffold::run_scaffold(
        "Product",
        &output,
        &[scaffold_test_field("title", "String")],
        OverwritePolicy::Ask,
    )
    .unwrap();
    let impl_path = output.join("business/src/application/product/create_product.rs");
    let before = fs::read_to_string(&impl_path).unwrap();

    let result = scaffold::run_use_case("Product", "create_product", &output);

    assert!(result.is_err());
    assert!(result.unwrap_err().to_string().contains("already exists"));
    assert_eq!(fs::read_to_string(&impl_path).unwrap(), before);

    cleanup(&dir);
}

#[test]
fn use_case_adds_its_field_to_the_entity_api_struct() {
    let dir = temp_dir("uc_routes_field");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    let output = generate_project("uc-routes-field", &dir).unwrap();
    scaffold::run_scaffold(
        "Product",
        &output,
        &[scaffold_test_field("title", "String")],
        OverwritePolicy::Ask,
    )
    .unwrap();

    scaffold::run_use_case("Product", "archive_product", &output).unwrap();

    let routes = fs::read_to_string(output.join("presentation/src/api/product/routes.rs")).unwrap();
    assert!(routes.contains("pub archive_product: Arc<dyn ArchiveProductUseCaseTrait>,"));
    assert!(routes.contains(
        "use business::domain::product::use_cases::archive_product::ArchiveProductUseCaseTrait;"
    ));
    assert!(!routes.contains("UseCaseImpl"), "{routes}");

    cleanup(&dir);
}

#[test]
fn rescaffold_with_force_keeps_custom_use_case_in_the_api_struct() {
    // The custom use case survives in puerto.toml (and so in bootstrap.rs); routes.rs is
    // rewritten from the CRUD template — it must get the field back or bootstrap stops compiling.
    let dir = temp_dir("uc_routes_force");
    cleanup(&dir);
    fs::create_dir_all(&dir).unwrap();
    let output = generate_project("uc-routes-force", &dir).unwrap();
    let fields = [scaffold_test_field("title", "String")];
    scaffold::run_scaffold("Product", &output, &fields, OverwritePolicy::Ask).unwrap();
    scaffold::run_use_case("Product", "archive_product", &output).unwrap();

    scaffold::run_scaffold("Product", &output, &fields, OverwritePolicy::Force).unwrap();

    let routes = fs::read_to_string(output.join("presentation/src/api/product/routes.rs")).unwrap();
    assert_eq!(
        routes
            .matches("pub archive_product: Arc<dyn ArchiveProductUseCaseTrait>,")
            .count(),
        1
    );

    cleanup(&dir);
}