sc-lint-attributes 0.2.0

Source-level declarative attributes for sc-lint analyzers.
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

use proc_macro::TokenStream;
use proc_macro2::TokenStream as TokenStream2;
use sc_lint_directives::AttributeInput;
use syn::Result;

#[cfg(test)]
use sc_lint_directives::Directive;

fn expand_sc_lint(args: TokenStream2, item: TokenStream2) -> Result<TokenStream2> {
    let _parsed = syn::parse2::<AttributeInput>(args)?;
    Ok(item)
}

#[proc_macro_attribute]
pub fn sc_lint(args: TokenStream, item: TokenStream) -> TokenStream {
    let item_ts: TokenStream2 = item.clone().into();
    let args_ts: TokenStream2 = args.into();
    match expand_sc_lint(args_ts, item_ts) {
        Ok(expanded) => TokenStream::from(expanded),
        Err(error) => TokenStream::from(error.to_compile_error()),
    }
}

#[cfg(test)]
mod tests {
    use super::AttributeInput;
    use super::Directive;
    use super::expand_sc_lint;
    use quote::quote;

    #[test]
    fn parses_boundary_allow_rule() {
        let parsed: AttributeInput =
            syn::parse2(quote!(boundary.allow("cycle.type_method_self_loop"))).unwrap();
        assert_eq!(
            parsed.directives,
            vec![Directive::Allow(vec![
                "cycle.type_method_self_loop".to_string()
            ])]
        );
    }

    #[test]
    fn parses_boundary_internal_only() {
        let parsed: AttributeInput = syn::parse2(quote!(boundary.internal_only)).unwrap();
        assert_eq!(parsed.directives, vec![Directive::InternalOnly]);
    }

    #[test]
    fn parses_boundary_forbid_external_impls() {
        let parsed: AttributeInput = syn::parse2(quote!(boundary.forbid_external_impls)).unwrap();
        assert_eq!(parsed.directives, vec![Directive::ForbidExternalImpls]);
    }

    #[test]
    fn parses_multiple_directives() {
        let parsed: AttributeInput = syn::parse2(quote!(
            boundary.internal_only,
            boundary.forbid_external_impls,
            boundary.allow("cycle.type_method_self_loop")
        ))
        .unwrap();
        assert_eq!(
            parsed.directives,
            vec![
                Directive::InternalOnly,
                Directive::ForbidExternalImpls,
                Directive::Allow(vec!["cycle.type_method_self_loop".to_string()]),
            ]
        );
    }

    #[test]
    fn rejects_unknown_boundary_directive() {
        let error = syn::parse2::<AttributeInput>(quote!(boundary.unknown)).unwrap_err();
        assert!(error.to_string().contains("unsupported boundary directive"));
    }

    #[test]
    fn expansion_is_noop_for_supported_directives() {
        let expanded = expand_sc_lint(
            quote!(
                boundary.internal_only,
                boundary.forbid_external_impls,
                boundary.allow("cycle.type_method_self_loop")
            ),
            quote!(
                pub struct Example;
            ),
        )
        .unwrap();
        assert_eq!(
            expanded.to_string(),
            quote!(
                pub struct Example;
            )
            .to_string()
        );
    }
}