Compare commits

..

No commits in common. "d4be1362fc740627161ef83ad7f48b3de8291b84" and "6091f451accdcf472614fd598bd18a8b30905a25" have entirely different histories.

15 changed files with 239 additions and 233 deletions

View file

@ -82,13 +82,13 @@ async fn homepage(request: HttpRequest) -> ResultPage<Markup, ErrorPage> {
use pagetop::prelude::*; use pagetop::prelude::*;
/// El tema usa las mismas regiones predefinidas por [`DefaultRegions`]. /// El tema usa las mismas regiones predefinidas por [`ThemeRegion`].
pub type AlinerRegions = DefaultRegions; pub type AlinerRegion = ThemeRegion;
/// Implementa el tema para usar en pruebas que muestran el esquema de páginas HTML. /// Implementa el tema para usar en pruebas que muestran el esquema de páginas HTML.
/// ///
/// Tema mínimo ideal para **pruebas y demos** que renderiza el **esqueleto HTML** con las mismas /// Tema mínimo ideal para **pruebas y demos** que renderiza el **esqueleto HTML** con las mismas
/// regiones básicas definidas por [`DefaultRegions`]. No pretende ser un tema para producción, está /// regiones básicas definidas por [`ThemeRegion`]. No pretende ser un tema para producción, está
/// pensado para: /// pensado para:
/// ///
/// - Verificar integración de componentes y composiciones (*layouts*) sin estilos complejos. /// - Verificar integración de componentes y composiciones (*layouts*) sin estilos complejos.

View file

@ -101,8 +101,8 @@ pub mod prelude {
pub use crate::theme::*; pub use crate::theme::*;
} }
/// El tema usa las mismas regiones predefinidas por [`DefaultRegions`]. /// El tema usa las mismas regiones predefinidas por [`ThemeRegion`].
pub type BootsierRegions = DefaultRegions; pub type BootsierRegion = ThemeRegion;
/// Implementa el tema. /// Implementa el tema.
pub struct Bootsier; pub struct Bootsier;

View file

@ -1,5 +1,8 @@
//! Acciones que operan sobre componentes. //! Acciones que operan sobre componentes.
mod is_renderable;
pub use is_renderable::*;
mod before_render_component; mod before_render_component;
pub use before_render_component::*; pub use before_render_component::*;

View file

@ -0,0 +1,96 @@
use crate::prelude::*;
/// Tipo de función para determinar si un componente se renderiza o no.
///
/// Se usa en la acción [`IsRenderable`] para controlar dinámicamente la visibilidad del componente
/// `component` según el contexto `cx`. El componente **no se renderiza** en cuanto una de las
/// funciones devuelva `false`.
pub type FnIsRenderable<C> = fn(component: &C, cx: &Context) -> bool;
/// Con la función [`FnIsRenderable`] se puede decidir si se renderiza o no un componente.
pub struct IsRenderable<C: Component> {
f: FnIsRenderable<C>,
referer_type_id: Option<UniqueId>,
referer_id: AttrId,
weight: Weight,
}
/// Filtro para despachar [`FnIsRenderable`] para decidir si se renderiza o no un componente `C`.
impl<C: Component> ActionDispatcher for IsRenderable<C> {
/// Devuelve el identificador de tipo ([`UniqueId`]) del componente `C`.
fn referer_type_id(&self) -> Option<UniqueId> {
self.referer_type_id
}
/// Devuelve el identificador del componente.
fn referer_id(&self) -> Option<String> {
self.referer_id.get()
}
/// Devuelve el peso para definir el orden de ejecución.
fn weight(&self) -> Weight {
self.weight
}
}
impl<C: Component> IsRenderable<C> {
/// Permite [registrar](Extension::actions) una nueva acción [`FnIsRenderable`].
pub fn new(f: FnIsRenderable<C>) -> Self {
IsRenderable {
f,
referer_type_id: Some(UniqueId::of::<C>()),
referer_id: AttrId::default(),
weight: 0,
}
}
/// Afina el registro para ejecutar la acción [`FnIsRenderable`] sólo para el componente `C`
/// con identificador `id`.
pub fn filter_by_referer_id(mut self, id: impl AsRef<str>) -> Self {
self.referer_id.alter_value(id);
self
}
/// Opcional. Acciones con pesos más bajos se aplican antes. Se pueden usar valores negativos.
pub fn with_weight(mut self, value: Weight) -> Self {
self.weight = value;
self
}
// Despacha las acciones. Se detiene en cuanto una [`FnIsRenderable`] devuelve `false`.
#[inline]
pub(crate) fn dispatch(component: &C, cx: &mut Context) -> bool {
let mut renderable = true;
dispatch_actions(
&ActionKey::new(
UniqueId::of::<Self>(),
None,
Some(UniqueId::of::<C>()),
None,
),
|action: &Self| {
if renderable && !(action.f)(component, cx) {
renderable = false;
}
},
);
if renderable {
if let Some(id) = component.id() {
dispatch_actions(
&ActionKey::new(
UniqueId::of::<Self>(),
None,
Some(UniqueId::of::<C>()),
Some(id),
),
|action: &Self| {
if renderable && !(action.f)(component, cx) {
renderable = false;
}
},
);
}
}
renderable
}
}

View file

@ -1,4 +1,4 @@
//! Temas básicos soportados por PageTop. //! Temas básicos soportados por PageTop.
mod basic; mod basic;
pub use basic::{Basic, BasicRegions}; pub use basic::{Basic, BasicRegion};

View file

@ -1,8 +1,8 @@
/// Es el tema básico que incluye PageTop por defecto. /// Es el tema básico que incluye PageTop por defecto.
use crate::prelude::*; use crate::prelude::*;
/// El tema básico usa las mismas regiones predefinidas por [`DefaultRegions`]. /// El tema básico usa las mismas regiones predefinidas por [`ThemeRegion`].
pub type BasicRegions = DefaultRegions; pub type BasicRegion = ThemeRegion;
/// Tema básico por defecto que extiende el funcionamiento predeterminado de [`Theme`]. /// Tema básico por defecto que extiende el funcionamiento predeterminado de [`Theme`].
pub struct Basic; pub struct Basic;

View file

@ -11,59 +11,6 @@ pub use children::{Typed, TypedOp};
mod context; mod context;
pub use context::{Context, ContextError, ContextOp, Contextual}; pub use context::{Context, ContextError, ContextOp, Contextual};
/// Alias de función (*callback*) para **determinar si un componente se renderiza o no**.
///
/// Puede usarse para permitir que una instancia concreta de un tipo de componente dado decida
/// dinámicamente durante el proceso de renderizado ([`Component::is_renderable()`]) si se renderiza
/// o no.
///
/// # Ejemplo
///
/// ```rust
/// # use pagetop::prelude::*;
/// #[derive(AutoDefault)]
/// struct SampleComponent {
/// renderable: Option<FnIsRenderable>,
/// }
///
/// impl Component for SampleComponent {
/// fn new() -> Self {
/// Self::default()
/// }
///
/// fn is_renderable(&self, cx: &mut Context) -> bool {
/// // Si hay callback, se usa; en caso contrario, se renderiza por defecto.
/// self.renderable.map_or(true, |f| f(cx))
/// }
///
/// fn prepare_component(&self, _cx: &mut Context) -> PrepareMarkup {
/// PrepareMarkup::Escaped("Visible component".into())
/// }
/// }
///
/// impl SampleComponent {
/// /// Asigna una función que decidirá si el componente se renderiza o no.
/// #[builder_fn]
/// pub fn with_renderable(mut self, f: Option<FnIsRenderable>) -> Self {
/// self.renderable = f;
/// self
/// }
/// }
///
/// fn sample() {
/// let mut cx = Context::default().with_param("user_logged_in", true);
///
/// // Se instancia un componente que sólo se renderiza si `user_logged_in` es `true`.
/// let mut component = SampleComponent::new().with_renderable(Some(|cx: &Context| {
/// cx.param::<bool>("user_logged_in").copied().unwrap_or(false)
/// }));
///
/// // Aquí simplemente se comprueba que compila y se puede invocar.
/// let _markup = component.render(&mut cx);
/// }
/// ```
pub type FnIsRenderable = fn(cx: &Context) -> bool;
/// Alias de función (*callback*) para **resolver una URL** según el contexto de renderizado. /// Alias de función (*callback*) para **resolver una URL** según el contexto de renderizado.
/// ///
/// Se usa para generar enlaces dinámicos en función del contexto (petición, idioma, etc.). Debe /// Se usa para generar enlaces dinámicos en función del contexto (petición, idioma, etc.). Debe

View file

@ -45,20 +45,6 @@ pub trait Component: AnyInfo + ComponentRender + Send + Sync {
None None
} }
/// Indica si el componente es renderizable.
///
/// Por defecto, todos los componentes son renderizables (`true`). Sin embargo, este método
/// puede sobrescribirse para decidir dinámicamente si los componentes de este tipo se
/// renderizan o no en función del contexto de renderizado.
///
/// También puede usarse junto con un alias de función como
/// ([`FnIsRenderable`](crate::core::component::FnIsRenderable)) para permitir que instancias
/// concretas del componente decidan si se renderizan o no.
#[allow(unused_variables)]
fn is_renderable(&self, cx: &mut Context) -> bool {
true
}
/// Configura el componente justo antes de preparar el renderizado. /// Configura el componente justo antes de preparar el renderizado.
/// ///
/// Este método puede sobrescribirse para modificar la estructura interna del componente o el /// Este método puede sobrescribirse para modificar la estructura interna del componente o el
@ -86,30 +72,30 @@ pub trait Component: AnyInfo + ComponentRender + Send + Sync {
/// Implementa [`render()`](ComponentRender::render) para todos los componentes. /// Implementa [`render()`](ComponentRender::render) para todos los componentes.
/// ///
/// El proceso de renderizado de cada componente sigue esta secuencia: /// Y para cada componente ejecuta la siguiente secuencia:
/// ///
/// 1. Ejecuta [`is_renderable()`](Component::is_renderable) para ver si puede renderizarse en el /// 1. Despacha [`action::component::IsRenderable`](crate::base::action::component::IsRenderable)
/// contexto actual. Si no es así, devuelve un [`Markup`] vacío. /// para ver si se puede renderizar. Si no es así, devuelve un [`Markup`] vacío.
/// 2. Ejecuta [`setup_before_prepare()`](Component::setup_before_prepare) para que el componente /// 2. Ejecuta [`setup_before_prepare()`](Component::setup_before_prepare) para que el componente
/// pueda ajustar su estructura interna o modificar el contexto. /// pueda ajustar su estructura interna o modificar el contexto.
/// 3. Despacha [`action::theme::BeforeRender<C>`](crate::base::action::theme::BeforeRender) para /// 3. Despacha [`action::theme::BeforeRender<C>`](crate::base::action::theme::BeforeRender) para
/// permitir que el tema realice ajustes previos. /// que el tema pueda hacer ajustes en el componente o el contexto.
/// 4. Despacha [`action::component::BeforeRender<C>`](crate::base::action::component::BeforeRender) /// 4. Despacha [`action::component::BeforeRender<C>`](crate::base::action::component::BeforeRender)
/// para que otras extensiones puedan también hacer ajustes previos. /// para que otras extensiones puedan hacer ajustes.
/// 5. **Prepara el renderizado del componente**: /// 5. **Prepara el renderizado del componente**:
/// - Despacha [`action::theme::PrepareRender<C>`](crate::base::action::theme::PrepareRender) /// - Despacha [`action::theme::PrepareRender<C>`](crate::base::action::theme::PrepareRender)
/// para permitir al tema generar un renderizado alternativo. /// para permitir al tema preparar un renderizado diferente al predefinido.
/// - Si el tema no lo modifica, llama a [`prepare_component()`](Component::prepare_component) /// - Si no es así, ejecuta [`prepare_component()`](Component::prepare_component) para preparar
/// para obtener el renderizado por defecto del componente. /// el renderizado predefinido del componente.
/// 6. Despacha [`action::theme::AfterRender<C>`](crate::base::action::theme::AfterRender) para /// 6. Despacha [`action::theme::AfterRender<C>`](crate::base::action::theme::AfterRender) para
/// que el tema pueda aplicar ajustes finales. /// que el tema pueda hacer sus últimos ajustes.
/// 7. Despacha [`action::component::AfterRender<C>`](crate::base::action::component::AfterRender) /// 7. Despacha [`action::component::AfterRender<C>`](crate::base::action::component::AfterRender)
/// para que otras extensiones puedan hacer sus últimos ajustes. /// para que otras extensiones puedan hacer sus últimos ajustes.
/// 8. Devuelve el [`Markup`] generado en el paso 5. /// 8. Finalmente devuelve un [`Markup`] del renderizado preparado en el paso 5.
impl<C: Component> ComponentRender for C { impl<C: Component> ComponentRender for C {
fn render(&mut self, cx: &mut Context) -> Markup { fn render(&mut self, cx: &mut Context) -> Markup {
// Si no es renderizable, devuelve un bloque HTML vacío. // Si no es renderizable, devuelve un bloque HTML vacío.
if !self.is_renderable(cx) { if !action::component::IsRenderable::dispatch(self, cx) {
return html! {}; return html! {};
} }

View file

@ -9,14 +9,13 @@
//! tipografías, espaciados y cualquier otro detalle visual o de comportamiento (comoanimaciones, //! tipografías, espaciados y cualquier otro detalle visual o de comportamiento (comoanimaciones,
//! scripts de interfaz, etc.). //! scripts de interfaz, etc.).
//! //!
//! Los temas son extensiones que implementan [`Extension`](crate::core::extension::Extension), por //! Los temas son extensiones que implementan [`Extension`](crate::core::extension::Extension); por
//! lo que se instancian, declaran dependencias y se inician igual que cualquier otra extensión. //! lo que se instancian, declaran sus dependencias y se inician igual que el resto de extensiones;
//! También deben implementar [`Theme`] y sobrescribir el método //! pero serán temas si además implementan [`theme()`](crate::core::extension::Extension::theme) y
//! [`Extension::theme()`](crate::core::extension::Extension::theme) para que PageTop pueda //! [`Theme`].
//! registrarlos como temas
mod definition; mod definition;
pub use definition::{Theme, ThemePage, ThemeRef, DefaultRegions}; pub use definition::{Theme, ThemePage, ThemeRef, ThemeRegion};
mod regions; mod regions;
pub(crate) use regions::{ChildrenInRegions, REGION_CONTENT}; pub(crate) use regions::{ChildrenInRegions, REGION_CONTENT};

View file

@ -4,7 +4,7 @@ use crate::core::theme::{Region, RegionRef, REGION_CONTENT};
use crate::html::{html, Markup, StyleSheet}; use crate::html::{html, Markup, StyleSheet};
use crate::locale::L10n; use crate::locale::L10n;
use crate::response::page::Page; use crate::response::page::Page;
use crate::{global, join, AutoDefault}; use crate::{global, join};
use std::sync::LazyLock; use std::sync::LazyLock;
@ -14,17 +14,16 @@ use std::sync::LazyLock;
/// implementen [`Theme`] y, a su vez, [`Extension`]. /// implementen [`Theme`] y, a su vez, [`Extension`].
pub type ThemeRef = &'static dyn Theme; pub type ThemeRef = &'static dyn Theme;
/// Conjunto de regiones predefinidas que los temas pueden exponer para el renderizado. /// Conjunto de regiones que los temas pueden exponer para el renderizado.
/// ///
/// `DefaultRegions` define un conjunto de regiones predefinidas para estructurar un documento HTML. /// `ThemeRegion` define un conjunto de regiones predefinidas para estructurar un documento HTML.
/// Proporciona **identificadores estables** (vía [`Region::key()`]) y **etiquetas localizables** /// Proporciona **identificadores estables** (vía [`Region::key()`]) y **etiquetas localizables**
/// (vía [`Region::label()`]) a las regiones donde se añadirán los componentes. /// (vía [`Region::label()`]) a las regiones donde se añadirán los componentes.
/// ///
/// Se usa por defecto en [`Theme::page_regions()`](crate::core::theme::Theme::page_regions) y sus /// Se usa por defecto en [`Theme::page_regions()`](crate::core::theme::Theme::page_regions) y sus
/// variantes representan el conjunto mínimo recomendado para cualquier tema. Sin embargo, cada tema /// variantes representan el conjunto mínimo recomendado para cualquier tema. Sin embargo, cada tema
/// podría exponer su propio conjunto de regiones. /// podría exponer su propio conjunto de regiones.
#[derive(AutoDefault)] pub enum ThemeRegion {
pub enum DefaultRegions {
/// Cabecera de la página. /// Cabecera de la página.
/// ///
/// Clave: `"header"`. Suele contener *branding*, navegación principal o avisos globales. /// Clave: `"header"`. Suele contener *branding*, navegación principal o avisos globales.
@ -33,7 +32,6 @@ pub enum DefaultRegions {
/// Contenido principal de la página (**obligatoria**). /// Contenido principal de la página (**obligatoria**).
/// ///
/// Clave: `"content"`. Es el destino por defecto para insertar componentes a nivel de página. /// Clave: `"content"`. Es el destino por defecto para insertar componentes a nivel de página.
#[default]
Content, Content,
/// Pie de página. /// Pie de página.
@ -42,12 +40,12 @@ pub enum DefaultRegions {
Footer, Footer,
} }
impl Region for DefaultRegions { impl Region for ThemeRegion {
fn key(&self) -> &str { fn key(&self) -> &str {
match self { match self {
Self::Header => "header", ThemeRegion::Header => "header",
Self::Content => REGION_CONTENT, ThemeRegion::Content => REGION_CONTENT,
Self::Footer => "footer", ThemeRegion::Footer => "footer",
} }
} }
@ -62,17 +60,16 @@ impl Region for DefaultRegions {
/// implementa automáticamente para cualquier tipo que implemente [`Theme`], por lo que normalmente /// implementa automáticamente para cualquier tipo que implemente [`Theme`], por lo que normalmente
/// no requiere implementación explícita. /// no requiere implementación explícita.
/// ///
/// Si un tema **sobrescribe** uno o más de los siguientes métodos de [`Theme`]: /// Si un tema **sobrescribe** uno o más de estos métodos de [`Theme`]:
/// ///
/// - [`render_page_region()`](Theme::render_page_region), /// - [`render_page_region()`](Theme::render_page_region),
/// - [`render_page_head()`](Theme::render_page_head), o /// - [`render_page_head()`](Theme::render_page_head), o
/// - [`render_page_body()`](Theme::render_page_body); /// - [`render_page_body()`](Theme::render_page_body);
/// ///
/// puede volver al comportamiento por defecto con una llamada FQS (*Fully Qualified Syntax*) a: /// es posible volver al comportamiento por defecto usando FQS (*Fully Qualified Syntax*):
/// ///
/// - `<Self as ThemePage>::render_region(self, page, region)`, /// - `<Self as ThemePage>::render_body(self, page, self.page_regions())`
/// - `<Self as ThemePage>::render_body(self, page, self.page_regions())`, o /// - `<Self as ThemePage>::render_head(self, page)`
/// - `<Self as ThemePage>::render_head(self, page)`.
pub trait ThemePage { pub trait ThemePage {
/// Renderiza el **contenedor** de una región concreta del `<body>` de la página. /// Renderiza el **contenedor** de una región concreta del `<body>` de la página.
/// ///
@ -209,9 +206,9 @@ pub trait Theme: Extension + ThemePage + Send + Sync {
/// fn page_regions(&self) -> &'static [RegionRef] { /// fn page_regions(&self) -> &'static [RegionRef] {
/// static REGIONS: LazyLock<[RegionRef; 4]> = LazyLock::new(|| { /// static REGIONS: LazyLock<[RegionRef; 4]> = LazyLock::new(|| {
/// [ /// [
/// &DefaultRegions::Header, /// &ThemeRegion::Header,
/// &DefaultRegions::Content, /// &ThemeRegion::Content,
/// &DefaultRegions::Footer, /// &ThemeRegion::Footer,
/// ] /// ]
/// }); /// });
/// &*REGIONS /// &*REGIONS
@ -220,9 +217,9 @@ pub trait Theme: Extension + ThemePage + Send + Sync {
fn page_regions(&self) -> &'static [RegionRef] { fn page_regions(&self) -> &'static [RegionRef] {
static REGIONS: LazyLock<[RegionRef; 3]> = LazyLock::new(|| { static REGIONS: LazyLock<[RegionRef; 3]> = LazyLock::new(|| {
[ [
&DefaultRegions::Header, &ThemeRegion::Header,
&DefaultRegions::Content, &ThemeRegion::Content,
&DefaultRegions::Footer, &ThemeRegion::Footer,
] ]
}); });
&*REGIONS &*REGIONS

View file

@ -31,25 +31,25 @@ pub const REGION_CONTENT: &str = "content";
/// `aria-label` o en descripciones semánticas del contenedor). /// `aria-label` o en descripciones semánticas del contenedor).
/// ///
/// Las implementaciones típicas son *enumeraciones estáticas* declaradas por cada tema (ver como /// Las implementaciones típicas son *enumeraciones estáticas* declaradas por cada tema (ver como
/// ejemplo [`DefaultRegions`](crate::core::theme::DefaultRegions)), de modo que las claves y /// ejemplo [`ThemeRegion`](crate::core::theme::ThemeRegion)), de modo que las claves y etiquetas
/// etiquetas permanecen inmutables y fácilmente referenciables. /// permanecen inmutables y fácilmente referenciables.
/// ///
/// # Ejemplo /// # Ejemplo
/// ///
/// ```rust /// ```rust
/// # use pagetop::prelude::*; /// # use pagetop::prelude::*;
/// pub enum MyThemeRegions { /// pub enum MyThemeRegion {
/// Header, /// Header,
/// Content, /// Content,
/// Footer, /// Footer,
/// } /// }
/// ///
/// impl Region for MyThemeRegions { /// impl Region for MyThemeRegion {
/// fn key(&self) -> &str { /// fn key(&self) -> &str {
/// match self { /// match self {
/// Self::Header => "header", /// MyThemeRegion::Header => "header",
/// Self::Content => "content", /// MyThemeRegion::Content => "content",
/// Self::Footer => "footer", /// MyThemeRegion::Footer => "footer",
/// } /// }
/// } /// }
/// ///
@ -111,7 +111,7 @@ impl ChildrenInRegions {
} }
} }
/// Permite añadir componentes a regiones globales o específicas de un tema. /// Punto de acceso para añadir componentes a regiones globales o específicas de un tema.
/// ///
/// Según la variante, se pueden añadir componentes ([`add()`](Self::add)) que permanecerán /// Según la variante, se pueden añadir componentes ([`add()`](Self::add)) que permanecerán
/// disponibles durante toda la ejecución. /// disponibles durante toda la ejecución.

View file

@ -104,11 +104,11 @@ pub use unit::UnitValue;
/// # use pagetop::prelude::*; /// # use pagetop::prelude::*;
/// // Texto normal, se escapa automáticamente para evitar inyección de HTML. /// // Texto normal, se escapa automáticamente para evitar inyección de HTML.
/// let fragment = PrepareMarkup::Escaped("Hola <b>mundo</b>".to_string()); /// let fragment = PrepareMarkup::Escaped("Hola <b>mundo</b>".to_string());
/// assert_eq!(fragment.into_string(), "Hola &lt;b&gt;mundo&lt;/b&gt;"); /// assert_eq!(fragment.render().into_string(), "Hola &lt;b&gt;mundo&lt;/b&gt;");
/// ///
/// // HTML literal, se inserta directamente, sin escapado adicional. /// // HTML literal, se inserta directamente, sin escapado adicional.
/// let raw_html = PrepareMarkup::Raw("<b>negrita</b>".to_string()); /// let raw_html = PrepareMarkup::Raw("<b>negrita</b>".to_string());
/// assert_eq!(raw_html.into_string(), "<b>negrita</b>"); /// assert_eq!(raw_html.render().into_string(), "<b>negrita</b>");
/// ///
/// // Fragmento ya preparado con la macro `html!`. /// // Fragmento ya preparado con la macro `html!`.
/// let prepared = PrepareMarkup::With(html! { /// let prepared = PrepareMarkup::With(html! {
@ -116,11 +116,11 @@ pub use unit::UnitValue;
/// p { "Este es un párrafo con contenido dinámico." } /// p { "Este es un párrafo con contenido dinámico." }
/// }); /// });
/// assert_eq!( /// assert_eq!(
/// prepared.into_string(), /// prepared.render().into_string(),
/// "<h2>Título de ejemplo</h2><p>Este es un párrafo con contenido dinámico.</p>" /// "<h2>Título de ejemplo</h2><p>Este es un párrafo con contenido dinámico.</p>"
/// ); /// );
/// ``` /// ```
#[derive(AutoDefault, Clone)] #[derive(AutoDefault)]
pub enum PrepareMarkup { pub enum PrepareMarkup {
/// No se genera contenido HTML (equivale a `html! {}`). /// No se genera contenido HTML (equivale a `html! {}`).
#[default] #[default]
@ -152,13 +152,8 @@ impl PrepareMarkup {
} }
} }
/// Convierte el contenido en una cadena HTML renderizada. Usar sólo para pruebas o depuración. /// Integra el renderizado fácilmente en la macro [`html!`].
pub fn into_string(&self) -> String { pub fn render(&self) -> Markup {
self.render().into_string()
}
// Integra el renderizado fácilmente en la macro [`html!`].
pub(crate) fn render(&self) -> Markup {
match self { match self {
PrepareMarkup::None => html! {}, PrepareMarkup::None => html! {},
PrepareMarkup::Escaped(text) => html! { (text) }, PrepareMarkup::Escaped(text) => html! { (text) },

View file

@ -2,28 +2,32 @@ use pagetop::prelude::*;
#[pagetop::test] #[pagetop::test]
async fn component_html_renders_static_markup() { async fn component_html_renders_static_markup() {
let mut component = Html::with(|_| { let component = Html::with(|_| {
html! { html! {
p { "Test" } p { "Test" }
} }
}); });
let markup = component.render(&mut Context::default()); let markup = component
.prepare_component(&mut Context::new(None))
.render();
assert_eq!(markup.0, "<p>Test</p>"); assert_eq!(markup.0, "<p>Test</p>");
} }
#[pagetop::test] #[pagetop::test]
async fn component_html_renders_using_context_param() { async fn component_html_renders_using_context_param() {
let mut cx = Context::default().with_param("username", "Alice".to_string()); let mut cx = Context::new(None).with_param("username", "Alice".to_string());
let mut component = Html::with(|cx| { let component = Html::with(|cx| {
let name = cx.param::<String>("username").cloned().unwrap_or_default(); let name = cx.param::<String>("username").cloned().unwrap_or_default();
html! { html! {
span { (name) } span { (name) }
} }
}); });
let markup = component.render(&mut cx); let markup = component.prepare_component(&mut cx).render();
assert_eq!(markup.0, "<span>Alice</span>"); assert_eq!(markup.0, "<span>Alice</span>");
} }
@ -33,15 +37,21 @@ async fn component_html_allows_replacing_render_function() {
component.alter_fn(|_| html! { div { "Modified" } }); component.alter_fn(|_| html! { div { "Modified" } });
let markup = component.render(&mut Context::default()); let markup = component
.prepare_component(&mut Context::new(None))
.render();
assert_eq!(markup.0, "<div>Modified</div>"); assert_eq!(markup.0, "<div>Modified</div>");
} }
#[pagetop::test] #[pagetop::test]
async fn component_html_default_renders_empty_markup() { async fn component_html_default_renders_empty_markup() {
let mut component = Html::default(); let component = Html::default();
let markup = component
.prepare_component(&mut Context::new(None))
.render();
let markup = component.render(&mut Context::default());
assert_eq!(markup.0, ""); assert_eq!(markup.0, "");
} }
@ -50,7 +60,7 @@ async fn component_html_can_access_http_method() {
let req = service::test::TestRequest::with_uri("/").to_http_request(); let req = service::test::TestRequest::with_uri("/").to_http_request();
let mut cx = Context::new(Some(req)); let mut cx = Context::new(Some(req));
let mut component = Html::with(|cx| { let component = Html::with(|cx| {
let method = cx let method = cx
.request() .request()
.map(|r| r.method().to_string()) .map(|r| r.method().to_string())
@ -58,6 +68,7 @@ async fn component_html_can_access_http_method() {
html! { span { (method) } } html! { span { (method) } }
}); });
let markup = component.render(&mut cx); let markup = component.prepare_component(&mut cx).render();
assert_eq!(markup.0, "<span>GET</span>"); assert_eq!(markup.0, "<span>GET</span>");
} }

View file

@ -4,8 +4,8 @@ use pagetop::prelude::*;
async fn poweredby_default_shows_only_pagetop_recognition() { async fn poweredby_default_shows_only_pagetop_recognition() {
let _app = service::test::init_service(Application::new().test()).await; let _app = service::test::init_service(Application::new().test()).await;
let mut p = PoweredBy::default(); let p = PoweredBy::default();
let html = p.render(&mut Context::default()); let html = render_component(&p);
// Debe mostrar el bloque de reconocimiento a PageTop. // Debe mostrar el bloque de reconocimiento a PageTop.
assert!(html.as_str().contains("poweredby__pagetop")); assert!(html.as_str().contains("poweredby__pagetop"));
@ -18,8 +18,8 @@ async fn poweredby_default_shows_only_pagetop_recognition() {
async fn poweredby_new_includes_current_year_and_app_name() { async fn poweredby_new_includes_current_year_and_app_name() {
let _app = service::test::init_service(Application::new().test()).await; let _app = service::test::init_service(Application::new().test()).await;
let mut p = PoweredBy::new(); let p = PoweredBy::new();
let html = p.render(&mut Context::default()); let html = render_component(&p);
let year = Utc::now().format("%Y").to_string(); let year = Utc::now().format("%Y").to_string();
assert!( assert!(
@ -43,8 +43,8 @@ async fn poweredby_with_copyright_overrides_text() {
let _app = service::test::init_service(Application::new().test()).await; let _app = service::test::init_service(Application::new().test()).await;
let custom = "2001 © FooBar Inc."; let custom = "2001 © FooBar Inc.";
let mut p = PoweredBy::default().with_copyright(Some(custom)); let p = PoweredBy::default().with_copyright(Some(custom));
let html = p.render(&mut Context::default()); let html = render_component(&p);
assert!(html.as_str().contains(custom)); assert!(html.as_str().contains(custom));
assert!(html.as_str().contains("poweredby__copyright")); assert!(html.as_str().contains("poweredby__copyright"));
@ -54,8 +54,8 @@ async fn poweredby_with_copyright_overrides_text() {
async fn poweredby_with_copyright_none_hides_text() { async fn poweredby_with_copyright_none_hides_text() {
let _app = service::test::init_service(Application::new().test()).await; let _app = service::test::init_service(Application::new().test()).await;
let mut p = PoweredBy::new().with_copyright(None::<String>); let p = PoweredBy::new().with_copyright(None::<String>);
let html = p.render(&mut Context::default()); let html = render_component(&p);
assert!(!html.as_str().contains("poweredby__copyright")); assert!(!html.as_str().contains("poweredby__copyright"));
// El reconocimiento a PageTop siempre debe aparecer. // El reconocimiento a PageTop siempre debe aparecer.
@ -66,8 +66,8 @@ async fn poweredby_with_copyright_none_hides_text() {
async fn poweredby_link_points_to_crates_io() { async fn poweredby_link_points_to_crates_io() {
let _app = service::test::init_service(Application::new().test()).await; let _app = service::test::init_service(Application::new().test()).await;
let mut p = PoweredBy::default(); let p = PoweredBy::default();
let html = p.render(&mut Context::default()); let html = render_component(&p);
assert!( assert!(
html.as_str().contains("https://pagetop.cillero.es"), html.as_str().contains("https://pagetop.cillero.es"),
@ -89,3 +89,11 @@ async fn poweredby_getter_reflects_internal_state() {
assert!(c1.contains(&Utc::now().format("%Y").to_string())); assert!(c1.contains(&Utc::now().format("%Y").to_string()));
assert!(c1.contains(&global::SETTINGS.app.name)); assert!(c1.contains(&global::SETTINGS.app.name));
} }
// **< HELPERS >************************************************************************************
fn render_component<C: Component>(c: &C) -> Markup {
let mut cx = Context::default();
let pm = c.prepare_component(&mut cx);
pm.render()
}

View file

@ -1,69 +1,70 @@
use pagetop::prelude::*; use pagetop::prelude::*;
/// Componente mínimo para probar `PrepareMarkup` pasando por el ciclo real #[pagetop::test]
/// de renderizado de componentes (`ComponentRender`). async fn prepare_markup_render_none_is_empty_string() {
#[derive(AutoDefault)] assert_eq!(PrepareMarkup::None.render().as_str(), "");
struct TestPrepareComponent {
pm: PrepareMarkup,
}
impl Component for TestPrepareComponent {
fn new() -> Self {
Self {
pm: PrepareMarkup::None,
}
}
fn prepare_component(&self, _cx: &mut Context) -> PrepareMarkup {
self.pm.clone()
}
}
impl TestPrepareComponent {
fn render_pm(pm: PrepareMarkup) -> String {
let mut c = TestPrepareComponent { pm };
c.render(&mut Context::default()).into_string()
}
} }
#[pagetop::test] #[pagetop::test]
async fn prepare_markup_none_is_empty_string() { async fn prepare_markup_render_escaped_escapes_html_and_ampersands() {
assert_eq!(PrepareMarkup::None.into_string(), "");
}
#[pagetop::test]
async fn prepare_markup_escaped_escapes_html_and_ampersands() {
let pm = PrepareMarkup::Escaped("<b>& \" ' </b>".to_string()); let pm = PrepareMarkup::Escaped("<b>& \" ' </b>".to_string());
assert_eq!(pm.into_string(), "&lt;b&gt;&amp; &quot; ' &lt;/b&gt;"); assert_eq!(pm.render().as_str(), "&lt;b&gt;&amp; &quot; ' &lt;/b&gt;");
} }
#[pagetop::test] #[pagetop::test]
async fn prepare_markup_raw_is_inserted_verbatim() { async fn prepare_markup_render_raw_is_inserted_verbatim() {
let pm = PrepareMarkup::Raw("<b>bold</b><script>1<2</script>".to_string()); let pm = PrepareMarkup::Raw("<b>bold</b><script>1<2</script>".to_string());
assert_eq!(pm.into_string(), "<b>bold</b><script>1<2</script>"); assert_eq!(pm.render().as_str(), "<b>bold</b><script>1<2</script>");
} }
#[pagetop::test] #[pagetop::test]
async fn prepare_markup_with_keeps_structure() { async fn prepare_markup_render_with_keeps_structure() {
let pm = PrepareMarkup::With(html! { let pm = PrepareMarkup::With(html! {
h2 { "Sample title" } h2 { "Sample title" }
p { "This is a paragraph." } p { "This is a paragraph." }
}); });
assert_eq!( assert_eq!(
pm.into_string(), pm.render().as_str(),
"<h2>Sample title</h2><p>This is a paragraph.</p>" "<h2>Sample title</h2><p>This is a paragraph.</p>"
); );
} }
#[pagetop::test]
async fn prepare_markup_does_not_double_escape_when_wrapped_in_html_macro() {
// Escaped: dentro de `html!` no debe volver a escaparse.
let escaped = PrepareMarkup::Escaped("<i>x</i>".into());
let wrapped_escaped = html! { div { (escaped.render()) } };
assert_eq!(
wrapped_escaped.into_string(),
"<div>&lt;i&gt;x&lt;/i&gt;</div>"
);
// Raw: tampoco debe escaparse al integrarlo.
let raw = PrepareMarkup::Raw("<i>x</i>".into());
let wrapped_raw = html! { div { (raw.render()) } };
assert_eq!(wrapped_raw.into_string(), "<div><i>x</i></div>");
// With: debe incrustar el Markup tal cual.
let with = PrepareMarkup::With(html! { span.title { "ok" } });
let wrapped_with = html! { div { (with.render()) } };
assert_eq!(
wrapped_with.into_string(),
"<div><span class=\"title\">ok</span></div>"
);
}
#[pagetop::test] #[pagetop::test]
async fn prepare_markup_unicode_is_preserved() { async fn prepare_markup_unicode_is_preserved() {
// Texto con acentos y emojis debe conservarse (salvo el escape HTML de signos). // Texto con acentos y emojis debe conservarse (salvo el escape HTML de signos).
let esc = PrepareMarkup::Escaped("Hello, tomorrow coffee ☕ & donuts!".into()); let esc = PrepareMarkup::Escaped("Hello, tomorrow coffee ☕ & donuts!".into());
assert_eq!(esc.into_string(), "Hello, tomorrow coffee ☕ &amp; donuts!"); assert_eq!(
esc.render().as_str(),
"Hello, tomorrow coffee ☕ &amp; donuts!"
);
// Raw debe pasar íntegro. // Raw debe pasar íntegro.
let raw = PrepareMarkup::Raw("Title — section © 2025".into()); let raw = PrepareMarkup::Raw("Title — section © 2025".into());
assert_eq!(raw.into_string(), "Title — section © 2025"); assert_eq!(raw.render().as_str(), "Title — section © 2025");
} }
#[pagetop::test] #[pagetop::test]
@ -87,36 +88,7 @@ async fn prepare_markup_is_empty_semantics() {
} }
#[pagetop::test] #[pagetop::test]
async fn prepare_markup_does_not_double_escape_when_markup_is_reinjected_in_html_macro() { async fn prepare_markup_equivalence_between_render_and_inline_in_html_macro() {
let mut cx = Context::default();
// Escaped: dentro de `html!` no debe volver a escaparse.
let mut comp = TestPrepareComponent {
pm: PrepareMarkup::Escaped("<i>x</i>".into()),
};
let markup = comp.render(&mut cx); // Markup
let wrapped_escaped = html! { div { (markup) } }.into_string();
assert_eq!(wrapped_escaped, "<div>&lt;i&gt;x&lt;/i&gt;</div>");
// Raw: tampoco debe escaparse al integrarlo.
let mut comp = TestPrepareComponent {
pm: PrepareMarkup::Raw("<i>x</i>".into()),
};
let markup = comp.render(&mut cx);
let wrapped_raw = html! { div { (markup) } }.into_string();
assert_eq!(wrapped_raw, "<div><i>x</i></div>");
// With: debe incrustar el Markup tal cual.
let mut comp = TestPrepareComponent {
pm: PrepareMarkup::With(html! { span.title { "ok" } }),
};
let markup = comp.render(&mut cx);
let wrapped_with = html! { div { (markup) } }.into_string();
assert_eq!(wrapped_with, "<div><span class=\"title\">ok</span></div>");
}
#[pagetop::test]
async fn prepare_markup_equivalence_between_component_render_and_markup_reinjected_in_html_macro() {
let cases = [ let cases = [
PrepareMarkup::None, PrepareMarkup::None,
PrepareMarkup::Escaped("<b>x</b>".into()), PrepareMarkup::Escaped("<b>x</b>".into()),
@ -125,20 +97,12 @@ async fn prepare_markup_equivalence_between_component_render_and_markup_reinject
]; ];
for pm in cases { for pm in cases {
// Vía 1: renderizamos y obtenemos directamente el String. let rendered = pm.render();
let via_component = TestPrepareComponent::render_pm(pm.clone()); let in_macro = html! { (rendered) }.into_string();
// Vía 2: renderizamos, reinyectamos el Markup en `html!` y volvemos a obtener String.
let via_macro = {
let mut cx = Context::default();
let mut comp = TestPrepareComponent { pm };
let markup = comp.render(&mut cx);
html! { (markup) }.into_string()
};
assert_eq!( assert_eq!(
via_component, via_macro, rendered.as_str(),
"The output of component render and (Markup) inside html! must match" in_macro,
"The output of Render and (pm) inside html! must match"
); );
} }
} }