From 00efaccf233f7ba29c82c27322c965875183d930 Mon Sep 17 00:00:00 2001 From: Rob Ede Date: Tue, 2 Feb 2021 01:39:23 +0000 Subject: [PATCH] prepare macros v0.2.0 release --- actix-macros/Cargo.toml | 9 +-- actix-macros/src/lib.rs | 64 ++++++++++--------- actix-macros/tests/trybuild.rs | 2 + .../tests/trybuild/main-02-only-async.stderr | 2 +- .../tests/trybuild/main-03-fn-params.rs | 6 ++ .../tests/trybuild/test-03-only-async.rs | 6 ++ .../tests/trybuild/test-03-only-async.stderr | 5 ++ actix-rt/Cargo.toml | 4 +- actix-rt/README.md | 2 +- actix-rt/src/lib.rs | 2 +- actix-server/Cargo.toml | 2 +- actix-service/Cargo.toml | 2 +- actix-tls/Cargo.toml | 3 +- actix-tracing/Cargo.toml | 2 +- actix-utils/Cargo.toml | 2 +- 15 files changed, 66 insertions(+), 47 deletions(-) create mode 100644 actix-macros/tests/trybuild/main-03-fn-params.rs create mode 100644 actix-macros/tests/trybuild/test-03-only-async.rs create mode 100644 actix-macros/tests/trybuild/test-03-only-async.stderr diff --git a/actix-macros/Cargo.toml b/actix-macros/Cargo.toml index 7392eb12..9e52d508 100644 --- a/actix-macros/Cargo.toml +++ b/actix-macros/Cargo.toml @@ -1,8 +1,8 @@ [package] name = "actix-macros" -version = "0.2.0-beta.1" +version = "0.2.0" authors = ["Nikolay Kim "] -description = "Actix runtime macros" +description = "Macros for Actix system and runtime" repository = "https://github.com/actix/actix-net" documentation = "https://docs.rs/actix-macros/" categories = ["network-programming", "asynchronous"] @@ -16,11 +16,8 @@ proc-macro = true quote = "1.0.3" syn = { version = "^1", features = ["full"] } -[features] -actix-reexport = [] - [dev-dependencies] -actix-rt = "2.0.0-beta.2" +actix-rt = "2.0.0-beta.3" futures-util = { version = "0.3", default-features = false } trybuild = "1" diff --git a/actix-macros/src/lib.rs b/actix-macros/src/lib.rs index 54b89565..df3cc4a9 100644 --- a/actix-macros/src/lib.rs +++ b/actix-macros/src/lib.rs @@ -1,4 +1,12 @@ -//! Macros for use with Tokio +//! Macros for Actix system and runtime. +//! +//! The [`actix-rt`](https://docs.rs/actix-rt) crate must be available for macro output to compile. +//! +//! # Entry-point +//! See docs for the [`#[main]`](macro@main) macro. +//! +//! # Tests +//! See docs for the [`#[test]`](macro@test) macro. #![deny(rust_2018_idioms, nonstandard_style)] #![doc(html_logo_url = "https://actix.rs/img/logo.png")] @@ -7,10 +15,9 @@ use proc_macro::TokenStream; use quote::quote; -/// Marks async function to be executed by Actix system. -/// -/// ## Usage +/// Marks async entry-point function to be executed by Actix system. /// +/// # Examples /// ``` /// #[actix_rt::main] /// async fn main() { @@ -28,9 +35,12 @@ pub fn main(_: TokenStream, item: TokenStream) -> TokenStream { let body = &input.block; if sig.asyncness.is_none() { - return syn::Error::new_spanned(sig.fn_token, "only async fn is supported") - .to_compile_error() - .into(); + return syn::Error::new_spanned( + sig.fn_token, + "the async keyword is missing from the function declaration", + ) + .to_compile_error() + .into(); } sig.asyncness = None; @@ -45,18 +55,17 @@ pub fn main(_: TokenStream, item: TokenStream) -> TokenStream { .into() } -/// Marks async test function to be executed by Actix system. +/// Marks async test function to be executed in an Actix system. /// -/// ## Usage -/// -/// ```no_run +/// # Examples +/// ``` /// #[actix_rt::test] /// async fn my_test() { /// assert!(true); /// } /// ``` #[proc_macro_attribute] -pub fn test(_: TokenStream, item: TokenStream) -> TokenStream { +pub fn test_base(_: TokenStream, item: TokenStream) -> TokenStream { let mut input = syn::parse_macro_input!(item as syn::ItemFn); let attrs = &input.attrs; let vis = &input.vis; @@ -73,7 +82,7 @@ pub fn test(_: TokenStream, item: TokenStream) -> TokenStream { if sig.asyncness.is_none() { return syn::Error::new_spanned( input.sig.fn_token, - format!("only async fn is supported, {}", input.sig.ident), + "the async keyword is missing from the function declaration", ) .to_compile_error() .into(); @@ -81,24 +90,19 @@ pub fn test(_: TokenStream, item: TokenStream) -> TokenStream { sig.asyncness = None; - let result = if has_test_attr { - quote! { - #(#attrs)* - #vis #sig { - actix_rt::System::new() - .block_on(async { #body }) - } - } + let missing_test_attr = if has_test_attr { + quote!() } else { - quote! { - #[test] - #(#attrs)* - #vis #sig { - actix_rt::System::new() - .block_on(async { #body }) - } - } + quote!(#[test]) }; - result.into() + (quote! { + #missing_test_attr + #(#attrs)* + #vis #sig { + actix_rt::System::new() + .block_on(async { #body }) + } + }) + .into() } diff --git a/actix-macros/tests/trybuild.rs b/actix-macros/tests/trybuild.rs index d944e3a2..a726d3bd 100644 --- a/actix-macros/tests/trybuild.rs +++ b/actix-macros/tests/trybuild.rs @@ -3,7 +3,9 @@ fn compile_macros() { let t = trybuild::TestCases::new(); t.pass("tests/trybuild/main-01-basic.rs"); t.compile_fail("tests/trybuild/main-02-only-async.rs"); + t.pass("tests/trybuild/main-03-fn-params.rs"); t.pass("tests/trybuild/test-01-basic.rs"); t.pass("tests/trybuild/test-02-keep-attrs.rs"); + t.compile_fail("tests/trybuild/test-03-only-async.rs"); } diff --git a/actix-macros/tests/trybuild/main-02-only-async.stderr b/actix-macros/tests/trybuild/main-02-only-async.stderr index e5e44492..fc060071 100644 --- a/actix-macros/tests/trybuild/main-02-only-async.stderr +++ b/actix-macros/tests/trybuild/main-02-only-async.stderr @@ -1,4 +1,4 @@ -error: only async fn is supported +error: the async keyword is missing from the function declaration --> $DIR/main-02-only-async.rs:2:1 | 2 | fn main() { diff --git a/actix-macros/tests/trybuild/main-03-fn-params.rs b/actix-macros/tests/trybuild/main-03-fn-params.rs new file mode 100644 index 00000000..3f83b4b6 --- /dev/null +++ b/actix-macros/tests/trybuild/main-03-fn-params.rs @@ -0,0 +1,6 @@ +#[actix_rt::main] +async fn main2(_param: bool) { + futures_util::future::ready(()).await +} + +fn main() {} diff --git a/actix-macros/tests/trybuild/test-03-only-async.rs b/actix-macros/tests/trybuild/test-03-only-async.rs new file mode 100644 index 00000000..436ff460 --- /dev/null +++ b/actix-macros/tests/trybuild/test-03-only-async.rs @@ -0,0 +1,6 @@ +#[actix_rt::test] +fn my_test() { + futures_util::future::ready(()).await +} + +fn main() {} diff --git a/actix-macros/tests/trybuild/test-03-only-async.stderr b/actix-macros/tests/trybuild/test-03-only-async.stderr new file mode 100644 index 00000000..4d8190a5 --- /dev/null +++ b/actix-macros/tests/trybuild/test-03-only-async.stderr @@ -0,0 +1,5 @@ +error: the async keyword is missing from the function declaration + --> $DIR/test-03-only-async.rs:2:1 + | +2 | fn my_test() { + | ^^ diff --git a/actix-rt/Cargo.toml b/actix-rt/Cargo.toml index 65877abd..f499d657 100644 --- a/actix-rt/Cargo.toml +++ b/actix-rt/Cargo.toml @@ -5,7 +5,7 @@ authors = [ "Nikolay Kim ", "Rob Ede ", ] -description = "Tokio-based single-thread async runtime for the Actix ecosystem" +description = "Tokio-based single-threaded async runtime for the Actix ecosystem" keywords = ["network", "framework", "async", "futures"] homepage = "https://actix.rs" repository = "https://github.com/actix/actix-net.git" @@ -23,7 +23,7 @@ default = ["macros"] macros = ["actix-macros"] [dependencies] -actix-macros = { version = "0.2.0-beta.1", optional = true } +actix-macros = { version = "0.2.0", optional = true } futures-core = { version = "0.3", default-features = false } tokio = { version = "1", features = ["rt", "net", "parking_lot", "signal", "sync", "time"] } diff --git a/actix-rt/README.md b/actix-rt/README.md index f58c2f4f..7027b91a 100644 --- a/actix-rt/README.md +++ b/actix-rt/README.md @@ -1,6 +1,6 @@ # actix-rt -> Tokio-based single-thread async runtime for the Actix ecosystem. +> Tokio-based single-threaded async runtime for the Actix ecosystem. See documentation for detailed explanations these components: [https://docs.rs/actix-rt][docs]. diff --git a/actix-rt/src/lib.rs b/actix-rt/src/lib.rs index 09d155e5..9c846203 100644 --- a/actix-rt/src/lib.rs +++ b/actix-rt/src/lib.rs @@ -1,4 +1,4 @@ -//! Tokio-based single-thread async runtime for the Actix ecosystem. +//! Tokio-based single-threaded async runtime for the Actix ecosystem. //! //! In most parts of the the Actix ecosystem, it has been chosen to use !Send futures. For this //! reason, a single-threaded runtime is appropriate since it is guaranteed that futures will not diff --git a/actix-server/Cargo.toml b/actix-server/Cargo.toml index c366124a..e408b8b1 100755 --- a/actix-server/Cargo.toml +++ b/actix-server/Cargo.toml @@ -24,7 +24,7 @@ default = [] [dependencies] actix-codec = "0.4.0-beta.1" -actix-rt = { version = "2.0.0-beta.2", default-features = false } +actix-rt = { version = "2.0.0-beta.3", default-features = false } actix-service = "2.0.0-beta.3" actix-utils = "3.0.0-beta.1" diff --git a/actix-service/Cargo.toml b/actix-service/Cargo.toml index e6cb1250..c0ba9d1f 100644 --- a/actix-service/Cargo.toml +++ b/actix-service/Cargo.toml @@ -24,5 +24,5 @@ futures-core = { version = "0.3.7", default-features = false } pin-project-lite = "0.2" [dev-dependencies] -actix-rt = "2.0.0-beta.2" +actix-rt = { version = "2.0.0-beta.3", default-features = false } futures-util = { version = "0.3.7", default-features = false } diff --git a/actix-tls/Cargo.toml b/actix-tls/Cargo.toml index c31cded0..c341bc9e 100755 --- a/actix-tls/Cargo.toml +++ b/actix-tls/Cargo.toml @@ -41,7 +41,7 @@ uri = ["http"] [dependencies] actix-codec = "0.4.0-beta.1" -actix-rt = { version = "2.0.0-beta.2", default-features = false } +actix-rt = { version = "2.0.0-beta.3", default-features = false } actix-service = "2.0.0-beta.3" actix-utils = "3.0.0-beta.1" @@ -67,7 +67,6 @@ tls-native-tls = { package = "native-tls", version = "0.2", optional = true } tokio-native-tls = { version = "0.3", optional = true } [dev-dependencies] -actix-rt = "2.0.0-beta.2" actix-server = "2.0.0-beta.2" bytes = "1" env_logger = "0.8" diff --git a/actix-tracing/Cargo.toml b/actix-tracing/Cargo.toml index 72f7b702..09a807d2 100644 --- a/actix-tracing/Cargo.toml +++ b/actix-tracing/Cargo.toml @@ -23,5 +23,5 @@ tracing = "0.1" tracing-futures = "0.2" [dev_dependencies] -actix-rt = "2.0.0-beta.2" +actix-rt = { version = "2.0.0-beta.3", default-features = false } slab = "0.4" diff --git a/actix-utils/Cargo.toml b/actix-utils/Cargo.toml index c82cf79e..d9c69bd8 100644 --- a/actix-utils/Cargo.toml +++ b/actix-utils/Cargo.toml @@ -17,7 +17,7 @@ path = "src/lib.rs" [dependencies] actix-codec = "0.4.0-beta.1" -actix-rt = { version = "2.0.0-beta.2", default-features = false } +actix-rt = { version = "2.0.0-beta.3", default-features = false } actix-service = "2.0.0-beta.3" futures-core = { version = "0.3.7", default-features = false }