# wouter-bauweraerts/instancio-fixture-builder architecture

> Architecture diagram of the GitHub repository wouter-bauweraerts/instancio-fixture-builder, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/wouter-bauweraerts/instancio-fixture-builder
- Repository: https://github.com/wouter-bauweraerts/instancio-fixture-builder

## Overview

##### Project type and purpose
- This is an open-source Java library (Maven multi-module project) that provides an annotation processor and code generator to produce “fixture builder” classes for test data. Users annotate their POJOs with @GenerateFixtureBuilder, and at compile time the processor generates builder classes they can use in unit tests.

##### File structure
- Top-level modules:
- instancio-fixture-builder – the core annotation processor and generator
- instancio-fixture-builder-tests – an integration test module that verifies generated builders
- docs – static site for documentation
- .github/workflows – CI pipelines (build, test, release)
- pom.xml – aggregator POM
- Core module layout (instancio-fixture-builder/src/main/java/io/github/...):
- fixture/builder – abstract base and entry point (AbstractFixtureBuilder, GenerateFixtureBuilder annotation, InstancioModel)
- fixture/builder/processor – FixtureBuilderProcessor (implements javax.annotation.processing.Processor)
- fixture/builder/generator – FixtureBuilderGenerator and a suite of Factory classes (BuildMethodFactory, NameFactory, etc.) that use the Factory pattern to assemble the generated Java source
- resources – instancio.properties configuration
- Test module mirrors user code, running the processor on dummy classes and asserting the generated builder code.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Compile-Time Pipeline
    subgraph "Compile-Time Pipeline"
        direction TB
        MavenBuild["Maven Build"]:::external
        JavaCompiler["Java Compiler"]:::process
        Processor["FixtureBuilderProcessor"]:::codeModule
        Model["InstancioModel"]:::codeModule
        Generator["FixtureBuilderGenerator"]:::codeModule
        Factories["Factory Classes"]:::codeModule
        GeneratedSources["Generated .java Files"]:::generated
        Packaging["Package into JAR"]:::process
        ArtifactJar["instancio-fixture-builder.jar"]:::storage
    end

    %% Modules
    subgraph "Core Module: instancio-fixture-builder" 
        direction TB
        CorePom["pom.xml"]:::codeModule
        Resources["instancio.properties"]:::codeModule
        AbstractBuilder["AbstractFixtureBuilder"]:::codeModule
        Annotation["@GenerateFixtureBuilder"]:::codeModule
        InstancioModelFile["InstancioModel.java"]:::codeModule
        ProcessorFile["FixtureBuilderProcessor.java"]:::codeModule
        GeneratorFile["FixtureBuilderGenerator.java"]:::codeModule
        FactoryPkg["generator/"]:::codeModule
        ExceptionPkg["generator/exception/"]:::codeModule
        ParameterPkg["generator/parameter/"]:::codeModule
        UtilPkg["generator/util/"]:::codeModule
    end

    subgraph "Integration Tests Module" 
        direction TB
        TestsPom["pom.xml"]:::codeModule
        TestSources["Integration Tests"]:::codeModule
    end

    subgraph "Documentation Site Module" 
        direction TB
        DocsConfig["_config.yml"]:::codeModule
        DocsIndex["index.md"]:::codeModule
        DocsExample1["example-with-annotation-processing.md"]:::codeModule
        DocsExample2["example-without-annotation-processing.md"]:::codeModule
    end

    subgraph "CI/CD Pipelines" 
        direction TB
        GithubCI["github-ci.yml"]:::external
        ReleaseYaml["release.yml"]:::external
    end

    subgraph "External Services"
        direction TB
        MavenCentral["Maven Central"]:::storage
        GitHubPages["GitHub Pages (Jekyll)"]:::external
    end

    %% Flow connections
    MavenBuild --> JavaCompiler
    JavaCompiler --> Processor
    Processor --> Model
    Model --> Generator
    Generator --> Factories
    Factories --> GeneratedSources
    GeneratedSources --> JavaCompiler
    JavaCompiler --> Packaging
    Packaging --> ArtifactJar
    ArtifactJar --> MavenCentral

    ArtifactJar --> TestsPom
    TestsPom --> TestSources

    DocsConfig --> GitHubPages
    DocsIndex --> GitHubPages
    DocsExample1 --> GitHubPages
    DocsExample2 --> GitHubPages

    GithubCI --> MavenBuild
    ReleaseYaml --> MavenBuild

    %% Module integration
    MavenBuild --> CorePom
    CorePom --> Resources
    CorePom --> AbstractBuilder
    CorePom --> Annotation
    CorePom --> InstancioModelFile
    CorePom --> ProcessorFile
    CorePom --> GeneratorFile
    CorePom --> FactoryPkg
    CorePom --> ExceptionPkg
    CorePom --> ParameterPkg
    CorePom --> UtilPkg

    %% Click Events
    click CorePom "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/instancio-fixture-builder/pom.xml"
    click ProcessorFile "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/instancio-fixture-builder/src/main/java/io/github/wouterbauweraerts/instancio/fixture/builder/processor/FixtureBuilderProcessor.java"
    click AbstractBuilder "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/instancio-fixture-builder/src/main/java/io/github/wouterbauweraerts/instancio/fixture/builder/AbstractFixtureBuilder.java"
    click Annotation "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/instancio-fixture-builder/src/main/java/io/github/wouterbauweraerts/instancio/fixture/builder/GenerateFixtureBuilder.java"
    click InstancioModelFile "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/instancio-fixture-builder/src/main/java/io/github/wouterbauweraerts/instancio/fixture/builder/InstancioModel.java"
    click GeneratorFile "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/instancio-fixture-builder/src/main/java/io/github/wouterbauweraerts/instancio/fixture/builder/generator/FixtureBuilderGenerator.java"
    click FactoryPkg "https://github.com/wouter-bauweraerts/instancio-fixture-builder/tree/main/instancio-fixture-builder/src/main/java/io/github/wouterbauweraerts/instancio/fixture/builder/generator/"
    click ExceptionPkg "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/instancio-fixture-builder/src/main/java/io/github/wouterbauweraerts/instancio/fixture/builder/generator/exception/FixtureBuilderGenerationException.java"
    click ParameterPkg "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/instancio-fixture-builder/src/main/java/io/github/wouterbauweraerts/instancio/fixture/builder/generator/parameter/ParamType.java"
    click UtilPkg "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/instancio-fixture-builder/src/main/java/io/github/wouterbauweraerts/instancio/fixture/builder/generator/util/GenerateFixtureBuilderUtils.java"
    click Resources "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/instancio-fixture-builder/src/main/resources/instancio.properties"
    click TestsPom "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/instancio-fixture-builder-tests/pom.xml"
    click TestSources "https://github.com/wouter-bauweraerts/instancio-fixture-builder/tree/main/instancio-fixture-builder-tests/src/test/java/io/github/wouterbauweraerts/instancio/fixture/builder/"
    click DocsConfig "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/docs/_config.yml"
    click DocsIndex "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/docs/index.md"
    click DocsExample1 "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/docs/example-with-annotation-processing.md"
    click DocsExample2 "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/docs/example-without-annotation-processing.md"
    click GithubCI "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/.github/workflows/github-ci.yml"
    click ReleaseYaml "https://github.com/wouter-bauweraerts/instancio-fixture-builder/blob/main/.github/workflows/release.yml"
    click CoreModule "https://github.com/wouter-bauweraerts/instancio-fixture-builder/tree/main/instancio-fixture-builder/"

    %% Styles
    classDef codeModule fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef external fill:#90EE90,stroke:#333,stroke-width:1px
    classDef storage fill:#FFFF99,stroke:#333,stroke-width:1px
    classDef process fill:#FFDAB9,stroke:#333,stroke-width:1px
    classDef generated fill:#E6E6FA,stroke:#333,stroke-width:1px
```
