🎨 [locale] Mejora el uso de lookup / using

This commit is contained in:
Manuel Cillero 2025-09-04 00:27:25 +02:00
parent 71c7793131
commit 19c16d962f
6 changed files with 75 additions and 59 deletions

View file

@ -31,7 +31,7 @@ impl Component for PoweredBy {
span class="poweredby__copyright" { (c) "." } " " span class="poweredby__copyright" { (c) "." } " "
} }
span class="poweredby__pagetop" { span class="poweredby__pagetop" {
(L10n::l("poweredby_pagetop").with_arg("pagetop_link", LINK).to_markup(cx)) (L10n::l("poweredby_pagetop").with_arg("pagetop_link", LINK).using(cx))
} }
} }
}) })

View file

@ -4,7 +4,7 @@ use crate::{builder_fn, AutoDefault};
/// Texto para [traducir](crate::locale) en atributos HTML. /// Texto para [traducir](crate::locale) en atributos HTML.
/// ///
/// Encapsula un tipo [`L10n`] para manejar traducciones de forma segura. /// Encapsula un [`L10n`] para manejar traducciones de forma segura en atributos.
/// ///
/// # Ejemplo /// # Ejemplo
/// ///
@ -16,19 +16,19 @@ use crate::{builder_fn, AutoDefault};
/// ///
/// // Español disponible. /// // Español disponible.
/// assert_eq!( /// assert_eq!(
/// hello.using(&LangMatch::resolve("es-ES")), /// hello.lookup(&LangMatch::resolve("es-ES")),
/// Some(String::from("¡Hola mundo!")) /// Some(String::from("¡Hola mundo!"))
/// ); /// );
/// ///
/// // Japonés no disponible, traduce al idioma de respaldo ("en-US"). /// // Japonés no disponible, traduce al idioma de respaldo ("en-US").
/// assert_eq!( /// assert_eq!(
/// hello.using(&LangMatch::resolve("ja-JP")), /// hello.lookup(&LangMatch::resolve("ja-JP")),
/// Some(String::from("Hello world!")) /// Some(String::from("Hello world!"))
/// ); /// );
/// ///
/// // Para incrustar en HTML escapado: /// // Uso típico en un atributo:
/// let markup = hello.to_markup(&LangMatch::resolve("es-ES")); /// let title = hello.value(&LangMatch::resolve("es-ES"));
/// assert_eq!(markup.into_string(), "¡Hola mundo!"); /// // Ejemplo: html! { a title=(title) { "Link" } }
/// ``` /// ```
#[derive(AutoDefault, Clone, Debug)] #[derive(AutoDefault, Clone, Debug)]
pub struct AttrL10n(L10n); pub struct AttrL10n(L10n);
@ -51,15 +51,18 @@ impl AttrL10n {
// AttrL10n GETTERS **************************************************************************** // AttrL10n GETTERS ****************************************************************************
/// Devuelve la traducción para `language`, si existe. /// Devuelve la traducción para `language`, si existe.
pub fn using(&self, language: &impl LangId) -> Option<String> { pub fn lookup(&self, language: &impl LangId) -> Option<String> {
self.0.using(language) self.0.lookup(language)
} }
/// Devuelve la traducción *escapada* como [`Markup`] para `language`, si existe. /// Devuelve la traducción para `language` o una cadena vacía si no existe.
/// pub fn value(&self, language: &impl LangId) -> String {
/// Útil para incrustar el texto directamente en plantillas HTML sin riesgo de inyección de self.0.lookup(language).unwrap_or_default()
/// contenido. }
/// **Obsoleto desde la versión 0.4.0**: no recomendado para atributos HTML.
#[deprecated(since = "0.4.0", note = "For attributes use `lookup()` or `value()`")]
pub fn to_markup(&self, language: &impl LangId) -> Markup { pub fn to_markup(&self, language: &impl LangId) -> Markup {
self.0.to_markup(language) self.0.using(language)
} }
} }

View file

@ -306,8 +306,7 @@ impl Context {
/// 4. Y si ninguna de las opciones anteriores aplica, se usa el idioma de respaldo (`"en-US"`). /// 4. Y si ninguna de las opciones anteriores aplica, se usa el idioma de respaldo (`"en-US"`).
/// ///
/// Resulta útil para usar un contexto ([`Context`]) como fuente de traducción en /// Resulta útil para usar un contexto ([`Context`]) como fuente de traducción en
/// [`L10n::using()`](crate::locale::L10n::using) o /// [`L10n::lookup()`](crate::locale::L10n::lookup) o [`L10n::using()`](crate::locale::L10n::using).
/// [`L10n::to_markup()`](crate::locale::L10n::to_markup).
impl LangId for Context { impl LangId for Context {
fn langid(&self) -> &'static LanguageIdentifier { fn langid(&self) -> &'static LanguageIdentifier {
self.langid self.langid

View file

@ -13,7 +13,7 @@
//! //!
//! # Recursos Fluent //! # Recursos Fluent
//! //!
//! Por defecto las traducciones están en el directorio `src/locale`, con subdirectorios para cada //! Por defecto, las traducciones están en el directorio `src/locale`, con subdirectorios para cada
//! [Identificador de Idioma Unicode](https://unicode.org/reports/tr35/tr35.html#Unicode_language_identifier) //! [Identificador de Idioma Unicode](https://unicode.org/reports/tr35/tr35.html#Unicode_language_identifier)
//! válido. Podríamos tener una estructura como esta: //! válido. Podríamos tener una estructura como esta:
//! //!
@ -34,7 +34,7 @@
//! └── main.ftl //! └── main.ftl
//! ``` //! ```
//! //!
//! Ejemplo de un archivo en `src/locale/en-US/main.ftl` //! Ejemplo de un archivo en `src/locale/en-US/main.ftl`:
//! //!
//! ```text //! ```text
//! hello-world = Hello world! //! hello-world = Hello world!
@ -53,7 +53,7 @@
//! Y su archivo equivalente para español en `src/locale/es-ES/main.ftl`: //! Y su archivo equivalente para español en `src/locale/es-ES/main.ftl`:
//! //!
//! ```text //! ```text
//! hello-world = Hola mundo! //! hello-world = ¡Hola, mundo!
//! hello-user = ¡Hola, {$userName}! //! hello-user = ¡Hola, {$userName}!
//! shared-photos = //! shared-photos =
//! {$userName} {$photoCount -> //! {$userName} {$photoCount ->
@ -81,7 +81,7 @@
//! include_locales!(LOCALES_SAMPLE); //! include_locales!(LOCALES_SAMPLE);
//! ``` //! ```
//! //!
//! Si están ubicados en otro directorio se puede usar la forma: //! Si están ubicados en otro directorio, se puede usar la forma:
//! //!
//! ```rust,ignore //! ```rust,ignore
//! include_locales!(LOCALES_SAMPLE from "ruta/a/las/traducciones"); //! include_locales!(LOCALES_SAMPLE from "ruta/a/las/traducciones");
@ -129,7 +129,7 @@ pub(crate) static FALLBACK_LANGID: LazyLock<LanguageIdentifier> =
// Identificador de idioma **por defecto** para la aplicación. // Identificador de idioma **por defecto** para la aplicación.
// //
// Se resuelve a partir de [`global::SETTINGS.app.language`](global::SETTINGS). Si el identificador // Se resuelve a partir de [`global::SETTINGS.app.language`](global::SETTINGS). Si el identificador
// de idioma no es válido o no está disponible entonces resuelve como [`FALLBACK_LANGID`]. // de idioma no es válido o no está disponible, se usa [`FALLBACK_LANGID`].
pub(crate) static DEFAULT_LANGID: LazyLock<Option<&LanguageIdentifier>> = pub(crate) static DEFAULT_LANGID: LazyLock<Option<&LanguageIdentifier>> =
LazyLock::new(|| LangMatch::resolve(&global::SETTINGS.app.language).as_option()); LazyLock::new(|| LangMatch::resolve(&global::SETTINGS.app.language).as_option());
@ -155,7 +155,7 @@ pub trait LangId {
/// let lang = LangMatch::resolve("es-ES"); /// let lang = LangMatch::resolve("es-ES");
/// assert_eq!(lang.langid().to_string(), "es-ES"); /// assert_eq!(lang.langid().to_string(), "es-ES");
/// ///
/// // Coincidencia parcial (con el idioma base). /// // Coincidencia parcial (retrocede al idioma base si no hay variante regional).
/// let lang = LangMatch::resolve("es-EC"); /// let lang = LangMatch::resolve("es-EC");
/// assert_eq!(lang.langid().to_string(), "es-ES"); // Porque "es-EC" no está soportado. /// assert_eq!(lang.langid().to_string(), "es-ES"); // Porque "es-EC" no está soportado.
/// ///
@ -221,7 +221,7 @@ impl LangMatch {
} }
} }
// En otro caso indica que el idioma no está soportado. // En caso contrario, indica que el idioma no está soportado.
Self::Unsupported(String::from(language)) Self::Unsupported(String::from(language))
} }
@ -241,7 +241,7 @@ impl LangMatch {
/// let lang = LangMatch::resolve("es-ES").as_option(); /// let lang = LangMatch::resolve("es-ES").as_option();
/// assert_eq!(lang.unwrap().to_string(), "es-ES"); /// assert_eq!(lang.unwrap().to_string(), "es-ES");
/// ///
/// let lang = LangMatch::resolve("jp-JP").as_option(); /// let lang = LangMatch::resolve("ja-JP").as_option();
/// assert!(lang.is_none()); /// assert!(lang.is_none());
/// ``` /// ```
#[inline] #[inline]
@ -259,8 +259,8 @@ impl LangMatch {
/// devuelve el idioma por defecto de la aplicación y, si tampoco está disponible, el idioma de /// devuelve el idioma por defecto de la aplicación y, si tampoco está disponible, el idioma de
/// respaldo ("en-US"). /// respaldo ("en-US").
/// ///
/// Resulta útil para usar un valor de [`LangMatch`] como fuente de traducción en [`L10n::using()`] /// Resulta útil para usar un valor de [`LangMatch`] como fuente de traducción en [`L10n::lookup()`]
/// o [`L10n::to_markup()`]. /// o [`L10n::using()`].
impl LangId for LangMatch { impl LangId for LangMatch {
fn langid(&self) -> &'static LanguageIdentifier { fn langid(&self) -> &'static LanguageIdentifier {
match self { match self {
@ -271,10 +271,10 @@ impl LangId for LangMatch {
} }
#[macro_export] #[macro_export]
/// Define un conjunto de elementos de localización y textos de traducción local. /// Incluye un conjunto de recursos **Fluent** y textos de traducción propios.
macro_rules! include_locales { macro_rules! include_locales {
// Se eliminan las marcas de aislamiento Unicode en los argumentos para mejorar la legibilidad y // Se desactiva la inserción de marcas de aislamiento Unicode (FSI/PDI) en los argumentos para
// la compatibilidad en ciertos contextos de renderizado. // mejorar la legibilidad y la compatibilidad en ciertos contextos de renderizado.
( $LOCALES:ident $(, $core_locales:literal)? ) => { ( $LOCALES:ident $(, $core_locales:literal)? ) => {
$crate::locale::fluent_templates::static_loader! { $crate::locale::fluent_templates::static_loader! {
static $LOCALES = { static $LOCALES = {
@ -310,8 +310,8 @@ include_locales!(LOCALES_PAGETOP);
enum L10nOp { enum L10nOp {
#[default] #[default]
None, None,
Text(String), Text(Cow<'static, str>),
Translate(String), Translate(Cow<'static, str>),
} }
/// Crea instancias para traducir textos localizados. /// Crea instancias para traducir textos localizados.
@ -324,7 +324,7 @@ enum L10nOp {
/// ///
/// # Ejemplo /// # Ejemplo
/// ///
/// Los argumentos dinámicos se añaden usando `with_arg()` o `with_args()`. /// Los argumentos dinámicos se añaden con `with_arg()` o `with_args()`.
/// ///
/// ```rust /// ```rust
/// use pagetop::prelude::*; /// use pagetop::prelude::*;
@ -338,11 +338,11 @@ enum L10nOp {
/// .get(); /// .get();
/// ``` /// ```
/// ///
/// También para traducciones a idiomas concretos. /// También sirve para traducciones contra un conjunto de recursos concreto.
/// ///
/// ```rust,ignore /// ```rust,ignore
/// // Traducción con clave, conjunto de traducciones y fuente de idioma. /// // Traducción con clave, conjunto de traducciones y fuente de idioma.
/// let bye = L10n::t("goodbye", &LOCALES_CUSTOM).using(&LangMatch::resolve("it")); /// let bye = L10n::t("goodbye", &LOCALES_CUSTOM).lookup(&LangMatch::resolve("it"));
/// ``` /// ```
#[derive(AutoDefault, Clone)] #[derive(AutoDefault, Clone)]
pub struct L10n { pub struct L10n {
@ -354,7 +354,7 @@ pub struct L10n {
impl L10n { impl L10n {
/// **n** = *“native”*. Crea una instancia con una cadena literal sin traducción. /// **n** = *“native”*. Crea una instancia con una cadena literal sin traducción.
pub fn n(text: impl Into<String>) -> Self { pub fn n(text: impl Into<Cow<'static, str>>) -> Self {
L10n { L10n {
op: L10nOp::Text(text.into()), op: L10nOp::Text(text.into()),
..Default::default() ..Default::default()
@ -363,7 +363,7 @@ impl L10n {
/// **l** = *“lookup”*. Crea una instancia para traducir usando una clave del conjunto de /// **l** = *“lookup”*. Crea una instancia para traducir usando una clave del conjunto de
/// traducciones predefinidas. /// traducciones predefinidas.
pub fn l(key: impl Into<String>) -> Self { pub fn l(key: impl Into<Cow<'static, str>>) -> Self {
L10n { L10n {
op: L10nOp::Translate(key.into()), op: L10nOp::Translate(key.into()),
..Default::default() ..Default::default()
@ -372,7 +372,7 @@ impl L10n {
/// **t** = *“translate”*. Crea una instancia para traducir usando una clave de un conjunto de /// **t** = *“translate”*. Crea una instancia para traducir usando una clave de un conjunto de
/// traducciones específico. /// traducciones específico.
pub fn t(key: impl Into<String>, locales: &'static Locales) -> Self { pub fn t(key: impl Into<Cow<'static, str>>, locales: &'static Locales) -> Self {
L10n { L10n {
op: L10nOp::Translate(key.into()), op: L10nOp::Translate(key.into()),
locales, locales,
@ -399,7 +399,8 @@ impl L10n {
self self
} }
/// Resuelve la traducción usando el idioma por defecto o de respaldo de la aplicación. /// Resuelve la traducción usando el idioma por defecto o, si no procede, el de respaldo de la
/// aplicación.
/// ///
/// Devuelve `None` si no aplica o no encuentra una traducción válida. /// Devuelve `None` si no aplica o no encuentra una traducción válida.
/// ///
@ -411,7 +412,7 @@ impl L10n {
/// let text = L10n::l("greeting").with_arg("name", "Manuel").get(); /// let text = L10n::l("greeting").with_arg("name", "Manuel").get();
/// ``` /// ```
pub fn get(&self) -> Option<String> { pub fn get(&self) -> Option<String> {
self.using(&LangMatch::default()) self.lookup(&LangMatch::default())
} }
/// Resuelve la traducción usando la fuente de idioma proporcionada. /// Resuelve la traducción usando la fuente de idioma proporcionada.
@ -432,20 +433,27 @@ impl L10n {
/// } /// }
/// ///
/// let r = ResourceLang; /// let r = ResourceLang;
/// let text = L10n::l("greeting").with_arg("name", "Usuario").using(&r); /// let text = L10n::l("greeting").with_arg("name", "Usuario").lookup(&r);
/// ``` /// ```
pub fn using(&self, language: &impl LangId) -> Option<String> { pub fn lookup(&self, language: &impl LangId) -> Option<String> {
match &self.op { match &self.op {
L10nOp::None => None, L10nOp::None => None,
L10nOp::Text(text) => Some(text.to_owned()), L10nOp::Text(text) => Some(text.clone().into_owned()),
L10nOp::Translate(key) => self.locales.try_lookup_with_args( L10nOp::Translate(key) => {
language.langid(), if self.args.is_empty() {
key, self.locales.try_lookup(language.langid(), key.as_ref())
&self.args.iter().fold(HashMap::new(), |mut arg, (k, v)| { } else {
arg.insert(Cow::Owned(k.clone()), v.to_owned().into()); self.locales.try_lookup_with_args(
arg language.langid(),
}), key.as_ref(),
), &self
.args
.iter()
.map(|(k, v)| (Cow::Owned(k.clone()), v.clone().into()))
.collect::<HashMap<_, _>>(),
)
}
}
} }
} }
@ -458,10 +466,16 @@ impl L10n {
/// ```rust /// ```rust
/// use pagetop::prelude::*; /// use pagetop::prelude::*;
/// ///
/// let html = L10n::l("welcome.message").to_markup(&LangMatch::resolve("es")); /// let html = L10n::l("welcome.message").using(&LangMatch::resolve("es"));
/// ``` /// ```
pub fn using(&self, language: &impl LangId) -> Markup {
PreEscaped(self.lookup(language).unwrap_or_default())
}
/// **Obsoleto desde la versión 0.4.0**: usar [`using()`](Self::using) en su lugar.
#[deprecated(since = "0.4.0", note = "Use `using()` instead")]
pub fn to_markup(&self, language: &impl LangId) -> Markup { pub fn to_markup(&self, language: &impl LangId) -> Markup {
PreEscaped(self.using(language).unwrap_or_default()) self.using(language)
} }
} }

View file

@ -151,12 +151,12 @@ impl Page {
/// Devuelve el título traducido para el idioma de la página, si existe. /// Devuelve el título traducido para el idioma de la página, si existe.
pub fn title(&mut self) -> Option<String> { pub fn title(&mut self) -> Option<String> {
self.title.using(&self.context) self.title.lookup(&self.context)
} }
/// Devuelve la descripción traducida para el idioma de la página, si existe. /// Devuelve la descripción traducida para el idioma de la página, si existe.
pub fn description(&mut self) -> Option<String> { pub fn description(&mut self) -> Option<String> {
self.description.using(&self.context) self.description.lookup(&self.context)
} }
/// Devuelve la lista de metadatos `<meta name=...>`. /// Devuelve la lista de metadatos `<meta name=...>`.

View file

@ -13,7 +13,7 @@ async fn translation_without_args() {
let _app = service::test::init_service(Application::new().test()).await; let _app = service::test::init_service(Application::new().test()).await;
let l10n = L10n::l("test-hello-world"); let l10n = L10n::l("test-hello-world");
let translation = l10n.using(&LangMatch::resolve("es-ES")); let translation = l10n.lookup(&LangMatch::resolve("es-ES"));
assert_eq!(translation, Some("¡Hola mundo!".to_string())); assert_eq!(translation, Some("¡Hola mundo!".to_string()));
} }
@ -22,7 +22,7 @@ async fn translation_with_args() {
let _app = service::test::init_service(Application::new().test()).await; let _app = service::test::init_service(Application::new().test()).await;
let l10n = L10n::l("test-hello-user").with_arg("userName", "Manuel"); let l10n = L10n::l("test-hello-user").with_arg("userName", "Manuel");
let translation = l10n.using(&LangMatch::resolve("es-ES")); let translation = l10n.lookup(&LangMatch::resolve("es-ES"));
assert_eq!(translation, Some("¡Hola, Manuel!".to_string())); assert_eq!(translation, Some("¡Hola, Manuel!".to_string()));
} }
@ -35,7 +35,7 @@ async fn translation_with_plural_and_select() {
("photoCount", "3"), ("photoCount", "3"),
("userGender", "male"), ("userGender", "male"),
]); ]);
let translation = l10n.using(&LangMatch::resolve("es-ES")).unwrap(); let translation = l10n.lookup(&LangMatch::resolve("es-ES")).unwrap();
assert!(translation.contains("añadido 3 nuevas fotos de él")); assert!(translation.contains("añadido 3 nuevas fotos de él"));
} }
@ -44,7 +44,7 @@ async fn check_fallback_language() {
let _app = service::test::init_service(Application::new().test()).await; let _app = service::test::init_service(Application::new().test()).await;
let l10n = L10n::l("test-hello-world"); let l10n = L10n::l("test-hello-world");
let translation = l10n.using(&LangMatch::resolve("xx-YY")); // Retrocede a "en-US". let translation = l10n.lookup(&LangMatch::resolve("xx-YY")); // Retrocede a "en-US".
assert_eq!(translation, Some("Hello world!".to_string())); assert_eq!(translation, Some("Hello world!".to_string()));
} }
@ -53,6 +53,6 @@ async fn check_unknown_key() {
let _app = service::test::init_service(Application::new().test()).await; let _app = service::test::init_service(Application::new().test()).await;
let l10n = L10n::l("non-existent-key"); let l10n = L10n::l("non-existent-key");
let translation = l10n.using(&LangMatch::resolve("en-US")); let translation = l10n.lookup(&LangMatch::resolve("en-US"));
assert_eq!(translation, None); assert_eq!(translation, None);
} }