From 7b23e9c1ea4c77fb9ff27d427d8436f95ca36148 Mon Sep 17 00:00:00 2001 From: Manuel Cillero Date: Sun, 7 Dec 2025 11:55:26 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20[minimal]=20A=C3=B1ade=20macros=20d?= =?UTF-8?q?eclarativas=20a=20utilidades?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Incorpora nuevo *crate* `pagetop-minimal` con macros básicas para operaciones con cadenas, bloques de texto o colecciones clave-valor. - Refactoriza código para usar `util::join!` y `util::join_pair!` en la concatenación de cadenas. - Normaliza la gestión de localización usando `util::kv!` para los argumentos con pares clave-valor. - Actualizada documentación y archivos README para reflejar la nueva estructura y funcionalidades. --- Cargo.lock | 18 +- Cargo.toml | 5 +- README.md | 16 +- examples/navbar-menus.rs | 2 +- .../src/theme/container/component.rs | 2 +- .../src/theme/navbar/component.rs | 8 +- .../src/theme/offcanvas/component.rs | 4 +- helpers/pagetop-macros/README.md | 2 +- helpers/pagetop-macros/src/lib.rs | 2 +- helpers/pagetop-minimal/Cargo.toml | 20 ++ helpers/pagetop-minimal/LICENSE-APACHE | 201 ++++++++++++++++++ helpers/pagetop-minimal/LICENSE-MIT | 21 ++ helpers/pagetop-minimal/README.md | 56 +++++ helpers/pagetop-minimal/src/lib.rs | 145 +++++++++++++ helpers/pagetop-statics/README.md | 2 +- helpers/pagetop-statics/src/lib.rs | 2 +- src/base/component/poweredby.rs | 2 +- src/core/component/context.rs | 4 +- src/core/theme.rs | 4 +- src/html/assets/javascript.rs | 12 +- src/html/assets/stylesheet.rs | 4 +- src/locale.rs | 6 +- src/prelude.rs | 2 - src/service.rs | 7 +- src/util.rs | 111 +--------- 25 files changed, 504 insertions(+), 154 deletions(-) create mode 100644 helpers/pagetop-minimal/Cargo.toml create mode 100644 helpers/pagetop-minimal/LICENSE-APACHE create mode 100644 helpers/pagetop-minimal/LICENSE-MIT create mode 100644 helpers/pagetop-minimal/README.md create mode 100644 helpers/pagetop-minimal/src/lib.rs diff --git a/Cargo.lock b/Cargo.lock index 4912a6df..7dd0c50b 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1300,9 +1300,12 @@ dependencies = [ [[package]] name = "indoc" -version = "2.0.6" +version = "2.0.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f4c7245a08504955605670dbf141fceab975f15ca21570696aebe9d2e71576bd" +checksum = "79cf5c93f93228cf8efb3ba362535fb11199ac548a09ce117c9b1adc3030d706" +dependencies = [ + "rustversion", +] [[package]] name = "inout" @@ -1565,17 +1568,16 @@ dependencies = [ "actix-web", "chrono", "colored", - "concat-string", "config", "figlet-rs", "fluent-templates", "getter-methods", - "indoc", "itoa", "pagetop-aliner", "pagetop-bootsier", "pagetop-build", "pagetop-macros", + "pagetop-minimal", "pagetop-statics", "parking_lot", "pastey", @@ -1626,6 +1628,14 @@ dependencies = [ "syn", ] +[[package]] +name = "pagetop-minimal" +version = "0.0.10" +dependencies = [ + "concat-string", + "indoc", +] + [[package]] name = "pagetop-statics" version = "0.1.2" diff --git a/Cargo.toml b/Cargo.toml index d8c42c6e..db70e370 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -17,11 +17,9 @@ authors.workspace = true [dependencies] chrono = "0.4" colored = "3.0" -concat-string = "1.0" config = { version = "0.15", default-features = false, features = ["toml"] } figlet-rs = "0.1" getter-methods = "2.0" -indoc = "2.0" itoa = "1.0" parking_lot = "0.12" paste = { package = "pastey", version = "0.1" } @@ -43,6 +41,7 @@ actix-web-files = { package = "actix-files", version = "0.6" } serde.workspace = true pagetop-macros.workspace = true +pagetop-minimal.workspace = true pagetop-statics.workspace = true [features] @@ -65,6 +64,7 @@ members = [ # Helpers "helpers/pagetop-build", "helpers/pagetop-macros", + "helpers/pagetop-minimal", "helpers/pagetop-statics", # Extensions "extensions/pagetop-aliner", @@ -83,6 +83,7 @@ serde = { version = "1.0", features = ["derive"] } # Helpers pagetop-build = { version = "0.3", path = "helpers/pagetop-build" } pagetop-macros = { version = "0.2", path = "helpers/pagetop-macros" } +pagetop-minimal = { version = "0.0", path = "helpers/pagetop-minimal" } pagetop-statics = { version = "0.1", path = "helpers/pagetop-statics" } # Extensions pagetop-aliner = { version = "0.0", path = "extensions/pagetop-aliner" } diff --git a/README.md b/README.md index 9a12c845..eceb5058 100644 --- a/README.md +++ b/README.md @@ -84,17 +84,21 @@ El código se organiza en un *workspace* donde actualmente se incluyen los sigui ## Auxiliares - * **[pagetop-statics](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/helpers/pagetop-statics)**, - es la librería que permite incluir archivos estáticos en el ejecutable de las aplicaciones - PageTop para servirlos de forma eficiente, con detección de cambios que optimizan el tiempo de - compilación. - * **[pagetop-build](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/helpers/pagetop-build)**, prepara los archivos estáticos o archivos SCSS compilados para incluirlos en el binario de las aplicaciones PageTop durante la compilación de los ejecutables. * **[pagetop-macros](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/helpers/pagetop-macros)**, - proporciona una colección de macros que mejoran la experiencia de desarrollo con PageTop. + proporciona una colección de macros procedurales que mejoran la experiencia de desarrollo con + PageTop. + + * **[pagetop-minimal](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/helpers/pagetop-minimal)**, + ofrece macros declarativas esenciales para optimizar tareas comunes como la composición de + texto, la concatenación de cadenas y el manejo de colecciones clave-valor. + + * **[pagetop-statics](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/helpers/pagetop-statics)**, + permite incluir archivos estáticos en el ejecutable de las aplicaciones PageTop para servirlos + de forma eficiente, con detección de cambios que optimizan el tiempo de compilación. ## Extensiones diff --git a/examples/navbar-menus.rs b/examples/navbar-menus.rs index 8d330542..d534afb8 100644 --- a/examples/navbar-menus.rs +++ b/examples/navbar-menus.rs @@ -10,7 +10,7 @@ impl Extension for SuperMenu { } fn initialize(&self) { - let home_path = |cx: &Context| join!("/lang/", cx.langid().language.as_str()).into(); + let home_path = |cx: &Context| util::join!("/lang/", cx.langid().language.as_str()).into(); let navbar_menu = Navbar::brand_left(navbar::Brand::new().with_path(Some(home_path))) .with_expand(BreakPoint::LG) diff --git a/extensions/pagetop-bootsier/src/theme/container/component.rs b/extensions/pagetop-bootsier/src/theme/container/component.rs index d20ca154..101d847c 100644 --- a/extensions/pagetop-bootsier/src/theme/container/component.rs +++ b/extensions/pagetop-bootsier/src/theme/container/component.rs @@ -40,7 +40,7 @@ impl Component for Container { } let style = match self.container_width() { container::Width::FluidMax(w) if w.is_measurable() => { - Some(join!("max-width: ", w.to_string(), ";")) + Some(util::join!("max-width: ", w.to_string(), ";")) } _ => None, }; diff --git a/extensions/pagetop-bootsier/src/theme/navbar/component.rs b/extensions/pagetop-bootsier/src/theme/navbar/component.rs index 21fc87f6..297827e5 100644 --- a/extensions/pagetop-bootsier/src/theme/navbar/component.rs +++ b/extensions/pagetop-bootsier/src/theme/navbar/component.rs @@ -51,7 +51,7 @@ impl Component for Navbar { fn prepare_component(&self, cx: &mut Context) -> PrepareMarkup { // Botón de despliegue (colapso u offcanvas) para la barra. fn button(cx: &mut Context, data_bs_toggle: &str, id_content: &str) -> Markup { - let id_content_target = join!("#", id_content); + let id_content_target = util::join!("#", id_content); let aria_expanded = if data_bs_toggle == TOGGLE_COLLAPSE { Some("false") } else { @@ -92,7 +92,7 @@ impl Component for Navbar { // Barra sencilla que se puede contraer/expandir. navbar::Layout::SimpleToggle => { - @let id_content = join!(id, "-content"); + @let id_content = util::join!(id, "-content"); (button(cx, TOGGLE_COLLAPSE, &id_content)) div id=(id_content) class="collapse navbar-collapse" { @@ -108,7 +108,7 @@ impl Component for Navbar { // Barra con marca a la izquierda y botón a la derecha. navbar::Layout::BrandLeft(brand) => { - @let id_content = join!(id, "-content"); + @let id_content = util::join!(id, "-content"); (brand.render(cx)) (button(cx, TOGGLE_COLLAPSE, &id_content)) @@ -119,7 +119,7 @@ impl Component for Navbar { // Barra con botón a la izquierda y marca a la derecha. navbar::Layout::BrandRight(brand) => { - @let id_content = join!(id, "-content"); + @let id_content = util::join!(id, "-content"); (button(cx, TOGGLE_COLLAPSE, &id_content)) (brand.render(cx)) diff --git a/extensions/pagetop-bootsier/src/theme/offcanvas/component.rs b/extensions/pagetop-bootsier/src/theme/offcanvas/component.rs index 8b543cfc..bee55a24 100644 --- a/extensions/pagetop-bootsier/src/theme/offcanvas/component.rs +++ b/extensions/pagetop-bootsier/src/theme/offcanvas/component.rs @@ -159,8 +159,8 @@ impl Offcanvas { } let id = cx.required_id::(self.id()); - let id_label = join!(id, "-label"); - let id_target = join!("#", id); + let id_label = util::join!(id, "-label"); + let id_target = util::join!("#", id); let body_scroll = match self.body_scroll() { offcanvas::BodyScroll::Disabled => None, diff --git a/helpers/pagetop-macros/README.md b/helpers/pagetop-macros/README.md index 66fdc1fa..b7f1ad5e 100644 --- a/helpers/pagetop-macros/README.md +++ b/helpers/pagetop-macros/README.md @@ -19,7 +19,7 @@ configurables, basadas en HTML, CSS y JavaScript. ## Créditos -Esta librería incluye entre sus macros una adaptación de +Este *crate* incluye entre sus macros una adaptación de [maud-macros](https://crates.io/crates/maud_macros) ([0.27.0](https://github.com/lambda-fairy/maud/tree/v0.27.0/maud_macros)) de [Chris Wong](https://crates.io/users/lambda-fairy) y una versión renombrada de diff --git a/helpers/pagetop-macros/src/lib.rs b/helpers/pagetop-macros/src/lib.rs index 6fa12357..6916d3fe 100644 --- a/helpers/pagetop-macros/src/lib.rs +++ b/helpers/pagetop-macros/src/lib.rs @@ -20,7 +20,7 @@ configurables, basadas en HTML, CSS y JavaScript. ## Créditos -Esta librería incluye entre sus macros una adaptación de +Este *crate* incluye entre sus macros una adaptación de [maud-macros](https://crates.io/crates/maud_macros) ([0.27.0](https://github.com/lambda-fairy/maud/tree/v0.27.0/maud_macros)) de [Chris Wong](https://crates.io/users/lambda-fairy) y una versión renombrada de diff --git a/helpers/pagetop-minimal/Cargo.toml b/helpers/pagetop-minimal/Cargo.toml new file mode 100644 index 00000000..a91f340b --- /dev/null +++ b/helpers/pagetop-minimal/Cargo.toml @@ -0,0 +1,20 @@ +[package] +name = "pagetop-minimal" +version = "0.0.10" +edition = "2021" + +description = """ + Reúne un conjunto mínimo de macros para mejorar el formato y la eficiencia de operaciones + básicas en PageTop. +""" +categories = ["development-tools::build-utils"] +keywords = ["pagetop", "build", "assets", "resources", "static"] + +repository.workspace = true +homepage.workspace = true +license.workspace = true +authors.workspace = true + +[dependencies] +concat-string = "1.0" +indoc = "2.0" diff --git a/helpers/pagetop-minimal/LICENSE-APACHE b/helpers/pagetop-minimal/LICENSE-APACHE new file mode 100644 index 00000000..263ddac1 --- /dev/null +++ b/helpers/pagetop-minimal/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2022 Manuel Cillero + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/helpers/pagetop-minimal/LICENSE-MIT b/helpers/pagetop-minimal/LICENSE-MIT new file mode 100644 index 00000000..cd8af3d6 --- /dev/null +++ b/helpers/pagetop-minimal/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Manuel Cillero + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/helpers/pagetop-minimal/README.md b/helpers/pagetop-minimal/README.md new file mode 100644 index 00000000..4ffbf60f --- /dev/null +++ b/helpers/pagetop-minimal/README.md @@ -0,0 +1,56 @@ +/*! +
+ +

PageTop Minimal

+ +

Reúne un conjunto mínimo de macros para mejorar el formato y la eficiencia de operaciones básicas en PageTop.

+ +[![Doc API](https://img.shields.io/docsrs/pagetop-minimal?label=Doc%20API&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-minimal) +[![Crates.io](https://img.shields.io/crates/v/pagetop-minimal.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-minimal) +[![Descargas](https://img.shields.io/crates/d/pagetop-minimal.svg?label=Descargas&style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-minimal) +[![Licencia](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?label=Licencia&style=for-the-badge)](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/helpers/pagetop-minimal#licencia) + +
+ +## Sobre PageTop + +[PageTop](https://docs.rs/pagetop) es un entorno de desarrollo que reivindica la esencia de la web +clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares, extensibles y +configurables, basadas en HTML, CSS y JavaScript. + +## Descripción general + +Este *crate* proporciona un conjunto básico de macros que se integran en las utilidades de PageTop +para optimizar operaciones habituales relacionadas con la composición estructurada de texto, la +concatenación de cadenas y el uso rápido de colecciones clave-valor. + +## Créditos + +Las macros para texto multilínea **`indoc!`**, **`formatdoc!`** y **`concatdoc!`** se reexportan del +*crate* [indoc](https://crates.io/crates/indoc) de [David Tolnay](https://crates.io/users/dtolnay). + +Las macros para la concatenación de cadenas **`join!`** y **`join_pair!`** se apoyan internamente en +el **crate** [concat-string](https://crates.io/crates/concat_string), desarrollado por +[FaultyRAM](https://crates.io/users/FaultyRAM), para evitar el uso del formato de cadenas cuando la +eficiencia pueda ser relevante. + + +# 🚧 Advertencia + +**PageTop** es un proyecto personal para aprender [Rust](https://www.rust-lang.org/es) y conocer su +ecosistema. Su API está sujeta a cambios frecuentes. No se recomienda su uso en producción, al menos +hasta que se libere la versión **1.0.0**. + + +# 📜 Licencia + +El código está disponible bajo una doble licencia: + + * **Licencia MIT** + ([LICENSE-MIT](LICENSE-MIT) o también https://opensource.org/licenses/MIT) + + * **Licencia Apache, Versión 2.0** + ([LICENSE-APACHE](LICENSE-APACHE) o también https://www.apache.org/licenses/LICENSE-2.0) + +Puedes elegir la licencia que prefieras. Este enfoque de doble licencia es el estándar de facto en +el ecosistema Rust. diff --git a/helpers/pagetop-minimal/src/lib.rs b/helpers/pagetop-minimal/src/lib.rs new file mode 100644 index 00000000..dd55cfdc --- /dev/null +++ b/helpers/pagetop-minimal/src/lib.rs @@ -0,0 +1,145 @@ +/*! +
+ +

PageTop Minimal

+ +

Reúne un conjunto mínimo de macros para mejorar el formato y la eficiencia de operaciones básicas en PageTop.

+ +[![Doc API](https://img.shields.io/docsrs/pagetop-minimal?label=Doc%20API&style=for-the-badge&logo=Docs.rs)](https://docs.rs/pagetop-minimal) +[![Crates.io](https://img.shields.io/crates/v/pagetop-minimal.svg?style=for-the-badge&logo=ipfs)](https://crates.io/crates/pagetop-minimal) +[![Descargas](https://img.shields.io/crates/d/pagetop-minimal.svg?label=Descargas&style=for-the-badge&logo=transmission)](https://crates.io/crates/pagetop-minimal) +[![Licencia](https://img.shields.io/badge/license-MIT%2FApache-blue.svg?label=Licencia&style=for-the-badge)](https://git.cillero.es/manuelcillero/pagetop/src/branch/main/helpers/pagetop-minimal#licencia) + +
+ +## Sobre PageTop + +[PageTop](https://docs.rs/pagetop) es un entorno de desarrollo que reivindica la esencia de la web +clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares, extensibles y +configurables, basadas en HTML, CSS y JavaScript. + +## Descripción general + +Este *crate* proporciona un conjunto básico de macros que se integran en las utilidades de PageTop +para optimizar operaciones habituales relacionadas con la composición estructurada de texto, la +concatenación de cadenas y el uso rápido de colecciones clave-valor. + +## Créditos + +Las macros para texto multilínea **`indoc!`**, **`formatdoc!`** y **`concatdoc!`** se reexportan del +*crate* [indoc](https://crates.io/crates/indoc) de [David Tolnay](https://crates.io/users/dtolnay). + +Las macros para la concatenación de cadenas **`join!`** y **`join_pair!`** se apoyan internamente en +el **crate** [concat-string](https://crates.io/crates/concat_string), desarrollado por +[FaultyRAM](https://crates.io/users/FaultyRAM), para evitar el uso del formato de cadenas cuando la +eficiencia pueda ser relevante. +*/ + +#![doc( + html_favicon_url = "https://git.cillero.es/manuelcillero/pagetop/raw/branch/main/static/favicon.ico" +)] + +#[doc(hidden)] +pub use concat_string::concat_string; + +pub use indoc::{concatdoc, formatdoc, indoc}; + +/// Concatena eficientemente varios fragmentos en un [`String`]. +/// +/// Esta macro exporta [`concat_string!`](https://docs.rs/concat-string). Acepta cualquier número de +/// fragmentos que implementen [`AsRef`] y construye un [`String`] con el tamaño óptimo, de +/// forma eficiente y evitando el uso de cadenas de formato que penalicen el rendimiento. +/// +/// # Ejemplo +/// +/// ```rust +/// # use pagetop_minimal::join; +/// // Concatena todos los fragmentos directamente. +/// let result = join!("Hello", " ", "World"); +/// assert_eq!(result, "Hello World".to_string()); +/// +/// // También funciona con valores vacíos. +/// let result_with_empty = join!("Hello", "", "World"); +/// assert_eq!(result_with_empty, "HelloWorld".to_string()); +/// +/// // Un único fragmento devuelve el mismo valor. +/// let single_result = join!("Hello"); +/// assert_eq!(single_result, "Hello".to_string()); +/// ``` +#[macro_export] +macro_rules! join { + ($($arg:expr),+) => { + $crate::concat_string!($($arg),+) + }; +} + +/// Concatena dos fragmentos en un [`String`] usando un separador inteligente. +/// +/// Une los dos fragmentos, que deben implementar [`AsRef`], usando el separador proporcionado. +/// Si uno de ellos está vacío, devuelve directamente el otro; y si ambos están vacíos devuelve un +/// [`String`] vacío. +/// +/// # Ejemplo +/// +/// ```rust +/// # use pagetop_minimal::join_pair; +/// let first = "Hello"; +/// let separator = "-"; +/// let second = "World"; +/// +/// // Concatena los dos fragmentos cuando ambos no están vacíos. +/// let result = join_pair!(first, separator, second); +/// assert_eq!(result, "Hello-World".to_string()); +/// +/// // Si el primer fragmento está vacío, devuelve el segundo. +/// let result_empty_first = join_pair!("", separator, second); +/// assert_eq!(result_empty_first, "World".to_string()); +/// +/// // Si el segundo fragmento está vacío, devuelve el primero. +/// let result_empty_second = join_pair!(first, separator, ""); +/// assert_eq!(result_empty_second, "Hello".to_string()); +/// +/// // Si ambos fragmentos están vacíos, devuelve una cadena vacía. +/// let result_both_empty = join_pair!("", separator, ""); +/// assert_eq!(result_both_empty, "".to_string()); +/// ``` +#[macro_export] +macro_rules! join_pair { + ($first:expr, $separator:expr, $second:expr) => {{ + let first_val = $first; + let second_val = $second; + let separator_val = $separator; + + let first = AsRef::::as_ref(&first_val); + let second = AsRef::::as_ref(&second_val); + let separator = if first.is_empty() || second.is_empty() { + "" + } else { + AsRef::::as_ref(&separator_val) + }; + + $crate::concat_string!(first, separator, second) + }}; +} + +/// Macro para construir una colección de pares clave-valor. +/// +/// ```rust +/// # use pagetop_minimal::kv; +/// # use std::collections::HashMap; +/// let args:HashMap<&str, String> = kv![ +/// "userName" => "Roberto", +/// "photoCount" => "3", +/// "userGender" => "male", +/// ]; +/// ``` +#[macro_export] +macro_rules! kv { + ( $($key:expr => $value:expr),* $(,)? ) => {{ + let mut a = std::collections::HashMap::new(); + $( + a.insert($key.into(), $value.into()); + )* + a + }}; +} diff --git a/helpers/pagetop-statics/README.md b/helpers/pagetop-statics/README.md index cd1da6ac..99e24b4d 100644 --- a/helpers/pagetop-statics/README.md +++ b/helpers/pagetop-statics/README.md @@ -19,7 +19,7 @@ configurables, basadas en HTML, CSS y JavaScript. ## Descripción general -Esta librería permite incluir archivos estáticos en el ejecutable de las aplicaciones PageTop para +Este *crate* permite incluir archivos estáticos en el ejecutable de las aplicaciones PageTop para servirlos de forma eficiente vía web, con detección de cambios que optimizan el tiempo de compilación. diff --git a/helpers/pagetop-statics/src/lib.rs b/helpers/pagetop-statics/src/lib.rs index 6f04bd2a..d2f147e3 100644 --- a/helpers/pagetop-statics/src/lib.rs +++ b/helpers/pagetop-statics/src/lib.rs @@ -20,7 +20,7 @@ configurables, basadas en HTML, CSS y JavaScript. ## Descripción general -Esta librería permite incluir archivos estáticos en el ejecutable de las aplicaciones PageTop para +Este *crate* permite incluir archivos estáticos en el ejecutable de las aplicaciones PageTop para servirlos de forma eficiente vía web, con detección de cambios que optimizan el tiempo de compilación. diff --git a/src/base/component/poweredby.rs b/src/base/component/poweredby.rs index 245f16b4..e90263c9 100644 --- a/src/base/component/poweredby.rs +++ b/src/base/component/poweredby.rs @@ -21,7 +21,7 @@ impl Component for PoweredBy { /// configurada en [`global::SETTINGS`], en el formato `YYYY © Nombre de la aplicación`. fn new() -> Self { let year = Utc::now().format("%Y").to_string(); - let c = join!(year, " © ", global::SETTINGS.app.name); + let c = util::join!(year, " © ", global::SETTINGS.app.name); PoweredBy { copyright: Some(c) } } diff --git a/src/core/component/context.rs b/src/core/component/context.rs index 59dd1f1a..74290569 100644 --- a/src/core/component/context.rs +++ b/src/core/component/context.rs @@ -6,7 +6,7 @@ use crate::html::{html, Markup}; use crate::html::{Assets, Favicon, JavaScript, StyleSheet}; use crate::locale::{LangId, LangMatch, LanguageIdentifier}; use crate::service::HttpRequest; -use crate::{builder_fn, join}; +use crate::{builder_fn, util}; use std::any::Any; use std::collections::HashMap; @@ -546,7 +546,7 @@ impl Contextual for Context { prefix }; self.id_counter += 1; - join!(prefix, "-", self.id_counter.to_string()) + util::join!(prefix, "-", self.id_counter.to_string()) } } } diff --git a/src/core/theme.rs b/src/core/theme.rs index 8485bf70..91646ab0 100644 --- a/src/core/theme.rs +++ b/src/core/theme.rs @@ -24,7 +24,7 @@ use crate::core::component::Context; use crate::html::{html, Markup}; use crate::locale::L10n; -use crate::{join, AutoDefault}; +use crate::{util, AutoDefault}; // **< Region >************************************************************************************* @@ -83,7 +83,7 @@ pub trait Region { @let region = cx.render_region(self); @if !region.is_empty() { div - class=(join!("region region-", self.name())) + class=(util::join!("region region-", self.name())) role="region" aria-label=[self.label().lookup(cx)] { diff --git a/src/html/assets/javascript.rs b/src/html/assets/javascript.rs index 6394842a..309c47f2 100644 --- a/src/html/assets/javascript.rs +++ b/src/html/assets/javascript.rs @@ -1,7 +1,7 @@ use crate::core::component::Context; use crate::html::assets::Asset; use crate::html::{html, Markup, PreEscaped}; -use crate::{join, join_pair, AutoDefault, Weight}; +use crate::{util, AutoDefault, Weight}; // Define el origen del recurso JavaScript y cómo debe cargarse en el navegador. // @@ -215,21 +215,21 @@ impl Asset for JavaScript { fn render(&self, cx: &mut Context) -> Markup { match &self.source { Source::From(path) => html! { - script src=(join_pair!(path, "?v=", &self.version)) {}; + script src=(util::join_pair!(path, "?v=", &self.version)) {}; }, Source::Defer(path) => html! { - script src=(join_pair!(path, "?v=", &self.version)) defer {}; + script src=(util::join_pair!(path, "?v=", &self.version)) defer {}; }, Source::Async(path) => html! { - script src=(join_pair!(path, "?v=", &self.version)) async {}; + script src=(util::join_pair!(path, "?v=", &self.version)) async {}; }, Source::Inline(_, f) => html! { script { (PreEscaped((f)(cx))) }; }, - Source::OnLoad(_, f) => html! { script { (PreEscaped(join!( + Source::OnLoad(_, f) => html! { script { (PreEscaped(util::join!( "document.addEventListener(\"DOMContentLoaded\",function(){", (f)(cx), "});" ))) } }, - Source::OnLoadAsync(_, f) => html! { script { (PreEscaped(join!( + Source::OnLoadAsync(_, f) => html! { script { (PreEscaped(util::join!( "document.addEventListener(\"DOMContentLoaded\",async()=>{", (f)(cx), "});" ))) } }, } diff --git a/src/html/assets/stylesheet.rs b/src/html/assets/stylesheet.rs index abadef8a..f86ba8fe 100644 --- a/src/html/assets/stylesheet.rs +++ b/src/html/assets/stylesheet.rs @@ -1,7 +1,7 @@ use crate::core::component::Context; use crate::html::assets::Asset; use crate::html::{html, Markup, PreEscaped}; -use crate::{join_pair, AutoDefault, Weight}; +use crate::{util, AutoDefault, Weight}; // Define el origen del recurso CSS y cómo se incluye en el documento. // @@ -170,7 +170,7 @@ impl Asset for StyleSheet { Source::From(path) => html! { link rel="stylesheet" - href=(join_pair!(path, "?v=", &self.version)) + href=(util::join_pair!(path, "?v=", &self.version)) media=[self.media.as_str()]; }, Source::Inline(_, f) => html! { diff --git a/src/locale.rs b/src/locale.rs index 11db7252..ba037491 100644 --- a/src/locale.rs +++ b/src/locale.rs @@ -91,7 +91,7 @@ use crate::html::{Markup, PreEscaped}; use crate::service::HttpRequest; -use crate::{global, hm, AutoDefault}; +use crate::{global, util, AutoDefault}; pub use fluent_templates; pub use unic_langid::{CharacterDirection, LanguageIdentifier}; @@ -110,7 +110,7 @@ use std::fmt; // Asocia cada identificador de idioma (como "en-US") con su respectivo [`LanguageIdentifier`] y la // clave en *locale/.../languages.ftl* para obtener el nombre del idioma según la localización. static LANGUAGES: LazyLock> = LazyLock::new(|| { - hm![ + util::kv![ "en" => ( langid!("en-US"), "english" ), "en-gb" => ( langid!("en-GB"), "english_british" ), "en-us" => ( langid!("en-US"), "english_united_states" ), @@ -411,7 +411,7 @@ impl L10n { self } - /// Añade varios argumentos a la traducción de una sola vez (p. ej. usando la macro [`hm!`], + /// Añade varios argumentos a la traducción de una vez (p. ej. usando la macro [`util::kv!`], /// también vec![("k", "v")], incluso un array de duplas u otras colecciones). pub fn with_args(mut self, args: I) -> Self where diff --git a/src/prelude.rs b/src/prelude.rs index be36a1d3..54e37694 100644 --- a/src/prelude.rs +++ b/src/prelude.rs @@ -10,8 +10,6 @@ pub use crate::{AutoDefault, Getters, StaticResources, UniqueId, Weight}; // MACROS. -// crate::util -pub use crate::{hm, join, join_pair}; // crate::config pub use crate::include_config; // crate::locale diff --git a/src/service.rs b/src/service.rs index cb69d76a..60131def 100644 --- a/src/service.rs +++ b/src/service.rs @@ -15,6 +15,9 @@ pub use pagetop_statics::ResourceFiles; #[doc(hidden)] pub use actix_web::test; +#[doc(hidden)] +pub use paste::paste; + /// Configura un servicio web para publicar archivos estáticos. /// /// La macro ofrece tres modos para configurar el servicio: @@ -72,7 +75,7 @@ macro_rules! static_files_service { } } if serve_embedded { - $crate::util::paste! { + $crate::service::paste! { mod [] { include!(concat!(env!("OUT_DIR"), "/", stringify!($bundle), ".rs")); } @@ -92,7 +95,7 @@ macro_rules! static_files_service { route = $route, ); let _ = span.in_scope(|| { - $crate::util::paste! { + $crate::service::paste! { mod [] { include!(concat!(env!("OUT_DIR"), "/", stringify!($bundle), ".rs")); } diff --git a/src/util.rs b/src/util.rs index 1cb21ae7..b3df8d43 100644 --- a/src/util.rs +++ b/src/util.rs @@ -8,116 +8,7 @@ use std::path::{Path, PathBuf}; // **< MACROS INTEGRADAS >************************************************************************** -#[doc(hidden)] -pub use paste::paste; - -#[doc(hidden)] -pub use concat_string::concat_string; - -pub use indoc::{concatdoc, formatdoc, indoc}; - -// **< MACROS ÚTILES >****************************************************************************** - -/// Macro para construir una colección de pares clave-valor. -/// -/// ```rust -/// use pagetop::hm; -/// use std::collections::HashMap; -/// -/// let args:HashMap<&str, String> = hm![ -/// "userName" => "Roberto", -/// "photoCount" => "3", -/// "userGender" => "male", -/// ]; -/// ``` -#[macro_export] -macro_rules! hm { - ( $($key:expr => $value:expr),* $(,)? ) => {{ - let mut a = std::collections::HashMap::new(); - $( - a.insert($key.into(), $value.into()); - )* - a - }}; -} - -/// Concatena eficientemente varios fragmentos en un [`String`]. -/// -/// Esta macro exporta [`concat_string!`](https://docs.rs/concat-string). Acepta cualquier número de -/// fragmentos que implementen [`AsRef`] y construye un [`String`] con el tamaño óptimo, de -/// forma eficiente y evitando el uso de cadenas de formato que penalicen el rendimiento. -/// -/// # Ejemplo -/// -/// ```rust -/// # use pagetop::prelude::*; -/// // Concatena todos los fragmentos directamente. -/// let result = join!("Hello", " ", "World"); -/// assert_eq!(result, "Hello World".to_string()); -/// -/// // También funciona con valores vacíos. -/// let result_with_empty = join!("Hello", "", "World"); -/// assert_eq!(result_with_empty, "HelloWorld".to_string()); -/// -/// // Un único fragmento devuelve el mismo valor. -/// let single_result = join!("Hello"); -/// assert_eq!(single_result, "Hello".to_string()); -/// ``` -#[macro_export] -macro_rules! join { - ($($arg:expr),+) => { - $crate::util::concat_string!($($arg),+) - }; -} - -/// Concatena dos fragmentos en un [`String`] usando un separador. -/// -/// Une los dos fragmentos, que deben implementar [`AsRef`], usando el separador proporcionado. -/// Si uno de ellos está vacío, devuelve directamente el otro; y si ambos están vacíos devuelve un -/// [`String`] vacío. -/// -/// # Ejemplo -/// -/// ```rust -/// # use pagetop::prelude::*; -/// let first = "Hello"; -/// let separator = "-"; -/// let second = "World"; -/// -/// // Concatena los dos fragmentos cuando ambos no están vacíos. -/// let result = join_pair!(first, separator, second); -/// assert_eq!(result, "Hello-World".to_string()); -/// -/// // Si el primer fragmento está vacío, devuelve el segundo. -/// let result_empty_first = join_pair!("", separator, second); -/// assert_eq!(result_empty_first, "World".to_string()); -/// -/// // Si el segundo fragmento está vacío, devuelve el primero. -/// let result_empty_second = join_pair!(first, separator, ""); -/// assert_eq!(result_empty_second, "Hello".to_string()); -/// -/// // Si ambos fragmentos están vacíos, devuelve una cadena vacía. -/// let result_both_empty = join_pair!("", separator, ""); -/// assert_eq!(result_both_empty, "".to_string()); -/// ``` -#[macro_export] -macro_rules! join_pair { - ($first:expr, $separator:expr, $second:expr) => {{ - let first_val = $first; - let second_val = $second; - let separator_val = $separator; - - let first = AsRef::::as_ref(&first_val); - let second = AsRef::::as_ref(&second_val); - let separator = if first.is_empty() || second.is_empty() { - "" - } else { - AsRef::::as_ref(&separator_val) - }; - - $crate::util::concat_string!(first, separator, second) - }}; -} +pub use pagetop_minimal::{concatdoc, formatdoc, indoc, join, join_pair, kv}; // **< FUNCIONES ÚTILES >***************************************************************************