codama-attributes 0.9.1

Codama attributes definitions and parsers
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

use crate::{utils::SetOnce, Attribute, CodamaAttribute, CodamaDirective};
use codama_errors::CodamaError;
use codama_syn_helpers::{extensions::*, Meta};

#[derive(Debug, PartialEq, Default, Clone)]
pub struct ErrorDirective {
    pub code: Option<usize>,
    pub message: Option<String>,
}

impl ErrorDirective {
    pub fn is_empty(&self) -> bool {
        self.code.is_none() && self.message.is_none()
    }
}

impl ErrorDirective {
    pub fn parse(meta: &Meta) -> syn::Result<Self> {
        let pl = meta.assert_directive("error")?.as_path_list()?;
        let mut code = SetOnce::<usize>::new("code");
        let mut message = SetOnce::<String>::new("message");
        pl.each(|ref meta| match meta.path_str().as_str() {
            "code" => code.set(meta.as_value()?.as_expr()?.as_unsigned_integer()?, meta),
            "message" => message.set(meta.as_value()?.as_expr()?.as_string()?, meta),
            _ => {
                if let Ok(expr) = meta.as_expr() {
                    if let Ok(value) = expr.as_unsigned_integer() {
                        return code.set(value, meta);
                    } else if let Ok(value) = expr.as_string() {
                        return message.set(value, meta);
                    }
                }
                Err(meta.error("unrecognized attribute"))
            }
        })?;
        let directive = Self {
            code: code.option(),
            message: message.option(),
        };
        if directive.is_empty() {
            return Err(pl.error("expected at least one `code` or `message` attribute"));
        }
        Ok(directive)
    }
}

impl<'a> TryFrom<&'a CodamaAttribute<'a>> for &'a ErrorDirective {
    type Error = CodamaError;

    fn try_from(attribute: &'a CodamaAttribute) -> Result<Self, Self::Error> {
        match attribute.directive.as_ref() {
            CodamaDirective::Error(ref a) => Ok(a),
            _ => Err(CodamaError::InvalidCodamaDirective {
                expected: "error".to_string(),
                actual: attribute.directive.name().to_string(),
            }),
        }
    }
}

impl<'a> TryFrom<&'a Attribute<'a>> for &'a ErrorDirective {
    type Error = CodamaError;

    fn try_from(attribute: &'a Attribute) -> Result<Self, Self::Error> {
        <&CodamaAttribute>::try_from(attribute)?.try_into()
    }
}

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

    #[test]
    fn ok() {
        let meta: Meta = syn::parse_quote! { error(42, "my message") };
        let directive = ErrorDirective::parse(&meta).unwrap();
        assert_eq!(
            directive,
            ErrorDirective {
                code: Some(42),
                message: Some("my message".to_string()),
            }
        );
    }

    #[test]
    fn ok_with_explicit_labels() {
        let meta: Meta = syn::parse_quote! { error(code = 42, message = "my message") };
        let directive = ErrorDirective::parse(&meta).unwrap();
        assert_eq!(
            directive,
            ErrorDirective {
                code: Some(42),
                message: Some("my message".to_string()),
            }
        );
    }

    #[test]
    fn fail_if_nothing_is_provided() {
        let meta: Meta = syn::parse_quote! { error() };
        let error = ErrorDirective::parse(&meta).unwrap_err();
        assert_eq!(
            error.to_string(),
            "expected at least one `code` or `message` attribute"
        );
    }
}