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

use crate::{CamelCaseString, ConstantNode, Docs, TypeNode, ValueNode};

impl ConstantNode {
    pub fn new<T, U, V>(name: T, r#type: U, value: V) -> Self
    where
        T: Into<CamelCaseString>,
        U: Into<TypeNode>,
        V: Into<ValueNode>,
    {
        Self {
            name: name.into(),
            docs: Docs::default(),
            r#type: Box::new(r#type.into()),
            value: Box::new(value.into()),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{NumberTypeNode, NumberValueNode, StringTypeNode, StringValueNode, U64};
    use pretty_assertions::assert_eq;

    #[test]
    fn new() {
        let node = ConstantNode::new(
            "max_items",
            NumberTypeNode::le(U64),
            NumberValueNode::new(100u64),
        );
        assert_eq!(node.name, CamelCaseString::new("maxItems"));
        assert_eq!(node.docs, Docs::default());
        assert_eq!(*node.r#type, TypeNode::Number(NumberTypeNode::le(U64)));
        assert_eq!(*node.value, ValueNode::Number(NumberValueNode::new(100u64)));
    }

    #[test]
    fn direct_instantiation() {
        let node = ConstantNode {
            name: "appName".into(),
            docs: Docs::default(),
            r#type: Box::new(StringTypeNode::utf8().into()),
            value: Box::new(StringValueNode::new("MyApp").into()),
        };
        assert_eq!(node.name, CamelCaseString::new("appName"));
        assert_eq!(node.docs, Docs::default());
        assert_eq!(*node.r#type, TypeNode::String(StringTypeNode::utf8()));
        assert_eq!(
            *node.value,
            ValueNode::String(StringValueNode::new("MyApp"))
        );
    }

    #[test]
    fn to_json() {
        let node = ConstantNode::new(
            "maxItems",
            NumberTypeNode::le(U64),
            NumberValueNode::new(100u64),
        );
        let json = serde_json::to_string(&node).unwrap();
        assert_eq!(
            json,
            r#"{"kind":"constantNode","name":"maxItems","type":{"kind":"numberTypeNode","format":"u64","endian":"le"},"value":{"kind":"numberValueNode","number":100}}"#
        );
    }

    #[test]
    fn from_json() {
        let json = r#"{"kind":"constantNode","name":"maxItems","type":{"kind":"numberTypeNode","format":"u64","endian":"le"},"value":{"kind":"numberValueNode","number":100}}"#;
        let node: ConstantNode = serde_json::from_str(json).unwrap();
        assert_eq!(
            node,
            ConstantNode::new(
                "maxItems",
                NumberTypeNode::le(U64),
                NumberValueNode::new(100u64)
            )
        );
    }

    #[test]
    fn to_json_with_docs() {
        let mut node = ConstantNode::new(
            "maxItems",
            NumberTypeNode::le(U64),
            NumberValueNode::new(100u64),
        );
        node.docs = Docs::new().add_doc("Maximum number of items.");
        let json = serde_json::to_string(&node).unwrap();
        assert_eq!(
            json,
            r#"{"kind":"constantNode","name":"maxItems","docs":["Maximum number of items."],"type":{"kind":"numberTypeNode","format":"u64","endian":"le"},"value":{"kind":"numberValueNode","number":100}}"#
        );
    }
}