codama-attributes 0.9.1

Codama attributes definitions and parsers
Documentation
use crate::{utils::SetOnce, Attribute, AttributeContext, CodamaDirective};
use codama_errors::CodamaError;
use codama_syn_helpers::extensions::*;

#[derive(Debug, PartialEq)]
pub struct CodamaAttribute<'a> {
    pub ast: &'a syn::Attribute,
    pub directive: Box<CodamaDirective>,
}

impl<'a> CodamaAttribute<'a> {
    pub fn parse(ast: &'a syn::Attribute, ctx: &AttributeContext) -> syn::Result<Self> {
        let unfeatured = ast.unfeatured();
        let effective = unfeatured.as_ref().unwrap_or(ast);
        Self::parse_from(ast, effective, ctx)
    }

    /// Parse a codama attribute using the effective attribute for content extraction.
    /// `ast` is stored as the original attribute reference (for error spans).
    /// `effective` is used to parse the actual directive content.
    pub fn parse_from(
        ast: &'a syn::Attribute,
        effective: &syn::Attribute,
        ctx: &AttributeContext,
    ) -> syn::Result<Self> {
        let list = effective.meta.require_list()?;
        if !list.path.is_strict("codama") {
            return Err(list.path.error("expected #[codama(...)]"));
        };

        let mut directive = SetOnce::<CodamaDirective>::new("codama");
        list.each(|ref meta| directive.set(CodamaDirective::parse(meta, ctx)?, meta))?;
        Ok(Self {
            ast,
            directive: Box::new(directive.take(effective)?),
        })
    }
}

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

    fn try_from(attribute: &'a Attribute) -> Result<Self, Self::Error> {
        match attribute {
            Attribute::Codama(a) => Ok(a),
            _ => Err(CodamaError::InvalidAttribute {
                expected: "codama".to_string(),
                actual: attribute.name(),
            }),
        }
    }
}

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

    #[test]
    fn test_codama_attribute() {
        let ast = parse_quote! { #[codama(type = boolean)] };
        let file = syn::File::empty();
        let ctx = AttributeContext::File(&file);
        let attribute = CodamaAttribute::parse(&ast, &ctx).unwrap();

        assert_eq!(attribute.ast, &ast);
        assert!(matches!(
            attribute.directive.as_ref(),
            CodamaDirective::Type(_)
        ));
    }

    #[test]
    fn test_feature_gated_codama_attribute() {
        let ast = parse_quote! { #[cfg_attr(feature = "some_feature", codama(type = boolean))] };
        let file = syn::File::empty();
        let ctx = AttributeContext::File(&file);
        let attribute = CodamaAttribute::parse(&ast, &ctx).unwrap();

        assert_eq!(attribute.ast, &ast);
        assert!(matches!(
            attribute.directive.as_ref(),
            CodamaDirective::Type(_)
        ));
    }
}