berkus
/
actix-web
mirror of https://github.com/fafhrd91/actix-web
1
0
Fork 0
Code Issues Releases Wiki Activity

added support for creating custom methods with route macro

This commit is contained in:
edgerunnergit 2023-01-25 15:16:07 +05:30
parent 6627109984
commit 63d49febea
2 changed files with 119 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

149
actix-web-codegen/src/route.rs
View File

@ -27,7 +27,13 @@ macro_rules! method_type {
fn parse(method: &str) -> Result<Self, String> { fn parse(method: &str) -> Result<Self, String> {
match method { match method {
$(stringify!($upper) => Ok(Self::$variant),)+ $(stringify!($upper) => Ok(Self::$variant),)+
_ => Err(format!("Unexpected HTTP method: `{}`", method)), _ => { if method.chars().all(|c| c.is_ascii_uppercase()) {
Ok(Self::Custom)
} else {
Err(format!("HTTP method must be uppercase: `{}`", method))
}
},
// _ => Err(format!("Unexpected HTTP method: `{}`", method)),
} }
} }
@ -41,6 +47,12 @@ macro_rules! method_type {
}; };
} }
#[derive(Eq, Hash, PartialEq)]
struct MethodTypeExt {
method: MethodType,
custom_method: Option<LitStr>,
}
method_type! { method_type! {
Get, GET, get, Get, GET, get,
Post, POST, post, Post, POST, post,
@ -51,6 +63,7 @@ method_type! {
Options, OPTIONS, options, Options, OPTIONS, options,
Trace, TRACE, trace, Trace, TRACE, trace,
Patch, PATCH, patch, Patch, PATCH, patch,
Custom, CUSTOM, custom,
} }
impl ToTokens for MethodType { impl ToTokens for MethodType {
@ -60,6 +73,21 @@ impl ToTokens for MethodType {
} }
} }
impl ToTokens for MethodTypeExt {
fn to_tokens(&self, stream: &mut TokenStream2) {
match self.method {
MethodType::Custom => {
let ident = Ident::new(
self.custom_method.as_ref().unwrap().value().as_str(),
Span::call_site(),
);
stream.append(ident);
}
_ => self.method.to_tokens(stream),
}
}
}
impl TryFrom<&syn::LitStr> for MethodType { impl TryFrom<&syn::LitStr> for MethodType {
type Error = syn::Error; type Error = syn::Error;
@ -74,7 +102,7 @@ struct Args {
resource_name: Option<syn::LitStr>, resource_name: Option<syn::LitStr>,
guards: Vec<Path>, guards: Vec<Path>,
wrappers: Vec<syn::Type>, wrappers: Vec<syn::Type>,
methods: HashSet<MethodType>, methods: HashSet<MethodTypeExt>,
} }
impl Args { impl Args {
@ -99,7 +127,12 @@ impl Args {
let is_route_macro = method.is_none(); let is_route_macro = method.is_none();
if let Some(method) = method { if let Some(method) = method {
methods.insert(method); methods.insert({
MethodTypeExt {
method,
custom_method: None,
}
});
} }
for arg in args { for arg in args {
@ -152,10 +185,22 @@ impl Args {
)); ));
} else if let syn::Lit::Str(ref lit) = nv.lit { } else if let syn::Lit::Str(ref lit) = nv.lit {
let method = MethodType::try_from(lit)?; let method = MethodType::try_from(lit)?;
if !methods.insert(method) { if !methods.insert({
if method == MethodType::Custom {
MethodTypeExt {
method,
custom_method: Some(lit.clone()),
}
} else {
MethodTypeExt {
method,
custom_method: None,
}
}
}) {
return Err(syn::Error::new_spanned( return Err(syn::Error::new_spanned(
&nv.lit, &nv.lit,
format!( &format!(
"HTTP method defined more than once: `{}`", "HTTP method defined more than once: `{}`",
lit.value() lit.value()
), ),
@ -298,38 +343,72 @@ impl ToTokens for Route {
.as_ref() .as_ref()
.map_or_else(|| name.to_string(), LitStr::value); .map_or_else(|| name.to_string(), LitStr::value);
let method_guards = { let method_guards = {
let mut others = methods.iter(); let mut others = methods.iter();
let first = others.next().unwrap();
// unwrapping since length is checked to be at least one let first_method = &first.method;
let first = others.next().unwrap(); if methods.len() > 1 {
let mut mult_method_guards: Vec<TokenStream2> = Vec::new();
if methods.len() > 1 { for method_ext in methods {
quote! { let method_type = &method_ext.method;
.guard( let custom_method = &method_ext.custom_method;
::actix_web::guard::Any(::actix_web::guard::#first()) match custom_method {
#(.or(::actix_web::guard::#others()))* Some(lit) => {
) mult_method_guards.push(quote! {
} .or(::actix_web::guard::#method_type(#lit.clone()))
} else { });
quote! { }
.guard(::actix_web::guard::#first()) None => {
mult_method_guards.push(quote! {
.or(::actix_web::guard::#method_type())
});
}
}
}
match &first.custom_method {
Some(lit) => {
quote! {
.guard(
::actix_web::guard::Any(::actix_web::guard::#first_method(#lit.clone()))
#(#mult_method_guards)*
)
}
}
None => {
quote! {
.guard(
::actix_web::guard::Any(::actix_web::guard::#first_method())
#(#mult_method_guards)*
)
}
}
}
} else {
match &first.custom_method {
Some(lit) => {
quote! {
.guard(::actix_web::guard::#first_method(#lit.clone()))
}
}
None => {
quote! {
.guard(::actix_web::guard::#first_method())
}
}
}
} }
};
quote! {
let __resource = ::actix_web::Resource::new(#path)
.name(#resource_name)
#method_guards
#(.guard(::actix_web::guard::fn_guard(#guards)))*
#(.wrap(#wrappers))*
.to(#name);
::actix_web::dev::HttpServiceFactory::register(__resource, __config);
} }
}; })
.collect();
quote! {
let __resource = ::actix_web::Resource::new(#path)
.name(#resource_name)
#method_guards
#(.guard(::actix_web::guard::fn_guard(#guards)))*
#(.wrap(#wrappers))*
.to(#name);
::actix_web::dev::HttpServiceFactory::register(__resource, __config);
}
})
.collect();
let stream = quote! { let stream = quote! {
#(#doc_attributes)* #(#doc_attributes)*

5
actix-web/src/guard/mod.rs
View File

@ -339,6 +339,11 @@ method_guard!(Connect, CONNECT);
method_guard!(Patch, PATCH); method_guard!(Patch, PATCH);
method_guard!(Trace, TRACE); method_guard!(Trace, TRACE);
#[allow(non_snake_case)]
pub fn Custom(custom_method: &str) -> impl Guard {
MethodGuard(HttpMethod::from_bytes(custom_method.as_bytes()).unwrap())
}
/// Creates a guard that matches if request contains given header name and value. /// Creates a guard that matches if request contains given header name and value.
/// ///
/// # Examples /// # Examples