runique 3.0.2

A Django-inspired web framework for Rust with ORM, templates, and comprehensive security middleware
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
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
//! Special fields: `ColorField`, `UUIDField`, `IPAddressField`, `JSONField`, `SlugField`.
use crate::forms::base::{CommonFieldConfig, FieldConfig, FormField};
use crate::utils::aliases::ATera;
use crate::utils::trad::{t, tf};
use async_trait::async_trait;
use serde::Serialize;
use serde_json::json;
use std::net::IpAddr;
use uuid::Uuid;

/// ColorField - HTML5 color selector
#[derive(Clone, Serialize, Debug)]
pub struct ColorField {
    pub base: FieldConfig,
}

impl ColorField {
    /// Creates a new color field rendered as an HTML5 `<input type="color">`.
    pub fn new(name: &str) -> Self {
        Self {
            base: FieldConfig::new(name, "color", "base_color.html"),
        }
    }

    /// Sets the field's display label.
    pub fn label(mut self, label: &str) -> Self {
        self.base.label = label.to_string();
        self
    }

    /// Marks the field as required; empty input fails validation.
    pub fn required(mut self) -> Self {
        self.set_required(true, None);
        self
    }

    /// Sets the default color value. Only accepted if it matches the `#RGB` or
    /// `#RRGGBB` hex format; otherwise the value passed in is silently ignored.
    pub fn default_color(mut self, color: &str) -> Self {
        // Validate the hex format
        if color.starts_with('#') && (color.len() == 7 || color.len() == 4) {
            self.base.value = color.to_string();
        }
        self
    }
}

impl CommonFieldConfig for ColorField {
    fn get_field_config(&self) -> &FieldConfig {
        &self.base
    }

    fn get_field_config_mut(&mut self) -> &mut FieldConfig {
        &mut self.base
    }
}

#[async_trait]
impl FormField for ColorField {
    async fn validate(&mut self) -> bool {
        let val = self.base.value.trim();

        if self.base.is_required.choice && val.is_empty() {
            let msg = self
                .base
                .is_required
                .message
                .clone()
                .unwrap_or_else(|| t("forms.required").to_string());
            self.set_error(msg);
            return false;
        }

        if !val.is_empty() {
            // Validate the hexadecimal format #RRGGBB or #RGB
            if !val.starts_with('#') {
                self.set_error(t("forms.color_no_hash").to_string());
                return false;
            }

            let hex = &val[1..];
            if hex.len() != 6 && hex.len() != 3 {
                self.set_error(t("forms.color_invalid").to_string());
                return false;
            }

            if !hex.chars().all(|c| c.is_ascii_hexdigit()) {
                self.set_error(t("forms.color_bad_hex").to_string());
                return false;
            }
        }

        self.clear_error();
        true
    }

    fn render(&self, tera: &ATera) -> Result<String, String> {
        let context = self.base_context();

        tera.render(&self.base.template_name, &context)
            .map_err(|e| {
                tf(
                    "forms.finalize_error",
                    &[&self.base.template_name, &e.to_string()],
                )
                .to_string()
            })
    }
}

/// SlugField - Field for URL-friendly slugs
#[derive(Clone, Serialize, Debug)]
pub struct SlugField {
    pub base: FieldConfig,
    /// When `true`, allows unicode letters and digits in the slug in addition
    /// to `-` and `_`; when `false` (the default), only ASCII alphanumerics are allowed.
    pub allow_unicode: bool,
}

impl CommonFieldConfig for SlugField {
    fn get_field_config(&self) -> &FieldConfig {
        &self.base
    }

    fn get_field_config_mut(&mut self) -> &mut FieldConfig {
        &mut self.base
    }
}

impl SlugField {
    /// Creates a new slug field with ASCII-only validation by default.
    pub fn new(name: &str) -> Self {
        Self {
            base: FieldConfig::new(name, "text", "base_special.html"),
            allow_unicode: false,
        }
    }

    /// Enables unicode letters and digits in slug validation, instead of
    /// restricting to ASCII alphanumerics.
    pub fn allow_unicode(mut self) -> Self {
        self.allow_unicode = true;
        self
    }
    /// Sets the placeholder text shown in the empty input.
    pub fn placeholder(mut self, p: &str) -> Self {
        self.set_placeholder(p);
        self
    }

    /// Sets the field's display label.
    pub fn label(mut self, label: &str) -> Self {
        self.set_label(label);
        self
    }

    /// Marks the field as required (empty value fails validation).
    pub fn required(mut self) -> Self {
        self.set_required(true, None);
        self
    }
}

#[async_trait]
impl FormField for SlugField {
    async fn validate(&mut self) -> bool {
        let val = self.base.value.trim();

        if self.base.is_required.choice && val.is_empty() {
            let msg = self
                .base
                .is_required
                .message
                .clone()
                .unwrap_or_else(|| t("forms.required").to_string());
            self.set_error(msg);
            return false;
        }

        if !val.is_empty() {
            // Slug validation
            if self.allow_unicode {
                // Unicode slug: letters, numbers, dashes, underscores
                let valid = val
                    .chars()
                    .all(|c| c.is_alphanumeric() || c == '-' || c == '_');
                if !valid {
                    self.set_error(t("forms.slug_unicode_invalid").to_string());
                    return false;
                }
            } else {
                // ASCII slug only
                let valid = val
                    .chars()
                    .all(|c| c.is_ascii_alphanumeric() || c == '-' || c == '_');
                if !valid {
                    self.set_error(t("forms.slug_invalid").to_string());
                    return false;
                }
            }

            // Must not start or end with a dash
            if val.starts_with('-') || val.ends_with('-') {
                self.set_error(t("forms.slug_no_dash").to_string());
                return false;
            }
        }

        self.clear_error();
        true
    }

    fn render(&self, tera: &ATera) -> Result<String, String> {
        let mut context = self.base_context();
        context.insert("field_hint", &t("forms.hint_slug").to_string());

        tera.render(&self.base.template_name, &context)
            .map_err(|e| {
                tf(
                    "forms.finalize_error",
                    &[&self.base.template_name, &e.to_string()],
                )
                .to_string()
            })
    }
}

/// UUIDField - Field for UUID identifiers
#[derive(Clone, Serialize, Debug)]
pub struct UUIDField {
    pub base: FieldConfig,
}

impl UUIDField {
    /// Creates a new UUID field rendered as a plain text input.
    pub fn new(name: &str) -> Self {
        Self {
            base: FieldConfig::new(name, "text", "base_special.html"),
        }
    }

    /// Sets the field's display label.
    pub fn label(mut self, label: &str) -> Self {
        self.base.label = label.to_string();
        self
    }

    /// Marks the field as required; empty input fails validation.
    pub fn required(mut self) -> Self {
        self.set_required(true, None);
        self
    }

    /// Sets the placeholder text shown in the empty input.
    pub fn placeholder(mut self, p: &str) -> Self {
        self.set_placeholder(p);
        self
    }
}

impl CommonFieldConfig for UUIDField {
    fn get_field_config(&self) -> &FieldConfig {
        &self.base
    }

    fn get_field_config_mut(&mut self) -> &mut FieldConfig {
        &mut self.base
    }
}

#[async_trait]
impl FormField for UUIDField {
    async fn validate(&mut self) -> bool {
        let val = self.base.value.trim();

        if self.base.is_required.choice && val.is_empty() {
            let msg = self
                .base
                .is_required
                .message
                .clone()
                .unwrap_or_else(|| t("forms.required").to_string());
            self.set_error(msg);
            return false;
        }

        if !val.is_empty() {
            // Validate the UUID format
            if Uuid::parse_str(val).is_err() {
                self.set_error(t("forms.uuid_invalid").to_string());
                return false;
            }
        }

        self.clear_error();
        true
    }

    fn render(&self, tera: &ATera) -> Result<String, String> {
        let mut context = self.base_context();
        context.insert("field_hint", &t("forms.hint_uuid").to_string());

        tera.render(&self.base.template_name, &context)
            .map_err(|e| {
                tf(
                    "forms.finalize_error",
                    &[&self.base.template_name, &e.to_string()],
                )
                .to_string()
            })
    }
}

/// JSONField - Textarea with JSON validation
#[derive(Clone, Serialize, Debug)]
pub struct JSONField {
    pub base: FieldConfig,
}

impl JSONField {
    /// Creates a new JSON field rendered as a textarea.
    pub fn new(name: &str) -> Self {
        Self {
            base: FieldConfig::new(name, "textarea", "base_special.html"),
        }
    }

    /// Sets the field's display label.
    pub fn label(mut self, label: &str) -> Self {
        self.base.label = label.to_string();
        self
    }

    /// Marks the field as required; empty input fails validation.
    pub fn required(mut self) -> Self {
        self.set_required(true, None);
        self
    }

    /// Sets the placeholder text shown in the empty textarea.
    pub fn placeholder(mut self, p: &str) -> Self {
        self.base.placeholder = p.to_string();
        self
    }

    /// Sets the number of visible rows on the rendered textarea (defaults to 10 if never set).
    pub fn rows(mut self, rows: usize) -> Self {
        self.base
            .extra_context
            .insert("rows".to_string(), json!(rows));
        self
    }
}

impl CommonFieldConfig for JSONField {
    fn get_field_config(&self) -> &FieldConfig {
        &self.base
    }

    fn get_field_config_mut(&mut self) -> &mut FieldConfig {
        &mut self.base
    }
}

#[async_trait]
impl FormField for JSONField {
    async fn validate(&mut self) -> bool {
        let val = self.base.value.trim();

        if self.base.is_required.choice && val.is_empty() {
            let msg = self
                .base
                .is_required
                .message
                .clone()
                .unwrap_or_else(|| t("forms.required").to_string());
            self.set_error(msg);
            return false;
        }

        if !val.is_empty() {
            // Validate the JSON
            if let Err(e) = serde_json::from_str::<serde_json::Value>(val) {
                self.set_error(tf("forms.json_invalid", &[&e]));
                return false;
            }
        }

        self.clear_error();
        true
    }

    fn render(&self, tera: &ATera) -> Result<String, String> {
        let mut context = self.base_context();
        context.insert("field_hint", &t("forms.hint_json").to_string());
        // Number of lines
        let rows = self
            .base
            .extra_context
            .get("rows")
            .and_then(|r| r.as_u64().map(|v| v as usize))
            .unwrap_or(10);
        context.insert("rows", &rows);

        tera.render(&self.base.template_name, &context)
            .map_err(|e| {
                tf(
                    "forms.finalize_error",
                    &[&self.base.template_name, &e.to_string()],
                )
                .to_string()
            })
    }
}

/// IPAddressField - IP address validation (v4 or v6)
#[derive(Clone, Serialize, Debug)]
pub struct IPAddressField {
    pub base: FieldConfig,
    /// When `true`, restricts validation to IPv6 addresses only. Set via
    /// [`IPAddressField::ipv6_only`].
    pub ipv6_only: bool,
    /// When `true`, restricts validation to IPv4 addresses only. Set via
    /// [`IPAddressField::ipv4_only`].
    pub ipv4_only: bool,
}

impl IPAddressField {
    /// Creates a new IP address field accepting both IPv4 and IPv6 by default.
    pub fn new(name: &str) -> Self {
        Self {
            base: FieldConfig::new(name, "text", "base_special.html"),
            ipv6_only: false,
            ipv4_only: false,
        }
    }

    /// Restricts validation to IPv4 addresses only, clearing any prior `ipv6_only` setting.
    pub fn ipv4_only(mut self) -> Self {
        self.ipv4_only = true;
        self.ipv6_only = false;
        self
    }

    /// Restricts validation to IPv6 addresses only, clearing any prior `ipv4_only` setting.
    pub fn ipv6_only(mut self) -> Self {
        self.ipv6_only = true;
        self.ipv4_only = false;
        self
    }

    /// Sets the field's display label.
    pub fn label(mut self, label: &str) -> Self {
        self.base.label = label.to_string();
        self
    }

    /// Marks the field as required; empty input fails validation.
    pub fn required(mut self) -> Self {
        self.set_required(true, None);
        self
    }

    /// Sets the placeholder text shown in the empty input.
    pub fn placeholder(mut self, p: &str) -> Self {
        self.base.placeholder = p.to_string();
        self
    }
}

impl CommonFieldConfig for IPAddressField {
    fn get_field_config(&self) -> &FieldConfig {
        &self.base
    }

    fn get_field_config_mut(&mut self) -> &mut FieldConfig {
        &mut self.base
    }
}

#[async_trait]
impl FormField for IPAddressField {
    async fn validate(&mut self) -> bool {
        let val = self.base.value.trim();

        if self.base.is_required.choice && val.is_empty() {
            let msg = self
                .base
                .is_required
                .message
                .clone()
                .unwrap_or_else(|| t("forms.required").to_string());
            self.set_error(msg);
            return false;
        }

        if !val.is_empty() {
            // Parse the IP address
            match val.parse::<IpAddr>() {
                Ok(ip) => {
                    if self.ipv4_only && ip.is_ipv6() {
                        self.set_error(t("forms.ipv4_only").to_string());
                        return false;
                    }
                    if self.ipv6_only && ip.is_ipv4() {
                        self.set_error(t("forms.ipv6_only").to_string());
                        return false;
                    }
                }
                Err(_) => {
                    self.set_error(t("forms.ip_invalid").to_string());
                    return false;
                }
            }
        }

        self.clear_error();
        true
    }

    fn render(&self, tera: &ATera) -> Result<String, String> {
        let mut context = self.base_context();

        let hint = if self.ipv4_only {
            t("forms.hint_ip_v4").to_string()
        } else if self.ipv6_only {
            t("forms.hint_ip_v6").to_string()
        } else {
            t("forms.hint_ip").to_string()
        };
        context.insert("field_hint", &hint);

        tera.render(&self.base.template_name, &context)
            .map_err(|e| {
                tf(
                    "forms.finalize_error",
                    &[&self.base.template_name, &e.to_string()],
                )
                .to_string()
            })
    }
}