utoipauto-core 0.2.0

Rust Macros to automate the addition of Paths/Schemas to Utoipa crate, simulating Reflection during the compilation phase
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use proc_macro::TokenStream;
use proc_macro2::Literal;
use quote::quote;
use syn::Attribute;

pub struct Parameters {
    pub paths: String,
    pub fn_attribute_name: String,
    pub schema_attribute_name: String,
    pub response_attribute_name: String,
}

/// Extract the paths string attribute from the proc_macro::TokenStream
///
/// If none is specified, we use the default path "./src"
pub fn extract_attributes(stream: proc_macro2::TokenStream) -> Parameters {
    let paths = extract_attribute("paths", stream.clone());
    let fn_attribute_name = extract_attribute("function_attribute_name", stream.clone());
    let schema_attribute_name = extract_attribute("schema_attribute_name", stream.clone());
    let response_attribute_name = extract_attribute("response_attribute_name", stream);
    // if no paths specified, we use the default path "./src"
    Parameters {
        paths: paths.unwrap_or("./src".to_string()),
        fn_attribute_name: fn_attribute_name.unwrap_or("utoipa".to_string()),
        schema_attribute_name: schema_attribute_name.unwrap_or("ToSchema".to_string()),
        response_attribute_name: response_attribute_name.unwrap_or("ToResponse".to_string()),
    }
}

// extract the name = "" attributes from the proc_macro::TokenStream
fn extract_attribute(name: &str, stream: proc_macro2::TokenStream) -> Option<String> {
    let mut has_value = false;

    for token in stream {
        if has_value {
            if let proc_macro2::TokenTree::Literal(lit) = token {
                return Some(get_content(lit));
            }
        }
        if let proc_macro2::TokenTree::Ident(ident) = token {
            if ident.to_string().eq(name) {
                has_value = true;
            }
        }
    }
    None
}

fn get_content(lit: Literal) -> String {
    let content = lit.to_string();
    content[1..content.len() - 1].to_string()
}

/// Check if the macro is placed before the #[derive] and #[openapi] attributes
/// Otherwise, panic!
pub fn check_macro_placement(attrs: Vec<Attribute>) {
    if !attrs.iter().any(|elm| elm.path().is_ident("derive")) {
        panic!("Please put utoipauto before #[derive] and #[openapi]");
    }

    if !attrs.iter().any(|elm| elm.path().is_ident("openapi")) {
        panic!("Please put utoipauto before #[derive] and #[openapi]");
    }
}

// Output the macro back to the compiler
pub fn output_macro(openapi_macro: syn::ItemStruct) -> proc_macro::TokenStream {
    let code = quote!(
          #openapi_macro
    );

    TokenStream::from(code)
}

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

    #[test]
    fn test_get_content() {
        let lit = Literal::string("p1");
        let content = get_content(lit);
        assert_eq!(content, "p1");
    }

    #[test]
    fn test_extract_attributes() {
        let tokens = quote! {
            paths = "p1"
        };

        let attributes = extract_attributes(tokens);
        assert_eq!(attributes.paths, "p1")
    }

    #[test]
    fn test_extract_attribute() {
        let quote = quote! {
            paths = "p1", thing = "thing", other = "other"
        };

        let attributes = extract_attribute("thing", quote).unwrap();
        assert_eq!(attributes, "thing");
    }

    #[test]
    fn test_extract_attribute_none() {
        let quote = quote! {
            paths = "p1", thing = "thing", other = "other"
        };

        let attributes = extract_attribute("not_found", quote);
        assert_eq!(attributes, None);
    }

    #[test]
    fn test_extract_attribute_empty() {
        let quote = quote! {};

        let attributes = extract_attribute("thing", quote);
        assert_eq!(attributes, None);
    }

    #[test]
    fn test_extract_attributes_empty() {
        let tokens = quote! {};

        let attributes = extract_attributes(tokens);
        assert_eq!(attributes.paths, "./src");
        assert_eq!(attributes.fn_attribute_name, "utoipa");
        assert_eq!(attributes.schema_attribute_name, "ToSchema");
        assert_eq!(attributes.response_attribute_name, "ToResponse");
    }

    #[test]
    fn test_extract_attributes_custom_name() {
        let tokens = quote! {
            paths = "p1", function_attribute_name = "handler", schema_attribute_name = "Schema", response_attribute_name = "Response"
        };

        let attributes = extract_attributes(tokens);
        assert_eq!(attributes.paths, "p1");
        assert_eq!(attributes.fn_attribute_name, "handler");
        assert_eq!(attributes.schema_attribute_name, "Schema");
        assert_eq!(attributes.response_attribute_name, "Response");
    }
}