cqrs-es2 0.8.0

A Rust library providing lightweight CQRS and event sourcing framework.
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

use crate::{
    aggregates::IAggregate,
    commands::ICommand,
    events::IEvent,
};
use std::marker::PhantomData;

use super::aggregate_test_executor::AggregateTestExecutor;

/// A framework for rigorously testing the aggregate logic, one of the
/// ***most important*** parts of any CQRS system.
///
/// ```rust
/// use cqrs_es2::{
///     example_impl::{
///         AddCustomerName,
///         Customer,
///         CustomerCommand,
///         CustomerEvent,
///         NameAdded,
///     },
///     TestFramework,
/// };
///
/// type CustomerTestFramework =
///     TestFramework<CustomerCommand, CustomerEvent, Customer>;
///
/// CustomerTestFramework::default()
///     .given_no_previous_events()
///     .when(CustomerCommand::AddCustomerName(
///         AddCustomerName {
///             changed_name: "John Doe".to_string(),
///         },
///     ))
///     .then_expect_events(vec![CustomerEvent::NameAdded(
///         NameAdded {
///             changed_name: "John Doe".to_string(),
///         },
///     )]);
///
/// CustomerTestFramework::default()
///     .given(vec![CustomerEvent::NameAdded(
///         NameAdded {
///             changed_name: "John Doe".to_string(),
///         },
///     )])
///     .when(CustomerCommand::AddCustomerName(
///         AddCustomerName {
///             changed_name: "John Doe".to_string(),
///         },
///     ))
///     .then_expect_error(
///         "a name has already been added for this customer",
///     )
/// ```
pub struct TestFramework<C: ICommand, E: IEvent, A: IAggregate<C, E>>
{
    _phantom: PhantomData<(C, E, A)>,
}

impl<C: ICommand, E: IEvent, A: IAggregate<C, E>>
    TestFramework<C, E, A>
{
    /// Initiates an aggregate test with no previous events.
    #[must_use]
    pub fn given_no_previous_events(
        &self
    ) -> AggregateTestExecutor<C, E, A> {
        AggregateTestExecutor::new(Vec::new())
    }

    /// Initiates an aggregate test with a collection of previous
    /// events.
    #[must_use]
    pub fn given(
        &self,
        events: Vec<E>,
    ) -> AggregateTestExecutor<C, E, A> {
        AggregateTestExecutor::new(events)
    }
}

impl<C: ICommand, E: IEvent, A: IAggregate<C, E>> Default
    for TestFramework<C, E, A>
{
    fn default() -> Self {
        TestFramework {
            _phantom: PhantomData,
        }
    }
}