Merge pull request #17 from MrRevillod/refactor/di-provider-impl

refactor: 🔥 change the way to declare `providers` and improve the di examples

Author: MrRevillod

Cargo.lock

@@ -6,4 +6,3 @@ edition = "2021"
 [dependencies]
 sword = { workspace = true }
 serde = { workspace = true }
-serde_json = { workspace = true }

examples/config-file/Cargo.toml

@@ -0,0 +1,4 @@
+POSTGRES_USER=user
+POSTGRES_PASSWORD=password
+POSTGRES_DB=postgres_db
+POSTGRES_DATABASE_URL="postgres://user:password@localhost:5432/postgres_db"

examples/dependency-injection/.env

@@ -10,5 +10,5 @@ path = "src/main.rs"
 [dependencies]
 sword = { workspace = true }
 serde = { workspace = true }
-serde_json = { workspace = true }
-tokio = { workspace = true }
+sqlx = { version = "0.8.6", features = ["postgres", "runtime-tokio"] }
+dotenv = "0.15.0"

examples/dependency-injection/Cargo.toml

@@ -0,0 +1,39 @@
+
+# Dependency injection example with SQLx
+
+To run this example, make sure you have Docker installed and running on your machine.
+
+## Setup
+
+1. Clone the Sword repository if you haven't already:
+
+   ```bash
+    git clone https://github.com/sword-web/sword.git
+    cd sword/examples/dependency-injection
+    ```
+
+2. Run the PostgreSQL database using Docker Compose:
+
+   ```bash
+   docker-compose up -d
+   ```
+
+3. Run the Sword application:
+
+   ```bash
+   cargo run
+   ```
+
+## Endpoints
+
+### List tasks
+
+```bash
+curl http://localhost:8080/tasks
+```
+
+### Create a new task (with default values)
+
+```bash
+curl -X POST http://localhost:8080/tasks
+```

examples/dependency-injection/README.md

@@ -0,0 +1,20 @@
+version: '3.8'
+
+services:
+  postgres:
+    image: postgres:15
+    env_file:
+      - "./.env"
+    container_name: sword_postgres_example
+    restart: unless-stopped
+    environment:
+      POSTGRES_USER: ${POSTGRES_USER}
+      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
+      POSTGRES_DB: ${POSTGRES_DB}
+    ports:
+      - "5432:5432"
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+
+volumes:
+  postgres_data:

examples/dependency-injection/compose.yaml

@@ -4,7 +4,8 @@ port = 8080
 body_limit = "10MB"
 request_timeout_seconds = 15
 graceful_shutdown = false
-name = "MySwordApp"
+name = "Dependency Injection Example"
 
 [db-config]
-collection_name = "tasks"
+uri = "${POSTGRES_DATABASE_URL}"
+migrations_path = "config/migrations"

examples/dependency-injection/config/config.toml

@@ -0,0 +1,6 @@
+-- Add migration script here
+
+CREATE TABLE tasks(
+    id INT PRIMARY KEY,
+    title TEXT NOT NULL
+)

examples/dependency-injection/config/migrations/20251024204317_tasks.sql

@@ -1,43 +1,42 @@
-use std::{collections::HashMap, sync::Arc};
+use std::{path::Path, sync::Arc};
 
 use serde::Deserialize;
-use serde_json::Value;
+use sqlx::{migrate::Migrator, PgPool};
 use sword::prelude::*;
-use tokio::sync::RwLock;
-
-pub type Store = Arc<RwLock<HashMap<String, Vec<Value>>>>;
 
 #[derive(Clone, Deserialize)]
 #[config(key = "db-config")]
 pub struct DatabaseConfig {
-    collection_name: String,
+    uri: String,
+    migrations_path: String,
 }
 
-#[injectable(kind = "provider")]
+#[injectable(provider)]
 pub struct Database {
-    db: Store,
+    pool: Arc<PgPool>,
 }
 
 impl Database {
     pub async fn new(db_conf: DatabaseConfig) -> Self {
-        let db = Arc::new(RwLock::new(HashMap::new()));
-
-        db.write().await.insert(db_conf.collection_name, Vec::new());
+        let pool = PgPool::connect(&db_conf.uri)
+            .await
+            .expect("Failed to create Postgres connection pool");
 
-        Self { db }
-    }
+        let migrator = Migrator::new(Path::new(&db_conf.migrations_path))
+            .await
+            .unwrap();
 
-    pub async fn insert(&self, table: &'static str, record: Value) {
-        let mut db = self.db.write().await;
+        migrator
+            .run(&pool)
+            .await
+            .expect("Failed to run database migrations");
 
-        if let Some(table_data) = db.get_mut(table) {
-            table_data.push(record);
+        Self {
+            pool: Arc::new(pool),
         }
     }
 
-    pub async fn get_all(&self, table: &'static str) -> Option<Vec<Value>> {
-        let db = self.db.read().await;
-
-        db.get(table).cloned()
+    pub fn get_pool(&self) -> &PgPool {
+        &self.pool
     }
 }

examples/dependency-injection/src/database.rs

@@ -1,24 +1,23 @@
 mod database;
 mod middleware;
 mod repository;
-mod service;
 
 use std::sync::Arc;
 
+use dotenv::dotenv;
 pub use middleware::MyMiddleware;
 pub use repository::TaskRepository;
 
-use serde_json::json;
 use sword::{core::DependencyContainer, prelude::*};
 
 use crate::{
     database::{Database, DatabaseConfig},
-    service::TasksService,
+    repository::Task,
 };
 
-#[controller("/tasks", version = "v1")]
+#[controller("/tasks")]
 struct TasksController {
-    tasks: Arc<TasksService>,
+    tasks: Arc<TaskRepository>,
 }
 
 #[routes]
@@ -33,12 +32,13 @@ impl TasksController {
 
     #[post("/")]
     async fn create_task(&self) -> HttpResponse {
-        let total_task = self.tasks.find_all().await.len();
+        let tasks = self.tasks.find_all().await;
+        let total_count = tasks.len() as i32 + 1;
 
-        let task = json!({
-            "id": total_task + 1,
-            "title": format!("Task {}", total_task + 1),
-        });
+        let task = Task {
+            id: total_count,
+            title: format!("Task {total_count}"),
+        };
 
         self.tasks.create(task.clone()).await;
 
@@ -48,6 +48,8 @@ impl TasksController {
 
 #[sword::main]
 async fn main() {
+    dotenv().ok();
+
     let app = Application::builder();
     let db_config = app.config::<DatabaseConfig>().unwrap();
 
@@ -56,7 +58,6 @@ async fn main() {
     let container = DependencyContainer::builder()
         .register_provider(db)
         .register_component::<TaskRepository>()
-        .register_component::<TasksService>()
         .build();
 
     let app = app