# shawn120/planen-android architecture

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

- Interactive diagram: https://gitdiagram.com/shawn120/planen-android
- Repository: https://github.com/shawn120/planen-android

## Overview

##### Main Components
- User Interface (UI) Layer:
- MainActivity and its associated fragments (Today, Month, Profile, AddPlan, GoogleCalendar) and dialogs.
- XML layouts, menus, and resource files.
- ViewModel Layer:
- ViewModel classes (e.g., MonthViewModel, ProfileViewModel, TaskViewModel) that support the MVVM architecture.
- Data Layer:
- Local database operations are defined in classes like AppDatabase, TaskItemDao, and various repository classes (e.g., HolidayRepository, TaskItemLocalRepository).
- Network/Service Layer:
- API integration components that handle external data, such as HolidayService for Nager public holiday API and OAuthService / GoogleTokenResponse for Google sign-in.
- Utility Components:
- Helper classes like Constants, CoroutinesExtension, and definitions for TaskType.
- Build/Configuration/Deployment:
- Gradle build files (build.gradle.kts, gradle.properties, settings.gradle.kts) and configuration files (credentials.json, proguard rules).

##### Depicting Relationships & Interactions
- UI components to the corresponding ViewModels (e.g., TodayFragment connects to TaskViewModel, MonthFragment connects to MonthViewModel).
- The ViewModels communicate with Repository components that encapsulate data-fetching logic.
- The Repository layer accesses the local database via DAOs (e.g., TaskItemDao) and also interfaces with the external API services (e.g., HolidayService, OAuthService).
- Where initialization happens (loading holidays on app startup) and how the OAuth sign-in integrates directly with the UI (ProfileFragment) via the network layer.
- Build and deployment nodes like Gradle and configurations which underlie the entire app.

##### Architectural Patterns & Design Principles
- MVVM Pattern: Clearly separate UI (activities/fragments), business logic (ViewModels), and data (repositories, database, external APIs).
- Modularity: The clearly segmented folders for UI, data, and util indicate an architecture favoring separation of concerns.
- Local Persistence: Emphasize the use of an SQLite database (through Room, inferred by AppDatabase and DAOs) for offline data storage.
- External API Integration: Clearly show dependency edges from the data repositories to external API services such as for holiday data and OAuth.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "UI Layer"
        MainActivity["MainActivity"]:::ui
        TodayFragment["TodayFragment"]:::ui
        TodayAdapter["TodayAdapter"]:::ui
        MonthFragment["MonthFragment"]:::ui
        ProfileFragment["ProfileFragment"]:::ui
        AddPlanDialog["AddPlanDialog"]:::ui
        GetEventFragment["GetEventFragment"]:::ui
        PrefFragment["PrefFragment"]:::ui
    end

    subgraph "ViewModel Layer"
        TaskViewModel["TaskViewModel"]:::vm
        MonthViewModel["MonthViewModel"]:::vm
        ProfileViewModel["ProfileViewModel"]:::vm
    end

    subgraph "Data Layer"
        AppDatabase["AppDatabase"]:::data
        TaskItem["TaskItem Model"]:::data
        TaskItemDao["TaskItemDao"]:::data
        TaskItemLocalRepository["TaskItemLocalRepository"]:::data
        HolidayRepository["HolidayRepository"]:::data
    end

    subgraph "Network Service Layer"
        HolidayService["HolidayService"]:::network
        OAuthService["OAuthService"]:::network
        GoogleTokenResponse["GoogleTokenResponse"]:::network
    end

    subgraph "Utility Components"
        Constants["Constants"]:::utility
        CoroutinesExtension["CoroutinesExtension"]:::utility
        TaskType["TaskType"]:::utility
    end

    subgraph "Build/Configuration"
        GradleBuild["Gradle Build Files"]:::build
        ConfigFiles["Credentials & Proguard Rules"]:::build
    end

    %% UI Navigation from MainActivity to various fragments
    MainActivity --> TodayFragment
    MainActivity --> MonthFragment
    MainActivity --> ProfileFragment
    MainActivity --> AddPlanDialog
    MainActivity --> GetEventFragment
    MainActivity --> PrefFragment

    %% UI Layer -> ViewModel Layer connections
    TodayFragment -->|"binds"| TaskViewModel
    MonthFragment -->|"binds"| MonthViewModel
    ProfileFragment -->|"binds"| ProfileViewModel

    %% Additional UI component relation
    TodayFragment --> TodayAdapter

    %% ViewModel -> Data Layer interactions
    TaskViewModel -->|"manages"| TaskItemLocalRepository
    TaskItemLocalRepository -->|"uses"| TaskItemDao
    TaskItemDao -->|"accesses"| AppDatabase
    TaskItemDao -->|"CRUD_on"| TaskItem

    %% ViewModel -> Data/Network interactions
    MonthViewModel -->|"fetches"| HolidayRepository
    HolidayRepository -->|"calls"| HolidayService

    ProfileViewModel -->|"initiates"| OAuthService
    OAuthService -->|"returns"| GoogleTokenResponse

    %% Utility usage (dashed lines)
    TaskItemLocalRepository ---|"uses"| Constants
    HolidayRepository ---|"uses"| Constants
    OAuthService ---|"may_use"| Constants

    %% Build/Configuration influences (dotted lines)
    GradleBuild --- MainActivity
    GradleBuild --- AppDatabase
    GradleBuild --- HolidayService
    GradleBuild --- OAuthService

    ConfigFiles --- MainActivity
    ConfigFiles --- AppDatabase
    ConfigFiles --- HolidayService
    ConfigFiles --- OAuthService

    %% Styling classes
    classDef ui fill:#ADD8E6,stroke:#000,stroke-width:2px;
    classDef vm fill:#90EE90,stroke:#000,stroke-width:2px;
    classDef data fill:#FFDAB9,stroke:#000,stroke-width:2px;
    classDef network fill:#FFB6C1,stroke:#000,stroke-width:2px;
    classDef utility fill:#E6E6FA,stroke:#000,stroke-width:2px;
    classDef build fill:#D3D3D3,stroke:#000,stroke-width:2px;

    %% Click Events for UI Layer
    click MainActivity "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/MainActivity.kt"
    click TodayFragment "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/ui/Today/TodayFragment.kt"
    click TodayAdapter "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/ui/Today/TodayAdapter.kt"
    click MonthFragment "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/ui/Month/MonthFragment.kt"
    click ProfileFragment "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/ui/Profile/ProfileFragment.kt"
    click AddPlanDialog "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/ui/AddPlan/AddPlanDialog.kt"
    click GetEventFragment "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/ui/GoogleCalendar/GetEventFragment.kt"
    click PrefFragment "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/ui/UserPref/PrefFragment.kt"

    %% Click Events for ViewModel Layer
    click MonthViewModel "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/ui/Month/MonthViewModel.kt"
    click ProfileViewModel "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/ui/Profile/ProfileViewModel.kt"

    %% Click Events for Data Layer
    click AppDatabase "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/data/AppDatabase.kt"
    click TaskItem "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/data/TaskItem.kt"
    click TaskItemDao "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/data/TaskItemDao.kt"
    click TaskItemLocalRepository "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/data/TaskItemLocalRepository.kt"
    click HolidayRepository "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/data/HolidayRepository.kt"

    %% Click Events for Network Service Layer
    click HolidayService "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/data/HolidayService.kt"
    click OAuthService "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/data/OAuthService.kt"
    click GoogleTokenResponse "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/data/GoogleTokenResponse.kt"

    %% Click Events for Utility Components
    click Constants "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/util/Constants.kt"
    click CoroutinesExtension "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/util/CoroutinesExtension.kt"
    click TaskType "https://github.com/shawn120/planen-android/blob/main/app/src/main/java/com/example/planmanager/util/TaskType.kt"

    %% Click Events for Build/Configuration
    click GradleBuild "https://github.com/shawn120/planen-android/blob/main/app/build.gradle.kts"
    click ConfigFiles "https://github.com/shawn120/planen-android/blob/main/app/credentials.json"
```
