runique 2.2.0

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

//! Administration forms provided by Runique.
//!
//! These forms are available directly in `runique::admin::forms` and can
//! be referenced via `create_form:` in `admin!{}` without having to rewrite them.

use crate::forms::field::RuniqueForm;
use crate::forms::fields::{BooleanField, CheckboxField, ChoiceField, HiddenField, TextField};
use crate::forms::form::Forms;
use crate::impl_form_access;
use crate::utils::aliases::definition::StrMap;
use crate::utils::trad::t;

#[derive(serde::Serialize, Debug, Clone)]
#[serde(transparent)]
pub struct DroitAdminForm {
    pub form: Forms,
}

impl RuniqueForm for DroitAdminForm {
    fn register_fields(form: &mut Forms) {
        // groupe_id, resource_key overridden dynamically in builtin.rs
        form.field(
            &ChoiceField::new("groupe_id")
                .label(t("admin.group").as_ref())
                .required(),
        );
        form.field(&CheckboxField::new("resource_key").label(t("admin.resources").as_ref()));
        form.field(&BooleanField::new("can_create").label(t("admin.can_create").as_ref()));
        form.field(&BooleanField::new("can_read").label(t("admin.can_read").as_ref()));
        form.field(&BooleanField::new("can_update").label(t("admin.can_update").as_ref()));
        form.field(&BooleanField::new("can_delete").label(t("admin.can_delete").as_ref()));
        form.field(&BooleanField::new("can_update_own").label(t("admin.can_update_own").as_ref()));
        form.field(&BooleanField::new("can_delete_own").label(t("admin.can_delete_own").as_ref()));
    }
    impl_form_access!();
}

// ─── GroupeAdminForm ─────────────────────────────────────────────────────────

#[derive(serde::Serialize, Debug, Clone)]
#[serde(transparent)]
pub struct GroupeAdminForm {
    pub form: Forms,
}

impl RuniqueForm for GroupeAdminForm {
    fn register_fields(form: &mut Forms) {
        form.field(
            &TextField::text("nom")
                .label(t("admin.name").as_ref())
                .required(),
        );
    }
    impl_form_access!();
}

/// User creation form from the admin interface.
///
/// The `password` field is hidden — Runique automatically injects a random hash
/// and sends a reset email to the created user.
///
/// Usage in `admin!{}`:
/// ```rust,ignore
/// users: eihwaz_users::Model => MyForm {
///     title: "Users",
///     permissions: ["admin"],
///     create_form: runique::admin::forms::UserAdminCreateForm,
///     edit_form: crate::formulaire::UserEditForm,
/// }
/// ```
#[derive(serde::Serialize, Debug, Clone)]
#[serde(transparent)]
pub struct UserAdminCreateForm {
    pub form: Forms,
}

#[async_trait::async_trait]
impl RuniqueForm for UserAdminCreateForm {
    fn register_fields(form: &mut Forms) {
        form.field(
            &TextField::text("username")
                .label(t("admin.username").as_ref())
                .required(),
        );
        form.field(
            &TextField::email("email")
                .label(t("admin.email").as_ref())
                .required(),
        );
        form.field(&HiddenField::new("password"));
        form.field(&BooleanField::new("is_staff").label(t("admin.staff").as_ref()));
        // No `is_superuser` field: an admin account can never be granted from
        // within the admin panel itself, not even by an existing superuser —
        // promotion only happens outside the app (CLI, direct DB access).
        // Field overridden dynamically with available groups (see builtin.rs)
        form.field(&CheckboxField::new("groupes").label(t("admin.groups").as_ref()));
    }

    impl_form_access!();

    async fn clean(&mut self) -> Result<(), StrMap> {
        let username = self.cleaned_string("username").unwrap_or_default();
        let email = self.cleaned_string("email").unwrap_or_default();
        let mut errors = StrMap::new();

        if username.len() < 3 {
            errors.insert(
                "username".to_string(),
                t("admin.user.username_too_short").to_string(),
            );
        }
        if !email.contains('@') {
            errors.insert(
                "email".to_string(),
                t("admin.user.invalid_email").to_string(),
            );
        }

        if errors.is_empty() {
            Ok(())
        } else {
            Err(errors)
        }
    }
}

// ─── UserAdminEditForm ────────────────────────────────────────────────────────

#[derive(serde::Serialize, Debug, Clone)]
#[serde(transparent)]
pub struct UserAdminEditForm {
    pub form: Forms,
}

impl RuniqueForm for UserAdminEditForm {
    fn register_fields(form: &mut Forms) {
        form.field(
            &TextField::text("username")
                .label(t("admin.username").as_ref())
                .required(),
        );
        form.field(
            &TextField::email("email")
                .label(t("admin.email").as_ref())
                .required(),
        );
        form.field(&BooleanField::new("is_active").label(t("admin.active").as_ref()));
        form.field(&BooleanField::new("is_staff").label(t("admin.staff").as_ref()));
        // No `is_superuser` field: see UserAdminCreateForm.
        // Field overridden dynamically with available groups (see builtin.rs)
        form.field(&CheckboxField::new("groupes").label(t("admin.groups").as_ref()));
    }
    impl_form_access!();
}