Rename app/services to app/persistence (#13)

kigawas · Aug 6, 2024 · 6ec02fd · 6ec02fd
1 parent 035d501
commit 6ec02fd
Show file tree

Hide file tree

Showing 11 changed files with 79 additions and 86 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -16,7 +16,7 @@ members = ["api", "app", "doc", "models", "migration", "utils"]
 [workspace.dependencies]
 axum = { version = "0.7.5", default-features = false }
 tower = { version = "0.4.13", default-features = false }
-sea-orm = { version = "1.0.0-rc.7", default-features = false }
+sea-orm = { version = "1.0.0", default-features = false }
 serde = { version = "1", features = ["derive"] }
 serde_json = { version = "1", default-features = false }
 tracing = "0.1.40"

diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Refer to [this post](https://kigawas.me/posts/rustacean-clean-architecture-appro
 
 - [Axum](https://github.com/tokio-rs/axum) framework
 - [SeaORM](https://github.com/SeaQL/sea-orm) domain models
-- Completely separated API routers and DB-related logic (named "services")
+- Completely separated API routers and DB-related logic (named "persistence" layer)
 - Completely separated input parameters, queries and output schemas
 - OpenAPI documentation ([Swagger UI](https://clean-axum.shuttleapp.rs/docs) and [Scalar](https://clean-axum.shuttleapp.rs/scalar)) powered by [Utoipa](https://github.com/juhaku/utoipa)
 - Error handling with [Anyhow](https://github.com/dtolnay/anyhow)
@@ -41,7 +41,7 @@ Main concept: Web framework is replaceable.
 
 All modules here should not include any specific API web framework logic.
 
-- `app::services`: DB manipulation (CRUD) functions
+- `app::persistence`: DB manipulation (CRUD) functions
 - `app::config`: DB or API server configuration
 - `app::state`: APP state, e.g. DB connection
 - `app::error`: APP errors used by `api::error`. e.g. "User not found"
@@ -61,7 +61,7 @@ Except `models::domains` and `migration`, all modules are ORM library agnostic.
 ### Unit and integration tests
 
 - `tests::api`: API integration tests. Hierarchy is the same as `api::routers`
-- `tests::app`: DB/ORM-related unit tests. Hierarchy is the same as `app::services`
+- `tests::app::persistence`: DB/ORM-related unit tests. Hierarchy is the same as `app::persistence`
 
 ### Others
 

diff --git a/api/src/routers/user.rs b/api/src/routers/user.rs
@@ -8,7 +8,7 @@ use axum::{
 use sea_orm::TryIntoModel;
 
 use app::error::UserError;
-use app::services::user::{create_user, get_user, search_users};
+use app::persistence::user::{create_user, get_user, search_users};
 use app::state::AppState;
 use models::params::user::CreateUserParams;
 use models::queries::user::UserQuery;

diff --git a/app/src/lib.rs b/app/src/lib.rs
@@ -1,4 +1,4 @@
 pub mod config;
 pub mod error;
-pub mod services;
+pub mod persistence;
 pub mod state;
diff --git a/app/src/services/mod.rs → app/src/persistence/mod.rs b/app/src/services/mod.rs → app/src/persistence/mod.rs
diff --git a/app/src/services/user.rs → app/src/persistence/user.rs b/app/src/services/user.rs → app/src/persistence/user.rs
diff --git a/migration/Cargo.toml b/migration/Cargo.toml
@@ -12,4 +12,4 @@ path = "src/lib.rs"
 models = { path = "../models" }
 
 async-std = { version = "1", features = ["attributes", "tokio1"] }
-sea-orm-migration = { version = "1.0.0-rc.7" }
+sea-orm-migration = { version = "1.0.0" }