codama_attributes/codama_directives/
account_directive.rs

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
use crate::{
    utils::{FromMeta, SetOnce},
    AttributeContext,
};
use codama_nodes::{CamelCaseString, Docs, InstructionAccountNode, IsAccountSigner};
use codama_syn_helpers::{extensions::*, Meta};

#[derive(Debug, PartialEq)]
pub struct AccountDirective {
    pub name: CamelCaseString,
    pub is_writable: bool,
    pub is_signer: IsAccountSigner,
    pub is_optional: bool,
    // TODO: `docs` for account directives not attached to fields.
}

impl AccountDirective {
    pub fn parse(meta: &Meta, ctx: &AttributeContext) -> syn::Result<Self> {
        meta.assert_directive("account")?;
        let mut name = SetOnce::<CamelCaseString>::new("name");
        match ctx {
            AttributeContext::Field(syn::Field {
                ident: Some(ident), ..
            }) => name = name.initial_value(ident.to_string().into()),
            _ => (),
        }
        let mut is_writable = SetOnce::<bool>::new("writable").initial_value(false);
        let mut is_signer = SetOnce::<IsAccountSigner>::new("signer").initial_value(false.into());
        let mut is_optional = SetOnce::<bool>::new("optional").initial_value(false);
        match meta.is_path_or_empty_list() {
            true => (),
            false => meta
                .as_path_list()?
                .each(|ref meta| match meta.path_str().as_str() {
                    "name" => name.set(String::from_meta(meta)?.into(), meta),
                    "writable" => is_writable.set(bool::from_meta(meta)?, meta),
                    "signer" => is_signer.set(IsAccountSigner::from_meta(meta)?, meta),
                    "optional" => is_optional.set(bool::from_meta(meta)?, meta),
                    _ => Err(meta.error("unrecognized attribute")),
                })?,
        }
        Ok(AccountDirective {
            name: name.take(meta)?,
            is_writable: is_writable.take(meta)?,
            is_signer: is_signer.take(meta)?,
            is_optional: is_optional.take(meta)?,
        })
    }
}

impl From<&AccountDirective> for InstructionAccountNode {
    fn from(value: &AccountDirective) -> Self {
        Self {
            name: value.name.clone(),
            is_writable: value.is_writable,
            is_signer: value.is_signer,
            is_optional: value.is_optional,
            docs: Docs::default(),
            default_value: None,
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn fully_set() {
        let meta: Meta = syn::parse_quote! { account(name = "payer", writable, signer, optional) };
        let item = syn::parse_quote! { struct Foo; };
        let ctx = AttributeContext::Item(&item);
        let directive = AccountDirective::parse(&meta, &ctx).unwrap();
        assert_eq!(
            directive,
            AccountDirective {
                name: "payer".into(),
                is_writable: true,
                is_signer: IsAccountSigner::True,
                is_optional: true,
            }
        );
    }

    #[test]
    fn fully_set_with_explicit_values() {
        let meta: Meta = syn::parse_quote! { account(name = "payer", writable = true, signer = "either", optional = false) };
        let item = syn::parse_quote! { struct Foo; };
        let ctx = AttributeContext::Item(&item);
        let directive = AccountDirective::parse(&meta, &ctx).unwrap();
        assert_eq!(
            directive,
            AccountDirective {
                name: "payer".into(),
                is_writable: true,
                is_signer: IsAccountSigner::Either,
                is_optional: false,
            }
        );
    }

    #[test]
    fn empty_on_nammed_field() {
        let meta: Meta = syn::parse_quote! { account };
        let field = syn::parse_quote! { authority: AccountMeta };
        let ctx = AttributeContext::Field(&field);
        let directive = AccountDirective::parse(&meta, &ctx).unwrap();
        assert_eq!(
            directive,
            AccountDirective {
                name: "authority".into(),
                is_writable: false,
                is_signer: IsAccountSigner::False,
                is_optional: false,
            }
        );
    }

    #[test]
    fn empty_on_struct() {
        let meta: Meta = syn::parse_quote! { account };
        let item = syn::parse_quote! { struct Foo; };
        let ctx = AttributeContext::Item(&item);
        let error = AccountDirective::parse(&meta, &ctx).unwrap_err();
        assert_eq!(error.to_string(), "name is missing");
    }
}