# m1crogravity/time-breaker architecture

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

- Interactive diagram: https://gitdiagram.com/m1crogravity/time-breaker
- Repository: https://github.com/m1crogravity/time-breaker

## Overview

##### Main Components

a) API Layer:
- Two endpoints (/api/v1/time-breaker)
- HTTP methods (GET/POST)
- Request/response formats

b) Domain Layer (Core Business Logic):
- TimeBreaker Domain
- IntervalSplitter
- Use Cases (BreakTime and FindRange)
- Value Objects (TimeInterval, TimePoint, TimeRange, TimeUnit)

c) Storage Layer:
- PostgreSQL Database
- Repositories

##### Architectural Patterns to Emphasize

The project follows several important architectural patterns that should be represented:
- Domain-Driven Design (DDD) structure (visible in the app/Domains organization)
- Repository Pattern (for data access)
- Use Case Pattern (for business logic organization)
- Value Objects for domain concepts

**┌─────────────────────────────────────────────────────────┐**
- Client Layer                        │
- ┘
- ↓
**┌─────────────────────────────────────────────────────────┐**
- API Layer                          │
- ┌─────────────┐              ┌────────────────┐       │
- GET /api/  │              │   POST /api/   │       │
- ┘              └────────────────┘       │
- ┘
- ↓
**┌─────────────────────────────────────────────────────────┐**
- Domain Layer                         │
- ┌─────────────┐    ┌──────────────┐   ┌──────────┐   │
- BreakTimeUC  │    │FindRangeUC   │   │TimeBreaker│   │
- ┘    └──────────────┘   └──────────┘   │
- ┌─────────────┐    ┌──────────────┐                  │
- ValueObjects │    │IntervalSplit │                  │
- ┘    └──────────────┘                  │
- ┘
- ↓
**┌─────────────────────────────────────────────────────────┐**
- Storage Layer                         │
- ┌─────────────┐              ┌────────────────┐       │
- RangeRepo    │──────────────│PostgreSQL DB   │       │
- ┘              └────────────────┘       │
- ┘

##### Important Details

a) API Layer:
- Request/response DTOs
- Validation components
- HTTP methods and routes

b) Domain Layer:
- TimeBreaker core domain
- Relationships between Use Cases and Value Objects
- IntervalSplitter service

c) Storage Layer:
- Repository interface and implementation
- Database tables (Range and Unit)

##### Technical Stack Indicators

Technology badges or labels for:
- Laravel Framework
- PostgreSQL
- Docker
- PHP-FPM

Remember to include notes about the testing structure, as the project has both Feature and Unit tests that verify the behavior of different components.

This system design should help developers understand both the high-level architecture and the detailed implementation of the Time Breaker API.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles and classes
    classDef api fill:#2196F3,stroke:#1565C0,color:white
    classDef domain fill:#4CAF50,stroke:#388E3C,color:white
    classDef storage fill:#FFC107,stroke:#FFA000,color:black
    classDef database fill:#795548,stroke:#5D4037,color:white
    classDef client fill:#9E9E9E,stroke:#616161,color:white

    %% Client Layer
    Client[Client Applications]:::client

    %% API Layer
    subgraph API
        BreakTimeAction["Break Time Action"]:::api
        FindRangeAction["Find Range Action"]:::api
    end

    %% Domain Layer
    subgraph Domain
        TimeBreaker["Time Breaker Core"]:::domain
        
        subgraph UseCases
            BreakTimeUC["Break Time Use Case"]:::domain
            FindRangeUC["Find Range Use Case"]:::domain
        end
        
        subgraph Services
            IntervalSplitter["Interval Splitter Interface"]:::domain
            CarbonSplitter["Carbon Interval Splitter"]:::domain
        end
        
        subgraph ValueObjects
            TimeInterval["Time Interval"]:::domain
            TimePoint["Time Point"]:::domain
            TimeRange["Time Range"]:::domain
            TimeUnit["Time Unit"]:::domain
        end
    end

    %% Storage Layer
    subgraph Storage
        RangeRepo["Range Repository Interface"]:::storage
        PostgresRepo["Postgres Repository"]:::storage
        DB[(PostgreSQL Database)]:::database
        
        subgraph Models
            RangeModel["Range Model"]:::storage
            UnitModel["Unit Model"]:::storage
        end
    end

    %% Relationships
    Client --> BreakTimeAction & FindRangeAction
    BreakTimeAction --> BreakTimeUC
    FindRangeAction --> FindRangeUC
    
    BreakTimeUC & FindRangeUC --> TimeBreaker
    TimeBreaker --> IntervalSplitter
    IntervalSplitter --> CarbonSplitter
    
    TimeBreaker --> ValueObjects
    TimeBreaker --> RangeRepo
    RangeRepo --> PostgresRepo
    PostgresRepo --> DB
    PostgresRepo --> Models
    
    %% Click events
    click BreakTimeAction "https://github.com/M1crogravity/time-breaker/blob/master/app/Http/Actions/Api/V1/TimeBreaker/BreakTime/BreakTimeAction.php"
    click FindRangeAction "https://github.com/M1crogravity/time-breaker/blob/master/app/Http/Actions/Api/V1/TimeBreaker/Find/FindRangeAction.php"
    click TimeBreaker "https://github.com/M1crogravity/time-breaker/tree/master/app/Domains/TimeBreaker"
    click IntervalSplitter "https://github.com/M1crogravity/time-breaker/blob/master/app/Domains/TimeBreaker/IntervalSplitter/IntervalSplitter.php"
    click CarbonSplitter "https://github.com/M1crogravity/time-breaker/blob/master/app/Domains/TimeBreaker/IntervalSplitter/CarbonIntervalSplitter.php"
    click BreakTimeUC "https://github.com/M1crogravity/time-breaker/blob/master/app/Domains/TimeBreaker/UseCases/BreakTime/BreakTimeUseCase.php"
    click FindRangeUC "https://github.com/M1crogravity/time-breaker/blob/master/app/Domains/TimeBreaker/UseCases/FindRange/FindRangeUseCase.php"
    click TimeInterval "https://github.com/M1crogravity/time-breaker/blob/master/app/Domains/TimeBreaker/VO/TimeInterval/TimeInterval.php"
    click TimePoint "https://github.com/M1crogravity/time-breaker/blob/master/app/Domains/TimeBreaker/VO/TimePoint.php"
    click TimeRange "https://github.com/M1crogravity/time-breaker/blob/master/app/Domains/TimeBreaker/VO/TimeRange.php"
    click TimeUnit "https://github.com/M1crogravity/time-breaker/blob/master/app/Domains/TimeBreaker/VO/TimeUnit/TimeUnit.php"
    click RangeRepo "https://github.com/M1crogravity/time-breaker/blob/master/app/Storage/Repositories/RangeRepository.php"
    click PostgresRepo "https://github.com/M1crogravity/time-breaker/blob/master/app/Storage/Repositories/Postgres/RangePostgresRepository.php"
    click RangeModel "https://github.com/M1crogravity/time-breaker/blob/master/app/Domains/TimeBreaker/Models/Range.php"
    click UnitModel "https://github.com/M1crogravity/time-breaker/blob/master/app/Domains/TimeBreaker/Models/Unit.php"
```
