doc refactor

ferrunix-core/Cargo.toml

@@ -28,3 +28,6 @@ thiserror = "1"
 inventory = "0.3.1"
 tokio = { version = "1.5", default-features = false, features = ["sync"], optional = true }
 async-trait = { version = "0.1", optional = true }
+
+[package.metadata."docs.rs"]
+all-features = true

ferrunix-core/src/dependencies.rs

@@ -54,13 +54,13 @@ pub trait Dep: Registerable + private::Sealed {
     /// Looks up the dependency in `registry`, and constructs a new [`Dep`].
     ///
     /// This function is allowed to panic, if the type isn't registered.
-    #[cfg(not(feature = "tokio"))]
+    #[cfg(any(doc, not(feature = "tokio")))]
     fn new(registry: &Registry) -> Self;
 
     /// Looks up the dependency in `registry`, and constructs a new [`Dep`].
     ///
     /// This function is allowed to panic, if the type isn't registered.
-    #[cfg(feature = "tokio")]
+    #[cfg(any(doc, feature = "tokio"))]
     fn new(
         registry: &Registry,
     ) -> impl std::future::Future<Output = Self> + Send
@@ -118,7 +118,7 @@ impl<T: Registerable> Dep for Transient<T> {
     ///
     /// # Panic
     /// This function panics if the `T` isn't registered.
-    #[cfg(not(feature = "tokio"))]
+    #[cfg(any(doc, not(feature = "tokio")))]
     fn new(registry: &Registry) -> Self {
         Self {
             inner: registry.get_transient::<T>().expect(
@@ -132,7 +132,7 @@ impl<T: Registerable> Dep for Transient<T> {
     ///
     /// # Panic
     /// This function panics if the `T` isn't registered.
-    #[cfg(feature = "tokio")]
+    #[cfg(any(doc, feature = "tokio"))]
     async fn new(registry: &Registry) -> Self {
         Self {
             inner: registry.get_transient::<T>().await.expect(
@@ -202,7 +202,7 @@ impl<T: Registerable> Dep for Singleton<T> {
     ///
     /// # Panic
     /// This function panics if the `T` isn't registered.
-    #[cfg(not(feature = "tokio"))]
+    #[cfg(any(doc, not(feature = "tokio")))]
     fn new(registry: &Registry) -> Self {
         Self {
             inner: registry.get_singleton::<T>().expect(
@@ -216,7 +216,7 @@ impl<T: Registerable> Dep for Singleton<T> {
     ///
     /// # Panic
     /// This function panics if the `T` isn't registered.
-    #[cfg(feature = "tokio")]
+    #[cfg(any(doc, feature = "tokio"))]
     async fn new(registry: &Registry) -> Self {
         Self {
             inner: registry.get_singleton::<T>().await.expect(

ferrunix-core/src/lib.rs

@@ -2,6 +2,7 @@
 //!
 //! [`ferrunix`]: https://crates.io/crates/ferrunix
 //! [`ferrunix-core`]: https://crates.io/crates/ferrunix-core
+// #![doc(test(attr(cfg(not(feature = "tokio")))))]
 
 pub mod dependencies;
 pub mod dependency_builder;

ferrunix-core/src/registration.rs

@@ -43,6 +43,7 @@ impl RegistrationFunc {
     ///
     /// # Example
     /// ```no_run
+    /// # #![cfg(not(feature = "tokio"))]
     /// # use ferrunix_core::*;
     /// # use ferrunix_core::registration::*;
     /// #[derive(Debug)]

ferrunix-core/src/registry.rs

@@ -39,7 +39,7 @@ impl Registry {
     ///
     /// This is the constructor for the global registry that can be acquired
     /// with [`Registry::global`].
-    #[cfg(not(feature = "tokio"))]
+    #[cfg(any(doc, not(feature = "tokio")))]
     #[must_use]
     pub fn autoregistered() -> Self {
         let registry = Self::empty();
@@ -54,7 +54,7 @@ impl Registry {
     ///
     /// This is the constructor for the global registry that can be acquired
     /// with [`Registry::global`].
-    #[cfg(feature = "tokio")]
+    #[cfg(any(doc, feature = "tokio"))]
     #[must_use]
     pub async fn autoregistered() -> Self {
         let registry = Self::empty();

ferrunix-macros/Cargo.toml

@@ -35,3 +35,6 @@ darling = "0.20"
 
 [dev-dependencies]
 thiserror = "1"
+
+[package.metadata."docs.rs"]
+all-features = true

ferrunix/Cargo.toml

@@ -29,3 +29,6 @@ ferrunix-macros = { path = "../ferrunix-macros", optional = true, version = "=0.
 [dev-dependencies]
 thiserror = "1"
 tokio = { version = "1", features = ["full"] }
+
+# [package.metadata."docs.rs"]
+# all-features = true

xtask/src/ci.rs

@@ -30,30 +30,37 @@ pub(super) fn run() -> Result<()> {
         exit(1);
     }
 
-    cmd!(sh, "cargo test -p ferrunix --no-default-features").run()?;
-    cmd!(sh, "cargo test -p ferrunix --no-default-features -F derive").run()?;
-    cmd!(
-        sh,
-        "cargo test -p ferrunix --no-default-features -F derive,multithread"
-    )
-    .run()?;
-    cmd!(sh, "cargo test -p ferrunix-core --no-default-features").run()?;
-    cmd!(
-        sh,
-        "cargo test -p ferrunix-core --no-default-features -F multithread"
-    )
-    .run()?;
-    cmd!(sh, "cargo test -p ferrunix-macros --no-default-features").run()?;
-    cmd!(
-        sh,
-        "cargo test -p ferrunix-macros --no-default-features -F multithread"
-    )
-    .run()?;
-    cmd!(
-        sh,
-        "cargo test -p ferrunix-macros --no-default-features -F multithread,development"
-    )
-    .run()?;
+    let test_matrix = [
+        ("ferrunix", ""),
+        ("ferrunix", "derive"),
+        ("ferrunix", "multithread"),
+        ("ferrunix", "tokio"),
+        ("ferrunix", "derive,multithread"),
+        ("ferrunix", "derive,tokio"),
+        ("ferrunix-core", ""),
+        ("ferrunix-core", "multithread"),
+        ("ferrunix-core", "tokio"),
+        ("ferrunix-macros", ""),
+        ("ferrunix-macros", "multithread"),
+        ("ferrunix-macros", "development"),
+        ("ferrunix-macros", "development,multithread"),
+    ];
+
+    let testrunner = &["test"];
+    for (proj, features) in test_matrix {
+        if features.is_empty() {
+            cmd!(sh, "cargo {testrunner...} -p {proj} --no-default-features")
+                .run()?;
+            continue;
+        }
+
+        cmd!(
+            sh,
+            "cargo {testrunner...} -p {proj} --no-default-features -F {features}"
+        )
+        .run()?;
+    }
+
     cmd!(sh, "cargo test --all").run()?;
     cmd!(sh, "cargo clippy --tests --workspace").run()?;