Compare commits
No commits in common. "main" and "pagetop-build-v0.2.0" have entirely different histories.
main
...
pagetop-bu
27 changed files with 334 additions and 698 deletions
26
CHANGELOG.md
26
CHANGELOG.md
|
|
@ -8,32 +8,6 @@ Resume la evolución del proyecto para usuarios y colaboradores, destacando nuev
|
|||
correcciones, mejoras durante el desarrollo o cambios en la documentación. Cambios menores o
|
||||
internos pueden omitirse si no afectan al uso del proyecto.
|
||||
|
||||
## 0.3.0 (2025-08-16)
|
||||
|
||||
### Cambiado
|
||||
|
||||
- Redefine función para directorios absolutos
|
||||
- Mejora la integración de archivos estáticos
|
||||
|
||||
### Documentado
|
||||
|
||||
- Cambia el formato para la documentación (#4)
|
||||
|
||||
## 0.2.0 (2025-08-09)
|
||||
|
||||
### Añadido
|
||||
|
||||
- Añade librería para gestionar recursos estáticos (#1)
|
||||
- Añade soporte a changelog de `pagetop-statics` (#2)
|
||||
|
||||
### Documentado
|
||||
|
||||
- Corrige enlace del botón de licencia en la documentación
|
||||
|
||||
### Otros cambios
|
||||
|
||||
- Afina Cargo.toml para buscar la mejor categoría
|
||||
|
||||
## 0.1.0 (2025-08-06)
|
||||
|
||||
- Versión inicial
|
||||
|
|
|
|||
8
Cargo.lock
generated
8
Cargo.lock
generated
|
|
@ -1557,7 +1557,7 @@ checksum = "b15813163c1d831bf4a13c3610c05c0d03b39feb07f7e09fa234dac9b15aaf39"
|
|||
|
||||
[[package]]
|
||||
name = "pagetop"
|
||||
version = "0.3.0"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"actix-files",
|
||||
"actix-session",
|
||||
|
|
@ -1587,7 +1587,7 @@ dependencies = [
|
|||
|
||||
[[package]]
|
||||
name = "pagetop-build"
|
||||
version = "0.3.0"
|
||||
version = "0.2.0"
|
||||
dependencies = [
|
||||
"grass",
|
||||
"pagetop-statics",
|
||||
|
|
@ -1595,7 +1595,7 @@ dependencies = [
|
|||
|
||||
[[package]]
|
||||
name = "pagetop-macros"
|
||||
version = "0.1.1"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"proc-macro2-diagnostics",
|
||||
|
|
@ -1605,7 +1605,7 @@ dependencies = [
|
|||
|
||||
[[package]]
|
||||
name = "pagetop-statics"
|
||||
version = "0.1.1"
|
||||
version = "0.1.0"
|
||||
dependencies = [
|
||||
"actix-web",
|
||||
"change-detection",
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[package]
|
||||
name = "pagetop"
|
||||
version = "0.3.0"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
description = """
|
||||
|
|
@ -71,6 +71,6 @@ authors = ["Manuel Cillero <manuel@cillero.es>"]
|
|||
[workspace.dependencies]
|
||||
actix-web = { version = "4.11.0", default-features = false }
|
||||
|
||||
pagetop-build = { version = "0.3", path = "helpers/pagetop-build" }
|
||||
pagetop-build = { version = "0.2", path = "helpers/pagetop-build" }
|
||||
pagetop-macros = { version = "0.1", path = "helpers/pagetop-macros" }
|
||||
pagetop-statics = { version = "0.1", path = "helpers/pagetop-statics" }
|
||||
|
|
|
|||
14
README.md
14
README.md
|
|
@ -11,7 +11,6 @@
|
|||
[](https://crates.io/crates/pagetop)
|
||||
[](https://crates.io/crates/pagetop)
|
||||
|
||||
<br>
|
||||
</div>
|
||||
|
||||
`PageTop` reivindica la esencia de la web clásica usando [Rust](https://www.rust-lang.org/es) para
|
||||
|
|
@ -33,7 +32,7 @@ según las necesidades de cada proyecto, incluyendo:
|
|||
|
||||
La aplicación más sencilla de `PageTop` se ve así:
|
||||
|
||||
```rust,no_run
|
||||
```rust
|
||||
use pagetop::prelude::*;
|
||||
|
||||
#[pagetop::main]
|
||||
|
|
@ -47,7 +46,7 @@ de bienvenida accesible desde un navegador local en la dirección `http://localh
|
|||
|
||||
Para personalizar el servicio, se puede crear una extensión de `PageTop` de la siguiente manera:
|
||||
|
||||
```rust,no_run
|
||||
```rust
|
||||
use pagetop::prelude::*;
|
||||
|
||||
struct HelloWorld;
|
||||
|
|
@ -84,14 +83,9 @@ 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.
|
||||
permite incluir fácilmente archivos estáticos o archivos SCSS compilados directamente en el
|
||||
binario de las aplicaciones `PageTop`.
|
||||
|
||||
* **[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`.
|
||||
|
|
|
|||
|
|
@ -8,17 +8,6 @@ Resume la evolución del proyecto para usuarios y colaboradores, destacando nuev
|
|||
correcciones, mejoras durante el desarrollo o cambios en la documentación. Cambios menores o
|
||||
internos pueden omitirse si no afectan al uso del proyecto.
|
||||
|
||||
## 0.3.0 (2025-08-16)
|
||||
|
||||
### Cambiado
|
||||
|
||||
- Mejora función `from_dir` por compatibilidad (#3)
|
||||
- Mejora la integración de archivos estáticos
|
||||
|
||||
### Documentado
|
||||
|
||||
- Cambia el formato para la documentación (#4)
|
||||
|
||||
## 0.2.0 (2025-08-09)
|
||||
|
||||
### Añadido
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[package]
|
||||
name = "pagetop-build"
|
||||
version = "0.3.0"
|
||||
version = "0.2.0"
|
||||
edition = "2021"
|
||||
|
||||
description = """
|
||||
|
|
|
|||
|
|
@ -18,99 +18,6 @@ clásica para crear soluciones web SSR (*renderizadas en el servidor*) modulares
|
|||
configurables, basadas en HTML, CSS y JavaScript.
|
||||
|
||||
|
||||
# ⚡️ Guía rápida
|
||||
|
||||
Añadir en el archivo `Cargo.toml` del proyecto:
|
||||
|
||||
```toml
|
||||
[build-dependencies]
|
||||
pagetop-build = { ... }
|
||||
```
|
||||
|
||||
Y crear un archivo `build.rs` a la altura de `Cargo.toml` para indicar cómo se van a incluir los
|
||||
archivos estáticos o cómo se van a compilar los archivos SCSS para el proyecto. Casos de uso:
|
||||
|
||||
## Incluir archivos estáticos desde un directorio
|
||||
|
||||
Hay que preparar una carpeta en el proyecto con todos los archivos que se quieren incluir, por
|
||||
ejemplo `static`, y añadir el siguiente código en `build.rs` para crear el conjunto de recursos:
|
||||
|
||||
```rust,no_run
|
||||
use pagetop_build::StaticFilesBundle;
|
||||
|
||||
fn main() -> std::io::Result<()> {
|
||||
StaticFilesBundle::from_dir("./static", None)
|
||||
.with_name("guides")
|
||||
.build()
|
||||
}
|
||||
```
|
||||
|
||||
Si es necesario, se puede añadir un filtro para seleccionar archivos específicos de la carpeta, por
|
||||
ejemplo:
|
||||
|
||||
```rust,no_run
|
||||
use pagetop_build::StaticFilesBundle;
|
||||
use std::path::Path;
|
||||
|
||||
fn main() -> std::io::Result<()> {
|
||||
fn only_pdf_files(path: &Path) -> bool {
|
||||
// Selecciona únicamente los archivos con extensión `.pdf`.
|
||||
path.extension().map_or(false, |ext| ext == "pdf")
|
||||
}
|
||||
|
||||
StaticFilesBundle::from_dir("./static", Some(only_pdf_files))
|
||||
.with_name("guides")
|
||||
.build()
|
||||
}
|
||||
```
|
||||
|
||||
## Compilar archivos SCSS a CSS
|
||||
|
||||
Se puede compilar un archivo SCSS, que podría importar otros a su vez, para preparar un recurso con
|
||||
el archivo CSS minificado obtenido. Por ejemplo:
|
||||
|
||||
```rust,no_run
|
||||
use pagetop_build::StaticFilesBundle;
|
||||
|
||||
fn main() -> std::io::Result<()> {
|
||||
StaticFilesBundle::from_scss("./styles/main.scss", "styles.min.css")
|
||||
.with_name("main_styles")
|
||||
.build()
|
||||
}
|
||||
```
|
||||
|
||||
Este código compila el archivo `main.scss` de la carpeta `static` del proyecto, y prepara un recurso
|
||||
llamado `main_styles` que contiene el archivo `styles.min.css` obtenido.
|
||||
|
||||
|
||||
# 📦 Archivos generados
|
||||
|
||||
Cada conjunto de recursos [`StaticFilesBundle`] genera un archivo en el directorio estándar
|
||||
[OUT_DIR](https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts)
|
||||
donde se incluye el código necesario para compilar el proyecto. Por ejemplo, para
|
||||
`with_name("guides")` se genera un archivo llamado `guides.rs`.
|
||||
|
||||
No hay ningún problema en generar más de un conjunto de recursos para cada proyecto siempre que se
|
||||
usen nombres diferentes.
|
||||
|
||||
Normalmente no habrá que acceder a estos módulos; sólo declarar el nombre del conjunto de recursos
|
||||
en [`static_files_service!`](https://docs.rs/pagetop/latest/pagetop/macro.static_files_service.html)
|
||||
para configurar un servicio web que sirva los archivos desde la ruta indicada. Por ejemplo:
|
||||
|
||||
```rust,ignore
|
||||
use pagetop::prelude::*;
|
||||
|
||||
pub struct MyExtension;
|
||||
|
||||
impl Extension for MyExtension {
|
||||
// Servicio web que publica los recursos de `guides` en `/ruta/a/guides`.
|
||||
fn configure_service(&self, scfg: &mut service::web::ServiceConfig) {
|
||||
static_files_service!(scfg, guides => "/ruta/a/guides");
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
# 🚧 Advertencia
|
||||
|
||||
`PageTop` es un proyecto personal para aprender [Rust](https://www.rust-lang.org/es) y conocer su
|
||||
|
|
|
|||
|
|
@ -1,116 +1,122 @@
|
|||
/*!
|
||||
<div align="center">
|
||||
|
||||
<h1>PageTop Build</h1>
|
||||
|
||||
<p>Prepara un conjunto de archivos estáticos o archivos SCSS compilados para ser incluidos en el binario de un proyecto <strong>PageTop</strong>.</p>
|
||||
|
||||
[](#-licencia)
|
||||
[](https://docs.rs/pagetop-build)
|
||||
[](https://crates.io/crates/pagetop-build)
|
||||
[](https://crates.io/crates/pagetop-build)
|
||||
|
||||
</div>
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
# ⚡️ Guía rápida
|
||||
|
||||
Añadir en el archivo `Cargo.toml` del proyecto:
|
||||
|
||||
```toml
|
||||
[build-dependencies]
|
||||
pagetop-build = { ... }
|
||||
```
|
||||
|
||||
Y crear un archivo `build.rs` a la altura de `Cargo.toml` para indicar cómo se van a incluir los
|
||||
archivos estáticos o cómo se van a compilar los archivos SCSS para el proyecto. Casos de uso:
|
||||
|
||||
## Incluir archivos estáticos desde un directorio
|
||||
|
||||
Hay que preparar una carpeta en el proyecto con todos los archivos que se quieren incluir, por
|
||||
ejemplo `static`, y añadir el siguiente código en `build.rs` para crear el conjunto de recursos:
|
||||
|
||||
```rust,no_run
|
||||
use pagetop_build::StaticFilesBundle;
|
||||
|
||||
fn main() -> std::io::Result<()> {
|
||||
StaticFilesBundle::from_dir("./static", None)
|
||||
.with_name("guides")
|
||||
.build()
|
||||
}
|
||||
```
|
||||
|
||||
Si es necesario, se puede añadir un filtro para seleccionar archivos específicos de la carpeta, por
|
||||
ejemplo:
|
||||
|
||||
```rust,no_run
|
||||
use pagetop_build::StaticFilesBundle;
|
||||
use std::path::Path;
|
||||
|
||||
fn main() -> std::io::Result<()> {
|
||||
fn only_pdf_files(path: &Path) -> bool {
|
||||
// Selecciona únicamente los archivos con extensión `.pdf`.
|
||||
path.extension().map_or(false, |ext| ext == "pdf")
|
||||
}
|
||||
|
||||
StaticFilesBundle::from_dir("./static", Some(only_pdf_files))
|
||||
.with_name("guides")
|
||||
.build()
|
||||
}
|
||||
```
|
||||
|
||||
## Compilar archivos SCSS a CSS
|
||||
|
||||
Se puede compilar un archivo SCSS, que podría importar otros a su vez, para preparar un recurso con
|
||||
el archivo CSS minificado obtenido. Por ejemplo:
|
||||
|
||||
```rust,no_run
|
||||
use pagetop_build::StaticFilesBundle;
|
||||
|
||||
fn main() -> std::io::Result<()> {
|
||||
StaticFilesBundle::from_scss("./styles/main.scss", "styles.min.css")
|
||||
.with_name("main_styles")
|
||||
.build()
|
||||
}
|
||||
```
|
||||
|
||||
Este código compila el archivo `main.scss` de la carpeta `static` del proyecto, y prepara un recurso
|
||||
llamado `main_styles` que contiene el archivo `styles.min.css` obtenido.
|
||||
|
||||
|
||||
# 📦 Archivos generados
|
||||
|
||||
Cada conjunto de recursos [`StaticFilesBundle`] genera un archivo en el directorio estándar
|
||||
[OUT_DIR](https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts)
|
||||
donde se incluye el código necesario para compilar el proyecto. Por ejemplo, para
|
||||
`with_name("guides")` se genera un archivo llamado `guides.rs`.
|
||||
|
||||
No hay ningún problema en generar más de un conjunto de recursos para cada proyecto siempre que se
|
||||
usen nombres diferentes.
|
||||
|
||||
Normalmente no habrá que acceder a estos módulos; sólo declarar el nombre del conjunto de recursos
|
||||
en [`static_files_service!`](https://docs.rs/pagetop/latest/pagetop/macro.static_files_service.html)
|
||||
para configurar un servicio web que sirva los archivos desde la ruta indicada. Por ejemplo:
|
||||
|
||||
```rust,ignore
|
||||
use pagetop::prelude::*;
|
||||
|
||||
pub struct MyExtension;
|
||||
|
||||
impl Extension for MyExtension {
|
||||
// Servicio web que publica los recursos de `guides` en `/ruta/a/guides`.
|
||||
fn configure_service(&self, scfg: &mut service::web::ServiceConfig) {
|
||||
static_files_service!(scfg, guides => "/ruta/a/guides");
|
||||
}
|
||||
}
|
||||
```
|
||||
*/
|
||||
//! <div align="center">
|
||||
//!
|
||||
//! <h1>PageTop Build</h1>
|
||||
//!
|
||||
//! <p>Prepara un conjunto de archivos estáticos o archivos SCSS compilados para ser incluidos en el binario de un proyecto <strong>PageTop</strong>.</p>
|
||||
//!
|
||||
//! [](#-licencia)
|
||||
//! [](https://docs.rs/pagetop-build)
|
||||
//! [](https://crates.io/crates/pagetop-build)
|
||||
//! [](https://crates.io/crates/pagetop-build)
|
||||
//!
|
||||
//! </div>
|
||||
//!
|
||||
//! ## 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.
|
||||
//!
|
||||
//!
|
||||
//! # ⚡️ Guía rápida
|
||||
//!
|
||||
//! Añadir en el archivo `Cargo.toml` del proyecto:
|
||||
//!
|
||||
//! ```toml
|
||||
//! [build-dependencies]
|
||||
//! pagetop-build = { ... }
|
||||
//! ```
|
||||
//!
|
||||
//! Y crear un archivo `build.rs` a la altura de `Cargo.toml` para indicar cómo se van a incluir los
|
||||
//! archivos estáticos o cómo se van a compilar los archivos SCSS para el proyecto. Casos de uso:
|
||||
//!
|
||||
//! ## Incluir archivos estáticos desde un directorio
|
||||
//!
|
||||
//! Hay que preparar una carpeta en el proyecto con todos los archivos que se quieren incluir, por
|
||||
//! ejemplo `static`, y añadir el siguiente código en `build.rs` para crear el conjunto de recursos:
|
||||
//!
|
||||
//! ```rust,no_run
|
||||
//! use pagetop_build::StaticFilesBundle;
|
||||
//!
|
||||
//! fn main() -> std::io::Result<()> {
|
||||
//! StaticFilesBundle::from_dir("./static", None)
|
||||
//! .with_name("guides")
|
||||
//! .build()
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! Si es necesario, se puede añadir un filtro para seleccionar archivos específicos de la carpeta,
|
||||
//! por ejemplo:
|
||||
//!
|
||||
//! ```rust,no_run
|
||||
//! use pagetop_build::StaticFilesBundle;
|
||||
//! use std::path::Path;
|
||||
//!
|
||||
//! fn main() -> std::io::Result<()> {
|
||||
//! fn only_pdf_files(path: &Path) -> bool {
|
||||
//! // Selecciona únicamente los archivos con extensión `.pdf`.
|
||||
//! path.extension().map_or(false, |ext| ext == "pdf")
|
||||
//! }
|
||||
//!
|
||||
//! StaticFilesBundle::from_dir("./static", Some(only_pdf_files))
|
||||
//! .with_name("guides")
|
||||
//! .build()
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! ## Compilar archivos SCSS a CSS
|
||||
//!
|
||||
//! Se puede compilar un archivo SCSS, que podría importar otros a su vez, para preparar un recurso
|
||||
//! con el archivo CSS minificado obtenido. Por ejemplo:
|
||||
//!
|
||||
//! ```rust,no_run
|
||||
//! use pagetop_build::StaticFilesBundle;
|
||||
//!
|
||||
//! fn main() -> std::io::Result<()> {
|
||||
//! StaticFilesBundle::from_scss("./styles/main.scss", "styles.min.css")
|
||||
//! .with_name("main_styles")
|
||||
//! .build()
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! Este código compila el archivo `main.scss` de la carpeta `static` del proyecto, y prepara un
|
||||
//! recurso llamado `main_styles` que contiene el archivo `styles.min.css` obtenido.
|
||||
//!
|
||||
//!
|
||||
//! # 📦 Módulos generados
|
||||
//!
|
||||
//! Cada conjunto de recursos [`StaticFilesBundle`] genera un archivo en el directorio estándar
|
||||
//! [OUT_DIR](https://doc.rust-lang.org/cargo/reference/environment-variables.html#environment-variables-cargo-sets-for-build-scripts)
|
||||
//! donde se incluyen los recursos necesarios para compilar el proyecto. Por ejemplo, para
|
||||
//! `with_name("guides")` se crea un archivo llamado `guides.rs`.
|
||||
//!
|
||||
//! No hay ningún problema en generar más de un conjunto de recursos para cada proyecto.
|
||||
//!
|
||||
//! Normalmente no habrá que acceder a estos módulos; bastará con incluirlos en el proyecto con
|
||||
//! [`include_files!`](https://docs.rs/pagetop/latest/pagetop/macro.include_files.html), y luego con
|
||||
//! [`include_files_service!`](https://docs.rs/pagetop/latest/pagetop/macro.include_files_service.html)
|
||||
//! configurar un servicio web para servir los recursos desde la ruta indicada:
|
||||
//!
|
||||
//! ```rust,ignore
|
||||
//! use pagetop::prelude::*;
|
||||
//!
|
||||
//! include_files!(guides);
|
||||
//!
|
||||
//! pub struct MyExtension;
|
||||
//!
|
||||
//! impl Extension for MyExtension {
|
||||
//! // Servicio web que publica los recursos de `guides` en `/ruta/a/guides`.
|
||||
//! fn configure_service(&self, scfg: &mut service::web::ServiceConfig) {
|
||||
//! include_files_service!(scfg, guides => "/ruta/a/guides");
|
||||
//! }
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! También se puede asignar el conjunto de recursos a una variable global; p.ej. `GUIDES`:
|
||||
//!
|
||||
//! ```rust,ignore
|
||||
//! include_files!(GUIDES => guides);
|
||||
//! ```
|
||||
|
||||
#.
|
||||
pub struct StaticFilesBundle {
|
||||
resource_dir: ResourceDir,
|
||||
}
|
||||
|
|
@ -156,19 +163,8 @@ impl StaticFilesBundle {
|
|||
/// .build()
|
||||
/// }
|
||||
/// ```
|
||||
pub fn from_dir<P>(dir: P, filter: Option<fn(&Path) -> bool>) -> Self
|
||||
where
|
||||
P: AsRef<Path>,
|
||||
{
|
||||
let dir_path = dir.as_ref();
|
||||
let dir_str = dir_path.to_str().unwrap_or_else(|| {
|
||||
panic!(
|
||||
"Resource directory path is not valid UTF-8: {}",
|
||||
dir_path.display()
|
||||
);
|
||||
});
|
||||
|
||||
let mut resource_dir = resource_dir(dir_str);
|
||||
pub fn from_dir(dir: impl AsRef<str>, filter: Option<fn(p: &Path) -> bool>) -> Self {
|
||||
let mut resource_dir = resource_dir(dir.as_ref());
|
||||
|
||||
// Aplica el filtro si está definido.
|
||||
if let Some(f) = filter {
|
||||
|
|
|
|||
|
|
@ -8,17 +8,6 @@ Resume la evolución del proyecto para usuarios y colaboradores, destacando nuev
|
|||
correcciones, mejoras durante el desarrollo o cambios en la documentación. Cambios menores o
|
||||
internos pueden omitirse si no afectan al uso del proyecto.
|
||||
|
||||
## 0.1.1 (2025-08-16)
|
||||
|
||||
### Documentado
|
||||
|
||||
- Cambia el formato para la documentación (#4)
|
||||
- Corrige enlaces de licencia en la documentación
|
||||
|
||||
### Otros cambios
|
||||
|
||||
- Afina Cargo.toml para buscar la mejor categoría
|
||||
|
||||
## 0.1.0 (2025-08-06)
|
||||
|
||||
- Versión inicial
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[package]
|
||||
name = "pagetop-macros"
|
||||
version = "0.1.1"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
description = """
|
||||
|
|
|
|||
|
|
@ -11,16 +11,9 @@
|
|||
|
||||
</div>
|
||||
|
||||
## Sobre PageTop
|
||||
## Descripción general
|
||||
|
||||
[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.
|
||||
|
||||
## Créditos
|
||||
|
||||
Esta librería incluye entre sus macros una adaptación de
|
||||
[maud-macros](https://crates.io/crates/maud_macros)
|
||||
Entre sus macros se incluye 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
|
||||
[SmartDefault](https://crates.io/crates/smart_default) (0.7.1) de
|
||||
|
|
@ -28,6 +21,12 @@ Esta librería incluye entre sus macros una adaptación de
|
|||
necesidad de referenciar `maud` o `smart_default` en las dependencias del archivo `Cargo.toml` de
|
||||
cada proyecto `PageTop`.
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
# 🚧 Advertencia
|
||||
|
||||
|
|
|
|||
|
|
@ -1,34 +1,21 @@
|
|||
/*!
|
||||
<div align="center">
|
||||
|
||||
<h1>PageTop Macros</h1>
|
||||
|
||||
<p>Una colección de macros que mejoran la experiencia de desarrollo con <strong>PageTop</strong>.</p>
|
||||
|
||||
[](#-licencia)
|
||||
[](https://docs.rs/pagetop-macros)
|
||||
[](https://crates.io/crates/pagetop-macros)
|
||||
[](https://crates.io/crates/pagetop-macros)
|
||||
|
||||
</div>
|
||||
|
||||
## 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.
|
||||
|
||||
## Créditos
|
||||
|
||||
Esta librería 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
|
||||
[SmartDefault](https://crates.io/crates/smart_default) (0.7.1) de
|
||||
[Jane Doe](https://crates.io/users/jane-doe), llamada `AutoDefault`. Estas macros eliminan la
|
||||
necesidad de referenciar `maud` o `smart_default` en las dependencias del archivo `Cargo.toml` de
|
||||
cada proyecto `PageTop`.
|
||||
*/
|
||||
//! <div align="center">
|
||||
//!
|
||||
//! <h1>PageTop Macros</h1>
|
||||
//!
|
||||
//! <p>Una colección de macros que mejoran la experiencia de desarrollo con <strong>PageTop</strong>.</p>
|
||||
//!
|
||||
//! [](#-licencia)
|
||||
//! [](https://docs.rs/pagetop-macros)
|
||||
//! [](https://crates.io/crates/pagetop-macros)
|
||||
//! [](https://crates.io/crates/pagetop-macros)
|
||||
//!
|
||||
//! </div>
|
||||
//!
|
||||
//! ## 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.
|
||||
|
||||
#![doc(
|
||||
html_favicon_url = "https://git.cillero.es/manuelcillero/pagetop/raw/branch/main/static/favicon.ico"
|
||||
|
|
|
|||
|
|
@ -8,12 +8,6 @@ Resume la evolución del proyecto para usuarios y colaboradores, destacando nuev
|
|||
correcciones, mejoras durante el desarrollo o cambios en la documentación. Cambios menores o
|
||||
internos pueden omitirse si no afectan al uso del proyecto.
|
||||
|
||||
## 0.1.1 (2025-08-16)
|
||||
|
||||
### Documentado
|
||||
|
||||
- Cambia el formato para la documentación (#4)
|
||||
|
||||
## 0.1.0 (2025-08-09)
|
||||
|
||||
### Añadido
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
[package]
|
||||
name = "pagetop-statics"
|
||||
version = "0.1.1"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
|
||||
description = """
|
||||
|
|
|
|||
|
|
@ -8,21 +8,12 @@
|
|||
|
||||
</div>
|
||||
|
||||
## 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
|
||||
|
||||
Esta librería 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.
|
||||
Permite a `PageTop` incluir archivos estáticos en el ejecutable de la aplicación para servirlos de
|
||||
forma eficiente vía web, con detección de cambios que optimiza el tiempo de compilación.
|
||||
|
||||
## Créditos
|
||||
|
||||
Para ello, adapta el código de los *crates* [static-files](https://crates.io/crates/static_files)
|
||||
Para ello, reúne el código de los *crates* [static-files](https://crates.io/crates/static_files)
|
||||
(versión [0.2.5](https://github.com/static-files-rs/static-files/tree/v0.2.5)) y
|
||||
[actix-web-static-files](https://crates.io/crates/actix_web_static_files) (versión
|
||||
[4.0.1](https://github.com/kilork/actix-web-static-files/tree/v4.0.1)), desarrollados ambos por
|
||||
|
|
@ -31,6 +22,12 @@ Para ello, adapta el código de los *crates* [static-files](https://crates.io/cr
|
|||
Estas implementaciones se integran en `PageTop` para evitar que cada proyecto tenga que declarar
|
||||
`static-files` manualmente como dependencia en su `Cargo.toml`.
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
# 🚧 Advertencia
|
||||
|
||||
|
|
|
|||
|
|
@ -1,37 +1,18 @@
|
|||
/*!
|
||||
<div align="center">
|
||||
|
||||
<h1>PageTop Statics</h1>
|
||||
|
||||
<p>Librería para automatizar la recopilación de recursos estáticos en <strong>PageTop</strong>.</p>
|
||||
|
||||
[](#-licencia)
|
||||
|
||||
</div>
|
||||
|
||||
## 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
|
||||
|
||||
Esta librería 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.
|
||||
|
||||
## Créditos
|
||||
|
||||
Para ello, adapta el código de los *crates* [static-files](https://crates.io/crates/static_files)
|
||||
(versión [0.2.5](https://github.com/static-files-rs/static-files/tree/v0.2.5)) y
|
||||
[actix-web-static-files](https://crates.io/crates/actix_web_static_files) (versión
|
||||
[4.0.1](https://github.com/kilork/actix-web-static-files/tree/v4.0.1)), desarrollados ambos por
|
||||
[Alexander Korolev](https://crates.io/users/kilork).
|
||||
|
||||
Estas implementaciones se integran en `PageTop` para evitar que cada proyecto tenga que declarar
|
||||
`static-files` manualmente como dependencia en su `Cargo.toml`.
|
||||
*/
|
||||
//! <div align="center">
|
||||
//!
|
||||
//! <h1>PageTop Statics</h1>
|
||||
//!
|
||||
//! <p>Librería para automatizar la recopilación de recursos estáticos en <strong>PageTop</strong>.</p>
|
||||
//!
|
||||
//! [](#-licencia)
|
||||
//!
|
||||
//! </div>
|
||||
//!
|
||||
//! ## 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.
|
||||
|
||||
#![doc(test(no_crate_inject))]
|
||||
#![doc(
|
||||
|
|
|
|||
|
|
@ -110,13 +110,11 @@
|
|||
//! }
|
||||
//! ```
|
||||
|
||||
use crate::util;
|
||||
|
||||
use config::builder::DefaultState;
|
||||
use config::{Config, ConfigBuilder, File};
|
||||
|
||||
use std::env;
|
||||
use std::path::PathBuf;
|
||||
use std::path::{Path, PathBuf};
|
||||
use std::sync::LazyLock;
|
||||
|
||||
// Nombre del directorio de configuración por defecto.
|
||||
|
|
@ -127,12 +125,25 @@ const DEFAULT_RUN_MODE: &str = "default";
|
|||
|
||||
/// Valores originales cargados desde los archivos de configuración como pares `clave = valor`.
|
||||
pub static CONFIG_VALUES: LazyLock<ConfigBuilder<DefaultState>> = LazyLock::new(|| {
|
||||
// CONFIG_DIR (si existe) o DEFAULT_CONFIG_DIR. Si no se puede resolver, se usa tal cual.
|
||||
let dir = env::var_os("CONFIG_DIR").unwrap_or_else(|| DEFAULT_CONFIG_DIR.into());
|
||||
let config_dir = util::resolve_absolute_dir(&dir).unwrap_or_else(|_| PathBuf::from(&dir));
|
||||
// Determina el directorio de configuración:
|
||||
// - Usa CONFIG_DIR si está definido en el entorno (p.ej.: CONFIG_DIR=/etc/myapp ./myapp).
|
||||
// - Si no, intenta DEFAULT_CONFIG_DIR dentro del proyecto (en CARGO_MANIFEST_DIR).
|
||||
// - Si nada de esto aplica, entonces usa DEFAULT_CONFIG_DIR relativo al ejecutable.
|
||||
let config_dir: PathBuf = if let Ok(env_dir) = env::var("CONFIG_DIR") {
|
||||
env_dir.into()
|
||||
} else if let Ok(manifest_dir) = env::var("CARGO_MANIFEST_DIR") {
|
||||
let manifest_config = Path::new(&manifest_dir).join(DEFAULT_CONFIG_DIR);
|
||||
if manifest_config.exists() {
|
||||
manifest_config
|
||||
} else {
|
||||
DEFAULT_CONFIG_DIR.into()
|
||||
}
|
||||
} else {
|
||||
DEFAULT_CONFIG_DIR.into()
|
||||
};
|
||||
|
||||
// Modo de ejecución según la variable de entorno PAGETOP_RUN_MODE. Si no está definida, se usa
|
||||
// por defecto, DEFAULT_RUN_MODE (p.ej.: PAGETOP_RUN_MODE=production).
|
||||
// Determina el modo de ejecución según la variable de entorno PAGETOP_RUN_MODE. Por defecto usa
|
||||
// DEFAULT_RUN_MODE si no está definida (p.ej.: PAGETOP_RUN_MODE=production ./myapp).
|
||||
let rm = env::var("PAGETOP_RUN_MODE").unwrap_or_else(|_| DEFAULT_RUN_MODE.into());
|
||||
|
||||
Config::builder()
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
use crate::core::action::add_action;
|
||||
use crate::core::extension::ExtensionRef;
|
||||
use crate::core::theme::all::THEMES;
|
||||
use crate::{global, service, static_files_service, trace};
|
||||
use crate::{global, include_files, include_files_service, service, trace};
|
||||
|
||||
use parking_lot::RwLock;
|
||||
|
||||
|
|
@ -125,6 +125,8 @@ pub fn initialize_extensions() {
|
|||
|
||||
// CONFIGURA LOS SERVICIOS *************************************************************************
|
||||
|
||||
include_files!(assets);
|
||||
|
||||
pub fn configure_services(scfg: &mut service::web::ServiceConfig) {
|
||||
// Sólo compila durante el desarrollo, para evitar errores 400 en la traza de eventos.
|
||||
#[cfg(debug_assertions)]
|
||||
|
|
@ -138,5 +140,7 @@ pub fn configure_services(scfg: &mut service::web::ServiceConfig) {
|
|||
extension.configure_service(scfg);
|
||||
}
|
||||
|
||||
static_files_service!(scfg, [&global::SETTINGS.dev.pagetop_static_dir, assets] => "/");
|
||||
include_files_service!(
|
||||
scfg, assets => "/", [&global::SETTINGS.dev.pagetop_project_dir, "static"]
|
||||
);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ include_config!(SETTINGS: Settings => [
|
|||
"app.startup_banner" => "Slant",
|
||||
|
||||
// [dev]
|
||||
"dev.pagetop_static_dir" => "",
|
||||
"dev.pagetop_project_dir" => "",
|
||||
|
||||
// [log]
|
||||
"log.enabled" => true,
|
||||
|
|
@ -68,15 +68,11 @@ pub struct App {
|
|||
#[derive(Debug, Deserialize)]
|
||||
/// Sección `[Dev]` de la configuración. Forma parte de [`Settings`].
|
||||
pub struct Dev {
|
||||
/// Directorio desde el que servir los archivos estáticos de `PageTop`.
|
||||
///
|
||||
/// Por defecto, los archivos se integran en el binario de la aplicación. Si aquí se indica una
|
||||
/// ruta válida, ya sea absoluta o relativa al directorio del proyecto o del binario en
|
||||
/// ejecución, se servirán desde el sistema de ficheros en su lugar. Esto es especialmente útil
|
||||
/// en desarrollo, ya que evita recompilar el proyecto por cambios en estos archivos.
|
||||
///
|
||||
/// Si la cadena está vacía, se ignora este ajuste.
|
||||
pub pagetop_static_dir: String,
|
||||
/// Los archivos estáticos requeridos por `PageTop` se integran por defecto en el binario
|
||||
/// ejecutable. Sin embargo, durante el desarrollo puede resultar útil servirlos desde su propio
|
||||
/// directorio para evitar recompilar cada vez que se modifican. En ese caso, este ajuste debe
|
||||
/// indicar la ruta absoluta al directorio raíz del proyecto.
|
||||
pub pagetop_project_dir: String,
|
||||
}
|
||||
|
||||
#[derive(Debug, Deserialize)]
|
||||
|
|
|
|||
|
|
@ -12,7 +12,8 @@ use crate::AutoDefault;
|
|||
///
|
||||
/// > **Nota**
|
||||
/// > Los archivos de los iconos deben estar disponibles en el servidor web de la aplicación. Pueden
|
||||
/// > servirse usando [`static_files_service!`](crate::static_files_service).
|
||||
/// > incluirse en el proyecto utilizando [`include_files!`](crate::include_files) y servirse con
|
||||
/// > [`include_files_service!`](crate::include_files_service).
|
||||
///
|
||||
/// # Ejemplo
|
||||
///
|
||||
|
|
|
|||
|
|
@ -30,7 +30,8 @@ enum Source {
|
|||
///
|
||||
/// > **Nota**
|
||||
/// > Los archivos de los *scripts* deben estar disponibles en el servidor web de la aplicación.
|
||||
/// > Pueden servirse usando [`static_files_service!`](crate::static_files_service).
|
||||
/// > Pueden incluirse en el proyecto utilizando [`include_files!`](crate::include_files) y servirse
|
||||
/// > con [`include_files_service!`](crate::include_files_service).
|
||||
///
|
||||
/// # Ejemplo
|
||||
///
|
||||
|
|
|
|||
|
|
@ -55,7 +55,8 @@ impl TargetMedia {
|
|||
///
|
||||
/// > **Nota**
|
||||
/// > Las hojas de estilo CSS deben estar disponibles en el servidor web de la aplicación. Pueden
|
||||
/// > servirse usando [`static_files_service!`](crate::static_files_service).
|
||||
/// > incluirse en el proyecto utilizando [`include_files!`](crate::include_files) y servirse con
|
||||
/// > [`include_files_service!`](crate::include_files_service).
|
||||
///
|
||||
/// # Ejemplo
|
||||
///
|
||||
|
|
|
|||
172
src/lib.rs
172
src/lib.rs
|
|
@ -1,89 +1,86 @@
|
|||
/*!
|
||||
<div align="center">
|
||||
|
||||
<img src="https://git.cillero.es/manuelcillero/pagetop/raw/branch/main/static/banner.png" />
|
||||
|
||||
<h1>PageTop</h1>
|
||||
|
||||
<p>Un entorno para el desarrollo de soluciones web modulares, extensibles y configurables.</p>
|
||||
|
||||
[](#-licencia)
|
||||
[](https://docs.rs/pagetop)
|
||||
[](https://crates.io/crates/pagetop)
|
||||
[](https://crates.io/crates/pagetop)
|
||||
|
||||
<br>
|
||||
</div>
|
||||
|
||||
`PageTop` reivindica la esencia de la web clásica usando [Rust](https://www.rust-lang.org/es) para
|
||||
la creación de soluciones web SSR (*renderizadas en el servidor*) basadas en HTML, CSS y JavaScript.
|
||||
Ofrece un conjunto de herramientas que los desarrolladores pueden implementar, extender o adaptar
|
||||
según las necesidades de cada proyecto, incluyendo:
|
||||
|
||||
* **Acciones** (*actions*): alteran la lógica interna de una funcionalidad interceptando su flujo
|
||||
de ejecución.
|
||||
* **Componentes** (*components*): encapsulan HTML, CSS y JavaScript en unidades funcionales,
|
||||
configurables y reutilizables.
|
||||
* **Extensiones** (*extensions*): añaden, extienden o personalizan funcionalidades usando las APIs
|
||||
de `PageTop` o de terceros.
|
||||
* **Temas** (*themes*): son extensiones que permiten modificar la apariencia de páginas y
|
||||
componentes sin comprometer su funcionalidad.
|
||||
|
||||
|
||||
# ⚡️ Guía rápida
|
||||
|
||||
La aplicación más sencilla de `PageTop` se ve así:
|
||||
|
||||
```rust,no_run
|
||||
use pagetop::prelude::*;
|
||||
|
||||
#[pagetop::main]
|
||||
async fn main() -> std::io::Result<()> {
|
||||
Application::new().run()?.await
|
||||
}
|
||||
```
|
||||
|
||||
Este código arranca el servidor de `PageTop`. Con la configuración por defecto, muestra una página
|
||||
de bienvenida accesible desde un navegador local en la dirección `http://localhost:8080`.
|
||||
|
||||
Para personalizar el servicio, se puede crear una extensión de `PageTop` de la siguiente manera:
|
||||
|
||||
```rust,no_run
|
||||
use pagetop::prelude::*;
|
||||
|
||||
struct HelloWorld;
|
||||
|
||||
impl Extension for HelloWorld {
|
||||
fn configure_service(&self, scfg: &mut service::web::ServiceConfig) {
|
||||
scfg.route("/", service::web::get().to(hello_world));
|
||||
}
|
||||
}
|
||||
|
||||
async fn hello_world(request: HttpRequest) -> ResultPage<Markup, ErrorPage> {
|
||||
Page::new(Some(request))
|
||||
.with_component(Html::with(move |_| html! { h1 { "Hello World!" } }))
|
||||
.render()
|
||||
}
|
||||
|
||||
#[pagetop::main]
|
||||
async fn main() -> std::io::Result<()> {
|
||||
Application::prepare(&HelloWorld).run()?.await
|
||||
}
|
||||
```
|
||||
|
||||
Este programa implementa una extensión llamada `HelloWorld` que sirve una página web en la ruta raíz
|
||||
(`/`) mostrando el texto "Hello world!" dentro de un elemento HTML `<h1>`.
|
||||
|
||||
|
||||
# 🧩 Gestión de Dependencias
|
||||
|
||||
Los proyectos que utilizan `PageTop` gestionan las dependencias con `cargo`, como cualquier otro
|
||||
proyecto en Rust.
|
||||
|
||||
Sin embargo, es fundamental que cada extensión declare explícitamente sus
|
||||
[dependencias](core::extension::Extension::dependencies), si las tiene, para que `PageTop` pueda
|
||||
estructurar e inicializar la aplicación de forma modular.
|
||||
*/
|
||||
//! <div align="center">
|
||||
//!
|
||||
//! <img src="https://git.cillero.es/manuelcillero/pagetop/raw/branch/main/static/banner.png" />
|
||||
//!
|
||||
//! <h1>PageTop</h1>
|
||||
//!
|
||||
//! <p>Un entorno de desarrollo para crear soluciones web modulares, extensibles y configurables.</p>
|
||||
//!
|
||||
//! [](#-licencia)
|
||||
//! [](https://docs.rs/pagetop)
|
||||
//! [](https://crates.io/crates/pagetop)
|
||||
//! [](https://crates.io/crates/pagetop)
|
||||
//!
|
||||
//! <br>
|
||||
//! </div>
|
||||
//!
|
||||
//! `PageTop` reivindica la esencia de la web clásica usando [Rust](https://www.rust-lang.org/es)
|
||||
//! para la creación de soluciones web SSR (*renderizadas en el servidor*) basadas en HTML, CSS y
|
||||
//! JavaScript. Ofrece un conjunto de herramientas que los desarrolladores pueden implementar,
|
||||
//! extender o adaptar según las necesidades de cada proyecto, incluyendo:
|
||||
//!
|
||||
//! * **Acciones** (*actions*): alteran la lógica interna de una funcionalidad interceptando su
|
||||
//! flujo de ejecución.
|
||||
//! * **Componentes** (*components*): encapsulan HTML, CSS y JavaScript en unidades funcionales,
|
||||
//! configurables y reutilizables.
|
||||
//! * **Extensiones** (*extensions*): añaden, extienden o personalizan funcionalidades usando las
|
||||
//! APIs de `PageTop` o de terceros.
|
||||
//! * **Temas** (*themes*): son extensiones que permiten modificar la apariencia de páginas y
|
||||
//! componentes sin comprometer su funcionalidad.
|
||||
//!
|
||||
//! # ⚡️ Guía rápida
|
||||
//!
|
||||
//! La aplicación más sencilla de `PageTop` se ve así:
|
||||
//!
|
||||
//! ```rust,no_run
|
||||
//! use pagetop::prelude::*;
|
||||
//!
|
||||
//! #[pagetop::main]
|
||||
//! async fn main() -> std::io::Result<()> {
|
||||
//! Application::new().run()?.await
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! Este código arranca el servidor de `PageTop`. Con la
|
||||
//! [configuración por defecto](crate::global::SETTINGS), muestra una página de bienvenida accesible
|
||||
//! desde un navegador local en la dirección `http://localhost:8080`.
|
||||
//!
|
||||
//! Para personalizar el servicio, se puede crear una extensión de `PageTop` de la siguiente manera:
|
||||
//!
|
||||
//! ```rust,no_run
|
||||
//! use pagetop::prelude::*;
|
||||
//!
|
||||
//! struct HelloWorld;
|
||||
//!
|
||||
//! impl Extension for HelloWorld {
|
||||
//! fn configure_service(&self, scfg: &mut service::web::ServiceConfig) {
|
||||
//! scfg.route("/", service::web::get().to(hello_world));
|
||||
//! }
|
||||
//! }
|
||||
//!
|
||||
//! async fn hello_world(request: HttpRequest) -> ResultPage<Markup, ErrorPage> {
|
||||
//! Page::new(Some(request))
|
||||
//! .with_component(Html::with(move |_| html! { h1 { "Hello world!" } }))
|
||||
//! .render()
|
||||
//! }
|
||||
//!
|
||||
//! #[pagetop::main]
|
||||
//! async fn main() -> std::io::Result<()> {
|
||||
//! Application::prepare(&HelloWorld).run()?.await
|
||||
//! }
|
||||
//! ```
|
||||
//!
|
||||
//! Este programa implementa una extensión llamada `HelloWorld` que sirve una página web en la ruta
|
||||
//! raíz (`/`) mostrando el texto "Hello world!" dentro de un elemento HTML `<h1>`.
|
||||
//!
|
||||
//! # 🧩 Gestión de Dependencias
|
||||
//!
|
||||
//! Los proyectos que utilizan `PageTop` gestionan las dependencias con `cargo`, como cualquier otro
|
||||
//! proyecto en Rust.
|
||||
//!
|
||||
//! Sin embargo, es fundamental que cada extensión declare explícitamente sus
|
||||
//! [dependencias](core::extension::Extension::dependencies), si las tiene, para que `PageTop` pueda
|
||||
//! estructurar e inicializar la aplicación de forma modular.
|
||||
|
||||
#![cfg_attr(docsrs, feature(doc_cfg))]
|
||||
#![doc(
|
||||
|
|
@ -103,8 +100,7 @@ pub use pagetop_macros::{builder_fn, html, main, test, AutoDefault};
|
|||
|
||||
pub use pagetop_statics::{resource, StaticResource};
|
||||
|
||||
/// Contenedor para un conjunto de recursos embebidos.
|
||||
#[derive(AutoDefault)]
|
||||
/// Conjunto de recursos asociados a `$STATIC` en [`include_files!`](crate::include_files).
|
||||
pub struct StaticResources {
|
||||
bundle: HashMap<&'static str, StaticResource>,
|
||||
}
|
||||
|
|
|
|||
|
|
@ -15,8 +15,7 @@ pub use crate::include_config;
|
|||
// crate::locale
|
||||
pub use crate::include_locales;
|
||||
// crate::service
|
||||
#[allow(deprecated)]
|
||||
pub use crate::{include_files, include_files_service, static_files_service};
|
||||
pub use crate::{include_files, include_files_service};
|
||||
// crate::core::action
|
||||
pub use crate::actions_boxed;
|
||||
|
||||
|
|
|
|||
119
src/service.rs
119
src/service.rs
|
|
@ -15,9 +15,6 @@ pub use pagetop_statics::ResourceFiles;
|
|||
#[doc(hidden)]
|
||||
pub use actix_web::test;
|
||||
|
||||
/// **Obsoleto desde la versión 0.3.0**: usar [`static_files_service!`](crate::static_files_service)
|
||||
/// en su lugar.
|
||||
///
|
||||
/// Incluye en código un conjunto de recursos previamente preparado con `build.rs`.
|
||||
///
|
||||
/// # Formas de uso
|
||||
|
|
@ -42,7 +39,6 @@ pub use actix_web::test;
|
|||
///
|
||||
/// include_files!(STATIC_ASSETS => assets);
|
||||
/// ```
|
||||
#[deprecated(since = "0.3.0", note = "Use `static_files_service!` instead")]
|
||||
#[macro_export]
|
||||
macro_rules! include_files {
|
||||
// Forma 1: incluye un conjunto de recursos por nombre.
|
||||
|
|
@ -67,9 +63,6 @@ macro_rules! include_files {
|
|||
};
|
||||
}
|
||||
|
||||
/// **Obsoleto desde la versión 0.3.0**: usar [`static_files_service!`](crate::static_files_service)
|
||||
/// en su lugar.
|
||||
///
|
||||
/// Configura un servicio web para publicar los recursos embebidos con [`include_files!`].
|
||||
///
|
||||
/// El código expandido de la macro decide durante el arranque de la aplicación si debe servir los
|
||||
|
|
@ -111,7 +104,6 @@ macro_rules! include_files {
|
|||
/// // También desde el directorio actual de ejecución.
|
||||
/// include_files_service!(cfg, assets => "/public", ["", "static"]);
|
||||
/// ```
|
||||
#[deprecated(since = "0.3.0", note = "Use `static_files_service!` instead")]
|
||||
#[macro_export]
|
||||
macro_rules! include_files_service {
|
||||
( $scfg:ident, $bundle:ident => $route:expr $(, [$root:expr, $relative:expr])? ) => {{
|
||||
|
|
@ -145,114 +137,3 @@ macro_rules! include_files_service {
|
|||
}
|
||||
}};
|
||||
}
|
||||
|
||||
/// Configura un servicio web para publicar archivos estáticos.
|
||||
///
|
||||
/// La macro ofrece tres modos para configurar el servicio:
|
||||
///
|
||||
/// - **Sistema de ficheros o embebido** (`[$path, $bundle]`): trata de servir los archivos desde
|
||||
/// `$path`; y si es una cadena vacía, no existe o no es un directorio, entonces usará el conjunto
|
||||
/// de recursos `$bundle` integrado en el binario.
|
||||
/// - **Sólo embebido** (`[$bundle]`): sirve siempre desde el conjunto de recursos `$bundle`
|
||||
/// integrado en el binario.
|
||||
/// - **Sólo sistema de ficheros** (`$path`): sin usar corchetes, sirve únicamente desde el sistema
|
||||
/// de ficheros si existe; en otro caso no registra el servicio.
|
||||
///
|
||||
/// # Argumentos
|
||||
///
|
||||
/// * `$scfg` – Instancia de [`ServiceConfig`](crate::service::web::ServiceConfig) donde aplicar la
|
||||
/// configuración.
|
||||
/// * `$path` – Ruta al directorio local con los archivos estáticos.
|
||||
/// * `$bundle` – Nombre del conjunto de recursos que esta macro integra en el binario.
|
||||
/// * `$route` – Ruta URL base desde la que se servirán los archivos.
|
||||
///
|
||||
/// # Ejemplos
|
||||
///
|
||||
/// ```rust,ignore
|
||||
/// use pagetop::prelude::*;
|
||||
///
|
||||
/// pub struct MyExtension;
|
||||
///
|
||||
/// impl Extension for MyExtension {
|
||||
/// fn configure_service(&self, scfg: &mut service::web::ServiceConfig) {
|
||||
/// // Forma 1) Sistema de ficheros o embebido.
|
||||
/// static_files_service!(scfg, ["/var/www/static", assets] => "/public");
|
||||
///
|
||||
/// // Forma 2) Siempre embebido.
|
||||
/// static_files_service!(scfg, [assets] => "/public");
|
||||
///
|
||||
/// // Forma 3) Sólo sistema de ficheros (no requiere `assets`).
|
||||
/// static_files_service!(scfg, "/var/www/static" => "/public");
|
||||
/// }
|
||||
/// }
|
||||
/// ```
|
||||
#[macro_export]
|
||||
macro_rules! static_files_service {
|
||||
// Forma 1: primero intenta servir desde el sistema de ficheros; si falla, sirve embebido.
|
||||
( $scfg:ident, [$path:expr, $bundle:ident] => $route:expr $(,)? ) => {{
|
||||
let span = $crate::trace::debug_span!(
|
||||
"Configuring static files (file system or embedded)",
|
||||
mode = "fs_or_embedded",
|
||||
route = $route,
|
||||
);
|
||||
let _ = span.in_scope(|| {
|
||||
let mut serve_embedded: bool = true;
|
||||
if !::std::path::Path::new(&$path).as_os_str().is_empty() {
|
||||
if let Ok(absolute) = $crate::util::resolve_absolute_dir($path) {
|
||||
$scfg.service($crate::service::ActixFiles::new($route, absolute));
|
||||
serve_embedded = false;
|
||||
}
|
||||
}
|
||||
if serve_embedded {
|
||||
$crate::util::paste! {
|
||||
mod [<static_files_ $bundle>] {
|
||||
include!(concat!(env!("OUT_DIR"), "/", stringify!($bundle), ".rs"));
|
||||
}
|
||||
$scfg.service($crate::service::ResourceFiles::new(
|
||||
$route,
|
||||
[<static_files_ $bundle>]::$bundle(),
|
||||
));
|
||||
}
|
||||
}
|
||||
});
|
||||
}};
|
||||
// Forma 2: sirve siempre embebido.
|
||||
( $scfg:ident, [$bundle:ident] => $route:expr $(,)? ) => {{
|
||||
let span = $crate::trace::debug_span!(
|
||||
"Configuring static files (using embedded only)",
|
||||
mode = "embedded",
|
||||
route = $route,
|
||||
);
|
||||
let _ = span.in_scope(|| {
|
||||
$crate::util::paste! {
|
||||
mod [<static_files_ $bundle>] {
|
||||
include!(concat!(env!("OUT_DIR"), "/", stringify!($bundle), ".rs"));
|
||||
}
|
||||
$scfg.service($crate::service::ResourceFiles::new(
|
||||
$route,
|
||||
[<static_files_ $bundle>]::$bundle(),
|
||||
));
|
||||
}
|
||||
});
|
||||
}};
|
||||
// Forma 3: intenta servir desde el sistema de ficheros.
|
||||
( $scfg:ident, $path:expr => $route:expr $(,)? ) => {{
|
||||
let span = $crate::trace::debug_span!(
|
||||
"Configuring static files (file system only)",
|
||||
mode = "fs",
|
||||
route = $route,
|
||||
);
|
||||
let _ = span.in_scope(|| match $crate::util::resolve_absolute_dir($path) {
|
||||
Ok(absolute) => {
|
||||
$scfg.service($crate::service::ActixFiles::new($route, absolute));
|
||||
}
|
||||
Err(e) => {
|
||||
$crate::trace::warn!(
|
||||
"Static dir not found or invalid for route `{}`: {:?} ({e})",
|
||||
$route,
|
||||
$path,
|
||||
);
|
||||
}
|
||||
});
|
||||
}};
|
||||
}
|
||||
|
|
|
|||
53
src/util.rs
53
src/util.rs
|
|
@ -2,44 +2,35 @@
|
|||
|
||||
use crate::trace;
|
||||
|
||||
use std::env;
|
||||
use std::io;
|
||||
use std::path::{Path, PathBuf};
|
||||
|
||||
// FUNCIONES ÚTILES ********************************************************************************
|
||||
|
||||
/// Resuelve y valida la ruta de un directorio existente, devolviendo una ruta absoluta.
|
||||
/// Devuelve la ruta absoluta a un directorio existente.
|
||||
///
|
||||
/// - Si la ruta es relativa, se resuelve respecto al directorio del proyecto según la variable de
|
||||
/// entorno `CARGO_MANIFEST_DIR` (si existe) o, en su defecto, respecto al directorio actual de
|
||||
/// trabajo.
|
||||
/// - Normaliza y valida la ruta final (resuelve `.`/`..` y enlaces simbólicos).
|
||||
/// - Devuelve error si la ruta no existe o no es un directorio.
|
||||
/// * Si `relative_path` es una ruta absoluta, entonces se ignora `root_path`.
|
||||
/// * Si la ruta final es relativa, se convierte en absoluta respecto al directorio actual.
|
||||
/// * Devuelve error si la ruta no existe o no es un directorio.
|
||||
///
|
||||
/// # Ejemplos
|
||||
/// # Ejemplo
|
||||
///
|
||||
/// ```rust,no_run
|
||||
/// use pagetop::prelude::*;
|
||||
///
|
||||
/// // Ruta relativa, se resuelve respecto a CARGO_MANIFEST_DIR o al directorio actual (`cwd`).
|
||||
/// println!("{:#?}", util::resolve_absolute_dir("documents"));
|
||||
///
|
||||
/// // Ruta absoluta, se normaliza y valida tal cual.
|
||||
/// println!("{:#?}", util::resolve_absolute_dir("/var/www"));
|
||||
/// let root = "/home/user";
|
||||
/// let rel = "documents";
|
||||
/// println!("{:#?}", util::absolute_dir(root, rel));
|
||||
/// ```
|
||||
pub fn resolve_absolute_dir<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
|
||||
let path = path.as_ref();
|
||||
|
||||
let candidate = if path.is_absolute() {
|
||||
path.to_path_buf()
|
||||
} else {
|
||||
// Directorio base CARGO_MANIFEST_DIR si está disponible; o current_dir() en su defecto.
|
||||
env::var_os("CARGO_MANIFEST_DIR")
|
||||
.map(PathBuf::from)
|
||||
.or_else(|| env::current_dir().ok())
|
||||
.unwrap_or_else(|| PathBuf::from("."))
|
||||
.join(path)
|
||||
};
|
||||
pub fn absolute_dir<P, Q>(root_path: P, relative_path: Q) -> io::Result<PathBuf>
|
||||
where
|
||||
P: AsRef<Path>,
|
||||
Q: AsRef<Path>,
|
||||
{
|
||||
// Une ambas rutas:
|
||||
// - Si `relative_path` es absoluta, el `join` la devuelve tal cual, descartando `root_path`.
|
||||
// - Si el resultado es aún relativo, lo será respecto al directorio actual.
|
||||
let candidate = root_path.as_ref().join(relative_path.as_ref());
|
||||
|
||||
// Resuelve `.`/`..`, enlaces simbólicos y obtiene la ruta absoluta en un único paso.
|
||||
let absolute_dir = candidate.canonicalize()?;
|
||||
|
|
@ -56,16 +47,6 @@ pub fn resolve_absolute_dir<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
|
|||
}
|
||||
}
|
||||
|
||||
/// Devuelve la ruta absoluta a un directorio existente.
|
||||
#[deprecated(since = "0.3.0", note = "Use [`resolve_absolute_dir`] instead")]
|
||||
pub fn absolute_dir<P, Q>(root_path: P, relative_path: Q) -> io::Result<PathBuf>
|
||||
where
|
||||
P: AsRef<Path>,
|
||||
Q: AsRef<Path>,
|
||||
{
|
||||
resolve_absolute_dir(root_path.as_ref().join(relative_path.as_ref()))
|
||||
}
|
||||
|
||||
// MACROS ÚTILES ***********************************************************************************
|
||||
|
||||
#[doc(hidden)]
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
use pagetop::prelude::*;
|
||||
|
||||
use std::{env, fs, io};
|
||||
use std::{fs, io};
|
||||
use tempfile::TempDir;
|
||||
|
||||
#[cfg(unix)]
|
||||
|
|
@ -13,36 +13,15 @@ mod unix {
|
|||
|
||||
// /tmp/<rand>/sub
|
||||
let td = TempDir::new()?;
|
||||
let sub = td.path().join("sub");
|
||||
let root = td.path();
|
||||
let sub = root.join("sub");
|
||||
fs::create_dir(&sub)?;
|
||||
|
||||
let abs = util::resolve_absolute_dir(&sub)?;
|
||||
let abs = util::absolute_dir(root, "sub")?;
|
||||
assert_eq!(abs, std::fs::canonicalize(&sub)?);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[pagetop::test]
|
||||
async fn ok_relative_dir_with_manifest() -> io::Result<()> {
|
||||
let _app = service::test::init_service(Application::new().test()).await;
|
||||
|
||||
let td = TempDir::new()?;
|
||||
let sub = td.path().join("sub");
|
||||
fs::create_dir(&sub)?;
|
||||
|
||||
// Fija CARGO_MANIFEST_DIR para que "sub" se resuelva contra td.path()
|
||||
let prev_manifest_dir = env::var_os("CARGO_MANIFEST_DIR");
|
||||
env::set_var("CARGO_MANIFEST_DIR", td.path());
|
||||
let res = util::resolve_absolute_dir("sub");
|
||||
// Restaura entorno.
|
||||
match prev_manifest_dir {
|
||||
Some(v) => env::set_var("CARGO_MANIFEST_DIR", v),
|
||||
None => env::remove_var("CARGO_MANIFEST_DIR"),
|
||||
}
|
||||
|
||||
assert_eq!(res?, std::fs::canonicalize(&sub)?);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[pagetop::test]
|
||||
async fn error_not_a_directory() -> io::Result<()> {
|
||||
let _app = service::test::init_service(Application::new().test()).await;
|
||||
|
|
@ -51,7 +30,7 @@ mod unix {
|
|||
let file = td.path().join("foo.txt");
|
||||
fs::write(&file, b"data")?;
|
||||
|
||||
let err = util::resolve_absolute_dir(&file).unwrap_err();
|
||||
let err = util::absolute_dir(td.path(), "foo.txt").unwrap_err();
|
||||
assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -67,36 +46,15 @@ mod windows {
|
|||
|
||||
// C:\Users\...\Temp\...
|
||||
let td = TempDir::new()?;
|
||||
let sub = td.path().join("sub");
|
||||
let root = td.path();
|
||||
let sub = root.join("sub");
|
||||
fs::create_dir(&sub)?;
|
||||
|
||||
let abs = util::resolve_absolute_dir(&sub)?;
|
||||
let abs = util::absolute_dir(root, sub.as_path())?;
|
||||
assert_eq!(abs, std::fs::canonicalize(&sub)?);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[pagetop::test]
|
||||
async fn ok_relative_dir_with_manifest() -> io::Result<()> {
|
||||
let _app = service::test::init_service(Application::new().test()).await;
|
||||
|
||||
let td = TempDir::new()?;
|
||||
let sub = td.path().join("sub");
|
||||
fs::create_dir(&sub)?;
|
||||
|
||||
// Fija CARGO_MANIFEST_DIR para que "sub" se resuelva contra td.path()
|
||||
let prev_manifest_dir = env::var_os("CARGO_MANIFEST_DIR");
|
||||
env::set_var("CARGO_MANIFEST_DIR", td.path());
|
||||
let res = util::resolve_absolute_dir("sub");
|
||||
// Restaura entorno.
|
||||
match prev_manifest_dir {
|
||||
Some(v) => env::set_var("CARGO_MANIFEST_DIR", v),
|
||||
None => env::remove_var("CARGO_MANIFEST_DIR"),
|
||||
}
|
||||
|
||||
assert_eq!(res?, std::fs::canonicalize(&sub)?);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
#[pagetop::test]
|
||||
async fn error_not_a_directory() -> io::Result<()> {
|
||||
let _app = service::test::init_service(Application::new().test()).await;
|
||||
|
|
@ -105,7 +63,7 @@ mod windows {
|
|||
let file = td.path().join("foo.txt");
|
||||
fs::write(&file, b"data")?;
|
||||
|
||||
let err = util::resolve_absolute_dir(&file).unwrap_err();
|
||||
let err = util::absolute_dir(td.path(), "foo.txt").unwrap_err();
|
||||
assert_eq!(err.kind(), io::ErrorKind::InvalidInput);
|
||||
Ok(())
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue