text-document-direct-access 1.4.0

Entity CRUD controllers and DTOs for text-document
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
// Generated by Qleany v1.5.6 from entity_controller.tera

use super::{
    dtos::{CreateInlineElementDto, InlineElementDto, UpdateInlineElementDto},
    units_of_work::{InlineElementReadUoWFactory, InlineElementWriteUoWFactory},
};
use anyhow::{Ok, Result};
use common::direct_access::use_cases;
use common::undo_redo::UndoRedoManager;
use common::{database::db_context::DbContext, event::EventHub, types::EntityId};
use std::sync::Arc;

pub fn create_orphan(
    db_context: &DbContext,
    event_hub: &Arc<EventHub>,
    undo_redo_manager: &mut UndoRedoManager,
    stack_id: Option<u64>,
    entity: &CreateInlineElementDto,
) -> Result<InlineElementDto> {
    let uow_factory = InlineElementWriteUoWFactory::new(db_context, event_hub);
    let mut uc = use_cases::UndoableCreateOrphanUseCase::new(uow_factory);
    let entity_in: common::entities::InlineElement = entity.into();
    let result = uc.execute(&entity_in)?;
    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
    Ok(result.into())
}

pub fn create_orphan_multi(
    db_context: &DbContext,
    event_hub: &Arc<EventHub>,
    undo_redo_manager: &mut UndoRedoManager,
    stack_id: Option<u64>,
    entities: &[CreateInlineElementDto],
) -> Result<Vec<InlineElementDto>> {
    let uow_factory = InlineElementWriteUoWFactory::new(db_context, event_hub);
    let entities_in: Vec<common::entities::InlineElement> =
        entities.iter().map(|dto| dto.into()).collect();
    let mut uc = use_cases::UndoableCreateOrphanUseCase::new(uow_factory);
    let result = uc.execute_multi(&entities_in)?;
    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
    Ok(result.into_iter().map(|e| e.into()).collect())
}

pub fn create(
    db_context: &DbContext,
    event_hub: &Arc<EventHub>,
    undo_redo_manager: &mut UndoRedoManager,
    stack_id: Option<u64>,
    entity: &CreateInlineElementDto,
    owner_id: EntityId,
    index: i32,
) -> Result<InlineElementDto> {
    let uow_factory = InlineElementWriteUoWFactory::new(db_context, event_hub);
    let entity_in: common::entities::InlineElement = entity.into();
    let strategy = use_cases::OwnerStrategy::Appending;
    let mut uc = use_cases::UndoableCreateUseCase::new(uow_factory, strategy);
    let result = uc.execute(&entity_in, owner_id, index)?;
    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
    Ok(result.into())
}

pub fn create_multi(
    db_context: &DbContext,
    event_hub: &Arc<EventHub>,
    undo_redo_manager: &mut UndoRedoManager,
    stack_id: Option<u64>,
    entities: &[CreateInlineElementDto],
    owner_id: EntityId,
    index: i32,
) -> Result<Vec<InlineElementDto>> {
    let uow_factory = InlineElementWriteUoWFactory::new(db_context, event_hub);
    let entities_in: Vec<common::entities::InlineElement> =
        entities.iter().map(|dto| dto.into()).collect();
    let strategy = use_cases::OwnerStrategy::Appending;
    let mut uc = use_cases::UndoableCreateUseCase::new(uow_factory, strategy);
    let result = uc.execute_multi(&entities_in, owner_id, index)?;
    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
    Ok(result.into_iter().map(|e| e.into()).collect())
}

pub fn get(db_context: &DbContext, id: &EntityId) -> Result<Option<InlineElementDto>> {
    let uow_factory = InlineElementReadUoWFactory::new(db_context);
    let uc = use_cases::GetUseCase::new(uow_factory);
    Ok(uc.execute(id)?.map(|e| e.into()))
}

pub fn get_all(db_context: &DbContext) -> Result<Vec<InlineElementDto>> {
    let uow_factory = InlineElementReadUoWFactory::new(db_context);
    let uc = use_cases::GetUseCase::new(uow_factory);
    Ok(uc.execute_all()?.into_iter().map(|e| e.into()).collect())
}

pub fn get_multi(
    db_context: &DbContext,
    ids: &[EntityId],
) -> Result<Vec<Option<InlineElementDto>>> {
    let uow_factory = InlineElementReadUoWFactory::new(db_context);
    let uc = use_cases::GetUseCase::new(uow_factory);
    Ok(uc
        .execute_multi(ids)?
        .into_iter()
        .map(|o| o.map(|e| e.into()))
        .collect())
}

pub fn update(
    db_context: &DbContext,
    event_hub: &Arc<EventHub>,
    undo_redo_manager: &mut UndoRedoManager,
    stack_id: Option<u64>,
    entity: &UpdateInlineElementDto,
) -> Result<InlineElementDto> {
    let uow_factory = InlineElementWriteUoWFactory::new(db_context, event_hub);
    let entity_in: common::entities::InlineElement = entity.into();
    let mut uc = use_cases::UndoableUpdateUseCase::new(uow_factory);
    let result = uc.execute(&entity_in)?;
    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
    Ok(result.into())
}

pub fn update_multi(
    db_context: &DbContext,
    event_hub: &Arc<EventHub>,
    undo_redo_manager: &mut UndoRedoManager,
    stack_id: Option<u64>,
    entities: &[UpdateInlineElementDto],
) -> Result<Vec<InlineElementDto>> {
    let uow_factory = InlineElementWriteUoWFactory::new(db_context, event_hub);
    let entities_in: Vec<common::entities::InlineElement> =
        entities.iter().map(|dto| dto.into()).collect();
    let mut uc = use_cases::UndoableUpdateUseCase::new(uow_factory);
    let result = uc.execute_multi(&entities_in)?;
    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
    Ok(result.into_iter().map(|e| e.into()).collect())
}

pub fn update_with_relationships(
    db_context: &DbContext,
    event_hub: &Arc<EventHub>,
    undo_redo_manager: &mut UndoRedoManager,
    stack_id: Option<u64>,
    entity: &InlineElementDto,
) -> Result<InlineElementDto> {
    let uow_factory = InlineElementWriteUoWFactory::new(db_context, event_hub);
    let entity_in: common::entities::InlineElement = entity.into();
    let mut uc = use_cases::UndoableUpdateWithRelationshipsUseCase::new(uow_factory);
    let result = uc.execute(&entity_in)?;
    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
    Ok(result.into())
}

pub fn update_with_relationships_multi(
    db_context: &DbContext,
    event_hub: &Arc<EventHub>,
    undo_redo_manager: &mut UndoRedoManager,
    stack_id: Option<u64>,
    entities: &[InlineElementDto],
) -> Result<Vec<InlineElementDto>> {
    let uow_factory = InlineElementWriteUoWFactory::new(db_context, event_hub);
    let entities_in: Vec<common::entities::InlineElement> =
        entities.iter().map(|dto| dto.into()).collect();
    let mut uc = use_cases::UndoableUpdateWithRelationshipsUseCase::new(uow_factory);
    let result = uc.execute_multi(&entities_in)?;
    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
    Ok(result.into_iter().map(|e| e.into()).collect())
}

pub fn remove(
    db_context: &DbContext,
    event_hub: &Arc<EventHub>,
    undo_redo_manager: &mut UndoRedoManager,
    stack_id: Option<u64>,
    id: &EntityId,
) -> Result<()> {
    let uow_factory = InlineElementWriteUoWFactory::new(db_context, event_hub);
    let mut uc = use_cases::UndoableRemoveUseCase::new(uow_factory);
    uc.execute(id)?;
    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
    Ok(())
}

pub fn remove_multi(
    db_context: &DbContext,
    event_hub: &Arc<EventHub>,
    undo_redo_manager: &mut UndoRedoManager,
    stack_id: Option<u64>,
    ids: &[EntityId],
) -> Result<()> {
    let uow_factory = InlineElementWriteUoWFactory::new(db_context, event_hub);
    let mut uc = use_cases::UndoableRemoveUseCase::new(uow_factory);
    uc.execute_multi(ids)?;
    undo_redo_manager.add_command_to_stack(Box::new(uc), stack_id)?;
    Ok(())
}

#[cfg(test)]
mod tests {
    #![allow(dead_code)]
    #![allow(unused_imports)]

    use super::*;
    use crate::block::block_controller;
    use crate::block::dtos::CreateBlockDto;
    use crate::document::document_controller;
    use crate::document::dtos::CreateDocumentDto;
    use crate::frame::dtos::CreateFrameDto;
    use crate::frame::frame_controller;
    use crate::root::dtos::CreateRootDto;
    use crate::root::root_controller;
    use common::database::db_context::DbContext;
    use common::event::EventHub;
    use common::types::EntityId;
    use common::undo_redo::UndoRedoManager;
    use std::sync::Arc;

    struct TestContext {
        db: DbContext,
        hub: Arc<EventHub>,
        undo: UndoRedoManager,
    }

    impl TestContext {
        fn new() -> Self {
            let db = DbContext::new().expect("Failed to create in-memory DB");
            let hub = Arc::new(EventHub::new());
            let mut undo = UndoRedoManager::new();
            undo.set_event_hub(&hub);
            TestContext { db, hub, undo }
        }
    }

    /// Build the ownership chain and return the direct owner's id.
    fn create_owner_chain(ctx: &mut TestContext) -> EntityId {
        let root =
            root_controller::create_orphan(&ctx.db, &ctx.hub, &CreateRootDto::default()).unwrap();
        let document = document_controller::create(
            &ctx.db,
            &ctx.hub,
            &mut ctx.undo,
            None,
            &CreateDocumentDto::default(),
            root.id,
            -1,
        )
        .unwrap();
        let frame = frame_controller::create(
            &ctx.db,
            &ctx.hub,
            &mut ctx.undo,
            None,
            &CreateFrameDto::default(),
            document.id,
            -1,
        )
        .unwrap();
        let block = block_controller::create(
            &ctx.db,
            &ctx.hub,
            &mut ctx.undo,
            None,
            &CreateBlockDto::default(),
            frame.id,
            -1,
        )
        .unwrap();
        block.id
    }

    /// Create an entity using create_orphan.
    fn create_one(ctx: &mut TestContext) -> InlineElementDto {
        create_orphan(
            &ctx.db,
            &ctx.hub,
            &mut ctx.undo,
            None,
            &CreateInlineElementDto::default(),
        )
        .unwrap()
    }

    // -----------------------------------------------------------------------
    // create_orphan + get
    // -----------------------------------------------------------------------

    #[test]
    fn test_create_orphan_and_get() {
        let mut ctx = TestContext::new();
        let created = create_one(&mut ctx);
        assert!(created.id > 0);

        let fetched = get(&ctx.db, &created.id).unwrap();
        assert!(fetched.is_some());
        assert_eq!(fetched.unwrap().id, created.id);
    }

    // -----------------------------------------------------------------------
    // get nonexistent
    // -----------------------------------------------------------------------

    #[test]
    fn test_get_nonexistent() {
        let ctx = TestContext::new();
        assert!(get(&ctx.db, &999999).unwrap().is_none());
    }

    // -----------------------------------------------------------------------
    // get_all
    // -----------------------------------------------------------------------

    #[test]
    fn test_get_all() {
        let mut ctx = TestContext::new();
        create_one(&mut ctx);
        let all = get_all(&ctx.db).unwrap();
        assert!(!all.is_empty());
    }

    // -----------------------------------------------------------------------
    // get_multi
    // -----------------------------------------------------------------------

    #[test]
    fn test_get_multi() {
        let mut ctx = TestContext::new();
        let a = create_one(&mut ctx);
        let results = get_multi(&ctx.db, &[a.id, 999999]).unwrap();
        assert_eq!(results.len(), 2);
        assert!(results[0].is_some());
        assert!(results[1].is_none());
    }

    // -----------------------------------------------------------------------
    // update
    // -----------------------------------------------------------------------

    #[test]
    fn test_update() {
        let mut ctx = TestContext::new();
        let created = create_one(&mut ctx);
        let update_dto: UpdateInlineElementDto = created.into();
        let updated = update(&ctx.db, &ctx.hub, &mut ctx.undo, None, &update_dto).unwrap();
        assert_eq!(updated.id, update_dto.id);
    }

    // -----------------------------------------------------------------------
    // remove
    // -----------------------------------------------------------------------

    #[test]
    fn test_remove() {
        let mut ctx = TestContext::new();
        let created = create_one(&mut ctx);
        remove(&ctx.db, &ctx.hub, &mut ctx.undo, None, &created.id).unwrap();
        assert!(get(&ctx.db, &created.id).unwrap().is_none());
    }

    // -----------------------------------------------------------------------
    // remove_multi
    // -----------------------------------------------------------------------

    #[test]
    fn test_remove_multi() {
        let mut ctx = TestContext::new();
        let a = create_one(&mut ctx);
        remove_multi(&ctx.db, &ctx.hub, &mut ctx.undo, None, &[a.id]).unwrap();
        assert!(get(&ctx.db, &a.id).unwrap().is_none());
    }

    // -----------------------------------------------------------------------
    // create with owner
    // -----------------------------------------------------------------------

    #[test]
    fn test_create_with_owner() {
        let mut ctx = TestContext::new();
        let owner_id = create_owner_chain(&mut ctx);
        let created = create(
            &ctx.db,
            &ctx.hub,
            &mut ctx.undo,
            None,
            &CreateInlineElementDto::default(),
            owner_id,
            -1,
        )
        .unwrap();
        assert!(created.id > 0);
        let fetched = get(&ctx.db, &created.id).unwrap();
        assert!(fetched.is_some());
    }

    // -----------------------------------------------------------------------
    // undo create_orphan
    // -----------------------------------------------------------------------

    #[test]
    fn test_create_orphan_undo() {
        let mut ctx = TestContext::new();
        let created = create_one(&mut ctx);
        assert!(get(&ctx.db, &created.id).unwrap().is_some());
        ctx.undo.undo(None).unwrap();
        assert!(get(&ctx.db, &created.id).unwrap().is_none());
    }

    // -----------------------------------------------------------------------
    // undo remove
    // -----------------------------------------------------------------------

    #[test]
    fn test_remove_undo() {
        let mut ctx = TestContext::new();
        let created = create_one(&mut ctx);
        remove(&ctx.db, &ctx.hub, &mut ctx.undo, None, &created.id).unwrap();
        assert!(get(&ctx.db, &created.id).unwrap().is_none());
        ctx.undo.undo(None).unwrap();
        assert!(get(&ctx.db, &created.id).unwrap().is_some());
    }
}