okapi-operation-macro 0.3.1

Macro implementation for okapi-operation
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

use darling::FromMeta;
use proc_macro2::TokenStream;
use quote::{ToTokens, quote};
use syn::{ItemFn, Meta, Token, punctuated::Punctuated};

use super::cookie::{COOKIE_ATTRIBUTE_NAME, Cookie};
use crate::{
    operation::{
        header::{HEADER_ATTRIBUTE_NAME, Header},
        path::{PATH_ATTRIBUTE_NAME, Path},
        query::{QUERY_ATTRIBUTE_NAME, Query},
        reference::{REFERENCE_ATTRIBUTE_NAME, Reference},
    },
    utils::meta_to_meta_list,
};

#[derive(Debug, FromMeta)]
#[darling(rename_all = "camelCase")]
pub(super) enum ParameterStyle {
    Matrix,
    Label,
    Form,
    Simple,
    SpaceDelimited,
    PipeDelimited,
    DeepObject,
}

impl ToTokens for ParameterStyle {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        let new_tokens = match self {
            Self::Matrix => quote! { okapi::openapi3::ParameterStyle::Matrix },
            Self::Label => quote! { okapi::openapi3::ParameterStyle::Label },
            Self::Form => quote! { okapi::openapi3::ParameterStyle::Form },
            Self::Simple => quote! { okapi::openapi3::ParameterStyle::Simple },
            Self::SpaceDelimited => quote! { okapi::openapi3::ParameterStyle::SpaceDelimited },
            Self::PipeDelimited => quote! { okapi::openapi3::ParameterStyle::PipeDelimited },
            Self::DeepObject => quote! { okapi::openapi3::ParameterStyle::DeepObject },
        };
        tokens.extend(new_tokens);
    }
}

/// Parameters description (header/path/query/cookie).
#[derive(Default, Debug)]
pub(super) struct Parameters {
    header_parameters: Vec<Header>,
    path_parameters: Vec<Path>,
    query_parameters: Vec<Query>,
    cookie_parameters: Vec<Cookie>,
    ref_parameters: Vec<Reference>,
}

impl Parameters {
    /// Append parameters that can be inferred from the function signature
    /// (currently: axum `Path<...>` extractor). Names already declared via the
    /// macro arguments win — inferred entries with a duplicate name are
    /// dropped.
    pub(super) fn add_inferred_from_signature(&mut self, item_fn: &ItemFn) {
        #[cfg(feature = "axum")]
        {
            let inferred = super::path_inference::infer_path_parameters(item_fn);
            for param in inferred {
                if self
                    .path_parameters
                    .iter()
                    .any(|p| p.name() == param.name())
                {
                    continue;
                }
                self.path_parameters.push(param);
            }
        }
        #[cfg(not(feature = "axum"))]
        {
            let _ = item_fn;
        }
    }
}

impl FromMeta for Parameters {
    fn from_meta(meta: &Meta) -> Result<Self, darling::Error> {
        let meta_list = meta_to_meta_list(meta)?;
        let mut this = Self::default();
        for meta in meta_list.parse_args_with(Punctuated::<Meta, Token![,]>::parse_terminated)? {
            let meta_ident = meta
                .path()
                .get_ident()
                .ok_or_else(|| darling::Error::custom("Should have Ident").with_span(&meta))?;
            if meta_ident == HEADER_ATTRIBUTE_NAME {
                this.header_parameters.push(Header::from_meta(&meta)?);
            } else if meta_ident == PATH_ATTRIBUTE_NAME {
                this.path_parameters.push(Path::from_meta(&meta)?);
            } else if meta_ident == QUERY_ATTRIBUTE_NAME {
                this.query_parameters.push(Query::from_meta(&meta)?);
            } else if meta_ident == COOKIE_ATTRIBUTE_NAME {
                this.cookie_parameters.push(Cookie::from_meta(&meta)?);
            } else if meta_ident == REFERENCE_ATTRIBUTE_NAME {
                this.ref_parameters.push(Reference::from_meta(&meta)?);
            } else {
                return Err(
                    darling::Error::custom("Unsupported type of parameter").with_span(meta_ident)
                );
            }
        }
        Ok(this)
    }
}

impl ToTokens for Parameters {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        let header_parameters = self.header_parameters.iter().map(|x| x.for_parameter());
        let path_parameters = &self.path_parameters;
        let query_parameters = &self.query_parameters;
        let cookie_parameters = &self.cookie_parameters;
        let ref_parameters = &self.ref_parameters;
        tokens.extend(quote! {
            parameters: {
                let mut v = Vec::new();
                #(v.push(okapi::openapi3::RefOr::Object(#header_parameters));)*
                #(v.push(okapi::openapi3::RefOr::Object(#path_parameters));)*
                #(v.push(okapi::openapi3::RefOr::Object(#query_parameters));)*
                #(v.push(okapi::openapi3::RefOr::Object(#cookie_parameters));)*
                #(v.push(#ref_parameters);)*
                v
            },
        });
    }
}