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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
//! Contraband codegen module.
//!
//! Generators for controllers, modules and route handlers.
//!
//! ## Documentation & community resources
//!
//! * [GitHub repository](https://github.com/styren/contraband)
//! * [Examples](https://github.com/styren/contraband/tree/master/examples)
extern crate proc_macro;

use proc_macro::TokenStream;
use proc_macro2::Span;
use proc_macro2::TokenStream as TokenStream2;
use quote::{format_ident, quote, ToTokens};
use syn::{parse_macro_input, DeriveInput, Ident, ItemImpl, ItemStruct};
mod args;
mod injected;
mod module;
mod route;
use crate::injected::InjectedBody;
use crate::module::ModuleArgs;
use crate::route::GuardType;
use args::Args;
use std::str::FromStr;

/// Marks function to be run in an async runtime
#[proc_macro_attribute]
pub fn main(_: TokenStream, item: TokenStream) -> TokenStream {
    let mut input = syn::parse_macro_input!(item as syn::ItemFn);
    let attrs = &input.attrs;
    let vis = &input.vis;
    let sig = &mut input.sig;
    let body = &input.block;
    let name = &sig.ident;

    if sig.asyncness.is_none() {
        return syn::Error::new_spanned(sig.fn_token, "only async fn is supported")
            .to_compile_error()
            .into();
    }

    sig.asyncness = None;

    (quote! {
        #(#attrs)*
        #vis #sig {
            contraband::Runtime::new(stringify!(#name))
                .block_on(async move { #body })
        }
    })
    .into()
}

/// Marks test function to be run in an async runtime
#[proc_macro_attribute]
pub fn test(_: TokenStream, item: TokenStream) -> TokenStream {
    let input = syn::parse_macro_input!(item as syn::ItemFn);

    let ret = &input.sig.output;
    let name = &input.sig.ident;
    let body = &input.block;
    let attrs = &input.attrs;
    let mut has_test_attr = false;

    for attr in attrs {
        if attr.path.is_ident("test") {
            has_test_attr = true;
        }
    }

    if input.sig.asyncness.is_none() {
        return syn::Error::new_spanned(
            input.sig.fn_token,
            format!("only async fn is supported, {}", input.sig.ident),
        )
        .to_compile_error()
        .into();
    }

    let result = if has_test_attr {
        quote! {
            #(#attrs)*
            fn #name() #ret {
                contraband::Runtime::new("test")
                    .block_on(async { #body })
            }
        }
    } else {
        quote! {
            #[test]
            #(#attrs)*
            fn #name() #ret {
                contraband::Runtime::new("test")
                    .block_on(async { #body })
            }
        }
    };

    result.into()
}

/// Derives the `Injectable` trait for dependency injection.
#[proc_macro_derive(Injectable)]
pub fn injectable(input: TokenStream) -> TokenStream {
    let ast = parse_macro_input!(input as DeriveInput);

    let name = &ast.ident;
    let graph_ident = Ident::new("graph", Span::call_site());
    let context_ident = Ident::new("ctx", Span::call_site());
    let fields = match &ast.data {
        syn::Data::Struct(st) => match InjectedBody::new(&graph_ident, &context_ident, st) {
            Ok(fields) => Ok(fields),
            err => err,
        },
        _ => Err(syn::Error::new_spanned(
            &ast,
            "Can only be applied to structs",
        )),
    };
    match fields {
        Ok(fi) => {
            let expanded = quote! {
                #[automatically_derived]
                impl contraband::graph::Injected for #name {
                    type Output = Self;
                    fn resolve(
                        #graph_ident: &mut contraband::graph::Graph,
                        #context_ident: &[&contraband::graph::Graph]
                    ) -> Self {
                        Self {
                            #fi
                        }
                    }
                }
            };
            TokenStream::from(expanded)
        }
        Err(err) => err.to_compile_error().into(),
    }
}

/// Creates a module.
///
/// Syntax: `#[module]`
///
/// ## Example
///
/// ```rust,no_run
/// use contraband::core::ContrabandApp;
/// use contraband::module;
/// use contraband::{Injectable, controller};
/// use actix_web::HttpResponse;
///
/// #[derive(Clone, Injectable)]
/// struct HelloController;
///
/// #[controller]
/// impl HelloController {
///     #[get]
///     async fn hello_world(self) -> HttpResponse {
///         HttpResponse::Ok().body("Hello world!")
///     }
/// }
///
/// #[module]
/// #[controller(HelloController)]
/// struct AppModule;
///
/// #[contraband::main]
/// async fn main() -> std::io::Result<()> {
///     ContrabandApp::new()
///         .start::<AppModule>()
///         .await
/// }
/// ```
///
/// # Providers
///
/// In order to inject a dependency into our different structures we need to register it as a
/// **provider**.
///
/// ## Example
///
/// ```rust,no_run
/// use contraband::core::ContrabandApp;
/// use contraband::module;
/// use contraband::{Injectable, controller};
/// use actix_web::HttpResponse;
///
/// #[derive(Clone, Injectable)]
/// struct HelloService;
///
/// impl HelloService {
///     fn get_hello<'a>(&self) -> &'a str {
///         "Hello world!"
///     }
/// }
///
/// #[derive(Clone, Injectable)]
/// struct HelloController {
///     hello_service: std::sync::Arc<HelloService>
/// }
///
/// #[controller]
/// impl HelloController {
///     #[get]
///     async fn hello_world(self) -> HttpResponse {
///         let ret = self.hello_service.get_hello();
///         HttpResponse::Ok().body(ret)
///     }
/// }
///
/// #[module]
/// #[controller(HelloController)]
/// #[provider(HelloService)]
/// struct AppModule;
///
/// #[contraband::main]
/// async fn main() -> std::io::Result<()> {
///     ContrabandApp::new()
///         .start::<AppModule>()
///         .await
/// }
/// ```
///
/// # Exporting and importing
///
/// Modules can be imported in order to share logic, such as database connection pools or database
/// repositories.
///
/// In order to use a provider from another module it first needs to be exported, using the
/// `export`-attribute. After which it can be imported in any other module using `import`.
///
/// ## Example
///
/// ```rust,no_run
/// use contraband::core::ContrabandApp;
/// use contraband::module;
/// use contraband::{Injectable, controller};
/// use actix_web::HttpResponse;
///
/// #[derive(Clone, Injectable)]
/// struct HelloService;
///
/// impl HelloService {
///     fn get_hello<'a>(&self) -> &'a str {
///         "Hello world!"
///     }
/// }
///
/// #[module]
/// #[export(HelloService)]
/// #[provider(HelloService)]
/// struct HelloModule;
///
/// #[derive(Clone, Injectable)]
/// struct HelloController {
///     hello_service: std::sync::Arc<HelloService>
/// }
///
/// #[controller]
/// impl HelloController {
///     #[get]
///     async fn hello_world(self) -> HttpResponse {
///         let ret = self.hello_service.get_hello();
///         HttpResponse::Ok().body(ret)
///     }
/// }
///
/// #[module]
/// #[controller(HelloController)]
/// #[import(HelloModule)]
/// struct AppModule;
///
/// #[contraband::main]
/// async fn main() -> std::io::Result<()> {
///     ContrabandApp::new()
///         .start::<AppModule>()
///         .await
/// }
/// ```
#[proc_macro_attribute]
pub fn module(_: TokenStream, item: TokenStream) -> TokenStream {
    let mut input = parse_macro_input!(item as ItemStruct);
    let name = &input.ident;
    match ModuleArgs::parse_and_strip(&mut input.attrs) {
        Ok(ModuleArgs {
            controllers,
            imports,
            exports,
            providers,
        }) => {
            let expanded = quote! {
                #input

                #[automatically_derived]
                impl contraband::module::ModuleFactory for #name {
                    fn get_module() -> contraband::module::Module {
                        contraband::module::Module::new()
                            #(.import::<#imports>())*
                            #(.export::<#exports>())*
                            #(.provide::<#providers>())*
                            #(.controller::<#controllers>())*
                    }
                }
            };
            TokenStream::from(expanded)
        }
        Err(err) => err.to_compile_error().into(),
    }
}

struct Method {
    name: Ident,
    guard_type: GuardType,
    args: Args,
    impl_item: syn::ImplItemMethod,
}

impl Method {
    fn new(impl_item: &mut syn::ImplItemMethod) -> Result<Option<Self>, syn::Error> {
        let mut guard_type = None;
        let mut args = None;
        let mut err = None;
        impl_item.attrs.retain(|attr| {
            match attr.parse_meta() {
                Ok(syn::Meta::List(list)) => {
                    if let Some(ident) = list.path.get_ident() {
                        if let Ok(gt) = GuardType::from_str(&*ident.to_string()) {
                            guard_type = Some(gt);
                            match Args::new(list.nested.into_iter().collect()) {
                                Ok(ar) => {
                                    args = Some(ar);
                                }
                                Err(e) => err = Some(e),
                            }
                            return false;
                        }
                    }
                }
                Ok(syn::Meta::Path(path)) => {
                    if let Some(ident) = path.get_ident() {
                        if let Ok(gt) = GuardType::from_str(&*ident.to_string()) {
                            guard_type = Some(gt);
                            return false;
                        }
                    }
                }
                Ok(_) => {}
                Err(_) => {}
            }
            true
        });

        if let Some(err_inner) = err {
            return Err(err_inner);
        }

        match guard_type {
            Some(gt) => Ok(Some(Self {
                name: format_ident!("{}_{}", "__CONTRABAND_", impl_item.sig.ident),
                guard_type: gt,
                args: args.unwrap_or_default(),
                impl_item: impl_item.clone(),
            })),
            None => Ok(None),
        }
    }
}

impl ToTokens for Method {
    fn to_tokens(&self, stream: &mut TokenStream2) {
        let Self {
            name,
            guard_type,
            args:
                Args {
                    path,
                    guards,
                    wrappers,
                },
            impl_item,
        } = self;
        let target = &impl_item.sig.ident;
        let expanded = quote! {
            #[allow(non_snake_case)]
            fn #name(&self) -> actix_web::Resource {
                actix_web::web::resource(#path)
                    .guard(actix_web::guard::#guard_type())
                    #(.guard(actix_web::guard::fn_guard(#guards)))*
                    #(.wrap(#wrappers))*
                    .to(Self::#target)
            }
        };
        stream.extend(expanded)
    }
}

/// Creates a controller.
///
/// Syntax: `#[controller("path")]`
///
/// ## Example
///
/// ```rust,no_run
/// use contraband::{Injectable, controller};
/// use contraband::core::ContrabandApp;
/// use actix_web::HttpResponse;
///
/// #[derive(Clone, Injectable)]
/// struct HelloController;
///
/// #[controller]
/// impl HelloController {
///     #[get]
///     async fn hello_world(self) -> HttpResponse {
///         HttpResponse::Ok().body("Hello world!")
///     }
/// }
/// ```
///
/// When you define an `impl`-block with a `controller`-attribute both the block and all methods
/// inside it will be parsed for specific Contraband-attributes. In the example above a
/// `get`-request is defined on the implemented method, this will automatically register it when
/// connected to a [module](module::attr.module.html).
///
/// **Note:** we don't need to import `get` since it is parsed by the `controller`-attribute
///
/// ## Impl method attributes
///
/// Valid method attributes are:
/// * All HTTP request methods (`get`, `post`, `put`, `delete`, `head`, `connect`, `options`, `trace`, `patch`)
#[proc_macro_attribute]
pub fn controller(attr: TokenStream, item: TokenStream) -> TokenStream {
    let mut input = parse_macro_input!(item as ItemImpl);
    let mut methods = Vec::new();
    for item in &mut input.items {
        if let syn::ImplItem::Method(ref mut item_method) = item {
            match Method::new(item_method) {
                Ok(Some(method)) => {
                    methods.push(method);
                }
                Ok(None) => {}
                Err(err) => {
                    return err.to_compile_error().into();
                }
            }
        }
    }

    match args::Args::new(parse_macro_input!(attr as syn::AttributeArgs)) {
        Ok(args::Args {
            path,
            guards,
            wrappers,
        }) => {
            let route_idents: Vec<&syn::Ident> = methods.iter().map(|x| &x.name).collect();
            let name = &input.self_ty;
            let expanded = quote! {
                #input
                impl #name {
                    #(#methods)*
                }

                #[automatically_derived]
                impl actix_web::FromRequest for #name {
                    type Error = actix_web::Error;
                    type Future = futures_util::future::Ready<Result<Self, Self::Error>>;
                    type Config = ();

                    #[inline]
                    fn from_request(req: &actix_web::HttpRequest, _: &mut actix_web::dev::Payload) -> Self::Future {
                        match req.app_data::<actix_web::web::Data<#name>>() {
                            Some(st) => futures_util::future::ok(st.get_ref().clone()),
                            None => panic!("Failed to extract data class."),
                        }
                    }
                }

                #[automatically_derived]
                impl contraband::module::ServiceFactory for #name {
                    fn register(&self, app: &mut actix_web::web::ServiceConfig) {
                        app.service(
                            actix_web::web::scope(#path)
                            .data(self.clone())
                            #(.guard(actix_web::guard::fn_guard(#guards)))*
                            #(.wrap(#wrappers))*
                            #(.service(Self::#route_idents(&self)))*
                        );
                    }
                }
            };
            TokenStream::from(expanded)
        }
        Err(err) => err.to_compile_error().into(),
    }
}