feat(templates): ✨ added blame_err! convenience macro

Author: arctic-hen7

examples/showcase/src/templates/post.rs

@@ -1,6 +1,4 @@
-use perseus::{
-    ErrorCause, GenericErrorWithCause, RenderFnResult, RenderFnResultWithCause, Template,
-};
+use perseus::{blame_err, RenderFnResult, RenderFnResultWithCause, Template};
 use serde::{Deserialize, Serialize};
 use sycamore::prelude::{component, template, GenericNode, Template as SycamoreTemplate};
 
@@ -40,10 +38,11 @@ pub async fn get_static_props(
 ) -> RenderFnResultWithCause<PostPageProps> {
     // This path is illegal, and can't be rendered
     if path == "post/tests" {
-        return Err(GenericErrorWithCause {
-            error: "illegal page".into(),
-            cause: ErrorCause::Client(Some(404)),
-        });
+        // return Err(GenericErrorWithCause {
+        //     error: "illegal page".into(),
+        //     cause: ErrorCause::Client(Some(404)),
+        // });
+        blame_err!(client, 404, "illegal page");
     }
     // This is just an example
     let title = urlencoding::decode(&path).unwrap();

packages/perseus/src/errors.rs

@@ -176,3 +176,42 @@ impl<E: std::error::Error + 'static> From<E> for GenericErrorWithCause {
         }
     }
 }
+
+/// Creates a new `GenericErrorWithCause` efficiently. This allows you to explicitly return errors from anything that returns
+/// `RenderFnResultWithCause`, which includes both an error and a statement of whether the server or the client is responsible. With
+/// this macro, you can use any of the following syntaxes (substituting `"error!"` for any error that can be converted with `.into()`
+/// into a `Box<dyn std::error::Error>`):
+///
+/// - `blame_err!(client, "error!")` -- an error that's the client's fault, with the default HTTP status code (400, a generic client error)
+/// - `blame_err!(server, "error!")` -- an error that's the server's fault, with the default HTTP status code (500, a generic server error)
+/// - `blame_err!(client, 404, "error!")` -- an error that's the client's fault, with a custom HTTP status code (404 in this example)
+/// - `blame_err!(server, 501, "error!")` -- an error that's the server's fault, with a custom HTTP status code (501 in this example)
+///
+/// Note that this macro will automatically `return` the error it creates.
+#[macro_export]
+macro_rules! blame_err {
+    (client, $err:expr) => {
+        return ::std::result::Result::Err(::perseus::GenericErrorWithCause {
+            error: $err.into(),
+            cause: $crate::ErrorCause::Client(::std::option::Option::None),
+        })
+    };
+    (client, $code:literal, $err:expr) => {
+        return ::std::result::Result::Err(::perseus::GenericErrorWithCause {
+            error: $err.into(),
+            cause: $crate::ErrorCause::Client(::std::option::Option::Some($code)),
+        })
+    };
+    (server, $err:expr) => {
+        return ::std::result::Result::Err(::perseus::GenericErrorWithCause {
+            error: $err.into(),
+            cause: $crate::ErrorCause::Server(::std::option::Option::None),
+        })
+    };
+    (server, $code:literal, $err:expr) => {
+        return ::std::result::Result::Err(::perseus::GenericErrorWithCause {
+            error: $err.into(),
+            cause: $crate::ErrorCause::Server(::std::option::Option::Some($code)),
+        })
+    };
+}