feat(shield-leptos): add style (#133)

DanielleHuisman · web-flow · commit 3bbfef89e4b8 · 2025-07-01T18:32:11.000+02:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/examples/leptos-actix/Cargo.toml b/examples/leptos-actix/Cargo.toml
@@ -48,6 +48,7 @@ leptos_actix = { workspace = true, optional = true }
 leptos_meta.workspace = true
 leptos_router.workspace = true
 shield.workspace = true
+# shield-bootstrap = { workspace = true, features = ["leptos"] }
 shield-leptos.workspace = true
 shield-leptos-actix = { workspace = true, optional = true }
 shield-memory = { workspace = true, optional = true }
diff --git a/examples/leptos-actix/src/home.rs b/examples/leptos-actix/src/home.rs
@@ -1,10 +1,10 @@
 use leptos::{either::Either, prelude::*};
 use leptos_router::components::A;
-use shield_leptos::integration::LeptosUser;
+use shield_leptos::LeptosUser;
 
 #[server]
 pub async fn user() -> Result<Option<LeptosUser>, ServerFnError> {
-    use shield_leptos::context::extract_user;
+    use shield_leptos::extract_user;
 
     Ok(extract_user().await)
 }
diff --git a/examples/leptos-axum/Cargo.toml b/examples/leptos-axum/Cargo.toml
@@ -44,6 +44,7 @@ leptos_axum = { workspace = true, optional = true }
 leptos_meta.workspace = true
 leptos_router.workspace = true
 shield.workspace = true
+# shield-bootstrap = { workspace = true, features = ["leptos"] }
 shield-leptos.workspace = true
 shield-leptos-axum = { workspace = true, features = [
     "utoipa",
diff --git a/examples/leptos-axum/src/home.rs b/examples/leptos-axum/src/home.rs
@@ -1,10 +1,10 @@
 use leptos::{either::Either, prelude::*};
 use leptos_router::components::A;
-use shield_leptos::integration::LeptosUser;
+use shield_leptos::LeptosUser;
 
 #[server]
 pub async fn user() -> Result<Option<LeptosUser>, ServerFnError> {
-    use shield_leptos::context::extract_user;
+    use shield_leptos::extract_user;
 
     Ok(extract_user().await)
 }
diff --git a/packages/core/shield/Cargo.toml b/packages/core/shield/Cargo.toml
@@ -20,4 +20,5 @@ futures.workspace = true
 serde = { workspace = true, features = ["derive"] }
 serde_json.workspace = true
 thiserror.workspace = true
+tracing.workspace = true
 utoipa = { workspace = true, optional = true }
diff --git a/packages/core/shield/src/action.rs b/packages/core/shield/src/action.rs
@@ -1,12 +1,21 @@
 use std::any::Any;
 
 use async_trait::async_trait;
+use serde::{Deserialize, Serialize};
 
 use crate::{
     error::ShieldError, form::Form, provider::Provider, request::Request, response::Response,
     session::Session,
 };
 
+// TODO: Think of a better name.
+#[derive(Clone, Debug, Deserialize, Serialize)]
+pub struct ActionForms {
+    pub id: String,
+    pub name: String,
+    pub forms: Vec<Form>,
+}
+
 #[async_trait]
 pub trait Action<P: Provider>: ErasedAction + Send + Sync {
     fn id(&self) -> String;
diff --git a/packages/core/shield/src/shield.rs b/packages/core/shield/src/shield.rs
@@ -1,10 +1,11 @@
 use std::{any::Any, collections::HashMap, sync::Arc};
 
 use futures::future::try_join_all;
+use tracing::warn;
 
 use crate::{
-    Session, error::ShieldError, form::Form, method::ErasedMethod, options::ShieldOptions,
-    storage::Storage, user::User,
+    action::ActionForms, error::ShieldError, method::ErasedMethod, options::ShieldOptions,
+    session::Session, storage::Storage, user::User,
 };
 
 #[derive(Clone)]
@@ -68,14 +69,23 @@ impl<U: User> Shield<U> {
         &self,
         action_id: &str,
         session: Session,
-    ) -> Result<Vec<Form>, ShieldError> {
+    ) -> Result<ActionForms, ShieldError> {
+        let mut action_name = None::<String>;
         let mut forms = vec![];
 
         for (_, method) in self.methods.iter() {
             let Some(action) = method.erased_action_by_id(action_id) else {
                 continue;
             };
 
+            let name = action.erased_name();
+            if let Some(action_name) = &action_name {
+                if *action_name != name {
+                    warn!("Action name mismatch `{}` != `{}`", action_name, name);
+                }
+            }
+            action_name = Some(name);
+
             for provider in method.erased_providers().await? {
                 if !action.erased_condition(&*provider, session.clone())? {
                     continue;
@@ -87,7 +97,11 @@ impl<U: User> Shield<U> {
             }
         }
 
-        Ok(forms)
+        Ok(ActionForms {
+            id: action_id.to_owned(),
+            name: action_name.unwrap_or(action_id.to_owned()),
+            forms,
+        })
     }
 }
 
diff --git a/packages/core/shield/src/shield_dyn.rs b/packages/core/shield/src/shield_dyn.rs
@@ -2,7 +2,9 @@ use std::{any::Any, sync::Arc};
 
 use async_trait::async_trait;
 
-use crate::{Session, error::ShieldError, form::Form, shield::Shield, user::User};
+use crate::{
+    action::ActionForms, error::ShieldError, session::Session, shield::Shield, user::User,
+};
 
 #[async_trait]
 pub trait DynShield: Send + Sync {
@@ -12,7 +14,7 @@ pub trait DynShield: Send + Sync {
         &self,
         action_id: &str,
         session: Session,
-    ) -> Result<Vec<Form>, ShieldError>;
+    ) -> Result<ActionForms, ShieldError>;
 }
 
 #[async_trait]
@@ -25,7 +27,7 @@ impl<U: User> DynShield for Shield<U> {
         &self,
         action_id: &str,
         session: Session,
-    ) -> Result<Vec<Form>, ShieldError> {
+    ) -> Result<ActionForms, ShieldError> {
         self.action_forms(action_id, session).await
     }
 }
@@ -45,7 +47,7 @@ impl ShieldDyn {
         &self,
         action_id: &str,
         session: Session,
-    ) -> Result<Vec<Form>, ShieldError> {
+    ) -> Result<ActionForms, ShieldError> {
         self.0.action_forms(action_id, session).await
     }
 }
diff --git a/packages/integrations/shield-dioxus/src/routes/action.rs b/packages/integrations/shield-dioxus/src/routes/action.rs
@@ -1,7 +1,7 @@
 use dioxus::prelude::*;
-use shield::Form;
+use shield::ActionForms;
 
-use crate::{DioxusIntegrationDyn, form::ToRsx};
+use crate::{DioxusIntegrationDyn, ErasedDioxusStyle};
 
 #[derive(Clone, PartialEq, Props)]
 pub struct ActionProps {
@@ -15,20 +15,19 @@ pub fn Action(props: ActionProps) -> Element {
 
         move || forms(action_id.clone())
     })?;
+    let style = use_context::<ErasedDioxusStyle>();
 
     let response_read = response.read();
     let response = response_read.as_ref().unwrap();
 
     match response {
-        Ok(forms) => rsx! {
-            {forms.iter().map(ToRsx::to_rsx)}
-        },
+        Ok(forms) => style.render(forms),
         Err(err) => rsx! { "{err}" },
     }
 }
 
 #[server]
-async fn forms(action_id: String) -> Result<Vec<Form>, ServerFnError> {
+async fn forms(action_id: String) -> Result<ActionForms, ServerFnError> {
     let FromContext(integration): FromContext<DioxusIntegrationDyn> = extract().await?;
     let shield = integration.extract_shield().await;
     let session = integration.extract_session().await;
diff --git a/packages/integrations/shield-dioxus/src/style.rs b/packages/integrations/shield-dioxus/src/style.rs
@@ -1,10 +1,10 @@
 use std::sync::Arc;
 
 use dioxus::prelude::Element;
-use shield::Form;
+use shield::ActionForms;
 
 pub trait DioxusStyle: Send + Sync {
-    fn render(&self, forms: &[Form]) -> Element;
+    fn render(&self, action: &ActionForms) -> Element;
 }
 
 #[derive(Clone)]
@@ -15,7 +15,7 @@ impl ErasedDioxusStyle {
         Self(Arc::new(integration))
     }
 
-    pub fn render(&self, forms: &[Form]) -> Element {
-        self.0.render(forms)
+    pub fn render(&self, action: &ActionForms) -> Element {
+        self.0.render(action)
     }
 }
diff --git a/packages/integrations/shield-leptos-actix/src/integration.rs b/packages/integrations/shield-leptos-actix/src/integration.rs
@@ -5,18 +5,18 @@ use leptos::prelude::provide_context;
 use leptos_actix::{extract, redirect};
 use shield::{Session, ShieldDyn, User};
 use shield_actix::{ExtractSession, ExtractShield, ExtractUser};
-use shield_leptos::integration::{LeptosIntegration, LeptosUser};
+use shield_leptos::{LeptosIntegration, LeptosUser};
 
-pub struct LeptosActixIntegration<U: User>(PhantomData<U>);
+pub struct ActixLeptosIntegration<U: User>(PhantomData<U>);
 
-impl<U: User> Default for LeptosActixIntegration<U> {
+impl<U: User> Default for ActixLeptosIntegration<U> {
     fn default() -> Self {
         Self(Default::default())
     }
 }
 
 #[async_trait]
-impl<U: User + Clone + 'static> LeptosIntegration for LeptosActixIntegration<U> {
+impl<U: User + Clone + 'static> LeptosIntegration for ActixLeptosIntegration<U> {
     async fn extract_shield(&self) -> ShieldDyn {
         let ExtractShield(shield) = extract::<ExtractShield<U>>().await.expect("TOD");
 
@@ -41,5 +41,5 @@ impl<U: User + Clone + 'static> LeptosIntegration for LeptosActixIntegration<U>
 }
 
 pub fn provide_actix_integration<U: User + Clone + 'static>() {
-    provide_context::<Arc<dyn LeptosIntegration>>(Arc::new(LeptosActixIntegration::<U>::default()));
+    provide_context::<Arc<dyn LeptosIntegration>>(Arc::new(ActixLeptosIntegration::<U>::default()));
 }
diff --git a/packages/integrations/shield-leptos-axum/src/integration.rs b/packages/integrations/shield-leptos-axum/src/integration.rs
@@ -5,18 +5,18 @@ use leptos::prelude::provide_context;
 use leptos_axum::{extract, redirect};
 use shield::{Session, ShieldDyn, User};
 use shield_axum::{ExtractSession, ExtractShield, ExtractUser};
-use shield_leptos::integration::{LeptosIntegration, LeptosUser};
+use shield_leptos::{LeptosIntegration, LeptosUser};
 
-pub struct LeptosAxumIntegration<U: User>(PhantomData<U>);
+pub struct AxumLeptosIntegration<U: User>(PhantomData<U>);
 
-impl<U: User> Default for LeptosAxumIntegration<U> {
+impl<U: User> Default for AxumLeptosIntegration<U> {
     fn default() -> Self {
         Self(Default::default())
     }
 }
 
 #[async_trait]
-impl<U: User + Clone + 'static> LeptosIntegration for LeptosAxumIntegration<U> {
+impl<U: User + Clone + 'static> LeptosIntegration for AxumLeptosIntegration<U> {
     async fn extract_shield(&self) -> ShieldDyn {
         let ExtractShield(shield) = extract::<ExtractShield<U>>().await.expect("TODO");
 
@@ -41,5 +41,5 @@ impl<U: User + Clone + 'static> LeptosIntegration for LeptosAxumIntegration<U> {
 }
 
 pub fn provide_axum_integration<U: User + Clone + 'static>() {
-    provide_context::<Arc<dyn LeptosIntegration>>(Arc::new(LeptosAxumIntegration::<U>::default()));
+    provide_context::<Arc<dyn LeptosIntegration>>(Arc::new(AxumLeptosIntegration::<U>::default()));
 }
diff --git a/packages/integrations/shield-leptos/src/lib.rs b/packages/integrations/shield-leptos/src/lib.rs
@@ -1,2 +1,7 @@
-pub mod context;
-pub mod integration;
+mod context;
+mod integration;
+mod style;
+
+pub use context::*;
+pub use integration::*;
+pub use style::*;
diff --git a/packages/integrations/shield-leptos/src/style.rs b/packages/integrations/shield-leptos/src/style.rs
@@ -0,0 +1,21 @@
+use std::sync::Arc;
+
+use leptos::prelude::AnyView;
+use shield::ActionForms;
+
+pub trait LeptosStyle: Send + Sync {
+    fn render(&self, action: &ActionForms) -> AnyView;
+}
+
+#[derive(Clone)]
+pub struct ErasedLeptosStyle(Arc<dyn LeptosStyle>);
+
+impl ErasedLeptosStyle {
+    pub fn new<I: LeptosStyle + 'static>(integration: I) -> Self {
+        Self(Arc::new(integration))
+    }
+
+    pub fn render(&self, action: &ActionForms) -> AnyView {
+        self.0.render(action)
+    }
+}
diff --git a/packages/styles/shield-bootstrap/Cargo.toml b/packages/styles/shield-bootstrap/Cargo.toml
@@ -10,8 +10,11 @@ version.workspace = true
 
 [features]
 dioxus = ["dep:dioxus", "dep:shield-dioxus"]
+leptos = ["dep:leptos", "dep:shield-leptos"]
 
 [dependencies]
 dioxus = { workspace = true, optional = true }
+leptos = { workspace = true, optional = true }
 shield.workspace = true
 shield-dioxus = { workspace = true, optional = true }
+shield-leptos = { workspace = true, optional = true }
diff --git a/packages/styles/shield-bootstrap/src/dioxus.rs b/packages/styles/shield-bootstrap/src/dioxus.rs
@@ -1,5 +1,5 @@
 use dioxus::prelude::*;
-use shield::Form;
+use shield::ActionForms;
 use shield_dioxus::{DioxusStyle, ErasedDioxusStyle};
 
 #[derive(Default)]
@@ -12,17 +12,16 @@ impl BootstrapDioxusStyle {
 }
 
 impl DioxusStyle for BootstrapDioxusStyle {
-    fn render(&self, forms: &[Form]) -> Element {
+    fn render(&self, action: &ActionForms) -> Element {
         rsx! {
             div {
                 class: "container",
 
                 h1 {
-                    // TODO: Get from action.
-                    "Sign in"
+                    "{action.name}"
                 }
 
-                for form in forms {
+                for form in &action.forms {
                     form {
                         for input in &form.inputs {
                             div {
diff --git a/packages/styles/shield-bootstrap/src/leptos.rs b/packages/styles/shield-bootstrap/src/leptos.rs
diff --git a/packages/styles/shield-bootstrap/src/lib.rs b/packages/styles/shield-bootstrap/src/lib.rs
