# pedrop3/stock architecture

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

- Interactive diagram: https://gitdiagram.com/pedrop3/stock
- Repository: https://github.com/pedrop3/stock

## Overview

##### Project type and purpose
- This is a backend-only, Java/Spring-Boot stock management microservice.
- It offers REST APIs for tracking stock movements, turnover analysis, ABC classification, alerts, and obsolete product handling.
- It uses a clean layered architecture and the Strategy pattern for movement processing.

##### File structure
- Top-level artifacts:
- Dockerfile & docker-compose.yml for containerized deployment
- build.gradle / Gradle wrapper for build automation
- settings.gradle for multi-module support (single module here)
- src/main/java/com/learn/stock:
- config (OpenApiConfig, RedisConfig)
- controller (REST entrypoints)
- service & service.impl (business logic)
- repository (JPA/Hibernate persistence)
- factory & strategy (Strategy pattern for IN/OUT movements)
- model (domain entities & enums)
- mapper (DTO↔Entity)
- exception (global handler & error response)
- response (DTOs and paging structures)
- src/main/resources:
- application.yml (app properties, DB, Redis)
- db/changelog (Liquibase migrations + seed SQL)
- src/test: unit and integration tests covering controllers, services, strategy factory

##### README insights
- Clean layered architecture
- Strategy pattern for movement types
- OpenAPI (Swagger) for API docs
- Liquibase for DB versioning
- Docker / Docker-Compose ready

a. Main components
- API Layer (StockController + Swagger)
- Service Layer (ProductService, StockMovementService, StockService)
- Strategy Layer (MovementTypeStrategy interface + In/Out implementations + StrategyFactory)
- Repository Layer (ProductRepository, StockMovementRepository)
- Persistence Store (PostgreSQL with Liquibase migrations)
- Cache Layer (Redis)
- External Interfaces (Swagger UI, H2 Console if enabled)
b. Relationships & interactions
- Controllers → Services → StrategyFactory → Strategy implementations
- Services ←→ Repositories → PostgreSQL
- Redis used by services for caching (highlight RedisConfig)
- Liquibase runs at startup (db.changelog-master.yaml → SQL scripts)
- HTTP clients (e.g., Swagger UI) → REST Controllers
c. Architectural patterns
- Layered (Controller → Service → Repository → DB)
- Strategy (MovementTypeStrategy + Factory)
- Exception handling via GlobalExceptionHandler
d. Technologies & frameworks
- Java 21, Spring Boot (REST, DI, Data JPA)
- Liquibase, PostgreSQL, Redis
- Swagger/OpenAPI
- Docker & Docker-Compose
- JUnit + Mockito for testing

##### Final advice
- Be thorough: break down services into individual components (Product vs. StockMovement vs. Stock services).
- StrategyFactory branching into IN/OUT strategies.
- Startup flows: config → Liquibase migrations → spring context initialization.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Interface
    APIClient["HTTP Client / Swagger UI"]:::external

    %% API Layer
    subgraph "API Layer"
        StockController["StockController"]:::api
        OpenApiConfig["OpenAPI Configuration"]:::api
    end

    %% Service Layer
    subgraph "Service Layer"
        ProdSvcI["ProductService"]:::service
        StockMovSvcI["StockMovementService"]:::service
        StockSvcI["StockService"]:::service

        ProdSvcImpl["ProductServiceImpl"]:::service
        StockMovSvcImpl["StockMovementServiceImpl"]:::service
        StockSvcImpl["StockServiceImpl"]:::service
    end

    %% Strategy Layer
    subgraph "Strategy Layer"
        StrategyIface["MovementTypeStrategy"]:::strategy
        InStrategy["InMovementStrategy"]:::strategy
        OutStrategy["OutMovementStrategy"]:::strategy
        StrategyFactory["MovementStrategyFactory"]:::strategy
    end

    %% Repository Layer
    subgraph "Repository Layer"
        ProdRepo["ProductRepository"]:::repo
        StockMovRepo["StockMovementRepository"]:::repo
    end

    %% Domain & Mapping
    subgraph "Domain & Mapping"
        Model["Entities & Enums"]:::domain
        Mapper["ProductMapper"]:::domain
    end

    %% Infrastructure
    subgraph "Infrastructure"
        RedisCfg["RedisConfig"]:::infra
        AppProps["application.yml"]:::infra
        Liquibase["db.changelog-master.yaml"]:::infra
    end

    %% Persistence Stores
    subgraph "Persistence Stores"
        PostgreSQL[(PostgreSQL DB)]:::db
        RedisDB[(Redis Cache)]:::db
    end

    %% Deployment Artifacts
    subgraph "Deployment Artifacts"
        Dockerfile["Dockerfile"]:::deploy
        DockerCompose["docker-compose.yml"]:::deploy
    end

    %% Connections
    APIClient -->|"uses REST"| StockController
    StockController -->|"calls"| ProdSvcI
    StockController -->|"calls"| StockMovSvcI
    StockController -->|"calls"| StockSvcI

    ProdSvcI -->|"implemented by"| ProdSvcImpl
    StockMovSvcI -->|"implemented by"| StockMovSvcImpl
    StockSvcI -->|"implemented by"| StockSvcImpl

    ProdSvcImpl -->|"uses mapper"| Mapper
    StockMovSvcImpl -->|"uses mapper"| Mapper

    ProdSvcImpl -->|"queries"| ProdRepo
    StockMovSvcImpl -->|"queries"| StockMovRepo
    StockSvcImpl -->|"queries"| ProdRepo
    StockSvcImpl -->|"queries"| StockMovRepo

    StockMovSvcImpl -->|"uses"| StrategyFactory
    StrategyFactory -->|"selects"| InStrategy
    StrategyFactory -->|"selects"| OutStrategy

    ProdSvcImpl -->|"caches"| RedisDB
    StockMovSvcImpl -->|"caches"| RedisDB
    RedisCfg -->|"connects"| RedisDB

    Liquibase -->|"migrates on startup"| PostgreSQL
    AppProps -->|"configures"| PostgreSQL
    AppProps -->|"configures"| RedisDB

    DockerCompose -->|"orchestrates containers"| Dockerfile
    DockerCompose -->|"deploys"| PostgreSQL
    DockerCompose -->|"deploys"| RedisDB
    DockerCompose -->|"deploys"| StockApplication

    %% Click Events
    click StockController "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/controller/StockController.java"
    click OpenApiConfig "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/config/OpenApiConfig.java"
    click ProdSvcI "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/service/ProductService.java"
    click StockMovSvcI "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/service/StockMovementService.java"
    click StockSvcI "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/service/StockService.java"
    click ProdSvcImpl "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/service/impl/ProductServiceImpl.java"
    click StockMovSvcImpl "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/service/impl/StockMovementServiceImpl.java"
    click StockSvcImpl "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/service/impl/StockServiceImpl.java"
    click StrategyIface "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/strategy/MovementTypeStrategy.java"
    click InStrategy "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/strategy/movement/type/InMovementStrategy.java"
    click OutStrategy "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/strategy/movement/type/OutMovementStrategy.java"
    click StrategyFactory "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/factory/MovementStrategyFactory.java"
    click ProdRepo "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/repository/ProductRepository.java"
    click StockMovRepo "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/repository/StockMovementRepository.java"
    click Mapper "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/mapper/ProductMapper.java"
    click RedisCfg "https://github.com/pedrop3/stock/blob/main/src/main/java/com/learn/stock/config/RedisConfig.java"
    click AppProps "https://github.com/pedrop3/stock/blob/main/src/main/resources/application.yml"
    click Liquibase "https://github.com/pedrop3/stock/blob/main/src/main/resources/db/changelog/db.changelog-master.yaml"
    click Dockerfile "https://github.com/pedrop3/stock/tree/main/Dockerfile"
    click DockerCompose "https://github.com/pedrop3/stock/blob/main/docker-compose.yml"

    %% Styles
    classDef api fill:#AED6F1,stroke:#1B4F72,stroke-width:1px;
    classDef service fill:#ABEBC6,stroke:#1D8348,stroke-width:1px;
    classDef strategy fill:#A9DFBF,stroke:#196F3D,stroke-width:1px;
    classDef repo fill:#F9E79F,stroke:#B9770E,stroke-width:1px;
    classDef domain fill:#FDEDEC,stroke:#922B21,stroke-width:1px;
    classDef infra fill:#FCF3CF,stroke:#B7950B,stroke-width:1px;
    classDef db fill:#F5B7B1,stroke:#C0392B,stroke-width:1px;
    classDef deploy fill:#D6EAF8,stroke:#2471A3,stroke-width:1px;
    classDef external fill:#E8DAEF,stroke:#6C3483,stroke-width:1px;
```
