codama-nodes 0.9.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

use crate::{CamelCaseString, DiscriminatorNode, Docs, HasName, TypeNode};
use codama_nodes_derive::node;

#[node]
pub struct EventNode {
    // Data.
    pub name: CamelCaseString,
    #[serde(default, skip_serializing_if = "crate::is_default")]
    pub docs: Docs,

    // Children.
    pub data: TypeNode,
    #[serde(default, skip_serializing_if = "crate::is_default")]
    pub discriminators: Vec<DiscriminatorNode>,
}

impl EventNode {
    pub fn new<T, U>(name: T, data: U) -> Self
    where
        T: Into<CamelCaseString>,
        U: Into<TypeNode>,
    {
        Self {
            name: name.into(),
            docs: Docs::default(),
            data: data.into(),
            discriminators: vec![],
        }
    }
}

impl HasName for EventNode {
    fn name(&self) -> &CamelCaseString {
        &self.name
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{NumberTypeNode, StringTypeNode, StructFieldTypeNode, StructTypeNode, U8};

    #[test]
    fn new() {
        let node = EventNode::new(
            "myEvent",
            StructTypeNode::new(vec![
                StructFieldTypeNode::new("name", StringTypeNode::utf8()),
                StructFieldTypeNode::new("age", NumberTypeNode::le(U8)),
            ]),
        );

        assert_eq!(node.name, CamelCaseString::new("myEvent"));
        assert_eq!(node.docs, Docs::default());
        assert_eq!(
            node.data,
            TypeNode::Struct(StructTypeNode::new(vec![
                StructFieldTypeNode::new("name", StringTypeNode::utf8()),
                StructFieldTypeNode::new("age", NumberTypeNode::le(U8)),
            ]))
        );
        assert_eq!(node.discriminators, vec![]);
    }

    #[test]
    fn direct_instantiation() {
        let node = EventNode {
            name: "myEvent".into(),
            docs: Docs::default(),
            data: StructTypeNode::new(vec![
                StructFieldTypeNode::new("name", StringTypeNode::utf8()),
                StructFieldTypeNode::new("age", NumberTypeNode::le(U8)),
            ])
            .into(),
            discriminators: vec![],
        };

        assert_eq!(node.name, CamelCaseString::new("myEvent"));
        assert_eq!(node.docs, Docs::default());
        assert_eq!(
            node.data,
            TypeNode::Struct(StructTypeNode::new(vec![
                StructFieldTypeNode::new("name", StringTypeNode::utf8()),
                StructFieldTypeNode::new("age", NumberTypeNode::le(U8)),
            ]))
        );
        assert_eq!(node.discriminators, vec![]);
    }

    #[test]
    fn to_json() {
        let node = EventNode::new(
            "myEvent",
            StructTypeNode::new(vec![
                StructFieldTypeNode::new("name", StringTypeNode::utf8()),
                StructFieldTypeNode::new("age", NumberTypeNode::le(U8)),
            ]),
        );

        let json = serde_json::to_string(&node).unwrap();

        assert_eq!(
            json,
            r#"{"kind":"eventNode","name":"myEvent","data":{"kind":"structTypeNode","fields":[{"kind":"structFieldTypeNode","name":"name","type":{"kind":"stringTypeNode","encoding":"utf8"}},{"kind":"structFieldTypeNode","name":"age","type":{"kind":"numberTypeNode","format":"u8","endian":"le"}}]}}"#
        );
    }

    #[test]
    fn from_json() {
        let json = r#"{"kind":"eventNode","name":"myEvent","data":{"kind":"structTypeNode","fields":[{"kind":"structFieldTypeNode","name":"name","type":{"kind":"stringTypeNode","encoding":"utf8"}},{"kind":"structFieldTypeNode","name":"age","type":{"kind":"numberTypeNode","format":"u8","endian":"le"}}]}}"#;

        let node: EventNode = serde_json::from_str(json).unwrap();

        assert_eq!(
            node,
            EventNode::new(
                "myEvent",
                StructTypeNode::new(vec![
                    StructFieldTypeNode::new("name", StringTypeNode::utf8()),
                    StructFieldTypeNode::new("age", NumberTypeNode::le(U8)),
                ]),
            )
        );
    }
}