From 66bd5bf4a2518bb0d0a5a3e9503c1091b9d086bc Mon Sep 17 00:00:00 2001 From: Rob Ede Date: Tue, 2 Feb 2021 02:07:58 +0000 Subject: [PATCH] prepare macros v0.2.0 release (#261) --- actix-codec/Cargo.toml | 2 +- actix-macros/CHANGES.md | 10 ++- actix-macros/Cargo.toml | 13 ++-- actix-macros/src/lib.rs | 62 ++++++++++--------- 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-router/Cargo.toml | 2 +- actix-rt/Cargo.toml | 6 +- actix-rt/README.md | 2 +- actix-rt/src/lib.rs | 2 +- actix-server/Cargo.toml | 4 +- actix-service/Cargo.toml | 2 +- actix-tls/Cargo.toml | 6 +- actix-tracing/Cargo.toml | 4 +- actix-utils/Cargo.toml | 4 +- bytestring/Cargo.toml | 2 +- 19 files changed, 85 insertions(+), 57 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-codec/Cargo.toml b/actix-codec/Cargo.toml index d0f6646d..95a24764 100644 --- a/actix-codec/Cargo.toml +++ b/actix-codec/Cargo.toml @@ -6,7 +6,7 @@ description = "Codec utilities for working with framed protocols" keywords = ["network", "framework", "async", "futures"] homepage = "https://actix.rs" repository = "https://github.com/actix/actix-net.git" -documentation = "https://docs.rs/actix-codec/" +documentation = "https://docs.rs/actix-codec" categories = ["network-programming", "asynchronous"] license = "MIT OR Apache-2.0" edition = "2018" diff --git a/actix-macros/CHANGES.md b/actix-macros/CHANGES.md index 065d8e30..e5245775 100644 --- a/actix-macros/CHANGES.md +++ b/actix-macros/CHANGES.md @@ -3,8 +3,16 @@ ## Unreleased - 2021-xx-xx +## 0.2.0 - 2021-02-02 +* Update to latest `actix_rt::System::new` signature. [#261] + +[#261]: https://github.com/actix/actix-net/pull/261 + + ## 0.2.0-beta.1 - 2021-01-09 -* Remove `actix-reexport` feature. +* Remove `actix-reexport` feature. [#218] + +[#218]: https://github.com/actix/actix-net/pull/218 ## 0.1.3 - 2020-12-03 diff --git a/actix-macros/Cargo.toml b/actix-macros/Cargo.toml index 7392eb12..5da49b16 100644 --- a/actix-macros/Cargo.toml +++ b/actix-macros/Cargo.toml @@ -1,10 +1,10 @@ [package] name = "actix-macros" -version = "0.2.0-beta.1" +version = "0.2.0" authors = ["Nikolay Kim "] -description = "Actix runtime macros" -repository = "https://github.com/actix/actix-net" -documentation = "https://docs.rs/actix-macros/" +description = "Macros for Actix system and runtime" +repository = "https://github.com/actix/actix-net.git" +documentation = "https://docs.rs/actix-macros" categories = ["network-programming", "asynchronous"] license = "MIT OR Apache-2.0" edition = "2018" @@ -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..0d634a59 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,11 +55,10 @@ 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); @@ -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-router/Cargo.toml b/actix-router/Cargo.toml index 4277cabf..2446fc1b 100644 --- a/actix-router/Cargo.toml +++ b/actix-router/Cargo.toml @@ -6,7 +6,7 @@ description = "Resource path matching library" keywords = ["actix"] homepage = "https://actix.rs" repository = "https://github.com/actix/actix-net.git" -documentation = "https://docs.rs/actix-router/" +documentation = "https://docs.rs/actix-router" license = "MIT OR Apache-2.0" edition = "2018" diff --git a/actix-rt/Cargo.toml b/actix-rt/Cargo.toml index 65877abd..79513580 100644 --- a/actix-rt/Cargo.toml +++ b/actix-rt/Cargo.toml @@ -5,11 +5,11 @@ 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" -documentation = "https://docs.rs/actix-rt/" +documentation = "https://docs.rs/actix-rt" categories = ["network-programming", "asynchronous"] license = "MIT OR Apache-2.0" edition = "2018" @@ -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..a5f112b4 100755 --- a/actix-server/Cargo.toml +++ b/actix-server/Cargo.toml @@ -9,7 +9,7 @@ description = "General purpose TCP server built for the Actix ecosystem" keywords = ["network", "framework", "async", "futures"] homepage = "https://actix.rs" repository = "https://github.com/actix/actix-net.git" -documentation = "https://docs.rs/actix-server/" +documentation = "https://docs.rs/actix-server" categories = ["network-programming", "asynchronous"] license = "MIT OR Apache-2.0" exclude = [".gitignore", ".cargo/config"] @@ -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..f83939f2 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 = "2.0.0-beta.3" futures-util = { version = "0.3.7", default-features = false } diff --git a/actix-tls/Cargo.toml b/actix-tls/Cargo.toml index c31cded0..8c13a2fd 100755 --- a/actix-tls/Cargo.toml +++ b/actix-tls/Cargo.toml @@ -6,7 +6,7 @@ description = "TLS acceptor and connector services for Actix ecosystem" keywords = ["network", "tls", "ssl", "async", "transport"] homepage = "https://actix.rs" repository = "https://github.com/actix/actix-net.git" -documentation = "https://docs.rs/actix-tls/" +documentation = "https://docs.rs/actix-tls" categories = ["network-programming", "asynchronous"] license = "MIT OR Apache-2.0" edition = "2018" @@ -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,7 @@ 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-rt = "2.0.0-beta.3" 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..24888da3 100644 --- a/actix-tracing/Cargo.toml +++ b/actix-tracing/Cargo.toml @@ -6,7 +6,7 @@ description = "Support for tokio tracing with Actix services" keywords = ["network", "framework", "tracing"] homepage = "https://actix.rs" repository = "https://github.com/actix/actix-net.git" -documentation = "https://docs.rs/actix-tracing/" +documentation = "https://docs.rs/actix-tracing" categories = ["network-programming", "asynchronous"] license = "MIT OR Apache-2.0" edition = "2018" @@ -23,5 +23,5 @@ tracing = "0.1" tracing-futures = "0.2" [dev_dependencies] -actix-rt = "2.0.0-beta.2" +actix-rt = "2.0.0-beta.3" slab = "0.4" diff --git a/actix-utils/Cargo.toml b/actix-utils/Cargo.toml index c82cf79e..468cb8d7 100644 --- a/actix-utils/Cargo.toml +++ b/actix-utils/Cargo.toml @@ -6,7 +6,7 @@ description = "Various network related services and utilities for the Actix ecos keywords = ["network", "framework", "async", "futures"] homepage = "https://actix.rs" repository = "https://github.com/actix/actix-net.git" -documentation = "https://docs.rs/actix-utils/" +documentation = "https://docs.rs/actix-utils" categories = ["network-programming", "asynchronous"] license = "MIT OR Apache-2.0" edition = "2018" @@ -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 } diff --git a/bytestring/Cargo.toml b/bytestring/Cargo.toml index 6af76031..3e53417c 100644 --- a/bytestring/Cargo.toml +++ b/bytestring/Cargo.toml @@ -10,7 +10,7 @@ keywords = ["string", "bytes", "utf8", "web", "actix"] categories = ["no-std", "web-programming"] homepage = "https://actix.rs" repository = "https://github.com/actix/actix-net.git" -documentation = "https://docs.rs/bytestring/" +documentation = "https://docs.rs/bytestring" license = "MIT OR Apache-2.0" edition = "2018"