# esoxjem/movieguide architecture

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

- Interactive diagram: https://gitdiagram.com/esoxjem/movieguide
- Repository: https://github.com/esoxjem/movieguide

## Overview

##### Main Components
- UI/Presentation Layer: This is represented by Android Activities and Fragments. In this project, you have separate packages for listing (e.g., MoviesListingActivity/Fragment), details (e.g., MovieDetailsActivity/Fragment), favorites, and sorting. These components serve as the entry points of the application’s user interaction.
- Presenter Layer: Each UI component has an associated presenter (MoviesListingPresenter, MovieDetailsPresenter, etc.) which handles UI logic and communication with interactors.
- Interactor/Domain Layer: Under each module (listing, details, favorites, sorting), there are interactor interfaces and their implementations that encapsulate presentation/business logic (e.g., MovieDetailsInteractor, MoviesListingInteractor).
- Dependency Injection (DI) Layer: Dagger 2 is used throughout the app, with various Components and Modules (e.g., AppComponent, AppModule, ListingComponent, ListingModule, DetailsComponent, DetailsModule, FavoritesModule, SortingModule). This layers how dependencies are provided and injected across the system.
- Data/Model Layer: Entities such as Movie, Review, Video, and their wrappers are defined to represent data from the TMDB API.
- Network Layer: The network package (including TmdbWebService, RequestInterceptor, and NetworkModule) encapsulates interactions with the external TMDB API. This layer handles REST API communication.
- Utility/Helper Components: Utilities like RxUtils, EspressoIdlingResource, and others facilitate asynchronous operations and testing support.

##### Relationships and Interactions
- Interactors coordinate with the Network layer (making calls via TmdbWebService) and with any local data storage (as represented by FavoritesStore or MovieRealmObject in the favorites package) to retrieve or persist data.
- The DI framework (Dagger 2) wires these components by injecting dependencies into Activities, Presenters, and Interactors.
- Utilities are used throughout (for example, RxUtils for reactive handling and EspressoIdlingResource for testing synchronization).

##### Architectural Patterns and Design Principles
- MVP Pattern: Clearly delineate the presentation (View/Activity/Fragment), presenter, and domain/interactor layers.
- Clean Architecture Principles: Show separation of concerns between UI, business logic, and data/network layers.
- Reactive Programming: Note that RxJava is used in conjunction with presenters and interactors for threading and asynchronous data flows.

##### Relevant Technologies and Frameworks
- Android SDK: The backbone of the UI components.
- Dagger 2: For dependency injection.
- RxJava: For managing asynchronous data streams.
- TMDB API: The external service for movie data.
- Gradle: Build system (suggesting modularization hints such as different build scripts).
- Additional libraries (implied by the project structure) that assist in testing (Espresso) and ensuring smooth UI operations.

##### Final Recommendations
- Avoid overcomplicating—while it is useful to separate individual packages (like listing, details, favorites, and sorting), ensure the overall architecture remains clear.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI/Presentation Layer
    subgraph "UI/Presentation Layer"
        A["MoviesListingActivity"]:::ui
        B["MoviesListingFragment"]:::ui
        C["MovieDetailsActivity"]:::ui
        D["MovieDetailsFragment"]:::ui
        E["SortingDialogFragment"]:::ui
    end

    %% Presenter Layer
    subgraph "Presenter Layer"
        F["MoviesListingPresenter"]:::presenter
        G["MoviesListingPresenterImpl"]:::presenter
        H["MovieDetailsPresenter"]:::presenter
        I["MovieDetailsPresenterImpl"]:::presenter
        J["SortingDialogPresenter"]:::presenter
        K["SortingDialogPresenterImpl"]:::presenter
    end

    %% Domain/Interactor Layer
    subgraph "Domain/Interactor Layer"
        L["MoviesListingInteractor"]:::domain
        M["MoviesListingInteractorImpl"]:::domain
        N["MovieDetailsInteractor"]:::domain
        O["MovieDetailsInteractorImpl"]:::domain
        P["SortingDialogInteractor"]:::domain
        Q["SortingDialogInteractorImpl"]:::domain
        R["FavoritesInteractor"]:::domain
        S["FavoritesInteractorImpl"]:::domain
    end

    %% Dependency Injection (DI) Layer
    subgraph "Dependency Injection (DI) Layer"
        T["AppComponent"]:::di
        U["AppModule"]:::di
        V["ListingComponent"]:::di
        W["ListingModule"]:::di
        X["DetailsComponent"]:::di
        Y["DetailsModule"]:::di
        Z["FavoritesModule"]:::di
        AA["SortingModule"]:::di
    end

    %% Data/Model & Network Layer
    subgraph "Data/Model & Network Layer"
        subgraph "Data Models"
            AB["Movie"]:::data
            AC["MoviesWraper"]:::data
            AD["Review"]:::data
            AE["ReviewsWrapper"]:::data
            AF["Video"]:::data
            AG["VideoWrapper"]:::data
            AH["MovieRealmObject"]:::data
        end
        subgraph "Network Layer"
            AI["TmdbWebService"]:::network
            AJ["RequestInterceptor"]:::network
            AK["NetworkModule"]:::network
            AL[("TMDB API")]:::network
        end
    end

    %% Utility/Helper Components
    subgraph "Utility/Helper Components"
        AM["RxUtils"]:::utility
        AN["EspressoIdlingResource"]:::utility
        AO["SimpleCountingIdlingResource"]:::utility
        AP["SoftKeyboardUtils"]:::utility
    end

    %% UI to Presenter connections
    A -->|"triggers"| F
    B -->|"triggers"| F
    C -->|"triggers"| H
    D -->|"triggers"| H
    E -->|"triggers"| J

    %% Presenter to Domain/Interactor connections
    F -->|"calls"| L
    H -->|"calls"| N
    J -->|"calls"| P

    %% Domain/Interactor to Network connections
    L -->|"fetchMovies"| AI
    N -->|"fetchDetails"| AI

    %% Network to External API
    AI -->|"RESTcalls"| AL

    %% DI injections into UI/Presenter/Domain
    T -->|"injects"| A
    T -->|"injects"| H
    T -->|"injects"| F
    V -->|"injects"| L
    X -->|"injects"| N
    Z -->|"injects"| R
    AA -->|"injects"| P

    %% Utility usage connections (dotted lines)
    AM -.-> F
    AM -.-> H
    AN -.-> A

    %% Styling for layers
    classDef ui fill:#ADD8E6,stroke:#00008B,stroke-width:2px;
    classDef presenter fill:#90EE90,stroke:#006400,stroke-width:2px;
    classDef domain fill:#FFFFE0,stroke:#CCCC00,stroke-width:2px;
    classDef di fill:#FFDAB9,stroke:#FF4500,stroke-width:2px;
    classDef data fill:#D3D3D3,stroke:#696969,stroke-width:2px;
    classDef network fill:#D3D3D3,stroke:#696969,stroke-width:2px;
    classDef utility fill:#FFB6C1,stroke:#C71585,stroke-width:2px;

    %% Click Events - UI/Presentation Layer
    click A "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/MoviesListingActivity.java"
    click B "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/MoviesListingFragment.java"
    click C "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/details/MovieDetailsActivity.java"
    click D "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/details/MovieDetailsFragment.java"
    click E "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/sorting/SortingDialogFragment.java"

    %% Click Events - Presenter Layer
    click F "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/MoviesListingPresenter.java"
    click G "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/MoviesListingPresenterImpl.java"
    click H "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/details/MovieDetailsPresenter.java"
    click I "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/details/MovieDetailsPresenterImpl.java"
    click J "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/sorting/SortingDialogPresenter.java"
    click K "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/sorting/SortingDialogPresenterImpl.java"

    %% Click Events - Domain/Interactor Layer
    click L "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/MoviesListingInteractor.java"
    click M "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/MoviesListingInteractorImpl.java"
    click N "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/details/MovieDetailsInteractor.java"
    click O "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/details/MovieDetailsInteractorImpl.java"
    click P "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/sorting/SortingDialogInteractor.java"
    click Q "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/sorting/SortingDialogInteractorImpl.java"
    click R "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/favorites/FavoritesInteractor.java"
    click S "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/favorites/FavoritesInteractorImpl.java"

    %% Click Events - Dependency Injection (DI) Layer
    click T "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/AppComponent.java"
    click U "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/AppModule.java"
    click V "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/ListingComponent.java"
    click W "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/ListingModule.java"
    click X "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/details/DetailsComponent.java"
    click Y "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/details/DetailsModule.java"
    click Z "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/favorites/FavoritesModule.java"
    click AA "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/listing/sorting/SortingModule.java"

    %% Click Events - Data/Model Layer
    click AB "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/Movie.java"
    click AC "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/MoviesWraper.java"
    click AD "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/Review.java"
    click AE "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/ReviewsWrapper.java"
    click AF "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/Video.java"
    click AG "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/VideoWrapper.java"
    click AH "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/favorites/MovieRealmObject.java"

    %% Click Events - Network Layer
    click AI "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/network/TmdbWebService.java"
    click AJ "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/network/RequestInterceptor.java"
    click AK "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/network/NetworkModule.java"

    %% Click Events - Utility/Helper Components
    click AM "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/util/RxUtils.java"
    click AN "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/util/EspressoIdlingResource.java"
    click AO "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/util/SimpleCountingIdlingResource.java"
    click AP "https://github.com/esoxjem/movieguide/blob/master/app/src/main/java/com/esoxjem/movieguide/util/SoftKeyboardUtils.java"
```
