# jeevanprakashr/protokit architecture

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

- Interactive diagram: https://gitdiagram.com/jeevanprakashr/protokit
- Repository: https://github.com/jeevanprakashr/protokit

## Overview

##### Project type and purpose
- This is a Java utility library (Maven-based) named “Protokit” whose sole purpose is to provide three core features around Google Protocol Buffers: comparison, merging, and simplification.
- It is not a front-end or back-end application; it’s a reusable toolkit intended to be embedded in other Java applications or services.

##### File structure
- Top-level files:
- pom.xml – Maven build descriptor
- README.md, LICENSE, .gitignore
- src/main/java/com/jash/protokit:
- comparer – public API entrypoints (ProtoComparer, CompareOptions, ProtoMapper) + internal helper
- merger – public API (ProtoMerger, MergeOptions, Result) + internal helper
- simplifier – public API (ProtoSimplifier, SimplifyOptions) + internal helper
- internal/util – shared utility code
- src/test – TestNG/JUnit test suites and resource samples (library.proto, comparer.xml, testng.xml)
- test-output – generated test reports

##### README for additional insights
- Describes usage patterns for each module (comparer, merger, simplifier).

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    ClientApp["Client Application"]:::client

    %% Facade Layer
    subgraph "Public API Facades"
        direction TB
        ProtoComparer["ProtoComparer"]:::facade
        CompareOptions["CompareOptions"]:::facade
        ProtoMapper["ProtoMapper"]:::facade
        InternalComparer["Internal (Comparer)"]:::core

        ProtoMerger["ProtoMerger"]:::facade
        MergeOptions["MergeOptions"]:::facade
        ResultModel["Result"]:::facade
        InternalMerger["Internal (Merger)"]:::core

        ProtoSimplifier["ProtoSimplifier"]:::facade
        SimplifyOptions["SimplifyOptions"]:::facade
        InternalSimplifier["Internal (Simplifier)"]:::core
    end

    %% Core Utilities
    subgraph "Core Logic"
        Util["Util"]:::core
    end

    %% External Dependency
    ExternalProto["Protocol Buffer Runtime & Generated Classes"]:::external

    %% Build & Test Infrastructure
    subgraph "Build & Test Infrastructure"
        direction TB
        MavenBuild["Maven Build (pom.xml)"]:::infra
        subgraph "Test Suites & Resources"
            ProtoComparerTest["ProtoComparerTest"]:::infra
            ProtoMergerTest["ProtoMergerTest"]:::infra
            ProtoSimplifierTest["ProtoSimplifierTest"]:::infra
            ProtoRes["library.proto"]:::external
            ComparerCases["comparer.xml"]:::infra
            TestNGSuite["testng.xml"]:::infra
        end
    end

    %% Flows
    ClientApp -->|calls| ProtoComparer
    ClientApp -->|calls| ProtoMerger
    ClientApp -->|calls| ProtoSimplifier

    ProtoComparer -->|delegates| InternalComparer
    CompareOptions -->|configures| InternalComparer
    ProtoMapper -->|helps| InternalComparer

    ProtoMerger -->|delegates| InternalMerger
    MergeOptions -->|configures| InternalMerger
    ResultModel -->|returns| ClientApp

    ProtoSimplifier -->|delegates| InternalSimplifier
    SimplifyOptions -->|configures| InternalSimplifier

    InternalComparer -->|uses| Util
    InternalMerger -->|uses| Util
    InternalSimplifier -->|uses| Util

    InternalComparer <-->|reads/writes| ExternalProto
    InternalMerger <-->|reads/writes| ExternalProto
    InternalSimplifier <-->|reads/writes| ExternalProto

    MavenBuild -->|builds & tests| ProtoComparer
    MavenBuild -->|builds & tests| ProtoMerger
    MavenBuild -->|builds & tests| ProtoSimplifier
    MavenBuild -->|runs| ProtoComparerTest
    MavenBuild -->|runs| ProtoMergerTest
    MavenBuild -->|runs| ProtoSimplifierTest

    ProtoComparerTest -->|uses| ProtoRes
    ProtoMergerTest -->|uses| ProtoRes
    ProtoSimplifierTest -->|uses| ProtoRes
    ProtoComparerTest -->|uses| ComparerCases
    ProtoComparerTest -->|configured by| TestNGSuite

    %% Click Events
    click ProtoComparer "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/comparer/ProtoComparer.java"
    click CompareOptions "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/comparer/CompareOptions.java"
    click ProtoMapper "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/comparer/ProtoMapper.java"
    click InternalComparer "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/comparer/Internal.java"

    click ProtoMerger "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/merger/ProtoMerger.java"
    click MergeOptions "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/merger/MergeOptions.java"
    click ResultModel "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/merger/Result.java"
    click InternalMerger "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/merger/Internal.java"

    click ProtoSimplifier "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/simplifier/ProtoSimplifier.java"
    click SimplifyOptions "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/simplifier/SimplifyOptions.java"
    click InternalSimplifier "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/simplifier/Internal.java"

    click Util "https://github.com/jeevanprakashr/protokit/blob/main/src/main/java/com/jash/protokit/internal/Util.java"

    click MavenBuild "https://github.com/jeevanprakashr/protokit/blob/main/pom.xml"
    click ProtoComparerTest "https://github.com/jeevanprakashr/protokit/blob/main/src/test/java/com/jash/protokit/comparer/ProtoComparerTest.java"
    click ProtoMergerTest "https://github.com/jeevanprakashr/protokit/blob/main/src/test/java/com/jash/protokit/merger/ProtoMergerTest.java"
    click ProtoSimplifierTest "https://github.com/jeevanprakashr/protokit/blob/main/src/test/java/com/jash/protokit/simplifier/ProtoSimplifierTest.java"
    click ProtoRes "https://github.com/jeevanprakashr/protokit/blob/main/src/test/resources/library.proto"
    click ComparerCases "https://github.com/jeevanprakashr/protokit/blob/main/src/test/resources/cases/comparer.xml"
    click TestNGSuite "https://github.com/jeevanprakashr/protokit/blob/main/src/test/resources/suites/testng.xml"

    %% Styles
    classDef facade fill:#add8e6,stroke:#333,stroke-width:1px
    classDef core fill:#d3d3d3,stroke:#333,stroke-width:1px
    classDef external fill:#90ee90,stroke:#333,stroke-width:1px
    classDef infra fill:#ffa500,stroke:#333,stroke-width:1px
    classDef client fill:#9370db,stroke:#333,stroke-width:1px
```
