# mkiperszmid/moviedb architecture

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

- Interactive diagram: https://gitdiagram.com/mkiperszmid/moviedb
- Repository: https://github.com/mkiperszmid/moviedb

## Overview

##### Main Components
- User Interface Layer: This includes activities, composable screens (such as HomeScreen and DetailScreen), presentation components (like HomeMoviePoster, CategoryTitle, etc.), and view models (HomeViewModel, DetailViewModel). This layer is responsible for handling user interactions and displaying data.
- Domain Layer: Contains business logic – the domain models (Movie, MovieDetail, MovieList, FilterType) and use cases (such as ReduceFilteredMovies). It also includes repository interfaces (MovieRepository) which abstract the data source.
- Data Layer: Split into several sub-components:
- Remote Data Source: Implements network operations. Contains APIs (MovieApi), DTOs (e.g., MovieDtoResponse, MovieDetailResponse, and related mapping classes such as MovieMapper and MovieDetailMapper), interceptors (ApiKeyInterceptor), and extensions to handle remote responses.
- Local Data Source: Manages local persistence. Includes the Room database (MovieDatabase), DAO (MovieDao), and entity definitions (MovieEntity) for caching data.
- Repository Implementation: MovieRepositoryImpl which connects domain requests to the appropriate data source (remote or local) and handles mapping between entities and domain models.
- Dependency Injection (DI): The DI layer (e.g., CoreModule) to manage dependencies across the project.
- Testing Modules: Although not a direct runtime component, the unit tests (in the /src/test directory) and instrumentation tests provide insight on how these layers are validated.

##### How the Components Interact
- The UI Layer (ViewModels and screens) triggers use cases from the Domain Layer.
- Use cases call the repository interface defined in the Domain Layer to fetch data.
- The repository interface is implemented by the Data Layer (MovieRepositoryImpl), which in turn decides whether to use remote data (via MovieApi and remote DTOs) or local data (via MovieDatabase/DAO).
- Mappers are applied as data passes from the Data to Domain layer, ensuring that the domain models remain decoupled from data transfer objects.
- Dependency Injection (via the CoreModule) wires all components together.

##### Architectural Patterns and Principles
- Clean Architecture: The separation between UI, Domain, and Data layers is central.
- Single Responsibility Principle: Each class or module (e.g., Repository vs. Mapper) follows a clear responsibility.
- Testability: The presence of unit and instrumentation testing: tests ensure that individual components work as expected.
- Use of Extensions and Interceptors to offload responsibilities from core classes (e.g., handling API key injection).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% User Interface Layer
    subgraph "User Interface Layer"
        A1["HomeScreen"]:::ui
        A2["HomeViewModel"]:::ui
        A3["DetailScreen"]:::ui
        A4["DetailViewModel"]:::ui
        A5["UI Theming"]:::ui
    end

    %% Domain Layer
    subgraph "Domain Layer"
        B1["Domain Models"]:::domain
        B2["Use Cases"]:::domain
        B3["Repository Interface"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        %% Remote Data Source
        subgraph "Remote Data Source"
            C1["MovieApi"]:::data
            C2["Remote DTOs"]:::data
            C3["Interceptor & Extensions"]:::data
            C4["Data Mappers"]:::data
        end
        %% Local Data Source
        subgraph "Local Data Source"
            D1["Room Database"]:::data
            D2["DAO"]:::data
            D3["Local Entities"]:::data
        end
        E1["MovieRepositoryImpl"]:::data
    end

    %% Dependency Injection
    subgraph "Dependency Injection"
        F1["CoreModule"]:::di
    end

    %% Testing Modules
    subgraph "Testing Modules"
        G1["Unit Tests"]:::test
        G2["Instrumentation Tests"]:::test
    end

    %% Relationships between layers
    A2 -->|"triggers"| B2
    A4 -->|"triggers"| B2
    B2 -->|"calls"| B3
    B3 -->|"implemented_by"| E1
    E1 -->|"fetches_from"| C1
    E1 -->|"fetches_from"| D1
    E1 -->|"maps_with"| C4
    C1 -->|"returns"| C2
    C1 -->|"uses"| C3
    D1 -->|"provides_DAO"| D2
    D1 -->|"stores"| D3

    %% Dependency Injection wiring
    F1 --- A2
    F1 --- A4
    F1 --- B2
    F1 --- E1
    F1 --- C1
    F1 --- D1

    %% Testing connections (validation flows)
    G1 --- A2
    G1 --- E1
    G1 --- B2
    G2 --- E1

    %% Click Events for User Interface Layer
    click A1 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/home/presentation"
    click A2 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/home/presentation"
    click A3 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/detail/presentation"
    click A4 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/detail/presentation"
    click A5 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/ui/theme"

    %% Click Events for Domain Layer
    click B1 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/core/domain/model"
    click B2 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/core/domain/usecase"
    click B3 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/core/domain/repository"

    %% Click Events for Data Layer
    click E1 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/core/data"
    click C1 "https://github.com/mkiperszmid/moviedb/blob/master/app/src/main/java/com/mk/moviedb/core/data/remote/MovieApi.kt"
    click C2 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/core/data/remote/dto"
    click C3 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/core/data/remote/interceptor"
    click C4 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/core/data/mapper"
    click D1 "https://github.com/mkiperszmid/moviedb/blob/master/app/src/main/java/com/mk/moviedb/core/data/local/MovieDatabase.kt"
    click D2 "https://github.com/mkiperszmid/moviedb/blob/master/app/src/main/java/com/mk/moviedb/core/data/local/MovieDao.kt"
    click D3 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/core/data/local/entity"

    %% Click Events for Dependency Injection
    click F1 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/main/java/com/mk/moviedb/core/di"

    %% Click Events for Testing Modules
    click G1 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/test"
    click G2 "https://github.com/mkiperszmid/moviedb/tree/master/app/src/androidTest"

    %% Styles
    classDef ui fill:#AED6F1,stroke:#1B4F72,stroke-width:2px;
    classDef domain fill:#F9E79F,stroke:#B7950B,stroke-width:2px;
    classDef data fill:#A9DFBF,stroke:#196F3D,stroke-width:2px;
    classDef di fill:#F5CBA7,stroke:#B03A2E,stroke-width:2px;
    classDef test fill:#D7BDE2,stroke:#6C3483,stroke-width:2px;
```
