From 318f741d9661274f98ca8808730ac9222dc7b5a0 Mon Sep 17 00:00:00 2001
From: Julian PEREZ-RAMIREZ <julian.perez-ramirez@imt-atlantique.net>
Date: Fri, 28 Feb 2025 23:06:55 +0100
Subject: [PATCH] adding mermaid code of diagrams
---
conception/class_diagram.mermaid | 230 +++++++++++++++++++++++++++++++
conception/db_scheme.mermaid | 69 ++++++++++
2 files changed, 299 insertions(+)
create mode 100644 conception/class_diagram.mermaid
create mode 100644 conception/db_scheme.mermaid
diff --git a/conception/class_diagram.mermaid b/conception/class_diagram.mermaid
new file mode 100644
index 0000000..820b687
--- /dev/null
+++ b/conception/class_diagram.mermaid
@@ -0,0 +1,230 @@
+<div class="mermaid">
+ classDiagram
+ %% ===== Website Class =====
+ class Website {
+ -users: List<IUser>
+ -wishLists: List<IWishList>
+ -items: List<IItem>
+ -purchases: List<IPurchase>
+ }
+ %% ===== INTERFACES (Contract Between Teams) =====
+ class IUser {
+ +createUser(req:Request)
+ +getAllUsers()
+ +getUserById(user_id:int)
+ +updateUser(user_id:int, req:Request)
+ +deleteUser(user_id:int)
+ +authenticateUser(username:string, password:string)
+ +changePassword(user_id:int, old_password:string, new_password:string)
+ }
+
+ class IWishList {
+ +createWishList(req:Request)
+ +getAllWishList()
+ +getWishListById(wishList_id:int)
+ +updateWishList(wishList_id:int, req:Request)
+ +deleteWishList(wishList_id:int)
+ +toggleIsActive(wishList_id:int)
+ +getUrl(wishList_id:int, mode:AccessMode)
+ +add_member(wishList_id: int, user_id: int, can_edit: bool)
+ +remove_member(wishList_id: int, user_id: int)
+ +update_member_permission(wishList_id: int, user_id: int, can_edit: bool)
+ +addItemToList(wishList_id:int, req:Request)
+ +removeItemFromList(wishList_id:int, req:Request)
+ }
+
+ class IItem {
+ +createItem(req:Request)
+ +getItemById(item_id: int)
+ +getAllItems(wishlist_id: int)
+ +update_item(item_id: int, req:Request)
+ +toggleIsBought(item_id: int)
+ +uploadProof(purchase_url: string)
+ }
+
+ class IPurchase {
+ +createPurchase(req: Request)
+ +getPurchaseById(purchase_id: int)
+ +getAllPurchases()
+ +updatePurchase(purchase_id:int, req: Request)
+ +deletePurchase(purchase_id: int)
+ }
+
+ %% ===== Enums used in MODEL LAYER =====
+ class UserRole {
+ +ADMIN
+ +USER
+ }
+
+ class AccessMode {
+ +VIEWER
+ +EDITOR
+ }
+
+ %% ===== MODEL LAYER =====
+ class User {
+ -username: string
+ -name: string
+ -username: string
+ -email: string
+ -password_hash: string
+ -is_blocked: bool
+ -role:UserRole
+ -created_at: datetime
+ }
+
+ class WishList {
+ -user: User
+ -name: string
+ -description: string
+ -items: Collection
+ -expiration_date: datetime
+ -is_active: boolean
+ -url_view_mode: string
+ -url_edit_mode: string
+ -created_at: datetime
+ }
+
+ class WishListMember {
+ -wishlist: WishList
+ -user: User
+ -can_edit: boolean
+ -is_accepted: boolean
+ }
+
+ class Item {
+ -title: string
+ -description: string
+ -price: float
+ -purchase_url: string
+ -is_bought: boolean
+ -created_at: datetime
+ }
+
+ class Purchase {
+ -user: User
+ -wishList: WishList
+ -item_id: int
+ -url_proof: string
+ -message: string
+ -created_at: datetime
+ }
+
+ %% ===== CONTROLLER LAYER =====
+ class UserController {
+ +createUser(req:Request)
+ +getAllUsers()
+ +getUserById(user_id:int)
+ +updateUser(user_id:int, req:Request)
+ +deleteUser(user_id:int)
+ +authenticateUser(username:string, password:string)
+ +changePassword(user_id:int, old_password:string, new_password:string)
+ }
+
+ class WishListController {
+ +createWishList(req:Request)
+ +getAllWishList()
+ +getWishListById(wishList_id:int)
+ +updateWishList(wishList_id:int, req:Request)
+ +deleteWishList(wishList_id:int)
+ +toggleIsActive(wishList_id:int)
+ +getUrl(wishList_id:int, mode:AccessMode)
+ +add_member(wishList_id: int, user_id: int, can_edit: bool)
+ +remove_member(wishList_id: int, user_id: int)
+ +update_member_permission(wishList_id: int, user_id: int, can_edit: bool)
+ +addItemToList(wishList_id:int, req:Request)
+ +removeItemFromList(wishList_id:int, req:Request)
+ }
+
+ class ItemController {
+ +createItem(req:Request)
+ +getItemById(item_id: int)
+ +getAllItems(wishlist_id: int)
+ +update_item(item_id: int, req:Request)
+ +toggleIsBought(item_id: int)
+ +uploadProof(purchase_url: string)
+ }
+
+ class PurchaseController {
+ +createPurchase(req: Request)
+ +getPurchaseById(purchase_id: int)
+ +getAllPurchases()
+ +updatePurchase(purchase_id:int, req: Request)
+ +deletePurchase(purchase_id: int)
+
+ }
+
+ %% ===== VIEW LAYER =====
+ %% class UserView {
+ %% +display_user_details(user: User)
+ %% +display_user_list(users: List[User])
+ %% +show_login_form()
+ %% +show_registration_form()
+ %% +show_edit_user_form(user: User)
+ %% +show_delete_user_confirmation(user: User)
+ %% +show_block_unblock_option(user: User)
+ %% }
+
+ %% class WishListView {
+ %% +display_wishlist_details(wishList: WishList)
+ %% +display_wishlist_list(wishLists: List[WishList])
+ %% +show_create_wishlist_form()
+ %% +show_edit_wishlist_form(wishList: WishList)
+ %% +show_delete_wishlist_confirmation(wishList: WishList)
+ %% +show_add_member_form(wishList: WishList)
+ %% +display_members_list(members: List[WishListMember])
+ %% }
+
+ %% class ItemView {
+ %% +display_item_details(item: Item)
+ %% +display_item_list(items: List[Item])
+ %% +show_add_item_form(wishlist: WishList)
+ %% +show_edit_item_form(item: Item)
+ %% +show_delete_item_confirmation(item: Item)
+ %% +show_mark_as_bought_option(item: Item, user: User)
+ %% }
+
+ %% class PurchaseView {
+ %% +display_purchase_details(purchase: Purchase)
+ %% +display_purchase_list(purchases: List[Purchase])
+ %% +show_purchase_form(wishList: WishList, item: Item)
+ %% +show_delete_purchase_confirmation(purchase: Purchase)
+ %% }
+
+ %% ===== RELATIONSHIPS =====
+ Website --> IUser : uses
+ Website --> IWishList : uses
+ Website --> IItem : uses
+ Website --> IPurchase : uses
+
+ User "1" --> "*" WishList : creates
+ User --> UserRole: uses
+ %% It contains multiple Item objects, but an Item can exist independently of a WishList
+ WishList "1" o-- "*" Item : has
+ %% Either a user or a wishLIst are removed, then the record the wishListMember Object cannot exist
+ WishList "1" *-- "*" WishListMember : has
+ User "*" *-- "*" WishListMember : can_access
+ %% It does not make sense for a Purchase to exist without an associated Item.
+ Item "1" *-- "1" Purchase : bought_as
+ User "1" --> "*" Purchase : buys
+
+ %% Controllers implement their respective interfaces
+ UserController ..|> IUser : implements
+ WishListController ..|> IWishList : implements
+ WishListController --> AccessMode: uses
+ ItemController ..|> IItem: implements
+ PurchaseController ..|> IPurchase: implements
+
+ %% Controllers handle their respective models
+ UserController --> User: uses
+ WishListController --> WishList: uses
+ ItemController --> Item: uses
+ PurchaseController --> Purchase: uses
+
+ %% %% Views are associated with their controllers
+ %% UserView --> UserController: uses
+ %% WishListView --> WishListController: uses
+ %% ItemView --> ItemController: uses
+ %% PurchaseView --> PurchaseController: uses
+
+</div>
diff --git a/conception/db_scheme.mermaid b/conception/db_scheme.mermaid
new file mode 100644
index 0000000..dd395eb
--- /dev/null
+++ b/conception/db_scheme.mermaid
@@ -0,0 +1,69 @@
+<div class="mermaid">
+ erDiagram
+ ITEM {
+ INT id PK
+ VARCHAR title
+ VARCHAR description
+ DOUBLE price
+ VARCHAR purchase_url
+ BOOLEAN is_bought
+ DATETIME created_at
+ }
+
+ PURCHASE {
+ INT id PK
+ INT user_id FK
+ INT wish_list_id FK
+ INT item_id FK
+ VARCHAR url_proof
+ VARCHAR message
+ DATETIME created_at
+ }
+
+ USER {
+ INT id PK
+ VARCHAR user_name
+ VARCHAR name
+ VARCHAR surname
+ VARCHAR email
+ VARCHAR password
+ BOOLEAN is_blocked
+ VARCHAR role
+ DATETIME created_at
+ }
+
+ WISH_LIST {
+ INT id PK
+ INT user_id FK
+ VARCHAR name
+ VARCHAR description
+ DATETIME expiration_date
+ BOOLEAN is_active
+ VARCHAR url_view_mode
+ VARCHAR url_edit_mode
+ DATETIME created_at
+ }
+
+ WISHLIST_ITEM {
+ INT wish_list_id FK
+ INT item_id FK
+ }
+
+ WISH_LIST_MEMBER {
+ INT id PK
+ INT wish_list_id FK
+ INT user_id FK
+ BOOLEAN can_edit
+ BOOLEAN is_accepted
+ DATETIME created_at
+ }
+
+ USER ||--o{ PURCHASE : makes
+ USER ||--o{ WISH_LIST : owns
+ USER ||--o{ WISH_LIST_MEMBER : is
+ PURCHASE ||--|{ ITEM : includes
+ PURCHASE ||--|{ WISH_LIST : for
+ WISH_LIST ||--o{ WISH_LIST_MEMBER : has
+ WISH_LIST ||--o{ WISHLIST_ITEM : contains
+ WISHLIST_ITEM ||--|| ITEM : links_to
+</div>
\ No newline at end of file
--
GitLab