Merge branch 'loco-rs:master' into feat/update-user-data-endpoint

Author: floscodes

Cargo.toml

@@ -13,7 +13,6 @@ version = "0.16.3"
 description = "The one-person framework for Rust"
 homepage = "https://loco.rs/"
 documentation = "https://docs.rs/loco-rs"
-authors = ["Dotan Nahum <dotan@rng0.io>", "Elad Kaplan <kaplan.elad@gmail.com>"]
 repository = "https://github.com/loco-rs/loco"
 license.workspace = true
 edition.workspace = true

README-pt_BR.md

@@ -16,7 +16,7 @@
 
  </div>
 
-[English](./README.md) · [中文](./README-zh_CN.md) · [Français](./README.fr.md) · Portuguese (Brazil) ・ [日本語](./README.ja.md) · [한국어](./README.ko.md) · [Русский](./README.ru.md)
+[English](./README.md) · [中文](./README-zh_CN.md) · [Français](./README.fr.md) · Portuguese (Brazil) ・ [日本語](./README.ja.md) · [한국어](./README.ko.md) · [Русский](./README.ru.md) · [Español](./README.es.md)
 
 
 ## O que é o Loco?

README-zh_CN.md

@@ -11,7 +11,7 @@
 
  </div>
 
-[English](./README.md) · 中文 · [Français](./README.fr.md) · [Portuguese (Brazil)](./README-pt_BR.md) ・ [日本語](./README.ja.md) · [한국어](./README.ko.md) · [Русский](./README.ru.md)
+[English](./README.md) · 中文 · [Français](./README.fr.md) · [Portuguese (Brazil)](./README-pt_BR.md) ・ [日本語](./README.ja.md) · [한국어](./README.ko.md) · [Русский](./README.ru.md) · [Español](./README.es.md)
 
 Loco 是一个用 Rust 编写的 Web 框架，类似于 Rails。Loco 提供快速构建 Web 应用的功能，并且允许创建自定义任务，可以通过 CLI 运行。
 

README.es.md

@@ -0,0 +1,117 @@
+<div align="center">
+
+   <img src="https://github.com/loco-rs/loco/assets/83390/992d215a-3cd3-42ee-a1c7-de9fd25a5bac"/>
+
+   <h1>Bienvenido a Loco</h1>
+
+   <h3>
+   <!-- <snip id="description" inject_from="yaml"> -->
+🚂 Loco es Rust on Rails.
+<!--</snip> -->
+   </h3>
+
+   [![crate](https://img.shields.io/crates/v/loco-rs.svg)](https://crates.io/crates/loco-rs)
+   [![docs](https://docs.rs/loco-rs/badge.svg)](https://docs.rs/loco-rs)
+   [![Discord channel](https://img.shields.io/badge/discord-Join-us)](https://discord.gg/fTvyBzwKS8)
+
+ </div>
+
+Español · [English](./README.md) · [中文](./README-zh_CN.md) · [Français](./README.fr.md) · [Português (Brasil)](./README-pt_BR.md) · [日本語](./README.ja.md) · [한국어](./README.ko.md) · [Русский](./README.ru.md) · Español
+
+## ¿Qué es Loco?
+
+`Loco` está fuertemente inspirado en Rails. Si conoces Rails y Rust, te sentirás como en casa. Si solo conoces Rails y eres nuevo en Rust, encontrarás Loco refrescante. No asumimos que conozcas Rails.
+
+Para una explicación más profunda de cómo funciona Loco, incluyendo guías detalladas, ejemplos y referencias de la API, consulta nuestro [sitio de documentación](https://loco.rs).
+
+## Características de Loco
+
+* `Convención sobre configuración:` Al igual que Ruby on Rails, Loco enfatiza la simplicidad y la productividad al reducir la necesidad de código repetitivo. Utiliza valores predeterminados sensatos, permitiendo a los desarrolladores centrarse en la lógica de negocio en lugar de perder tiempo en la configuración.
+
+* `Desarrollo rápido:` Loco está diseñado para una alta productividad del desarrollador, reduciendo el código repetitivo y proporcionando APIs intuitivas, permitiendo iterar rápidamente y construir prototipos con un esfuerzo mínimo.
+
+* `Integración ORM:` Modela tu negocio con entidades robustas, eliminando la necesidad de escribir SQL. Define relaciones, validaciones y lógica personalizada directamente en tus entidades para una mayor mantenibilidad y escalabilidad.
+
+* `Controladores:` Maneja parámetros de solicitudes web, cuerpo, validación y renderiza una respuesta consciente del contenido. Usamos Axum para el mejor rendimiento, simplicidad y extensibilidad. Los controladores también permiten construir middlewares fácilmente, que pueden usarse para agregar lógica como autenticación, registro o manejo de errores antes de pasar las solicitudes a las acciones principales del controlador.
+
+* `Vistas:` Loco puede integrarse con motores de plantillas para generar contenido HTML dinámico a partir de plantillas.
+
+* `Trabajos en segundo plano:` Realiza trabajos intensivos en computación o I/O en segundo plano con una cola respaldada por Redis o con hilos. Implementar un worker es tan simple como implementar una función perform para el trait Worker.
+
+* `Planificador:` Simplifica el tradicional y a menudo engorroso sistema crontab, facilitando y haciendo más elegante la programación de tareas o scripts de shell.
+
+* `Mailers:` Un mailer enviará correos electrónicos en segundo plano usando la infraestructura de background worker de Loco. Todo será transparente para ti.
+
+* `Almacenamiento:` En Loco Storage, facilitamos el trabajo con archivos a través de múltiples operaciones. El almacenamiento puede ser en memoria, en disco o usar servicios en la nube como AWS S3, GCP y Azure.
+
+* `Caché:` Loco proporciona una capa de caché para mejorar el rendimiento de la aplicación almacenando datos de acceso frecuente.
+
+Para ver más características de Loco, consulta nuestro [sitio de documentación](https://loco.rs/docs/getting-started/tour/).
+
+## Primeros pasos
+<!-- <snip id="quick-installation-command" inject_from="yaml" template="sh"> -->
+```sh
+cargo install loco
+cargo install sea-orm-cli # Solo si necesitas base de datos
+```
+<!-- </snip> -->
+
+Ahora puedes crear tu nueva app (elige "`SaaS` app").
+
+<!-- <snip id="loco-cli-new-from-template" inject_from="yaml" template="sh"> -->
+```sh
+❯ loco new
+✔ ❯ ¿Nombre de la app? · miapp
+✔ ❯ ¿Qué te gustaría construir? · App SaaS con renderizado del lado del cliente
+✔ ❯ Selecciona un proveedor de BD · Sqlite
+✔ ❯ Selecciona el tipo de worker en segundo plano · Async (tareas async in-process con tokio)
+
+🚂 App Loco generada exitosamente en:
+miapp/
+
+- assets: Has seleccionado `clientside` para la configuración de tu servidor de assets.
+
+Siguiente paso, construye tu frontend:
+  $ cd frontend/
+  $ npm install && npm run build
+```
+<!-- </snip> -->
+
+Ahora entra en tu `miapp` y arranca tu app:
+<!-- <snip id="starting-the-server-command-with-output" inject_from="yaml" template="sh"> -->
+```sh
+$ cargo loco start
+
+                      ▄     ▀
+                                ▀  ▄
+                  ▄       ▀     ▄  ▄ ▄▀
+                                    ▄ ▀▄▄
+                        ▄     ▀    ▀  ▀▄▀█▄
+                                          ▀█▄
+▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄   ▄▄▄▄▄▄▄▄▄▄▄ ▄▄▄▄▄▄▄▄▄ ▀▀█
+██████  █████   ███ █████   ███ █████   ███ ▀█
+██████  █████   ███ █████   ▀▀▀ █████   ███ ▄█▄
+██████  █████   ███ █████       █████   ███ ████▄
+██████  █████   ███ █████   ▄▄▄ █████   ███ █████
+██████  █████   ███  ████   ███ █████   ███ ████▀
+  ▀▀▀██▄ ▀▀▀▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀▀▀▀  ▀▀▀▀▀▀▀▀▀▀ ██▀
+      ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀
+                https://loco.rs
+
+listening on port 5150
+```
+<!-- </snip> -->
+
+## Proyectos impulsados por Loco
+
+* [SpectralOps](https://spectralops.io) - varios servicios impulsados por el framework Loco
+
+* [Nativish](https://nativi.sh) - backend de la app impulsado por el framework Loco
+
+## Contribuidores ✨
+
+Gracias a estas personas maravillosas:
+
+<a href="https://github.com/loco-rs/loco/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=loco-rs/loco" />
+</a>

README.fr.md

@@ -5,7 +5,7 @@
    <h1>Loco vous souhaite la bienvenue</h1>
 
    <h3>
-🚂 Loco c'est Rust on Rails. 
+🚂 Loco c'est Rust on Rails.
    </h3>
 
    [![crate](https://img.shields.io/crates/v/loco-rs.svg)](https://crates.io/crates/loco-rs)
@@ -14,7 +14,7 @@
 
  </div>
 
-[English](./README.md) · [中文](./README-zh_CN.md) · Français · [Portuguese (Brazil)](./README-pt_BR.md) ・ [日本語](./README.ja.md) · [한국어](./README.ko.md) · [Русский](./README.ru.md)
+[English](./README.md) · [中文](./README-zh_CN.md) · Français · [Portuguese (Brazil)](./README-pt_BR.md) ・ [日本語](./README.ja.md) · [한국어](./README.ko.md) · [Русский](./README.ru.md) · [Español](./README.es.md)
 
 ## À propos de Loco
 `Loco` est fortement inspiré de Rails. Si vous connaissez Rails et Rust, vous vous sentirez chez vous. Si vous ne connaissez que Rails et que vous êtes nouveau sur Rust, vous trouverez Loco rafraîchissant. Nous ne supposons pas que vous connaissez Rails.

README.ko.md

@@ -14,7 +14,7 @@
 
  </div>
 
-[English](./README.md) · [中文](./README-zh_CN.md) · [Français](./README.fr.md) · [Portuguese (Brazil)](./README-pt_BR.md) ・ [日本語](./README.ja.md) · 한국어 · [Русский](./README.ru.md)
+[English](./README.md) · [中文](./README-zh_CN.md) · [Français](./README.fr.md) · [Portuguese (Brazil)](./README-pt_BR.md) ・ [日本語](./README.ja.md) · 한국어 · [Русский](./README.ru.md) · [Español](./README.es.md)
 
 
 ## Loco란?

README.md

@@ -17,7 +17,7 @@
  </div>
 
 
-English · [中文](./README-zh_CN.md) · [Français](./README.fr.md) · [Portuguese (Brazil)](./README-pt_BR.md) ・ [日本語](./README.ja.md) · [한국어](./README.ko.md) · [Русский](./README.ru.md)
+English · [中文](./README-zh_CN.md) · [Français](./README.fr.md) · [Portuguese (Brazil)](./README-pt_BR.md) ・ [日本語](./README.ja.md) · [한국어](./README.ko.md) · [Русский](./README.ru.md) · [Español](./README.es.md)
 
 
 ## What's Loco?

README.ru.md

@@ -16,7 +16,7 @@
 
  </div>
 
-[English](./README.md) · [中文](./README-zh_CN.md) · [Français](./README.fr.md) · [Portuguese (Brazil)](./README-pt_BR.md) ・ [日本語](./README.ja.md) · Русский
+[English](./README.md) · [中文](./README-zh_CN.md) · [Français](./README.fr.md) · [Portuguese (Brazil)](./README-pt_BR.md) ・ [日本語](./README.ja.md) · Русский · [Español](./README.es.md)
 
 
 ## Что такое Loco?

docs-site/content/docs/getting-started/starters.md

@@ -45,6 +45,34 @@ Next step, build your frontend:
 
 ## Available Starters
 
+### Command Line Options
+
+Print the command line options:
+
+```console
+$ loco new --help
+Create a new Loco app
+
+Usage: loco[EXE] new [OPTIONS]
+
+Options:
+  -p, --path <PATH>          Local path to generate into [default: .]
+  -v, --verbose <VERBOSE>    Verbosity level [default: ERROR]
+  -n, --name <NAME>          App name
+  -t, --template <TEMPLATE>  Starter template
+      --db <DB>              DB Provider [possible values: sqlite, postgres]
+      --bg <BG>              Background worker configuration [possible values: async, queue, blocking]
+      --assets <ASSETS>      Assets serving configuration [possible values: serverside, clientside]
+  -h, --help                 Print help
+  -V, --version              Print version
+```
+
+Example starter with a SQLite database, async background worker, and server side assets:
+
+```sh
+loco new --db sqlite --bg async --assets serverside
+```
+
 ### SaaS Starter
 
 The SaaS starter is an all-included set up for projects requiring both a UI and a REST API. For the UI this starter supports a client-side app or classic server-side templates (or a combination).

docs-site/content/docs/the-app/controller.md

@@ -571,7 +571,7 @@ async fn current(
 }
 ```
 
-Additionally, you can fetch the current user by replacing auth::JWT with `auth::ApiToken<users::Model>`.
+Additionally, you can fetch the current user by replacing auth::JWT with `auth::JWTWithUser<users::Model>`.
 
 #### API Key
 
@@ -1243,6 +1243,94 @@ impl PaginationResponse {
 }
 ```
 
+## Custom Extractors
+
+When it is necessary to validate request information contained in the request header, a custom extractor can be implemented for this purpose. For example, in a multi-tenant application that includes the current tenant identifier in the headers, the extractor should retrieve the value, verify its validity in the database, and ensure that the user is authorized to access it. To implement a custom extractor, it is required to implement one of the following traits: FromRequest or FromRequestParts.
+
+```rust
+use axum::{
+    extract::FromRequestParts,
+    extract::FromRef,
+    http::{request::Parts, StatusCode},
+};
+use loco_rs::prelude::*;
+use sea_orm::{EntityTrait, DatabaseConnection};
+
+use loco_rs::app::AppContext;
+use crate::models::_entities::companies; // Adjust to your strucuture
+
+#[derive(Debug, Clone)]
+pub struct CompanyContext(pub i32, pub String);
+
+impl<S> FromRequestParts<S> for CompanyContext
+where
+    AppContext: FromRef<S>,
+    S: Send + Sync,
+{
+    type Rejection = (StatusCode, String);
+
+    async fn from_request_parts(
+        parts: &mut Parts,
+        state: &S
+    ) -> Result<Self, Self::Rejection> {
+
+        // 1. get header
+        let nickname = parts.headers
+            .get("x-my-company")
+            .and_then(|h| h.to_str().ok())
+            .ok_or((
+                StatusCode::BAD_REQUEST,
+                "Missing X-MY-COMPANY".to_string(),
+            ))?
+            .to_string();
+
+        let ctx = AppContext::from_ref(state);
+        let db: &DatabaseConnection = &ctx.db;
+
+        // 3. Search tenant on database
+        let company = companies::Entity::find()
+            .filter(companies::Column::Uuid.eq(nickname.clone()))
+            .one(db)
+            .await
+            .map_err(|e| {
+                (
+                    StatusCode::INTERNAL_SERVER_ERROR,
+                    format!("DB error: {}", e),
+                )
+            })?
+            .ok_or((
+                StatusCode::NOT_FOUND,
+                "Company not found".to_string(),
+            ))?;
+
+        Ok(CompanyContext(company.id, nickname))
+    }
+}
+
+```
+
+After that just added to your action. 
+
+```rust
+#[debug_handler]
+pub async fn add(
+    CompanyContext(company_id, nickname): CompanyContext,
+    State(ctx): State<AppContext>,
+    Json(params): Json<Params>,
+) -> Result<Response> {
+
+    // Action logic ... 
+
+
+    format::json({ message: "added!" })
+}
+```
+
+<div class="infobox">
+More information about extractors can be found in the <a href="https://docs.rs/axum/latest/axum/extract/index.html#the-order-of-extractors">axum documentation</a>.
+</div>
+
+
 # Testing
 
 When testing controllers, the goal is to call the router's controller endpoint and verify the HTTP response, including the status code, response content, headers, and more.