# rukayaafrin/employee_management_service architecture

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

- Interactive diagram: https://gitdiagram.com/rukayaafrin/employee_management_service
- Repository: https://github.com/rukayaafrin/employee_management_service

## Overview

##### Project type and purpose
- This is a simple console-based Employee Management Service that performs Create, Read, Update, and Delete (CRUD) operations on “Employee” records.
- The README confirms it’s a local, in-memory or file-based CRUD utility intended to demonstrate separation of concerns in successive implementations (functional, OOP, service-layered).

##### File structure
- Three parallel implementations:
– functional/ – purely function-based modules
– oop/ – object-oriented classes in a single layer
– oop_service_layers/ – separates into UI, service, model, and utils layers
- Common sub-directories in each approach:
– main.py – console entry point and menu loop
– employee modules – CRUD operations or class definitions
- No external database – data lives in memory or could be serialized to disk by employee_manager.

##### README for additional insights
- Refactoring toward separation of concerns.

a. Main Components (for the service-layered version):
1. Presentation Layer (Console UI)
- main.py
- employee_ui_service.py
2. Service Layer
- employee_input_service.py (translates raw input into domain objects)
- employee_validation_service.py (applies business rules)
- employee_manager.py (core CRUD logic, data store handling)
3. Domain Layer (Models)
- model/employee.py
- model/address.py
4. Utility Layer
- utils/ansi_colors.py
- utils/format_table.py
- utils/dict_helper.py
5. Data Store
- In-memory collection managed by employee_manager (optionally persisted)
b. Relationships & Interactions
– The Console UI calls employee_input_service → passes sanitized input to employee_validation_service → invokes employee_manager for CRUD → employee_manager manipulates in-memory list of Model objects → results flow back through validation/UI for display.
– Utils modules are imported by all layers for formatting and helper functions.
c. Architectural Patterns & Principles
– Layered architecture: clear separation between UI, service logic, domain entities, and utilities.
– Single Responsibility: each service handles one concern (input parsing, validation, data management).
– Dependency Direction: UI depends on service layer; service depends on domain; domain is independent; utils are horizontal.
d. Key Technologies & Libraries
– Python 3.x standard library
– Custom table formatter for tabular output

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation Layer"
        UI_main["main.py"]:::presentation
        UI_service["employee_ui_service.py"]:::presentation
    end

    %% Service Layer
    subgraph "Service Layer"
        InputService["employee_input_service.py"]:::service
        ValidationService["employee_validation_service.py"]:::service
        Manager["employee_manager.py"]:::service
    end

    %% Domain Layer
    subgraph "Domain Layer"
        Employee["employee.py"]:::domain
        Address["address.py"]:::domain
    end

    %% Utility Layer
    subgraph "Utility Layer"
        ANSI["ansi_colors.py"]:::utils
        Table["format_table.py"]:::utils
        DictHelper["dict_helper.py"]:::utils
    end

    %% Data Store
    DataStore[(In-Memory Store)]:::datastore

    %% Flow of Commands
    UI_main -->|"launch/menu"| UI_service
    UI_service -->|"EmployeeDTO"| InputService
    InputService -->|"ParsedInput"| ValidationService
    ValidationService -->|"ValidationResult"| Manager
    Manager -->|"CRUD Operations"| DataStore
    Manager -->|"creates/reads/updates"| Employee
    Manager -->|"manages addresses"| Address

    %% Utilities Usage
    UI_main -.-> ANSI
    UI_main -.-> Table
    UI_main -.-> DictHelper
    UI_service -.-> ANSI
    UI_service -.-> Table
    UI_service -.-> DictHelper
    InputService -.-> ANSI
    InputService -.-> DictHelper
    ValidationService -.-> ANSI
    ValidationService -.-> DictHelper
    Manager -.-> ANSI
    Manager -.-> Table
    Manager -.-> DictHelper

    %% Click Events
    click UI_main "https://github.com/rukayaafrin/employee_management_service/blob/master/oop_service_layers/main.py"
    click UI_service "https://github.com/rukayaafrin/employee_management_service/blob/master/oop_service_layers/service/employee_ui_service.py"
    click InputService "https://github.com/rukayaafrin/employee_management_service/blob/master/oop_service_layers/service/employee_input_service.py"
    click ValidationService "https://github.com/rukayaafrin/employee_management_service/blob/master/oop_service_layers/service/employee_validation_service.py"
    click Manager "https://github.com/rukayaafrin/employee_management_service/blob/master/oop_service_layers/service/employee_manager.py"
    click Employee "https://github.com/rukayaafrin/employee_management_service/blob/master/oop_service_layers/model/employee.py"
    click Address "https://github.com/rukayaafrin/employee_management_service/blob/master/oop_service_layers/model/address.py"
    click ANSI "https://github.com/rukayaafrin/employee_management_service/blob/master/oop_service_layers/utils/ansi_colors.py"
    click Table "https://github.com/rukayaafrin/employee_management_service/blob/master/oop_service_layers/utils/format_table.py"
    click DictHelper "https://github.com/rukayaafrin/employee_management_service/blob/master/oop_service_layers/utils/dict_helper.py"

    %% Styles
    classDef presentation fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef service fill:#90EE90,stroke:#333,stroke-width:1px
    classDef domain fill:#FFFACD,stroke:#333,stroke-width:1px
    classDef utils fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef datastore fill:#FFD700,stroke:#333,stroke-width:1px,shape:cylinder
```
