# tasssinclair/dumplings architecture

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

- Interactive diagram: https://gitdiagram.com/tasssinclair/dumplings
- Repository: https://github.com/tasssinclair/dumplings

## Overview

##### Main Components

a. User Interface Layer
- Activities Package
- MainActivity (entry point)
- AboutActivity
- RatingsActivity
- SpecificServingsActivity
- YourOrderActivity
- UI Components
- Fragments (RatiosFragment, SpecificServingsFragment)
- Custom Widgets
- Layouts (XML resources)

b. Domain Layer
- Core Business Logic
- Dumpling Models
- Order Management
- Rating System
- Serving Calculations

c. Binding Layer
- Adapters for Data Binding
- View-Model Connections

d. Calculation Engine
- Serving Calculations
- Rating Transformations
- Order Equalization

##### Specific Elements

a. Activities Flow:
- MainActivity → [RatingsActivity, SpecificServingsActivity, YourOrderActivity]

b. Core Domain Models:
- Dumpling
- DumplingOrder
- DumplingRating
- DumplingServings

c. Key Calculation Components:
- DumplingCalculationEqualiser
- DumplingRatingTransformer
- DumplingServingAccumulator

##### Implementation Details to Highlight

- Annotations for important architectural patterns

##### Architectural Patterns to Emphasize

- Activity-Fragment relationship
- Adapter pattern for list views
- Observer pattern for data binding
- Factory pattern for object creation

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef ui fill:#90EE90,stroke:#333,stroke-width:2px
    classDef domain fill:#87CEEB,stroke:#333,stroke-width:2px
    classDef binding fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef calc fill:#FFD700,stroke:#333,stroke-width:2px
    
    %% UI Layer
    subgraph UI["User Interface Layer"]
        MA["MainActivity"]:::ui
        AA["AboutActivity"]:::ui
        RA["RatingsActivity"]:::ui
        SA["SpecificServingsActivity"]:::ui
        YA["YourOrderActivity"]:::ui
        
        subgraph Fragments
            RF["RatiosFragment"]:::ui
            SF["SpecificServingsFragment"]:::ui
        end
        
        TS["Theme System"]:::ui
        LO["Layouts"]:::ui
    end
    
    %% Domain Layer
    subgraph Domain["Domain Layer"]
        DM["Dumpling Model"]:::domain
        DOM["Order Management"]:::domain
        RS["Rating System"]:::domain
        SC["Serving Calculations"]:::domain
    end
    
    %% Binding Layer
    subgraph Binding["Binding Layer"]
        DOA["DumplingOrderAdapter"]:::binding
        DRA["DumplingRatingAdapter"]:::binding
        DSA["DumplingServingAdapter"]:::binding
    end
    
    %% Calculation Engine
    subgraph Calc["Calculation Engine"]
        DCE["DumplingCalculationEqualiser"]:::calc
        DRT["DumplingRatingTransformer"]:::calc
        DSC["DumplingServingAccumulator"]:::calc
    end
    
    %% Relationships
    MA --> AA
    MA --> RA
    MA --> SA
    MA --> YA
    
    RA --> RF
    SA --> SF
    
    RF --> DRA
    SF --> DSA
    YA --> DOA
    
    DOA --> DOM
    DRA --> RS
    DSA --> SC
    
    DOM --> DCE
    RS --> DRT
    SC --> DSC
    
    %% Click Events
    click MA "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/activity/MainActivity.kt"
    click AA "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/activity/AboutActivity.kt"
    click RA "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/activity/RatingsActivity.kt"
    click SA "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/activity/SpecificServingsActivity.kt"
    click YA "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/activity/YourOrderActivity.kt"
    click RF "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/activity/RatiosFragment.kt"
    click SF "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/activity/SpecificServingsFragment.kt"
    click TS "https://github.com/TassSinclair/dumplings/tree/master/app/src/main/java/net/sinclairstudios/dumplings/ui/theme"
    click LO "https://github.com/TassSinclair/dumplings/tree/master/app/src/main/res/layout"
    click DM "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/domain/Dumpling.kt"
    click DOM "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/domain/DumplingOrder.kt"
    click RS "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/domain/DumplingRating.kt"
    click SC "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/domain/DumplingServingCalculation.kt"
    click DOA "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/binding/DumplingOrderAdapter.kt"
    click DRA "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/binding/DumplingRatingAdapter.kt"
    click DSA "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/binding/DumplingServingAdapter.kt"
    click DCE "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/calculation/DumplingCalculationEqualiser.kt"
    click DRT "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/calculation/DumplingRatingTransformer.kt"
    click DSC "https://github.com/TassSinclair/dumplings/blob/master/app/src/main/java/net/sinclairstudios/dumplings/calculation/DumplingServingAccumulator.kt"
```
