codama-koroks 0.9.0

Intermediate tree structure for collecting nodes
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

use crate::KorokTrait;
use codama_attributes::{Attributes, NameDirective, TryFromFilter};
use codama_errors::{CodamaResult, IteratorCombineErrors};
use codama_nodes::{CamelCaseString, Node, RegisteredTypeNode, StructFieldTypeNode, TypeNode};

#[derive(Debug, PartialEq)]
pub struct FieldKorok<'a> {
    pub ast: &'a syn::Field,
    pub attributes: Attributes<'a>,
    pub node: Option<Node>,
}

impl<'a> FieldKorok<'a> {
    pub fn parse(ast: &'a syn::Field) -> CodamaResult<Self> {
        let attributes = Attributes::parse(&ast.attrs, ast.into())?;
        Ok(Self {
            ast,
            attributes,
            node: None,
        })
    }

    pub fn parse_all(ast: &'a syn::Fields) -> CodamaResult<Vec<Self>> {
        match ast {
            syn::Fields::Named(f) => f.named.iter().map(Self::parse).collect_and_combine_errors(),
            syn::Fields::Unnamed(f) => f
                .unnamed
                .iter()
                .map(Self::parse)
                .collect_and_combine_errors(),
            syn::Fields::Unit => Ok(vec![]),
        }
    }

    pub fn name(&self) -> Option<CamelCaseString> {
        self.attributes
            .get_last(NameDirective::filter)
            .map(|n| n.name.clone())
            .or_else(|| self.ast.ident.as_ref().map(|i| i.to_string().into()))
    }

    pub fn get_updated_type_node(&self, node: TypeNode) -> Option<Node> {
        match &self.node {
            Some(Node::Type(RegisteredTypeNode::StructField(field))) => Some(
                StructFieldTypeNode {
                    r#type: node,
                    ..field.clone()
                }
                .into(),
            ),
            // Only wrap in StructFieldTypeNode for named fields (those with an AST ident).
            // Tuple fields store the raw TypeNode; callers use field.name() to get custom
            // names from #[codama(name = "...")] when needed.
            _ => match self.ast.ident.as_ref() {
                Some(_) => Some(StructFieldTypeNode::new(self.name().unwrap(), node).into()),
                None => Some(node.into()),
            },
        }
    }

    pub fn set_type_node(&mut self, node: TypeNode) {
        self.node = self.get_updated_type_node(node);
    }
}

impl KorokTrait for FieldKorok<'_> {
    fn node(&self) -> &Option<Node> {
        &self.node
    }

    fn set_node(&mut self, node: Option<Node>) {
        self.node = node;
    }

    fn attributes(&self) -> Option<&Attributes<'_>> {
        Some(&self.attributes)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use codama_nodes::{
        NumberFormat::{U32, U64},
        NumberTypeNode,
    };

    #[test]
    fn get_updated_type_node_with_named_none() {
        let korok = FieldKorok {
            ast: &syn::parse_quote! { pub my_field: u32 },
            attributes: Attributes(vec![]),
            node: None,
        };
        assert_eq!(
            korok.get_updated_type_node(NumberTypeNode::le(U32).into()),
            Some(StructFieldTypeNode::new("my_field", NumberTypeNode::le(U32)).into())
        );
    }

    #[test]
    fn get_updated_type_node_with_unnamed_none() {
        let korok = FieldKorok {
            ast: &syn::parse_quote! { u32 },
            attributes: Attributes(vec![]),
            node: None,
        };
        assert_eq!(
            korok.get_updated_type_node(NumberTypeNode::le(U32).into()),
            Some(NumberTypeNode::le(U32).into())
        );
    }

    #[test]
    fn get_updated_type_node_with_some() {
        let korok = FieldKorok {
            ast: &syn::parse_quote! { pub my_field: u32 },
            attributes: Attributes(vec![]),
            node: Some(StructFieldTypeNode::new("my_node_name", NumberTypeNode::le(U32)).into()),
        };
        assert_eq!(
            korok.get_updated_type_node(NumberTypeNode::le(U64).into()),
            Some(StructFieldTypeNode::new("my_node_name", NumberTypeNode::le(U64)).into())
        );
    }
}