sword_macros/

lib.rs

use proc_macro::TokenStream;
use quote::quote;
use syn::parse_macro_input;

mod config;
mod shared;

mod controller {
    pub mod expand;
    pub mod generation;
    pub mod parsing;

    pub mod routes {
        mod expand;
        mod generation;
        mod parsing;

        pub use expand::*;
        pub use generation::*;
        pub use parsing::*;
    }

    pub use expand::expand_controller;
    pub use routes::expand_controller_routes;
}

mod middlewares;

mod injectable;

/// Defines a handler for HTTP GET requests.
/// This macro should be used inside an `impl` block of a struct annotated with the `#[controller]` macro.
///
/// ### Parameters
/// - `path`: The path for the GET request, e.g., `"/items"`
///
/// ### Usage
/// ```rust,ignore
/// #[controller("/api")]
/// struct MyController {}
///
/// #[routes]
/// impl MyController {
///     #[get("/items")]
///     async fn get_items(&self) -> HttpResponse {
///         HttpResponse::Ok().message("List of items")
///     }
/// }
/// ```
#[proc_macro_attribute]
pub fn get(attr: TokenStream, item: TokenStream) -> TokenStream {
    let _ = attr;
    item
}

/// Defines a handler for HTTP POST requests.
/// This macro should be used inside an `impl` block of a struct annotated with the `#[controller]` macro.
///
/// ### Parameters
/// - `path`: The path for the POST request, e.g., `"/api"`
///
/// ## Usage
/// ```rust,ignore
/// #[controller("/api")]
/// struct MyController {}
///
/// #[routes]
/// impl MyController {
///     #[post("/items")]
///     async fn create_item(&self, req: Request) -> HttpResult<HttpResponse> {
///         Ok(HttpResponse::Ok().message("Item created"))
///     }
/// }
/// ```
#[proc_macro_attribute]
pub fn post(attr: TokenStream, item: TokenStream) -> TokenStream {
    let _ = attr;
    item
}

/// Defines a handler for HTTP PUT requests.
/// This macro should be used inside an `impl` block of a struct annotated with the `#[controller]` macro.
///
/// ### Parameters
/// - `path`: The path for the PUT request, e.g., `"/items"`
///
/// ## Usage
/// ```rust,ignore
/// #[controller("/api")]
/// struct MyController {}
///
/// #[routes]
/// impl MyController {
///     #[put("/item/{id}")]
///     async fn update_item(&self, req: Request) -> HttpResult<HttpResponse> {
///         Ok(HttpResponse::Ok().message("Item updated"))
///     }
/// }
/// ```
#[proc_macro_attribute]
pub fn put(attr: TokenStream, item: TokenStream) -> TokenStream {
    let _ = attr;
    item
}

/// Defines a handler for HTTP DELETE requests.
/// This macro should be used inside an `impl` block of a struct annotated with the `#[controller]` macro.
///
/// ### Parameters
/// - `path`: The path for the DELETE request, e.g., `"/item/{id}"`
///
/// ## Usage
/// ```rust,ignore
/// #[controller("/api")]
/// struct MyController {}
///
/// #[routes]
/// impl MyController {
///     #[delete("/item/{id}")]
///     async fn delete_item(&self, req: Request) -> HttpResult<HttpResponse> {
///         Ok(HttpResponse::Ok().message("Item deleted"))
///     }
/// }
/// ```
#[proc_macro_attribute]
pub fn delete(attr: TokenStream, item: TokenStream) -> TokenStream {
    let _ = attr;
    item
}

/// Defines a handler for PATCH DELETE requests.
/// This macro should be used inside an `impl` block of a struct annotated with the `#[controller]` macro.
///
/// ### Parameters
/// - `path`: The path for the PATCH request, e.g., `"/item/{id}"`
///
/// ## Usage
/// ```rust,ignore
/// #[controller("/api")]
/// struct MyController {}
///
/// #[routes]
/// impl MyController {
///     #[patch("/item/{id}")]
///     async fn patch_item(&self, req: Request) -> HttpResult<HttpResponse> {
///         Ok(HttpResponse::Ok().message("Item patched"))
///     }
/// }
/// ```
#[proc_macro_attribute]
pub fn patch(attr: TokenStream, item: TokenStream) -> TokenStream {
    let _ = attr;
    item
}

/// Defines a controller with a base path.
/// This macro should be used in combination with the `#[routes]` macro.
///
/// ### Parameters
/// - `base_path`: The base path for the controller, e.g., "/api
///
/// ### Usage
/// ```rust,ignore
/// #[controller("/base_path")]
/// struct MyController {}
///
/// #[routes]
/// impl MyController {
///     #[get("/sub_path")]
///     async fn my_handler(&self) -> HttpResponse {
///        Ok(HttpResponse::Ok().message("Hello from MyController"))    
///     }
/// }
/// ```
#[proc_macro_attribute]
pub fn controller(attr: TokenStream, item: TokenStream) -> TokenStream {
    controller::expand_controller(attr, item)
        .unwrap_or_else(|err| err.to_compile_error().into())
}

/// Implements the routes for a controller defined with the `#[controller]` macro.
///
/// ### Usage
/// ```rust,ignore
/// #[controller("/base_path")]
/// struct MyController {}
///
/// #[routes]
/// impl MyController {
///     #[get("/sub_path")]
///     async fn my_handler(&self) -> HttpResponse {
///        HttpResponse::Ok().message("Hello from MyController")
///     }
/// }
/// ```
#[proc_macro_attribute]
pub fn routes(attr: TokenStream, item: TokenStream) -> TokenStream {
    controller::expand_controller_routes(attr, item)
        .unwrap_or_else(|err| err.to_compile_error().into())
}

///  Declares a middleware struct.
#[proc_macro_attribute]
pub fn middleware(attr: TokenStream, item: TokenStream) -> TokenStream {
    middlewares::expand_middleware(attr, item)
        .unwrap_or_else(|err| err.to_compile_error().into())
}

/// Declares a executable middleware to apply to a route controller.
/// This macro should be used inside an `impl` block of a struct annotated with the `#[controller]` macro.
///
/// ### Parameters
/// - `MiddlewareName`: The name of the middleware struct that implements the `Middleware` or `MiddlewareWithConfig` trait.
///   Also can receive an instance of a `tower-http` service layer like `CorsLayer`, `CompressionLayer`, `TraceLayer`, etc.
///   If the layer can be added without errors on `Application::with_layer` there will not be any problem using it.  
///
/// - `config`: (Optional) Configuration parameters for the middleware,
///
/// ### Handle errors
/// To throw an error from a middleware, simply return an `Err` with an `HttpResponse`
/// struct in the same way as a controller handler.
///
/// ### Usage
/// ```rust,ignore
/// pub struct RoleMiddleware;
///
/// impl MiddlewareWithConfig<Vec<&str>> for RoleMiddleware {
///     async fn handle(roles: Vec<&str>, req: Request, next: Next) -> MiddlewareResult {
///         next!(ctx, next)
///     }
/// }
///
/// #[controller("/api")]
/// struct MyController {}
///
/// #[routes]
/// impl MyController {
///     #[get("/items")]
///     #[uses(RoleMiddleware)]
///     async fn get_items(&self) -> HttpResponse {
///         HttpResponse::Ok().message("List of items")
///     }
/// }
/// ```
#[proc_macro_attribute]
pub fn uses(attr: TokenStream, item: TokenStream) -> TokenStream {
    let _ = attr;
    item
}

/// Defines a configuration struct for the application.
/// This macro generates the necessary code to deserialize the struct from
/// the configuration toml file.
///
/// The struct must derive `Deserialize` from `serde`.
///
/// ### Parameters
/// - `key`: The key in the configuration file where the struct is located.
///
/// ### Usage
/// ```rust,ignore
/// #[derive(Deserialize)]
/// #[config(key = "my-section")]
/// struct MyConfig {
///     my_key: String,
/// }
/// ```
///
/// This allows you to access the configuration in your handlers or middlewares
///
/// ```rust,ignore
/// #[controller("/some_path")]
/// struct SomeController {
///     my_config: MyConfig,
/// }
///
/// #[routes]
/// impl SomeController {
///     #[get("/config")]
///     async fn get_config(&self) -> HttpResponse {
///         let message = format!("Config key: {}", &self.config.my_key);
///
///         HttpResponse::Ok().message(message)
///     }
/// }
#[proc_macro_attribute]
pub fn config(attr: TokenStream, item: TokenStream) -> TokenStream {
    config::expand_config_struct(attr, item)
}

/// Marks a struct as injectable.
///
/// This macro generates the necessary code to register the struct
/// in the dependency injection container. It can be used with or without
/// parameters.
///
/// ### Parameters
///
/// - `kind`: (Optional) Specifies the kind of injectable.
///   It can be either `provider` or `component`.
///
///  `provider`: The struct that has to be instantiated manually and
///   registered in the container. The struct will be treated as a singleton by default.
///
///  `component`: The struct will be instantiated automatically by the container
///   based on its dependencies. It's also treated as a singleton by default.
///
///   By default, if no kind is provided, it will be treated as `component`.
///
/// - `no_derive_clone`: (Optional) If provided, the struct will not derive the `Clone` automatically.
///   By default, the struct will derive `Clone` if all its fields implement `Clone`.
///
/// ### Usage of `#[injectable]` without parameters
///
/// ```rust,ignore
/// #[injectable]
/// pub struct TaskRepository {
///     db: Database,
/// }
///
/// impl TaskRepository {
///     pub async fn create(&self, task: Value) {
///         self.db.insert("tasks", task).await;
///     }
///
///     pub async fn find_all(&self) -> Option<Vec<Value>> {
///         self.db.get_all("tasks").await
///     }
/// }
/// ```
///
/// ### Usage of `#[injectable(instance)]` with parameters
///
/// ```rust,ignore
/// #[injectable(kind = "provider")]
/// pub struct Database {
///     db: Store,
/// }
///
/// impl Database {
///     pub async fn new(db_conf: DatabaseConfig) -> Self {
///         let db = Arc::new(RwLock::new(HashMap::new()));
///
///         db.write().await.insert(db_conf.collection_name, Vec::new());
///
///         Self { db }
///     }
///
///     pub async fn insert(&self, table: &'static str, record: Value) {
///         let mut db = self.db.write().await;
///
///         if let Some(table_data) = db.get_mut(table) {
///             table_data.push(record);
///         }
///     }
///
///     pub async fn get_all(&self, table: &'static str) -> Option<Vec<Value>> {
///         let db = self.db.read().await;
///
///         db.get(table).cloned()
///     }
/// }
/// ```
#[proc_macro_attribute]
pub fn injectable(attr: TokenStream, item: TokenStream) -> TokenStream {
    injectable::expand_injectable(attr, item)
        .unwrap_or_else(|err| err.to_compile_error().into())
}

/// ### This is just a re-export of `tokio::main` to simplify the initial setup of
/// ### Sword, you can use your own version of tokio adding it to your
/// ### `Cargo.toml`, we are providing this initial base by default
///
/// ---
///
/// Marks async function to be executed by the selected runtime. This macro
/// helps set up a `Runtime` without requiring the user to use
/// [Runtime](../tokio/runtime/struct.Runtime.html) or
/// [Builder](../tokio/runtime/struct.Builder.html) directly.
///
/// Note: This macro is designed to be simplistic and targets applications that
/// do not require a complex setup. If the provided functionality is not
/// sufficient, you may be interested in using
/// [Builder](../tokio/runtime/struct.Builder.html), which provides a more
/// powerful interface.
///
/// Note: This macro can be used on any function and not just the `main`
/// function. Using it on a non-main function makes the function behave as if it
/// was synchronous by starting a new runtime each time it is called. If the
/// function is called often, it is preferable to create the runtime using the
/// runtime builder so the runtime can be reused across calls.
///
/// # Non-worker async function
///
/// Note that the async function marked with this macro does not run as a
/// worker. The expectation is that other tasks are spawned by the function here.
/// Awaiting on other futures from the function provided here will not
/// perform as fast as those spawned as workers.
///
/// # Multi-threaded runtime
///
/// To use the multi-threaded runtime, the macro can be configured using
///
/// ```rust,ignore
/// #[tokio::main(flavor = "multi_thread", worker_threads = 10)]
/// # async fn main() {}
/// ```
///
/// The `worker_threads` option configures the number of worker threads, and
/// defaults to the number of cpus on the system. This is the default flavor.
///
/// Note: The multi-threaded runtime requires the `rt-multi-thread` feature
/// flag.
///
/// # Current thread runtime
///
/// To use the single-threaded runtime known as the `current_thread` runtime,
/// the macro can be configured using
///
/// ```rust,ignore
/// #[tokio::main(flavor = "current_thread")]
/// # async fn main() {}
/// ```
///
/// ## Function arguments:
///
/// Arguments are allowed for any functions aside from `main` which is special
///
/// ## Usage
///
/// ### Using the multi-thread runtime
///
/// ```ignore
/// #[tokio::main]
/// async fn main() {
///     println!("Hello world");
/// }
/// ```
///
/// Equivalent code not using `#[tokio::main]`
///
/// ```ignore
/// fn main() {
///     tokio::runtime::Builder::new_multi_thread()
///         .enable_all()
///         .build()
///         .unwrap()
///         .block_on(async {
///             println!("Hello world");
///         })
/// }
/// ```
///
/// ### Using current thread runtime
///
/// The basic scheduler is single-threaded.
///
/// ```ignore
/// #[tokio::main(flavor = "current_thread")]
/// async fn main() {
///     println!("Hello world");
/// }
/// ```
///
/// Equivalent code not using `#[tokio::main]`
///
/// ```ignore
/// fn main() {
///     tokio::runtime::Builder::new_current_thread()
///         .enable_all()
///         .build()
///         .unwrap()
///         .block_on(async {
///             println!("Hello world");
///         })
/// }
/// ```
///
/// ### Set number of worker threads
///
/// ```ignore
/// #[tokio::main(worker_threads = 2)]
/// async fn main() {
///     println!("Hello world");
/// }
/// ```
///
/// Equivalent code not using `#[tokio::main]`
///
/// ```ignore
/// fn main() {
///     tokio::runtime::Builder::new_multi_thread()
///         .worker_threads(2)
///         .enable_all()
///         .build()
///         .unwrap()
///         .block_on(async {
///             println!("Hello world");
///         })
/// }
/// ```
///
/// ### Configure the runtime to start with time paused
///
/// ```ignore
/// #[tokio::main(flavor = "current_thread", start_paused = true)]
/// async fn main() {
///     println!("Hello world");
/// }
/// ```
///
/// Equivalent code not using `#[tokio::main]`
///
/// ```ignore
/// fn main() {
///     tokio::runtime::Builder::new_current_thread()
///         .enable_all()
///         .start_paused(true)
///         .build()
///         .unwrap()
///         .block_on(async {
///             println!("Hello world");
///         })
/// }
/// ```
///
/// Note that `start_paused` requires the `test-util` feature to be enabled.
///
/// ### Rename package
///
/// ```ignore
/// use tokio as tokio1;
///
/// #[tokio1::main(crate = "tokio1")]
/// async fn main() {
///     println!("Hello world");
/// }
/// ```
///
/// Equivalent code not using `#[tokio::main]`
///
/// ```ignore
/// use tokio as tokio1;
///
/// fn main() {
///     tokio1::runtime::Builder::new_multi_thread()
///         .enable_all()
///         .build()
///         .unwrap()
///         .block_on(async {
///             println!("Hello world");
///         })
/// }
/// ```
///
/// ### Configure unhandled panic behavior
///
/// Available options are `shutdown_runtime` and `ignore`. For more details, see
/// [`Builder::unhandled_panic`].
///
/// This option is only compatible with the `current_thread` runtime.
///
/// ```no_run, ignore
/// # #![allow(unknown_lints, unexpected_cfgs)]
/// #[cfg(tokio_unstable)]
/// #[tokio::main(flavor = "current_thread", unhandled_panic = "shutdown_runtime")]
/// async fn main() {
///     let _ = tokio::spawn(async {
///         panic!("This panic will shutdown the runtime.");
///     }).await;
/// }
/// # #[cfg(not(tokio_unstable))]
/// # fn main() { }
/// ```
///
/// Equivalent code not using `#[tokio::main]`
///
/// ```no_run, ignore
/// # #![allow(unknown_lints, unexpected_cfgs)]
/// #[cfg(tokio_unstable)]
/// fn main() {
///     tokio::runtime::Builder::new_current_thread()
///         .enable_all()
///         .unhandled_panic(UnhandledPanic::ShutdownRuntime)
///         .build()
///         .unwrap()
///         .block_on(async {
///             let _ = tokio::spawn(async {
///                 panic!("This panic will shutdown the runtime.");
///             }).await;
///         })
/// }
/// # #[cfg(not(tokio_unstable))]
/// # fn main() { }
/// ```
///
/// **Note**: This option depends on Tokio's [unstable API][unstable]. See [the
/// documentation on unstable features][unstable] for details on how to enable
/// Tokio's unstable features.
///
/// [`Builder::unhandled_panic`]: ../tokio/runtime/struct.Builder.html#method.unhandled_panic
/// [unstable]: ../tokio/index.html#unstable-features
#[proc_macro_attribute]
pub fn main(_args: TokenStream, item: TokenStream) -> TokenStream {
    let input = parse_macro_input!(item as syn::ItemFn);

    let fn_body = input.block.clone();
    let fn_attrs = input.attrs.clone();
    let fn_vis = input.vis.clone();
    let _fn_sig = input.sig;

    #[allow(unused)]
    let mut output = quote! {};

    if cfg!(feature = "hot-reload") {
        output = quote! {

            async fn __internal_main() {
                #fn_body
            }

            #(#fn_attrs)*
            #fn_vis fn main() {
                ::sword::__internal::tokio_runtime::Builder::new_multi_thread()
                    .enable_all()
                    .build()
                    .expect("Failed building the Runtime")
                    .block_on(::sword::__internal::dioxus_devtools::serve_subsecond(__internal_main))
            }
        };
    } else {
        output = quote! {
            #(#fn_attrs)*
            #fn_vis fn main() {
                ::sword::__internal::tokio_runtime::Builder::new_multi_thread()
                    .enable_all()
                    .build()
                    .expect("Failed building the Runtime")
                    .block_on( async #fn_body )
            }
        };
    }

    output.into()
}