Skip to main content

forge_core/schema/
field.rs

1use serde::{Deserialize, Serialize};
2
3use super::types::{RustType, SqlType};
4
5/// Definition of a model field.
6#[derive(Debug, Clone, Serialize, Deserialize)]
7pub struct FieldDef {
8    /// Field name in Rust (snake_case).
9    pub name: String,
10
11    /// Column name in SQL (may differ from field name).
12    pub column_name: String,
13
14    /// Rust type.
15    pub rust_type: RustType,
16
17    /// SQL type.
18    pub sql_type: SqlType,
19
20    /// Whether the field is nullable.
21    pub nullable: bool,
22
23    /// Documentation comment.
24    pub doc: Option<String>,
25}
26
27impl FieldDef {
28    /// Create a new field definition.
29    pub fn new(name: &str, rust_type: RustType) -> Self {
30        let sql_type = rust_type.to_sql_type();
31        let nullable = rust_type.is_nullable();
32        let column_name = to_snake_case(name);
33
34        Self {
35            name: name.to_string(),
36            column_name,
37            rust_type,
38            sql_type,
39            nullable,
40            doc: None,
41        }
42    }
43}
44
45use crate::util::to_snake_case;
46
47#[cfg(test)]
48#[allow(clippy::unwrap_used, clippy::indexing_slicing)]
49mod tests {
50    use super::*;
51
52    #[test]
53    fn test_field_def_basic() {
54        let field = FieldDef::new("email", RustType::String);
55        assert_eq!(field.name, "email");
56        assert_eq!(field.column_name, "email");
57        assert!(!field.nullable);
58    }
59
60    #[test]
61    fn test_field_def_nullable() {
62        let field = FieldDef::new("avatar_url", RustType::Option(Box::new(RustType::String)));
63        assert!(field.nullable);
64    }
65
66    #[test]
67    fn test_to_snake_case() {
68        assert_eq!(to_snake_case("createdAt"), "created_at");
69        assert_eq!(to_snake_case("userId"), "user_id");
70        assert_eq!(to_snake_case("HTTPServer"), "http_server");
71    }
72}