statum-graph 0.7.0

Static graph export for Statum machine introspection
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

#![allow(dead_code)]

use statum_graph::CodebaseDoc;

mod cfg_surface {
    use statum::{machine, state, validators, Error};

    #[state]
    pub enum State {
        Draft,
        Done,
    }

    #[machine]
    pub struct Machine<State> {}

    pub struct VisibleRow {
        pub done: bool,
    }

    /// Rebuilds cfg-surface machines from visible persisted rows.
    #[validators(Machine)]
    impl VisibleRow {
        fn is_draft(&self) -> statum::Result<()> {
            if !self.done {
                Ok(())
            } else {
                Err(Error::InvalidState)
            }
        }

        fn is_done(&self) -> statum::Result<()> {
            if self.done {
                Ok(())
            } else {
                Err(Error::InvalidState)
            }
        }
    }

    pub struct HiddenRow;

    /// Hidden validator docs should not appear in the active build.
    #[cfg(any())]
    #[validators(Machine)]
    impl HiddenRow {
        fn is_draft(&self) -> statum::Result<()> {
            Ok(())
        }

        fn is_done(&self) -> statum::Result<()> {
            Ok(())
        }
    }
}

mod macro_surface {
    use statum::{machine, state, validators, Error};

    #[state]
    pub enum State {
        Draft,
        Done,
    }

    #[machine]
    pub struct Machine<State> {}

    pub struct MacroRow {
        pub done: bool,
    }

    macro_rules! define_validators {
        () => {
            /// Rebuilds macro-surface machines from macro-generated rows.
            #[validators(Machine)]
            impl MacroRow {
                fn is_draft(&self) -> statum::Result<()> {
                    if !self.done {
                        Ok(())
                    } else {
                        Err(Error::InvalidState)
                    }
                }

                fn is_done(&self) -> statum::Result<()> {
                    if self.done {
                        Ok(())
                    } else {
                        Err(Error::InvalidState)
                    }
                }
            }
        };
    }

    define_validators!();
}

#[test]
fn linked_codebase_uses_compiled_validator_impl_surfaces() {
    let doc = CodebaseDoc::linked().expect("linked codebase doc");

    let cfg_machine = doc
        .machines()
        .iter()
        .find(|machine| machine.rust_type_path.ends_with("cfg_surface::Machine"))
        .expect("cfg machine");
    assert_eq!(cfg_machine.validator_entries.len(), 1);
    assert_eq!(
        cfg_machine.validator_entries[0].source_type_display,
        "VisibleRow"
    );
    assert_eq!(cfg_machine.validator_entries[0].target_states, vec![0, 1]);
    assert_eq!(
        cfg_machine.validator_entries[0].docs,
        Some("Rebuilds cfg-surface machines from visible persisted rows.")
    );

    let macro_machine = doc
        .machines()
        .iter()
        .find(|machine| machine.rust_type_path.ends_with("macro_surface::Machine"))
        .expect("macro machine");
    assert_eq!(macro_machine.validator_entries.len(), 1);
    assert_eq!(
        macro_machine.validator_entries[0].source_type_display,
        "MacroRow"
    );
    assert_eq!(macro_machine.validator_entries[0].target_states, vec![0, 1]);
    assert_eq!(
        macro_machine.validator_entries[0].docs,
        Some("Rebuilds macro-surface machines from macro-generated rows.")
    );
}