sz-rust-cli 1.4.0

SZ-Rust 命令行工具:项目脚手架、数据库迁移、调度器管理
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
// SPDX-License-Identifier: Apache-2.0
// Copyright (c) 2024-2026 SZ-Rust Team
//
//! 模板上下文构建器
//!
//! 对应 design.md 第 2.2.2.5 节,从 CLI 参数构建 Tera 渲染上下文。

use tera::Context;

use crate::error::CliError;
use crate::field_parser::{Field, FieldParser};

/// `make:plugin` 命令参数
#[derive(Debug, Clone)]
pub struct PluginCommandArgs {
    /// 模板类型(必填,如 "crud" 或 "master-slave")
    pub template: String,
    /// 插件名称(必填)
    pub name: String,
    /// 表名(可选,默认取插件名 snake_case)
    pub table: Option<String>,
    /// 字段定义(可选,如 "id:i32:pk,name:String")
    pub fields: Option<String>,
    /// 是否强制覆盖已存在目录
    pub force: bool,
    /// 输出目录(可选,默认 `plugins/<name>/`)
    pub output: Option<String>,
    /// 主表名(主从模板,可选)
    pub master: Option<String>,
    /// 从表名(主从模板,可选)
    pub slave: Option<String>,
    /// 主表字段定义(主从模板,可选)
    pub master_fields: Option<String>,
    /// 从表字段定义(主从模板,可选)
    pub slave_fields: Option<String>,
    /// 外键字段名(主从模板,可选)
    pub foreign_key: Option<String>,
}

/// 模板上下文构建器
pub struct TemplateContextBuilder {
    args: PluginCommandArgs,
}

impl TemplateContextBuilder {
    /// 创建新的上下文构建器
    pub fn new(args: PluginCommandArgs) -> Self {
        Self { args }
    }

    /// 构建 CRUD 模板上下文
    ///
    /// 含 6 个必需变量:plugin_name, table_name, class_name, fields, module_path, template_version
    /// 外加 generated_at, primary_key_name, primary_key_type
    pub fn build(&self) -> Result<Context, CliError> {
        let table_name = self
            .args
            .table
            .clone()
            .unwrap_or_else(|| to_snake_case(&self.args.name));

        let class_name = to_pascal_case(&table_name);

        let fields_str = self
            .args
            .fields
            .as_deref()
            .unwrap_or("id:i32:pk,name:String");
        let fields = FieldParser::parse(fields_str)?;

        let (pk_name, pk_type) = find_primary_key(&fields);

        let module_path = format!("plugins::{}", to_snake_case(&self.args.name));

        let fields_json: Vec<serde_json::Value> = fields
            .iter()
            .map(|f| {
                serde_json::json!({
                    "name": f.name,
                    "rust_type": f.rust_type,
                    "sql_type": f.sql_type,
                    "is_nullable": f.is_nullable,
                    "is_primary_key": f.is_primary_key,
                    "is_indexed": f.is_indexed,
                })
            })
            .collect();

        let mut ctx = Context::new();
        ctx.insert("plugin_name", &self.args.name);
        ctx.insert("table_name", &table_name);
        ctx.insert("class_name", &class_name);
        ctx.insert("fields", &fields_json);
        ctx.insert("module_path", &module_path);
        ctx.insert("template_type", &self.args.template);
        ctx.insert("template_version", "1.0.0");
        ctx.insert("generated_at", &current_timestamp());
        ctx.insert("primary_key_name", &pk_name);
        ctx.insert("primary_key_type", &pk_type);

        Ok(ctx)
    }

    /// 构建主从模板上下文
    ///
    /// 额外含 master_table, slave_table, foreign_key, master_fields, slave_fields
    pub fn build_master_slave(&self) -> Result<Context, CliError> {
        let master_table = self.args.master.clone().ok_or_else(|| {
            CliError::Generic("--master is required for master-slave template".to_string())
        })?;

        let slave_table = self.args.slave.clone().ok_or_else(|| {
            CliError::Generic("--slave is required for master-slave template".to_string())
        })?;

        if master_table == slave_table {
            return Err(CliError::MasterSlaveSame);
        }

        let foreign_key = self.args.foreign_key.clone().ok_or_else(|| {
            CliError::Generic("--foreign-key is required for master-slave template".to_string())
        })?;

        let master_fields_str = self
            .args
            .master_fields
            .as_deref()
            .unwrap_or("id:i32:pk,name:String");
        let slave_fields_str = self.args.slave_fields.as_deref().unwrap_or("id:i32:pk");

        let master_fields = FieldParser::parse(master_fields_str)?;
        let slave_fields = FieldParser::parse(slave_fields_str)?;

        crate::validator::InputValidator::validate_foreign_key(&foreign_key, &slave_fields)?;

        let (master_pk_name, master_pk_type) = find_primary_key(&master_fields);

        let master_fields_json: Vec<serde_json::Value> = fields_to_json(&master_fields);
        let slave_fields_json: Vec<serde_json::Value> = fields_to_json(&slave_fields);

        let master_class_name = to_pascal_case(&master_table);
        let slave_class_name = to_pascal_case(&slave_table);
        let module_path = format!("plugins::{}", to_snake_case(&self.args.name));

        let mut ctx = Context::new();
        ctx.insert("plugin_name", &self.args.name);
        ctx.insert("table_name", &master_table);
        ctx.insert("class_name", &master_class_name);
        ctx.insert("fields", &master_fields_json);
        ctx.insert("module_path", &module_path);
        ctx.insert("template_type", &self.args.template);
        ctx.insert("template_version", "1.0.0");
        ctx.insert("generated_at", &current_timestamp());
        ctx.insert("primary_key_name", &master_pk_name);
        ctx.insert("primary_key_type", &master_pk_type);

        ctx.insert("master_table", &master_table);
        ctx.insert("slave_table", &slave_table);
        ctx.insert("master_class_name", &master_class_name);
        ctx.insert("slave_class_name", &slave_class_name);
        ctx.insert("master_fields", &master_fields_json);
        ctx.insert("slave_fields", &slave_fields_json);
        ctx.insert("foreign_key", &foreign_key);

        Ok(ctx)
    }

    /// 返回参数引用
    pub fn args(&self) -> &PluginCommandArgs {
        &self.args
    }
}

/// snake_case 转换
fn to_snake_case(s: &str) -> String {
    let mut result = String::new();
    for (i, ch) in s.chars().enumerate() {
        if ch.is_uppercase() {
            if i > 0 {
                result.push('_');
            }
            result.push(ch.to_ascii_lowercase());
        } else if ch == '-' {
            result.push('_');
        } else {
            result.push(ch);
        }
    }
    result
}

/// PascalCase 转换
fn to_pascal_case(s: &str) -> String {
    let mut result = String::new();
    let mut next_upper = true;
    for ch in s.chars() {
        if ch == '_' || ch == '-' || ch == ' ' {
            next_upper = true;
        } else if next_upper {
            result.push(ch.to_ascii_uppercase());
            next_upper = false;
        } else {
            result.push(ch);
        }
    }
    result
}

/// 查找主键字段
fn find_primary_key(fields: &[Field]) -> (String, String) {
    for f in fields {
        if f.is_primary_key {
            return (f.name.clone(), f.rust_type.clone());
        }
    }
    ("id".to_string(), "i32".to_string())
}

/// 字段列表转 JSON
fn fields_to_json(fields: &[Field]) -> Vec<serde_json::Value> {
    fields
        .iter()
        .map(|f| {
            serde_json::json!({
                "name": f.name,
                "rust_type": f.rust_type,
                "sql_type": f.sql_type,
                "is_nullable": f.is_nullable,
                "is_primary_key": f.is_primary_key,
                "is_indexed": f.is_indexed,
            })
        })
        .collect()
}

/// 当前时间戳
fn current_timestamp() -> String {
    chrono::Utc::now()
        .format("%Y-%m-%d %H:%M:%S UTC")
        .to_string()
}

#[cfg(test)]
mod tests {
    use super::*;

    fn make_crud_args() -> PluginCommandArgs {
        PluginCommandArgs {
            template: "crud".to_string(),
            name: "user-management".to_string(),
            table: Some("users".to_string()),
            fields: Some("id:i32:pk,name:String,age:i32".to_string()),
            force: false,
            output: None,
            master: None,
            slave: None,
            master_fields: None,
            slave_fields: None,
            foreign_key: None,
        }
    }

    #[test]
    fn test_build_crud_context() {
        let builder = TemplateContextBuilder::new(make_crud_args());
        let ctx = builder.build().unwrap();

        assert_eq!(ctx.get("plugin_name").unwrap(), "user-management");
        assert_eq!(ctx.get("table_name").unwrap(), "users");
        assert_eq!(ctx.get("class_name").unwrap(), "Users");
        assert_eq!(ctx.get("template_type").unwrap(), "crud");
        assert!(ctx.get("generated_at").is_some());
        assert_eq!(ctx.get("primary_key_name").unwrap(), "id");
        assert_eq!(ctx.get("primary_key_type").unwrap(), "i32");
    }

    #[test]
    fn test_build_crud_default_table() {
        let mut args = make_crud_args();
        args.table = None;
        let builder = TemplateContextBuilder::new(args);
        let ctx = builder.build().unwrap();
        assert_eq!(ctx.get("table_name").unwrap(), "user_management");
    }

    #[test]
    fn test_build_crud_default_fields() {
        let mut args = make_crud_args();
        args.fields = None;
        let builder = TemplateContextBuilder::new(args);
        let ctx = builder.build().unwrap();
        assert!(ctx.get("fields").is_some());
    }

    #[test]
    fn test_build_master_slave_context() {
        let args = PluginCommandArgs {
            template: "master-slave".to_string(),
            name: "order-plugin".to_string(),
            table: None,
            fields: None,
            force: false,
            output: None,
            master: Some("users".to_string()),
            slave: Some("orders".to_string()),
            master_fields: Some("id:i32:pk,name:String".to_string()),
            slave_fields: Some("id:i32:pk,user_id:i32,total:f64".to_string()),
            foreign_key: Some("user_id".to_string()),
        };
        let builder = TemplateContextBuilder::new(args);
        let ctx = builder.build_master_slave().unwrap();

        assert_eq!(ctx.get("master_table").unwrap(), "users");
        assert_eq!(ctx.get("slave_table").unwrap(), "orders");
        assert_eq!(ctx.get("master_class_name").unwrap(), "Users");
        assert_eq!(ctx.get("slave_class_name").unwrap(), "Orders");
        assert_eq!(ctx.get("foreign_key").unwrap(), "user_id");
    }

    #[test]
    fn test_build_master_slave_same_table() {
        let args = PluginCommandArgs {
            template: "master-slave".to_string(),
            name: "test".to_string(),
            table: None,
            fields: None,
            force: false,
            output: None,
            master: Some("users".to_string()),
            slave: Some("users".to_string()),
            master_fields: Some("id:i32:pk".to_string()),
            slave_fields: Some("id:i32:pk".to_string()),
            foreign_key: Some("id".to_string()),
        };
        let builder = TemplateContextBuilder::new(args);
        let result = builder.build_master_slave();
        assert!(result.is_err());
        assert!(matches!(result.unwrap_err(), CliError::MasterSlaveSame));
    }

    #[test]
    fn test_build_master_slave_fk_not_found() {
        let args = PluginCommandArgs {
            template: "master-slave".to_string(),
            name: "test".to_string(),
            table: None,
            fields: None,
            force: false,
            output: None,
            master: Some("users".to_string()),
            slave: Some("orders".to_string()),
            master_fields: Some("id:i32:pk,name:String".to_string()),
            slave_fields: Some("id:i32:pk,total:f64".to_string()),
            foreign_key: Some("user_id".to_string()),
        };
        let builder = TemplateContextBuilder::new(args);
        let result = builder.build_master_slave();
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            CliError::ForeignKeyNotFound(_)
        ));
    }

    #[test]
    fn test_to_snake_case() {
        assert_eq!(to_snake_case("UserManagement"), "user_management");
        assert_eq!(to_snake_case("user-management"), "user_management");
        assert_eq!(to_snake_case("user_management"), "user_management");
    }

    #[test]
    fn test_to_pascal_case() {
        assert_eq!(to_pascal_case("users"), "Users");
        assert_eq!(to_pascal_case("user_orders"), "UserOrders");
        assert_eq!(to_pascal_case("user-orders"), "UserOrders");
        assert_eq!(to_pascal_case("UserOrders"), "UserOrders");
    }

    #[test]
    fn test_find_primary_key() {
        let fields = vec![
            Field {
                name: "name".to_string(),
                rust_type: "String".to_string(),
                sql_type: "VARCHAR(255)".to_string(),
                is_nullable: false,
                is_primary_key: false,
                is_indexed: false,
            },
            Field {
                name: "id".to_string(),
                rust_type: "i64".to_string(),
                sql_type: "BIGINT".to_string(),
                is_nullable: false,
                is_primary_key: true,
                is_indexed: false,
            },
        ];
        let (name, ty) = find_primary_key(&fields);
        assert_eq!(name, "id");
        assert_eq!(ty, "i64");
    }

    #[test]
    fn test_find_primary_key_default() {
        let fields = vec![Field {
            name: "name".to_string(),
            rust_type: "String".to_string(),
            sql_type: "VARCHAR(255)".to_string(),
            is_nullable: false,
            is_primary_key: false,
            is_indexed: false,
        }];
        let (name, ty) = find_primary_key(&fields);
        assert_eq!(name, "id");
        assert_eq!(ty, "i32");
    }

    #[test]
    fn test_build_master_slave_missing_master() {
        let args = PluginCommandArgs {
            template: "master-slave".to_string(),
            name: "test".to_string(),
            table: None,
            fields: None,
            force: false,
            output: None,
            master: None,
            slave: Some("orders".to_string()),
            master_fields: None,
            slave_fields: None,
            foreign_key: None,
        };
        let builder = TemplateContextBuilder::new(args);
        let result = builder.build_master_slave();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("--master is required"));
    }

    #[test]
    fn test_build_master_slave_missing_slave() {
        let args = PluginCommandArgs {
            template: "master-slave".to_string(),
            name: "test".to_string(),
            table: None,
            fields: None,
            force: false,
            output: None,
            master: Some("users".to_string()),
            slave: None,
            master_fields: None,
            slave_fields: None,
            foreign_key: None,
        };
        let builder = TemplateContextBuilder::new(args);
        let result = builder.build_master_slave();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("--slave is required"));
    }

    #[test]
    fn test_build_master_slave_missing_foreign_key() {
        let args = PluginCommandArgs {
            template: "master-slave".to_string(),
            name: "test".to_string(),
            table: None,
            fields: None,
            force: false,
            output: None,
            master: Some("users".to_string()),
            slave: Some("orders".to_string()),
            master_fields: None,
            slave_fields: None,
            foreign_key: None,
        };
        let builder = TemplateContextBuilder::new(args);
        let result = builder.build_master_slave();
        assert!(result.is_err());
        assert!(result
            .unwrap_err()
            .to_string()
            .contains("--foreign-key is required"));
    }

    #[test]
    fn test_args_accessor() {
        let args = make_crud_args();
        let builder = TemplateContextBuilder::new(args.clone());
        assert_eq!(builder.args().name, args.name);
        assert_eq!(builder.args().template, args.template);
    }

    #[test]
    fn test_to_snake_case_lowercase_input() {
        assert_eq!(to_snake_case("users"), "users");
        assert_eq!(to_snake_case(""), "");
    }

    #[test]
    fn test_to_pascal_case_empty() {
        assert_eq!(to_pascal_case(""), "");
        assert_eq!(to_pascal_case("a"), "A");
    }

    #[test]
    fn test_fields_to_json_empty() {
        let json = fields_to_json(&[]);
        assert!(json.is_empty());
    }
}