rjango 0.1.1

A full-stack Rust backend framework inspired by Django
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

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct AppTemplateConfig {
    pub app_name: String,
    pub include_urls: bool,
    pub include_tests: bool,
}

impl Default for AppTemplateConfig {
    fn default() -> Self {
        Self::new("app")
    }
}

impl AppTemplateConfig {
    #[must_use]
    pub fn new(app_name: impl Into<String>) -> Self {
        let app_name = canonical_name(app_name.into(), "app");

        Self {
            app_name,
            include_urls: true,
            include_tests: true,
        }
    }

    #[must_use]
    pub fn with_urls(mut self, value: bool) -> Self {
        self.include_urls = value;
        self
    }

    #[must_use]
    pub fn with_tests(mut self, value: bool) -> Self {
        self.include_tests = value;
        self
    }

    #[must_use]
    pub fn module_name(&self) -> String {
        normalize_identifier(&self.app_name, "app")
    }

    #[must_use]
    pub fn model_struct_name(&self) -> String {
        format!("{}Model", pascal_case(&self.module_name()))
    }

    #[must_use]
    pub fn scaffold_files(&self) -> Vec<&'static str> {
        let mut files = vec!["mod.rs", "models.rs", "views.rs"];
        if self.include_urls {
            files.push("urls.rs");
        }
        if self.include_tests {
            files.push("tests.rs");
        }
        files
    }
}

pub(crate) fn normalize_identifier(name: &str, fallback: &str) -> String {
    let mut normalized = String::new();
    let mut last_was_separator = false;

    for ch in name.chars() {
        if ch.is_ascii_alphanumeric() {
            normalized.push(ch.to_ascii_lowercase());
            last_was_separator = false;
        } else if !normalized.is_empty() && !last_was_separator {
            normalized.push('_');
            last_was_separator = true;
        }
    }

    let normalized = normalized.trim_matches('_');
    if normalized.is_empty() {
        return String::from(fallback);
    }

    if normalized
        .chars()
        .next()
        .is_some_and(|first| first.is_ascii_digit())
    {
        format!("{fallback}_{normalized}")
    } else {
        normalized.to_owned()
    }
}

fn canonical_name(name: String, fallback: &str) -> String {
    let trimmed = name.trim();
    if trimmed.is_empty() {
        String::from(fallback)
    } else {
        trimmed.to_owned()
    }
}

fn pascal_case(name: &str) -> String {
    let mut result = String::new();

    for segment in name.split('_').filter(|segment| !segment.is_empty()) {
        let mut chars = segment.chars();
        if let Some(first) = chars.next() {
            result.extend(first.to_uppercase());
            result.extend(chars);
        }
    }

    if result.is_empty() {
        String::from("App")
    } else {
        result
    }
}

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

    #[test]
    fn default_config_enables_standard_app_files() {
        let config = AppTemplateConfig::default();

        assert_eq!(config.app_name, "app");
        assert_eq!(config.module_name(), "app");
        assert_eq!(
            config.scaffold_files(),
            vec!["mod.rs", "models.rs", "views.rs", "urls.rs", "tests.rs"]
        );
    }

    #[test]
    fn module_name_is_normalized_for_rust_modules() {
        let config = AppTemplateConfig::new("Blog Posts");

        assert_eq!(config.module_name(), "blog_posts");
        assert_eq!(config.model_struct_name(), "BlogPostsModel");
    }

    #[test]
    fn file_list_honors_optional_urls_and_tests() {
        let config = AppTemplateConfig::new("billing")
            .with_urls(false)
            .with_tests(false);

        assert_eq!(
            config.scaffold_files(),
            vec!["mod.rs", "models.rs", "views.rs"]
        );
    }

    #[test]
    fn module_name_prefixes_leading_digits() {
        let config = AppTemplateConfig::new("123 reports");

        assert_eq!(config.module_name(), "app_123_reports");
    }
}