# nndai/project-oop architecture

> Architecture diagram of the GitHub repository nndai/project-oop, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nndai/project-oop
- Repository: https://github.com/nndai/project-oop

## Overview

##### Project Type and Purpose
- This is a console-based full-stack C++ application (“Music Store Management System”) that implements an MVC-like layered architecture.
- Purpose: allow admins and users to manage music items, customers, orders, authentication, and export invoices via a dynamic menu-driven console UI.

##### File Structure Analysis
- src/ – all C++ source and header files.
- Models: MusicItem, Customer, Order, User
- Managers (business logic): MusicStore, CustomerManager, OrderManager, AuthManager, Database
- Controllers / Actions: classes ending in Action (e.g., AddItemAction, ViewOrdersAction) implement IMenuAction
- Infrastructure: MenuManager, MenuActionFactory, Hasher, TableUI, main.cpp
- database/ – SQL scripts to create and seed MySQL database
- config/ – .env for connection parameters, Doxyfile
- out/ – compiled executables
- test/ – automated unit tests

##### Key Architectural Insights from README
- MVC flavor:
- Model layer: domain entities (MusicItem, Customer, Order, User)
- View layer: TableUI (console)
- Controller layer: Action classes, MenuManager
- Design patterns:
- Singleton: Database (single connection)
- Factory: MenuActionFactory → IMenuAction
- Dependency Injection: Managers take Database* or other managers in constructor
- SOLID principles strictly applied

##### Main Components & Relationships
a. Components
1. User Interface (TableUI + MenuManager)
2. Controller Layer (MenuActionFactory + Action classes implementing IMenuAction)
3. Business Logic / Managers (AuthManager, MusicStore, CustomerManager, OrderManager)
4. Data Access Layer (Database singleton)
5. Persistence (MySQL server + database schema defined in SQL files)
b. Interactions
- User selects menu option via MenuManager → MenuActionFactory
- Factory returns an IMenuAction instance → Action::execute()
- Action uses one or more Managers (injected at construction)
- Managers call Database singleton to run SQL queries / transactions
- Results returned → TableUI renders data back to user
- AuthManager and Hasher collaborate for login/register flows
- ExportInvoice writes invoice files based on Order data
c. Architectural Patterns / Principles
- MVC separation (Model, View, Controller)
- Singleton for database connection
- Factory for action instantiation
- DI ensures loose coupling and testability
d. Technologies & Libraries
- C++23, g++ (or MSVC)
- MySQL (connector library)
- Doxygen for documentation
- Unit tests (test_main.cpp)

##### Additional Details
- Test harness (test_main.cpp) optionally connecting to managers via mock Database or the real one.
- Config/.env feeding parameters into Database initialization.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI Layer
    subgraph "UI Layer" 
        direction TB
        Console["Console I/O"]:::external
        TableUI["TableUI"]:::ui
        MenuManager["MenuManager"]:::ui
    end

    %% Controller Layer
    subgraph "Controller Layer"
        direction TB
        IMenuAction["IMenuAction"]:::controller
        MenuActionFactory["MenuActionFactory\n(Factory Pattern)"]:::controller

        subgraph "Actions"
            direction TB
            AddItemAction["AddItemAction"]:::controller
            DisplayAllItemsAction["DisplayAllItemsAction"]:::controller
            FindItemAction["FindItemAction"]:::controller
            EditItemAction["EditItemAction"]:::controller
            RemoveItemAction["RemoveItemAction"]:::controller
            ItemInStockAction["ItemInStockAction"]:::controller
            ManageCustomersAction["ManageCustomersAction"]:::controller
            AdminCreateOrderAction["AdminCreateOrderAction"]:::controller
            UserCreateOrderAction["UserCreateOrderAction"]:::controller
            ViewOrdersAction["ViewOrdersAction"]:::controller
            ViewUserOrdersAction["ViewUserOrdersAction"]:::controller
        end
    end

    %% Service Layer
    subgraph "Service Layer"
        direction TB
        AuthManager["AuthManager"]:::service
        MusicStore["MusicStore"]:::service
        CustomerManager["CustomerManager"]:::service
        OrderManager["OrderManager"]:::service
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        Database["Database\n(Singleton)"]:::data
    end

    %% Models
    subgraph "Domain Models"
        direction TB
        MusicItem["MusicItem"]:::model
        Customer["Customer"]:::model
        OrderModel["Order"]:::model
        User["User"]:::model
    end

    %% Utilities
    subgraph "Utilities"
        direction TB
        Hasher["Hasher"]:::util
        ExportInvoice["ExportInvoice"]:::util
    end

    %% Persistence & Config & Tests
    subgraph "Persistence & Config & Tests"
        direction TB
        SQLSchema["music_store_db.sql"]:::external
        SQLData["data_music_store_db.sql"]:::external
        Env[".env"]:::external
        Doxyfile["Doxyfile"]:::external
        TestMain["test_main.cpp"]:::external
    end

    %% External
    MySQL["MySQL Server"]:::external

    %% Connections
    Console -->|interacts with| TableUI
    TableUI -->|uses| MenuManager
    MenuManager -->|resolves action| MenuActionFactory
    MenuActionFactory -->|returns| IMenuAction

    IMenuAction -->|implemented by| AddItemAction
    AddItemAction -->|uses| MusicStore
    DisplayAllItemsAction -->|uses| MusicStore
    FindItemAction -->|uses| MusicStore
    EditItemAction -->|uses| MusicStore
    RemoveItemAction -->|uses| MusicStore
    ItemInStockAction -->|uses| MusicStore
    ManageCustomersAction -->|uses| CustomerManager
    AdminCreateOrderAction -->|uses| OrderManager
    UserCreateOrderAction -->|uses| OrderManager
    ViewOrdersAction -->|uses| OrderManager
    ViewUserOrdersAction -->|uses| OrderManager

    AuthManager -->|injects| Database
    MusicStore -->|injects| Database
    CustomerManager -->|injects| Database
    OrderManager -->|injects| Database

    Database -->|executes queries on| MySQL
    OrderManager -->|passes data to| ExportInvoice

    MusicStore -->|manages| MusicItem
    CustomerManager -->|manages| Customer
    OrderManager -->|manages| OrderModel
    AuthManager -->|manages| User

    %% Config & Tests flows
    Env -->|provides config for| Database
    SQLSchema -->|used by| Database
    SQLData -->|seeded into| Database
    TestMain -->|tests via mock| Database

    %% Click Events
    click TableUI "https://github.com/nndai/project-oop/blob/main/src/TableUI.h"
    click MenuManager "https://github.com/nndai/project-oop/blob/main/src/MenuManager.h"
    click IMenuAction "https://github.com/nndai/project-oop/blob/main/src/IMenuAction.h"
    click MenuActionFactory "https://github.com/nndai/project-oop/blob/main/src/MenuActionFactory.h"
    click AddItemAction "https://github.com/nndai/project-oop/blob/main/src/AddItemAction.h"
    click DisplayAllItemsAction "https://github.com/nndai/project-oop/blob/main/src/DisplayAllItemsAction.h"
    click FindItemAction "https://github.com/nndai/project-oop/blob/main/src/FindItemAction.h"
    click EditItemAction "https://github.com/nndai/project-oop/blob/main/src/EditItemAction.h"
    click RemoveItemAction "https://github.com/nndai/project-oop/blob/main/src/RemoveItemAction.h"
    click ItemInStockAction "https://github.com/nndai/project-oop/blob/main/src/ItemInStockAction.h"
    click ManageCustomersAction "https://github.com/nndai/project-oop/blob/main/src/ManageCustomersAction.h"
    click AdminCreateOrderAction "https://github.com/nndai/project-oop/blob/main/src/AdminCreateOrderAction.h"
    click UserCreateOrderAction "https://github.com/nndai/project-oop/blob/main/src/UserCreateOrderAction.h"
    click ViewOrdersAction "https://github.com/nndai/project-oop/blob/main/src/ViewOrdersAction.h"
    click ViewUserOrdersAction "https://github.com/nndai/project-oop/blob/main/src/ViewUserOrdersAction.h"
    click AuthManager "https://github.com/nndai/project-oop/blob/main/src/AuthManager.h"
    click MusicStore "https://github.com/nndai/project-oop/blob/main/src/MusicStore.h"
    click CustomerManager "https://github.com/nndai/project-oop/blob/main/src/CustomerManager.h"
    click OrderManager "https://github.com/nndai/project-oop/blob/main/src/OrderManager.h"
    click Database "https://github.com/nndai/project-oop/blob/main/src/Database.h"
    click MusicItem "https://github.com/nndai/project-oop/blob/main/src/MusicItem.h"
    click Customer "https://github.com/nndai/project-oop/blob/main/src/Customer.h"
    click OrderModel "https://github.com/nndai/project-oop/blob/main/src/Order.h"
    click User "https://github.com/nndai/project-oop/blob/main/src/User.h"
    click Hasher "https://github.com/nndai/project-oop/blob/main/src/Hasher.h"
    click ExportInvoice "https://github.com/nndai/project-oop/blob/main/src/ExportInvoice.h"
    click SQLSchema "https://github.com/nndai/project-oop/blob/main/database/music_store_db.sql"
    click SQLData "https://github.com/nndai/project-oop/blob/main/database/data_music_store_db.sql"
    click Env "https://github.com/nndai/project-oop/blob/main/config/.env"
    click Doxyfile "https://github.com/nndai/project-oop/tree/main/config/Doxyfile"
    click TestMain "https://github.com/nndai/project-oop/blob/main/test/test_main.cpp"

    %% Styles
    classDef ui fill:#D0E8FF,stroke:#0366D6
    classDef controller fill:#DFF2BF,stroke:#4F8A10
    classDef service fill:#FFE4B5,stroke:#CC5500
    classDef data fill:#E0E0E0,stroke:#7F7F7F
    classDef model fill:#FFFACD,stroke:#B8860B
    classDef util fill:#E6E6FA,stroke:#9370DB
    classDef external fill:#F5F5F5,stroke:#A9A9A9,stroke-dasharray: 5 5
```
