codama-nodes 0.10.0

Node specifications and helpers for the Codama standard
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

use crate::{
    AccountNode, CamelCaseString, ConstantNode, DefinedTypeNode, ErrorNode, EventNode,
    InstructionNode, PdaNode, ProgramNode,
};

impl ProgramNode {
    pub fn new<T: Into<CamelCaseString>, U: Into<String>>(name: T, public_key: U) -> Self {
        Self {
            name: name.into(),
            public_key: public_key.into(),
            version: "0.0.0".into(),
            ..Default::default()
        }
    }

    pub fn set_version<T: Into<String>>(mut self, version: T) -> Self {
        self.version = version.into();
        self
    }

    pub fn add_account(mut self, account: AccountNode) -> Self {
        self.accounts.push(account);
        self
    }

    pub fn add_instruction(mut self, instruction: InstructionNode) -> Self {
        self.instructions.push(instruction);
        self
    }

    pub fn add_defined_type(mut self, defined_type: DefinedTypeNode) -> Self {
        self.defined_types.push(defined_type);
        self
    }

    pub fn add_pda(mut self, pda: PdaNode) -> Self {
        self.pdas.push(pda);
        self
    }

    pub fn add_event(mut self, event: EventNode) -> Self {
        self.events.push(event);
        self
    }

    pub fn add_error(mut self, error: ErrorNode) -> Self {
        self.errors.push(error);
        self
    }

    pub fn add_constant(mut self, constant: ConstantNode) -> Self {
        self.constants.push(constant);
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::Docs;
    use pretty_assertions::assert_eq;

    #[test]
    fn new() {
        let node = ProgramNode::new("my_program", "1234..5678");
        assert_eq!(node.name, CamelCaseString::new("myProgram"));
        assert_eq!(node.public_key, "1234..5678".to_string());
        assert_eq!(node.version, "0.0.0".to_string());
        assert_eq!(node.origin, None);
        assert_eq!(node.docs, Docs::default());
        assert_eq!(node.accounts, vec![]);
        assert_eq!(node.instructions, vec![]);
        assert_eq!(node.defined_types, vec![]);
        assert_eq!(node.pdas, vec![]);
        assert_eq!(node.events, vec![]);
        assert_eq!(node.errors, vec![]);
        assert_eq!(node.constants, vec![]);
    }

    #[test]
    fn default_program() {
        let node = ProgramNode::default();
        assert_eq!(node.name, CamelCaseString::new(""));
        assert_eq!(node.public_key, "".to_string());
        assert_eq!(node.version, "".to_string());
        assert_eq!(node.origin, None);
        assert_eq!(node.docs, Docs::default());
        assert_eq!(node.accounts, vec![]);
        assert_eq!(node.instructions, vec![]);
        assert_eq!(node.defined_types, vec![]);
        assert_eq!(node.pdas, vec![]);
        assert_eq!(node.events, vec![]);
        assert_eq!(node.errors, vec![]);
        assert_eq!(node.constants, vec![]);
    }

    #[test]
    fn direct_instantiation() {
        let node = ProgramNode {
            name: "myProgram".into(),
            public_key: "1234..5678".into(),
            version: "1.2.3".into(),
            ..ProgramNode::default()
        };
        assert_eq!(node.name, CamelCaseString::new("myProgram"));
        assert_eq!(node.public_key, "1234..5678".to_string());
        assert_eq!(node.version, "1.2.3".to_string());
        assert_eq!(node.origin, None);
        assert_eq!(node.docs, Docs::default());
        assert_eq!(node.accounts, vec![]);
        assert_eq!(node.instructions, vec![]);
        assert_eq!(node.defined_types, vec![]);
        assert_eq!(node.pdas, vec![]);
        assert_eq!(node.events, vec![]);
        assert_eq!(node.errors, vec![]);
        assert_eq!(node.constants, vec![]);
    }

    #[test]
    fn to_json() {
        let node = ProgramNode {
            name: "myProgram".into(),
            public_key: "1234..5678".into(),
            version: "1.2.3".into(),
            ..ProgramNode::default()
        };
        let json = serde_json::to_string(&node).unwrap();
        // Empty arrays are omitted on write (skip-when-empty convention).
        assert_eq!(
            json,
            r#"{"kind":"programNode","name":"myProgram","publicKey":"1234..5678","version":"1.2.3"}"#
        );
    }

    #[test]
    fn from_json() {
        // Absent arrays default to empty on read (skip-when-empty convention).
        let json = r#"{"kind":"programNode","name":"myProgram","publicKey":"1234..5678","version":"1.2.3"}"#;
        let node: ProgramNode = serde_json::from_str(json).unwrap();
        assert_eq!(
            node,
            ProgramNode {
                name: "myProgram".into(),
                public_key: "1234..5678".into(),
                version: "1.2.3".into(),
                ..ProgramNode::default()
            }
        );
    }
}