Skip to main content

text_document_direct_access/document/
document_controller.rs

1// Generated by Qleany v1.5.6 from entity_controller.tera
2
3use super::{
4    dtos::{CreateDocumentDto, DocumentDto, UpdateDocumentDto},
5    units_of_work::{DocumentReadUoWFactory, DocumentWriteUoWFactory},
6};
7use crate::DocumentRelationshipDto;
8use anyhow::{Ok, Result};
9use common::direct_access::document::DocumentRelationshipField;
10use common::direct_access::use_cases;
11use common::undo_redo::UndoRedoManager;
12use common::{database::db_context::DbContext, event::EventHub, types::EntityId};
13use std::sync::Arc;
14
15pub fn create_orphan(
16    db_context: &DbContext,
17    event_hub: &Arc<EventHub>,
18    undo_redo_manager: &mut UndoRedoManager,
19    stack_id: Option<u64>,
20    entity: &CreateDocumentDto,
21) -> Result<DocumentDto> {
22    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
23    let mut uc = use_cases::UndoableCreateOrphanUseCase::new(uow_factory);
24    let entity_in: common::entities::Document = entity.into();
25    let result = uc.execute(&entity_in)?;
26    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
27    Ok(result.into())
28}
29
30pub fn create_orphan_multi(
31    db_context: &DbContext,
32    event_hub: &Arc<EventHub>,
33    undo_redo_manager: &mut UndoRedoManager,
34    stack_id: Option<u64>,
35    entities: &[CreateDocumentDto],
36) -> Result<Vec<DocumentDto>> {
37    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
38    let entities_in: Vec<common::entities::Document> =
39        entities.iter().map(|dto| dto.into()).collect();
40    let mut uc = use_cases::UndoableCreateOrphanUseCase::new(uow_factory);
41    let result = uc.execute_multi(&entities_in)?;
42    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
43    Ok(result.into_iter().map(|e| e.into()).collect())
44}
45
46pub fn create(
47    db_context: &DbContext,
48    event_hub: &Arc<EventHub>,
49    undo_redo_manager: &mut UndoRedoManager,
50    stack_id: Option<u64>,
51    entity: &CreateDocumentDto,
52    owner_id: EntityId,
53    index: i32,
54) -> Result<DocumentDto> {
55    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
56    let entity_in: common::entities::Document = entity.into();
57    let strategy = use_cases::OwnerStrategy::Replacing;
58    let mut uc = use_cases::UndoableCreateUseCase::new(uow_factory, strategy);
59    let result = uc.execute(&entity_in, owner_id, index)?;
60    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
61    Ok(result.into())
62}
63
64pub fn create_multi(
65    db_context: &DbContext,
66    event_hub: &Arc<EventHub>,
67    undo_redo_manager: &mut UndoRedoManager,
68    stack_id: Option<u64>,
69    entities: &[CreateDocumentDto],
70    owner_id: EntityId,
71    index: i32,
72) -> Result<Vec<DocumentDto>> {
73    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
74    let entities_in: Vec<common::entities::Document> =
75        entities.iter().map(|dto| dto.into()).collect();
76    let strategy = use_cases::OwnerStrategy::Replacing;
77    let mut uc = use_cases::UndoableCreateUseCase::new(uow_factory, strategy);
78    let result = uc.execute_multi(&entities_in, owner_id, index)?;
79    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
80    Ok(result.into_iter().map(|e| e.into()).collect())
81}
82
83pub fn get(db_context: &DbContext, id: &EntityId) -> Result<Option<DocumentDto>> {
84    let uow_factory = DocumentReadUoWFactory::new(db_context);
85    let uc = use_cases::GetUseCase::new(uow_factory);
86    Ok(uc.execute(id)?.map(|e| e.into()))
87}
88
89pub fn get_all(db_context: &DbContext) -> Result<Vec<DocumentDto>> {
90    let uow_factory = DocumentReadUoWFactory::new(db_context);
91    let uc = use_cases::GetUseCase::new(uow_factory);
92    Ok(uc.execute_all()?.into_iter().map(|e| e.into()).collect())
93}
94
95pub fn get_multi(db_context: &DbContext, ids: &[EntityId]) -> Result<Vec<Option<DocumentDto>>> {
96    let uow_factory = DocumentReadUoWFactory::new(db_context);
97    let uc = use_cases::GetUseCase::new(uow_factory);
98    Ok(uc
99        .execute_multi(ids)?
100        .into_iter()
101        .map(|o| o.map(|e| e.into()))
102        .collect())
103}
104
105pub fn update(
106    db_context: &DbContext,
107    event_hub: &Arc<EventHub>,
108    undo_redo_manager: &mut UndoRedoManager,
109    stack_id: Option<u64>,
110    entity: &UpdateDocumentDto,
111) -> Result<DocumentDto> {
112    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
113    let entity_in: common::entities::Document = entity.into();
114    let mut uc = use_cases::UndoableUpdateUseCase::new(uow_factory);
115    let result = uc.execute(&entity_in)?;
116    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
117    Ok(result.into())
118}
119
120pub fn update_multi(
121    db_context: &DbContext,
122    event_hub: &Arc<EventHub>,
123    undo_redo_manager: &mut UndoRedoManager,
124    stack_id: Option<u64>,
125    entities: &[UpdateDocumentDto],
126) -> Result<Vec<DocumentDto>> {
127    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
128    let entities_in: Vec<common::entities::Document> =
129        entities.iter().map(|dto| dto.into()).collect();
130    let mut uc = use_cases::UndoableUpdateUseCase::new(uow_factory);
131    let result = uc.execute_multi(&entities_in)?;
132    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
133    Ok(result.into_iter().map(|e| e.into()).collect())
134}
135
136pub fn update_with_relationships(
137    db_context: &DbContext,
138    event_hub: &Arc<EventHub>,
139    undo_redo_manager: &mut UndoRedoManager,
140    stack_id: Option<u64>,
141    entity: &DocumentDto,
142) -> Result<DocumentDto> {
143    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
144    let entity_in: common::entities::Document = entity.into();
145    let mut uc = use_cases::UndoableUpdateWithRelationshipsUseCase::new(uow_factory);
146    let result = uc.execute(&entity_in)?;
147    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
148    Ok(result.into())
149}
150
151pub fn update_with_relationships_multi(
152    db_context: &DbContext,
153    event_hub: &Arc<EventHub>,
154    undo_redo_manager: &mut UndoRedoManager,
155    stack_id: Option<u64>,
156    entities: &[DocumentDto],
157) -> Result<Vec<DocumentDto>> {
158    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
159    let entities_in: Vec<common::entities::Document> =
160        entities.iter().map(|dto| dto.into()).collect();
161    let mut uc = use_cases::UndoableUpdateWithRelationshipsUseCase::new(uow_factory);
162    let result = uc.execute_multi(&entities_in)?;
163    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
164    Ok(result.into_iter().map(|e| e.into()).collect())
165}
166
167pub fn remove(
168    db_context: &DbContext,
169    event_hub: &Arc<EventHub>,
170    undo_redo_manager: &mut UndoRedoManager,
171    stack_id: Option<u64>,
172    id: &EntityId,
173) -> Result<()> {
174    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
175    let mut uc = use_cases::UndoableRemoveUseCase::new(uow_factory);
176    uc.execute(id)?;
177    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
178    Ok(())
179}
180
181pub fn remove_multi(
182    db_context: &DbContext,
183    event_hub: &Arc<EventHub>,
184    undo_redo_manager: &mut UndoRedoManager,
185    stack_id: Option<u64>,
186    ids: &[EntityId],
187) -> Result<()> {
188    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
189    let mut uc = use_cases::UndoableRemoveUseCase::new(uow_factory);
190    uc.execute_multi(ids)?;
191    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
192    Ok(())
193}
194
195pub fn get_relationship(
196    db_context: &DbContext,
197    id: &EntityId,
198    field: &DocumentRelationshipField,
199) -> Result<Vec<EntityId>> {
200    let uow_factory = DocumentReadUoWFactory::new(db_context);
201    let uc = use_cases::GetRelationshipUseCase::<DocumentRelationshipField, _>::new(uow_factory);
202    uc.execute(id, field)
203}
204
205pub fn get_relationship_many(
206    db_context: &DbContext,
207    ids: &[EntityId],
208    field: &DocumentRelationshipField,
209) -> Result<std::collections::HashMap<EntityId, Vec<EntityId>>> {
210    let uow_factory = DocumentReadUoWFactory::new(db_context);
211    let uc =
212        use_cases::GetRelationshipManyUseCase::<DocumentRelationshipField, _>::new(uow_factory);
213    uc.execute(ids, field)
214}
215
216pub fn get_relationship_count(
217    db_context: &DbContext,
218    id: &EntityId,
219    field: &DocumentRelationshipField,
220) -> Result<usize> {
221    let uow_factory = DocumentReadUoWFactory::new(db_context);
222    let uc =
223        use_cases::GetRelationshipCountUseCase::<DocumentRelationshipField, _>::new(uow_factory);
224    uc.execute(id, field)
225}
226
227pub fn get_relationship_in_range(
228    db_context: &DbContext,
229    id: &EntityId,
230    field: &DocumentRelationshipField,
231    offset: usize,
232    limit: usize,
233) -> Result<Vec<EntityId>> {
234    let uow_factory = DocumentReadUoWFactory::new(db_context);
235    let uc =
236        use_cases::GetRelationshipInRangeUseCase::<DocumentRelationshipField, _>::new(uow_factory);
237    uc.execute(id, field, offset, limit)
238}
239
240pub fn set_relationship(
241    db_context: &DbContext,
242    event_hub: &Arc<EventHub>,
243    undo_redo_manager: &mut UndoRedoManager,
244    stack_id: Option<u64>,
245    dto: &DocumentRelationshipDto,
246) -> Result<()> {
247    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
248    let mut uc =
249        use_cases::UndoableSetRelationshipUseCase::<DocumentRelationshipField, _>::new(uow_factory);
250    uc.execute(&dto.id, &dto.field, dto.right_ids.as_slice())?;
251    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
252    Ok(())
253}
254
255pub fn move_relationship(
256    db_context: &DbContext,
257    event_hub: &Arc<EventHub>,
258    undo_redo_manager: &mut UndoRedoManager,
259    stack_id: Option<u64>,
260    id: &EntityId,
261    field: &DocumentRelationshipField,
262    ids_to_move: &[EntityId],
263    new_index: i32,
264) -> Result<Vec<EntityId>> {
265    let uow_factory = DocumentWriteUoWFactory::new(db_context, event_hub);
266    let mut uc = use_cases::UndoableMoveRelationshipUseCase::<DocumentRelationshipField, _>::new(
267        uow_factory,
268    );
269    let result = uc.execute(id, field, ids_to_move, new_index)?;
270    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
271    Ok(result)
272}
273
274#[cfg(test)]
275mod tests {
276    #![allow(dead_code)]
277    #![allow(unused_imports)]
278
279    use super::*;
280    use crate::root::dtos::CreateRootDto;
281    use crate::root::root_controller;
282    use common::database::db_context::DbContext;
283    use common::event::EventHub;
284    use common::types::EntityId;
285    use common::undo_redo::UndoRedoManager;
286    use std::sync::Arc;
287
288    struct TestContext {
289        db: DbContext,
290        hub: Arc<EventHub>,
291        undo: UndoRedoManager,
292    }
293
294    impl TestContext {
295        fn new() -> Self {
296            let db = DbContext::new().expect("Failed to create in-memory DB");
297            let hub = Arc::new(EventHub::new());
298            let mut undo = UndoRedoManager::new();
299            undo.set_event_hub(&hub);
300            TestContext { db, hub, undo }
301        }
302    }
303
304    /// Build the ownership chain and return the direct owner's id.
305    fn create_owner_chain(ctx: &mut TestContext) -> EntityId {
306        let root =
307            root_controller::create_orphan(&ctx.db, &ctx.hub, &CreateRootDto::default()).unwrap();
308        root.id
309    }
310
311    /// Create an entity using create_orphan.
312    fn create_one(ctx: &mut TestContext) -> DocumentDto {
313        create_orphan(
314            &ctx.db,
315            &ctx.hub,
316            &mut ctx.undo,
317            None,
318            &CreateDocumentDto::default(),
319        )
320        .unwrap()
321    }
322
323    // -----------------------------------------------------------------------
324    // create_orphan + get
325    // -----------------------------------------------------------------------
326
327    #[test]
328    fn test_create_orphan_and_get() {
329        let mut ctx = TestContext::new();
330        let created = create_one(&mut ctx);
331        assert!(created.id > 0);
332
333        let fetched = get(&ctx.db, &created.id).unwrap();
334        assert!(fetched.is_some());
335        assert_eq!(fetched.unwrap().id, created.id);
336    }
337
338    // -----------------------------------------------------------------------
339    // get nonexistent
340    // -----------------------------------------------------------------------
341
342    #[test]
343    fn test_get_nonexistent() {
344        let ctx = TestContext::new();
345        assert!(get(&ctx.db, &999999).unwrap().is_none());
346    }
347
348    // -----------------------------------------------------------------------
349    // get_all
350    // -----------------------------------------------------------------------
351
352    #[test]
353    fn test_get_all() {
354        let mut ctx = TestContext::new();
355        create_one(&mut ctx);
356        let all = get_all(&ctx.db).unwrap();
357        assert!(!all.is_empty());
358    }
359
360    // -----------------------------------------------------------------------
361    // get_multi
362    // -----------------------------------------------------------------------
363
364    #[test]
365    fn test_get_multi() {
366        let mut ctx = TestContext::new();
367        let a = create_one(&mut ctx);
368        let results = get_multi(&ctx.db, &[a.id, 999999]).unwrap();
369        assert_eq!(results.len(), 2);
370        assert!(results[0].is_some());
371        assert!(results[1].is_none());
372    }
373
374    // -----------------------------------------------------------------------
375    // update
376    // -----------------------------------------------------------------------
377
378    #[test]
379    fn test_update() {
380        let mut ctx = TestContext::new();
381        let created = create_one(&mut ctx);
382        let update_dto: UpdateDocumentDto = created.into();
383        let updated = update(&ctx.db, &ctx.hub, &mut ctx.undo, None, &update_dto).unwrap();
384        assert_eq!(updated.id, update_dto.id);
385    }
386
387    // -----------------------------------------------------------------------
388    // remove
389    // -----------------------------------------------------------------------
390
391    #[test]
392    fn test_remove() {
393        let mut ctx = TestContext::new();
394        let created = create_one(&mut ctx);
395        remove(&ctx.db, &ctx.hub, &mut ctx.undo, None, &created.id).unwrap();
396        assert!(get(&ctx.db, &created.id).unwrap().is_none());
397    }
398
399    // -----------------------------------------------------------------------
400    // remove_multi
401    // -----------------------------------------------------------------------
402
403    #[test]
404    fn test_remove_multi() {
405        let mut ctx = TestContext::new();
406        let a = create_one(&mut ctx);
407        remove_multi(&ctx.db, &ctx.hub, &mut ctx.undo, None, &[a.id]).unwrap();
408        assert!(get(&ctx.db, &a.id).unwrap().is_none());
409    }
410
411    // -----------------------------------------------------------------------
412    // create with owner
413    // -----------------------------------------------------------------------
414
415    #[test]
416    fn test_create_with_owner() {
417        let mut ctx = TestContext::new();
418        let owner_id = create_owner_chain(&mut ctx);
419        let created = create(
420            &ctx.db,
421            &ctx.hub,
422            &mut ctx.undo,
423            None,
424            &CreateDocumentDto::default(),
425            owner_id,
426            -1,
427        )
428        .unwrap();
429        assert!(created.id > 0);
430        let fetched = get(&ctx.db, &created.id).unwrap();
431        assert!(fetched.is_some());
432    }
433
434    // -----------------------------------------------------------------------
435    // undo create_orphan
436    // -----------------------------------------------------------------------
437
438    #[test]
439    fn test_create_orphan_undo() {
440        let mut ctx = TestContext::new();
441        let created = create_one(&mut ctx);
442        assert!(get(&ctx.db, &created.id).unwrap().is_some());
443        ctx.undo.undo(None).unwrap();
444        assert!(get(&ctx.db, &created.id).unwrap().is_none());
445    }
446
447    // -----------------------------------------------------------------------
448    // undo remove
449    // -----------------------------------------------------------------------
450
451    #[test]
452    fn test_remove_undo() {
453        let mut ctx = TestContext::new();
454        let created = create_one(&mut ctx);
455        remove(&ctx.db, &ctx.hub, &mut ctx.undo, None, &created.id).unwrap();
456        assert!(get(&ctx.db, &created.id).unwrap().is_none());
457        ctx.undo.undo(None).unwrap();
458        assert!(get(&ctx.db, &created.id).unwrap().is_some());
459    }
460
461    // -----------------------------------------------------------------------
462    // relationship: get empty
463    // -----------------------------------------------------------------------
464
465    #[test]
466    fn test_get_relationship_empty() {
467        let mut ctx = TestContext::new();
468        let created = create_one(&mut ctx);
469        let rel_ids =
470            get_relationship(&ctx.db, &created.id, &DocumentRelationshipField::Frames).unwrap();
471        assert!(rel_ids.is_empty());
472    }
473
474    // -----------------------------------------------------------------------
475    // relationship: count zero
476    // -----------------------------------------------------------------------
477
478    #[test]
479    fn test_get_relationship_count_zero() {
480        let mut ctx = TestContext::new();
481        let created = create_one(&mut ctx);
482        let count =
483            get_relationship_count(&ctx.db, &created.id, &DocumentRelationshipField::Frames)
484                .unwrap();
485        assert_eq!(count, 0);
486    }
487}