repox 0.1.0

trait framework for data repository patterns
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

//!
//! Mockall support for repox.
//!

pub use stub_repo::StubRepo;
mod stub_repo {
    use crate::*;

    /// # Stub Repopository
    ///
    /// This is just a marker trait for the main [Repo] trait.
    ///
    /// It allows us to generate a mock repository with Mockall that avoids
    /// the need to implement all of the individual traits for each method,
    /// and instead just rely on these blankets to catch all of the needs
    /// of the main [Repo] trait.
    ///
    pub trait StubRepo: Repo {}

    impl<T, E> Insert<E> for T
    where
        T: StubRepo,
        E: Entity + Send,
    {
        async fn exec(&self, _entity: E) -> Result<(), InsertError<E>> {
            unreachable!("Called `insert` without a mock prepared!")
        }
    }

    impl<T, E> FetchById<E> for T
    where
        T: StubRepo,
        E: Entity,
    {
        async fn exec(&self, _id: <E as Identity>::ID) -> Result<E, FetchError<E>> {
            unreachable!("Called `fetch_by_id` without a mock prepared!")
        }
    }

    impl<T, E> UpdateById<E> for T
    where
        T: StubRepo,
        E: Entity + Send,
    {
        async fn exec(&self, _entity: E) -> Result<(), UpdateError<E>> {
            unreachable!("Called `update_by_id` without a mock prepared!")
        }
    }

    impl<T, E> DeleteById<E> for T
    where
        T: StubRepo,
        E: Entity + Send,
    {
        async fn exec(
            &self,
            _id: <E as Identity>::ID,
        ) -> Result<DeleteStatus, ::anyhow::Error> {
            unreachable!("Called `delete_by_id` without a mock prepared!")
        }
    }

    impl<T, E, P> CreateWith<E, P> for T
    where
        T: StubRepo,
        E: Entity + Send,
        P: Creatable<E>,
    {
        async fn exec(&self, _params: P) -> Result<E, ::anyhow::Error> {
            unreachable!("Called `create_with` without a mock prepared!")
        }
    }

    impl<T, E, O> FetchWithParentById<E, O> for T
    where
        T: StubRepo,
        E: BelongsToForeignKey<O> + Send,
        O: Entity,
    {
        async fn exec(
            &self,
            _id: <E as Identity>::ID,
        ) -> Result<(E, O), FetchWithParentError<E>> {
            unreachable!("Called `fetch_with_parent_by_id` without a mock prepared!")
        }
    }

    impl<T, E, O> FetchWithChildrenById<E, O> for T
    where
        T: StubRepo,
        E: HasManyForeignKey<O> + Send,
        O: Entity,
    {
        async fn exec(
            &self,
            _id: <E as Identity>::ID,
        ) -> Result<(E, Vec<O>), FetchWithChildrenError<E>> {
            unreachable!(
                "Called `fetch_with_children_by_id` without a mock prepared!"
            )
        }
    }
}

pub use helper_fns::ok_val;
pub use helper_fns::ok_with;
mod helper_fns {
    use std::pin::Pin;

    pub fn ok_val<T, P, E>(
        value: T,
    ) -> impl FnMut(P) -> Pin<Box<dyn Future<Output = Result<T, E>> + Send>>
    where
        T: 'static + Send + Clone,
        E: 'static + Send,
    {
        move |_| {
            let value = value.clone();
            Box::pin(std::future::ready(Ok(value)))
        }
    }

    pub fn ok_with<T, P, E, F>(
        mut f: F,
    ) -> impl FnMut(P) -> Pin<Box<dyn Future<Output = Result<T, E>> + Send>>
    where
        T: 'static + Send,
        E: 'static + Send,
        F: FnMut(P) -> T + 'static,
    {
        move |params| {
            let value = f(params);
            Box::pin(std::future::ready(Ok(value)))
        }
    }
}