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
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
//! `RuniqueQueryBuilder<E>` — Django-style query builder: filter, exclude, order_by, limit, all, get, count…
use crate::db::DatabaseConfig;
/// Django-inspired query builder for SeaORM
///
/// This struct wraps SeaORM's `Select<E>` and provides convenient,
/// chainable methods like `.filter()`, `.exclude()`, `.order_by_desc()`, etc.
///
/// # Examples
///
/// ```rust,ignore
/// #[cfg(feature = "sqlite")]
/// async fn sqlite_query_example() {
///     use sea_orm::entity::prelude::*;
///     use sea_orm::{Database, DbBackend, Schema, Set};
///
///     #[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
///     #[sea_orm(table_name = "users")]
///     pub struct Model {
///         #[sea_orm(primary_key)]
///         pub id: i32,
///         pub username: String,
///         pub age: i32,
///     }
///
///     #[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
///     pub enum Relation {}
///
///     impl ActiveModelBehavior for ActiveModel {}
///
///     // SQLite in-memory connection
///     let db = Database::connect("sqlite::memory:").await.unwrap();
///
///     // Table creation
///     let stmt = Schema::new(DbBackend::Sqlite).create_table_from_entity(Entity);
///     db.execute(&stmt).await.unwrap();
///
///     // User insertion
///     ActiveModel {
///         username: Set("Alice".to_owned()),
///         age: Set(30),
///         ..Default::default()
///     }
///     .insert(&db)
///     .await
///     .unwrap();
///
///     // Verification via query
///     let user: Option<Model> = Entity::find()
///         .filter(Column::Username.eq("Alice"))
///         .one(&db)
///         .await
///         .unwrap();
///     assert!(user.is_some());
/// }
///
/// #[cfg(feature = "sqlite")]
/// tokio::runtime::Runtime::new().unwrap().block_on(sqlite_query_example());
/// ```
use axum::response::IntoResponse;
use sea_orm::{
    ColumnTrait, Condition, DatabaseConnection, DbErr, EntityTrait, ExprTrait, JoinType,
    QueryFilter, QueryOrder, QuerySelect, Select,
};
use std::sync::Arc;

pub struct RuniqueQueryBuilder<E: EntityTrait> {
    query: Select<E>,
}

impl<E: EntityTrait> RuniqueQueryBuilder<E> {
    pub fn new(query: Select<E>) -> Self {
        Self { query }
    }

    // Allows extracting the connection directly from the Engine
    pub async fn all_from_engine(
        self,
        engine: Arc<DatabaseConfig>,
    ) -> Result<Vec<E::Model>, DbErr> {
        let db = engine.connect().await?;
        self.query.all(&db).await
    }
    pub async fn all(self, db: &DatabaseConnection) -> Result<Vec<E::Model>, DbErr> {
        self.query.all(db).await
    }

    // In impl<E: EntityTrait> RuniqueQueryBuilder<E>

    // === EXISTING (keeping current filter/exclude) ===
    pub fn filter<C>(mut self, condition: C) -> Self
    where
        C: Into<Condition>,
    {
        self.query = self.query.filter(condition.into());
        self
    }

    pub fn exclude<C>(mut self, condition: C) -> Self
    where
        C: Into<Condition>,
    {
        self.query = self.query.filter(condition.into().not());
        self
    }

    // === NEW : vector version, simplified syntax ===
    pub fn filter_many<C, V, I>(mut self, filters: I) -> Self
    where
        C: ColumnTrait,
        V: Into<sea_orm::Value>,
        I: IntoIterator<Item = (C, V)>,
    {
        for (col, val) in filters {
            self.query = self.query.filter(col.eq(val));
        }
        self
    }

    pub fn exclude_many<C, V, I>(mut self, filters: I) -> Self
    where
        C: ColumnTrait,
        V: Into<sea_orm::Value>,
        I: IntoIterator<Item = (C, V)>,
    {
        for (col, val) in filters {
            self.query = self.query.filter(col.eq(val).not());
        }
        self
    }

    pub fn order_by_asc<C: ColumnTrait>(mut self, column: C) -> Self {
        self.query = self.query.order_by_asc(column);
        self
    }

    pub fn order_by_desc<C: ColumnTrait>(mut self, column: C) -> Self {
        self.query = self.query.order_by_desc(column);
        self
    }

    pub fn asc<C: ColumnTrait>(mut self, column: C) -> Self {
        self.query = self.query.order_by_asc(column);
        self
    }

    pub fn desc<C: ColumnTrait>(mut self, column: C) -> Self {
        self.query = self.query.order_by_desc(column);
        self
    }

    pub fn order_by_random(mut self) -> Self {
        use sea_orm::Order;
        use sea_query::Expr;
        self.query = self.query.order_by(Expr::cust("RANDOM()"), Order::Asc);
        self
    }

    pub fn order_by_expr<T>(mut self, expr: T, order: sea_orm::Order) -> Self
    where
        T: sea_orm::IntoSimpleExpr,
    {
        self.query = self.query.order_by(expr, order);
        self
    }

    pub fn into_select(self) -> Select<E> {
        self.query
    }

    pub fn limit(mut self, limit: u64) -> Self {
        self.query = self.query.limit(limit);
        self
    }

    pub fn offset(mut self, offset: u64) -> Self {
        self.query = self.query.offset(offset);
        self
    }

    pub async fn count(self, db: &DatabaseConnection) -> Result<u64, DbErr>
    where
        E::Model: Sync,
    {
        use sea_orm::PaginatorTrait;
        self.query.count(db).await
    }

    pub async fn first(self, db: &DatabaseConnection) -> Result<Option<E::Model>, DbErr> {
        self.query.one(db).await
    }

    pub async fn one(self, db: &DatabaseConnection) -> Result<Option<E::Model>, DbErr>
    where
        E::Model: Sync,
    {
        use sea_orm::PaginatorTrait;
        let mut results = self.query.paginate(db, 2).fetch_page(0).await?;
        match results.len() {
            0 => Ok(None),
            1 => Ok(Some(results.remove(0))),
            _ => Err(DbErr::Custom(
                "search!.one(): multiple rows returned".to_string(),
            )),
        }
    }

    pub fn join(mut self, rel: sea_orm::RelationDef) -> Self {
        self.query = self.query.join(JoinType::InnerJoin, rel);
        self
    }

    pub fn left_join(mut self, rel: sea_orm::RelationDef) -> Self {
        self.query = self.query.join(JoinType::LeftJoin, rel);
        self
    }

    /// Loads the related entity at the same time — returns `Vec<(E::Model, Option<R::Model>)>`.
    ///
    /// ```rust,ignore
    /// search!(ContributionEntity => desc Id,)
    ///     .also_related(eihwaz_users::Entity)
    ///     .all(db).await
    /// ```
    pub fn also_related<R>(self, r: R) -> sea_orm::SelectTwo<E, R>
    where
        R: sea_orm::EntityTrait,
        E: sea_orm::Related<R>,
    {
        self.query.find_also_related(r)
    }

    pub async fn get_or_404(
        self,
        db: &DatabaseConnection,
        ctx: &crate::context::template::Request,
        error_msg: &str,
    ) -> Result<E::Model, axum::response::Response> {
        match self.first(db).await {
            Ok(Some(entity)) => Ok(entity),
            Ok(None) => {
                let mut context = ctx.context.clone();
                context.insert("title", "Page not found");
                context.insert("error_message", error_msg);

                match ctx.engine.tera.render("404.html", &context) {
                    Ok(html) => Err(axum::response::Html(html).into_response()),
                    Err(e) => {
                        tracing::error!("Tera render 404 error: {}", e);
                        Err((
                            axum::http::StatusCode::INTERNAL_SERVER_ERROR,
                            "Internal error",
                        )
                            .into_response())
                    }
                }
            }
            Err(_) => {
                let mut context = ctx.context.clone();
                context.insert("title", "Server error");
                context.insert("error_message", "Database error");

                match ctx.engine.tera.render("500.html", &context) {
                    Ok(html) => Err(axum::response::Html(html).into_response()),
                    Err(e) => {
                        tracing::error!("Tera render 500 error: {}", e);
                        Err((
                            axum::http::StatusCode::INTERNAL_SERVER_ERROR,
                            "Internal error",
                        )
                            .into_response())
                    }
                }
            }
        }
    }
}

pub trait Queryable {
    fn objects() -> RuniqueQueryBuilder<Self>
    where
        Self: Sized + EntityTrait,
    {
        RuniqueQueryBuilder::new(Self::find())
    }
}

impl<T: EntityTrait> Queryable for T {}

// =====================================================
// SQLite tests enabled with "sqlite" feature
// =====================================================

#[cfg(feature = "sqlite")]
#[cfg(test)]
mod tests {
    use super::*;
    use sea_orm::ActiveModelTrait;
    use sea_orm::Set;
    use sea_orm::entity::prelude::*;

    // Test model definition
    #[derive(Clone, Debug, PartialEq, DeriveEntityModel, Eq)]
    #[sea_orm(table_name = "users")]
    pub struct Model {
        #[sea_orm(primary_key)]
        pub id: i32,
        pub username: String,
        pub age: i32,
    }

    #[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
    pub enum Relation {}

    impl ActiveModelBehavior for ActiveModel {}

    async fn setup_db() -> Result<DatabaseConnection, DbErr> {
        let db = sea_orm::Database::connect("sqlite::memory:").await?;

        use sea_orm::Schema;
        let schema = Schema::new(sea_orm::DatabaseBackend::Sqlite);
        let stmt = schema.create_table_from_entity(Entity);
        db.execute(&stmt).await?;

        Ok(db)
    }

    #[tokio::test]
    async fn test_querybuilder_all() -> Result<(), DbErr> {
        let db = setup_db().await?;

        let user = ActiveModel {
            username: Set("alice".to_string()),
            age: Set(25),
            ..Default::default()
        };
        user.insert(&db).await?;

        let users = RuniqueQueryBuilder::new(Entity::find()).all(&db).await?;
        assert_eq!(users.len(), 1);
        Ok(())
    }

    #[tokio::test]
    async fn test_querybuilder_filter_exclude() -> Result<(), DbErr> {
        let db = setup_db().await?;

        let alice = ActiveModel {
            username: Set("alice".to_string()),
            age: Set(25),
            ..Default::default()
        };
        let bob = ActiveModel {
            username: Set("bob".to_string()),
            age: Set(30),
            ..Default::default()
        };
        alice.insert(&db).await?;
        bob.insert(&db).await?;

        let adults = RuniqueQueryBuilder::new(Entity::find())
            .filter(Column::Age.gte(26))
            .all(&db)
            .await?;
        assert_eq!(adults.len(), 1);
        assert_eq!(adults[0].username, "bob");

        let not_bob = RuniqueQueryBuilder::new(Entity::find())
            .exclude(Column::Username.eq("bob"))
            .all(&db)
            .await?;
        assert_eq!(not_bob.len(), 1);
        assert_eq!(not_bob[0].username, "alice");

        Ok(())
    }

    #[tokio::test]
    async fn test_querybuilder_order_limit_count_first() -> Result<(), DbErr> {
        let db = setup_db().await?;

        for i in 1..=3 {
            let user = ActiveModel {
                username: Set(format!("user{}", i)),
                age: Set(20 + i),
                ..Default::default()
            };
            user.insert(&db).await?;
        }

        let count = RuniqueQueryBuilder::new(Entity::find()).count(&db).await?;
        assert_eq!(count, 3);

        let first = RuniqueQueryBuilder::new(Entity::find())
            .order_by_asc(Column::Age)
            .first(&db)
            .await?
            .unwrap();
        assert_eq!(first.age, 21);

        let limited = RuniqueQueryBuilder::new(Entity::find())
            .limit(2)
            .all(&db)
            .await?;
        assert_eq!(limited.len(), 2);

        Ok(())
    }

    #[tokio::test]
    async fn test_querybuilder_filter_many() -> Result<(), DbErr> {
        let db = setup_db().await?;
        for (name, age) in [("alice", 25), ("bob", 30), ("carol", 25)] {
            ActiveModel {
                username: Set(name.to_string()),
                age: Set(age),
                ..Default::default()
            }
            .insert(&db)
            .await?;
        }
        let result = RuniqueQueryBuilder::new(Entity::find())
            .filter_many([(Column::Age, 25)])
            .all(&db)
            .await?;
        assert_eq!(result.len(), 2);
        Ok(())
    }

    #[tokio::test]
    async fn test_querybuilder_exclude_many() -> Result<(), DbErr> {
        let db = setup_db().await?;
        for (name, age) in [("alice", 25), ("bob", 30)] {
            ActiveModel {
                username: Set(name.to_string()),
                age: Set(age),
                ..Default::default()
            }
            .insert(&db)
            .await?;
        }
        let result = RuniqueQueryBuilder::new(Entity::find())
            .exclude_many([(Column::Username, "bob".to_string())])
            .all(&db)
            .await?;
        assert_eq!(result.len(), 1);
        assert_eq!(result[0].username, "alice");
        Ok(())
    }

    #[tokio::test]
    async fn test_querybuilder_order_by_desc() -> Result<(), DbErr> {
        let db = setup_db().await?;
        for i in 1..=3 {
            ActiveModel {
                username: Set(format!("u{}", i)),
                age: Set(20 + i),
                ..Default::default()
            }
            .insert(&db)
            .await?;
        }
        let result = RuniqueQueryBuilder::new(Entity::find())
            .order_by_desc(Column::Age)
            .first(&db)
            .await?
            .unwrap();
        assert_eq!(result.age, 23);
        Ok(())
    }

    #[tokio::test]
    async fn test_querybuilder_desc_asc_aliases() -> Result<(), DbErr> {
        let db = setup_db().await?;
        for i in 1..=3 {
            ActiveModel {
                username: Set(format!("u{}", i)),
                age: Set(20 + i),
                ..Default::default()
            }
            .insert(&db)
            .await?;
        }
        let asc_first = RuniqueQueryBuilder::new(Entity::find())
            .asc(Column::Age)
            .first(&db)
            .await?
            .unwrap();
        assert_eq!(asc_first.age, 21);

        let desc_first = RuniqueQueryBuilder::new(Entity::find())
            .desc(Column::Age)
            .first(&db)
            .await?
            .unwrap();
        assert_eq!(desc_first.age, 23);
        Ok(())
    }

    #[tokio::test]
    async fn test_querybuilder_offset() -> Result<(), DbErr> {
        let db = setup_db().await?;
        for i in 1..=4 {
            ActiveModel {
                username: Set(format!("u{}", i)),
                age: Set(i),
                ..Default::default()
            }
            .insert(&db)
            .await?;
        }
        let result = RuniqueQueryBuilder::new(Entity::find())
            .order_by_asc(Column::Age)
            .limit(10)
            .offset(2)
            .all(&db)
            .await?;
        assert_eq!(result.len(), 2);
        assert_eq!(result[0].age, 3);
        Ok(())
    }

    #[tokio::test]
    async fn test_querybuilder_into_select() -> Result<(), DbErr> {
        let db = setup_db().await?;
        ActiveModel {
            username: Set("alice".to_string()),
            age: Set(25),
            ..Default::default()
        }
        .insert(&db)
        .await?;
        let select = RuniqueQueryBuilder::new(Entity::find()).into_select();
        let result = select.all(&db).await?;
        assert_eq!(result.len(), 1);
        Ok(())
    }
}