🚧 [context] Generaliza los parámetros de contexto

This commit is contained in:
Manuel Cillero 2025-09-06 09:41:01 +02:00
parent 8274519405
commit 3bf058b8a5
4 changed files with 168 additions and 38 deletions

View file

@ -25,7 +25,7 @@ use crate::prelude::*;
/// use pagetop::prelude::*; /// use pagetop::prelude::*;
/// ///
/// let component = Html::with(|cx| { /// let component = Html::with(|cx| {
/// let user = cx.get_param::<String>("username").unwrap_or(String::from("visitor")); /// let user = cx.param::<String>("username").cloned().unwrap_or(String::from("visitor"));
/// html! { /// html! {
/// h1 { "Hello, " (user) } /// h1 { "Hello, " (user) }
/// } /// }

View file

@ -7,10 +7,8 @@ use crate::locale::{LangId, LangMatch, LanguageIdentifier, DEFAULT_LANGID, FALLB
use crate::service::HttpRequest; use crate::service::HttpRequest;
use crate::{builder_fn, join}; use crate::{builder_fn, join};
use std::any::Any;
use std::collections::HashMap; use std::collections::HashMap;
use std::error::Error;
use std::fmt::{self, Display};
use std::str::FromStr;
/// Operaciones para modificar el contexto ([`Context`]) del documento. /// Operaciones para modificar el contexto ([`Context`]) del documento.
pub enum AssetsOp { pub enum AssetsOp {
@ -33,32 +31,28 @@ pub enum AssetsOp {
RemoveJavaScript(&'static str), RemoveJavaScript(&'static str),
} }
/// Errores de lectura o conversión de parámetros almacenados en el contexto. /// Errores de acceso a parámetros dinámicos del contexto.
///
/// - [`ErrorParam::NotFound`]: la clave no existe.
/// - [`ErrorParam::TypeMismatch`]: la clave existe, pero el valor guardado no coincide con el tipo
/// solicitado. Incluye nombre de la clave (`key`), tipo esperado (`expected`) y tipo realmente
/// guardado (`saved`) para facilitar el diagnóstico.
#[derive(Debug)] #[derive(Debug)]
pub enum ErrorParam { pub enum ErrorParam {
/// El parámetro solicitado no existe.
NotFound, NotFound,
/// El valor del parámetro no pudo convertirse al tipo requerido. TypeMismatch {
ParseError(String), key: &'static str,
expected: &'static str,
saved: &'static str,
},
} }
impl Display for ErrorParam {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
ErrorParam::NotFound => write!(f, "Parameter not found"),
ErrorParam::ParseError(e) => write!(f, "Parse error: {e}"),
}
}
}
impl Error for ErrorParam {}
/// Representa el contexto de un documento HTML. /// Representa el contexto de un documento HTML.
/// ///
/// Se crea internamente para manejar información relevante del documento, como la solicitud HTTP de /// Se crea internamente para manejar información relevante del documento, como la solicitud HTTP de
/// origen, el idioma, tema y composición para el renderizado, los recursos *favicon* ([`Favicon`]), /// origen, el idioma, tema y composición para el renderizado, los recursos *favicon* ([`Favicon`]),
/// hojas de estilo ([`StyleSheet`]) y *scripts* ([`JavaScript`]), así como parámetros de contexto /// hojas de estilo ([`StyleSheet`]) y *scripts* ([`JavaScript`]), así como *parámetros dinámicos
/// definidos en tiempo de ejecución. /// heterogéneos* de contexto definidos en tiempo de ejecución.
/// ///
/// # Ejemplos /// # Ejemplos
/// ///
@ -95,7 +89,7 @@ impl Error for ErrorParam {}
/// assert_eq!(active_theme.short_name(), "aliner"); /// assert_eq!(active_theme.short_name(), "aliner");
/// ///
/// // Recupera el parámetro a su tipo original. /// // Recupera el parámetro a su tipo original.
/// let id: i32 = cx.get_param("usuario_id").unwrap(); /// let id: i32 = *cx.get_param::<i32>("usuario_id").unwrap();
/// assert_eq!(id, 42); /// assert_eq!(id, 42);
/// ///
/// // Genera un identificador para un componente de tipo `Menu`. /// // Genera un identificador para un componente de tipo `Menu`.
@ -113,7 +107,7 @@ pub struct Context {
favicon : Option<Favicon>, // Favicon, si se ha definido. favicon : Option<Favicon>, // Favicon, si se ha definido.
stylesheets: Assets<StyleSheet>, // Hojas de estilo CSS. stylesheets: Assets<StyleSheet>, // Hojas de estilo CSS.
javascripts: Assets<JavaScript>, // Scripts JavaScript. javascripts: Assets<JavaScript>, // Scripts JavaScript.
params : HashMap<&'static str, String>, // Parámetros definidos en tiempo de ejecución. params : HashMap<&'static str, (Box<dyn Any>, &'static str)>, // Parámetros definidos en tiempo de ejecución.
id_counter : usize, // Contador para generar identificadores únicos. id_counter : usize, // Contador para generar identificadores únicos.
} }
@ -152,7 +146,7 @@ impl Context {
favicon : None, favicon : None,
stylesheets: Assets::<StyleSheet>::new(), stylesheets: Assets::<StyleSheet>::new(),
javascripts: Assets::<JavaScript>::new(), javascripts: Assets::<JavaScript>::new(),
params : HashMap::<&str, String>::new(), params : HashMap::default(),
id_counter : 0, id_counter : 0,
} }
} }
@ -246,29 +240,146 @@ impl Context {
// Context PARAMS ****************************************************************************** // Context PARAMS ******************************************************************************
/// Añade o modifica un parámetro del contexto almacenando el valor como [`String`]. /// Añade o modifica un parámetro dinámico del contexto.
///
/// El valor se guarda conservando el *nombre del tipo* real para mejorar los mensajes de error
/// posteriores.
///
/// # Ejemplos
///
/// ```rust
/// use pagetop::prelude::*;
///
/// let cx = Context::new(None)
/// .with_param("usuario_id", 42_i32)
/// .with_param("titulo", String::from("Hola"))
/// .with_param("flags", vec!["a", "b"]);
/// ```
#[builder_fn] #[builder_fn]
pub fn with_param<T: ToString>(mut self, key: &'static str, value: T) -> Self { pub fn with_param<T: 'static>(mut self, key: &'static str, value: T) -> Self {
self.params.insert(key, value.to_string()); let type_name = TypeInfo::FullName.of::<T>();
self.params.insert(key, (Box::new(value), type_name));
self self
} }
/// Recupera un parámetro del contexto convertido al tipo especificado. /// Recupera un parámetro como [`Option`], simplificando el acceso.
/// ///
/// Devuelve un error si el parámetro no existe ([`ErrorParam::NotFound`]) o la conversión falla /// A diferencia de [`get_param`](Self::get_param), que devuelve un [`Result`] con información
/// ([`ErrorParam::ParseError`]). /// detallada de error, este método devuelve `None` tanto si la clave no existe como si el valor
pub fn get_param<T: FromStr>(&self, key: &'static str) -> Result<T, ErrorParam> { /// guardado no coincide con el tipo solicitado.
self.params ///
.get(key) /// Resulta útil en escenarios donde sólo interesa saber si el valor existe y es del tipo
.ok_or(ErrorParam::NotFound) /// correcto, sin necesidad de diferenciar entre error de ausencia o de tipo.
.and_then(|v| T::from_str(v).map_err(|_| ErrorParam::ParseError(v.clone()))) ///
/// # Ejemplo
///
/// ```rust
/// use pagetop::prelude::*;
///
/// let cx = Context::new(None).with_param("username", String::from("Alice"));
///
/// // Devuelve Some(&String) si existe y coincide el tipo.
/// assert_eq!(cx.param::<String>("username").map(|s| s.as_str()), Some("Alice"));
///
/// // Devuelve None si no existe o si el tipo no coincide.
/// assert!(cx.param::<i32>("username").is_none());
/// assert!(cx.param::<String>("missing").is_none());
///
/// // Acceso con valor por defecto.
/// let user = cx.param::<String>("missing")
/// .cloned()
/// .unwrap_or_else(|| "visitor".to_string());
/// assert_eq!(user, "visitor");
/// ```
pub fn param<T: 'static>(&self, key: &'static str) -> Option<&T> {
self.get_param::<T>(key).ok()
} }
/// Elimina un parámetro del contexto. Devuelve `true` si existía y se eliminó. /// Recupera una *referencia tipada* al parámetro solicitado.
///
/// Devuelve:
///
/// - `Ok(&T)` si la clave existe y el tipo coincide.
/// - `Err(ErrorParam::NotFound)` si la clave no existe.
/// - `Err(ErrorParam::TypeMismatch)` si la clave existe pero el tipo no coincide.
///
/// # Ejemplos
///
/// ```rust
/// use pagetop::prelude::*;
///
/// let cx = Context::new(None)
/// .with_param("usuario_id", 42_i32)
/// .with_param("titulo", String::from("Hola"));
///
/// let id: &i32 = cx.get_param("usuario_id").unwrap();
/// let titulo: &String = cx.get_param("titulo").unwrap();
///
/// // Error de tipo:
/// assert!(cx.get_param::<String>("usuario_id").is_err());
/// ```
pub fn get_param<T: 'static>(&self, key: &'static str) -> Result<&T, ErrorParam> {
let (any, type_name) = self.params.get(key).ok_or(ErrorParam::NotFound)?;
any.downcast_ref::<T>()
.ok_or_else(|| ErrorParam::TypeMismatch {
key,
expected: TypeInfo::FullName.of::<T>(),
saved: *type_name,
})
}
/// Elimina un parámetro del contexto. Devuelve `true` si la clave existía y se eliminó.
///
/// Devuelve `false` en caso contrario. Usar cuando solo interesa borrar la entrada.
///
/// # Ejemplos
///
/// ```rust
/// use pagetop::prelude::*;
///
/// let mut cx = Context::new(None).with_param("temp", 1u8);
/// assert!(cx.remove_param("temp"));
/// assert!(!cx.remove_param("temp")); // ya no existe
/// ```
pub fn remove_param(&mut self, key: &'static str) -> bool { pub fn remove_param(&mut self, key: &'static str) -> bool {
self.params.remove(key).is_some() self.params.remove(key).is_some()
} }
/// Recupera el parámetro solicitado y lo elimina del contexto.
///
/// Devuelve:
///
/// - `Ok(T)` si la clave existía y el tipo coincide.
/// - `Err(ErrorParam::NotFound)` si la clave no existe.
/// - `Err(ErrorParam::TypeMismatch)` si el tipo no coincide.
///
/// # Ejemplos
///
/// ```rust
/// use pagetop::prelude::*;
///
/// let mut cx = Context::new(None)
/// .with_param("contador", 7_i32)
/// .with_param("titulo", String::from("Hola"));
///
/// let n: i32 = cx.take_param("contador").unwrap();
/// assert!(cx.get_param::<i32>("contador").is_err()); // ya no está
///
/// // Error de tipo:
/// assert!(cx.take_param::<i32>("titulo").is_err());
/// ```
pub fn take_param<T: 'static>(&mut self, key: &'static str) -> Result<T, ErrorParam> {
let (boxed, saved) = self.params.remove(key).ok_or(ErrorParam::NotFound)?;
boxed
.downcast::<T>()
.map(|b| *b)
.map_err(|_| ErrorParam::TypeMismatch {
key,
expected: TypeInfo::FullName.of::<T>(),
saved,
})
}
// Context EXTRAS ****************************************************************************** // Context EXTRAS ******************************************************************************
/// Genera un identificador único si no se proporciona uno explícito. /// Genera un identificador único si no se proporciona uno explícito.

View file

@ -108,6 +108,12 @@ impl Page {
self self
} }
#[builder_fn]
pub fn with_param<T: 'static>(mut self, key: &'static str, value: T) -> Self {
self.context.alter_param(key, value);
self
}
/// Establece el atributo `id` del elemento `<body>`. /// Establece el atributo `id` del elemento `<body>`.
#[builder_fn] #[builder_fn]
pub fn with_body_id(mut self, id: impl AsRef<str>) -> Self { pub fn with_body_id(mut self, id: impl AsRef<str>) -> Self {
@ -214,6 +220,10 @@ impl Page {
self.context.layout() self.context.layout()
} }
pub fn param<T: 'static>(&self, key: &'static str) -> Option<&T> {
self.context.param(key)
}
/// Devuelve el identificador del elemento `<body>`. /// Devuelve el identificador del elemento `<body>`.
pub fn body_id(&self) -> &AttrId { pub fn body_id(&self) -> &AttrId {
&self.body_id &self.body_id
@ -223,7 +233,16 @@ impl Page {
pub fn body_classes(&self) -> &AttrClasses { pub fn body_classes(&self) -> &AttrClasses {
&self.body_classes &self.body_classes
} }
/*
/// Devuelve una referencia mutable al [`Context`] de la página.
///
/// El [`Context`] actúa como intermediario para muchos métodos de `Page` (idioma, tema,
/// *layout*, recursos, solicitud HTTP, etc.). Resulta especialmente útil cuando un componente
/// o un tema necesita recibir el contexto como parámetro.
pub fn context(&mut self) -> &mut Context {
&mut self.context
}
*/
// Page RENDER ********************************************************************************* // Page RENDER *********************************************************************************
/// Renderiza los componentes de una región (`regiona_name`) de la página. /// Renderiza los componentes de una región (`regiona_name`) de la página.

View file

@ -20,7 +20,7 @@ async fn component_html_renders_using_context_param() {
let mut cx = Context::new(None).with_param("username", String::from("Alice")); let mut cx = Context::new(None).with_param("username", String::from("Alice"));
let component = Html::with(|cx| { let component = Html::with(|cx| {
let name = cx.get_param::<String>("username").unwrap_or_default(); let name = cx.param::<String>("username").cloned().unwrap_or_default();
html! { html! {
span { (name) } span { (name) }
} }