# scalalandio/chimney architecture

> Architecture diagram of the GitHub repository scalalandio/chimney, 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/scalalandio/chimney
- Repository: https://github.com/scalalandio/chimney

## Overview

##### Main Components Identification

The system should be divided into these main components:

a) Core Library Components:
- Transformer Engine (chimney-engine/)
- Core Transformers (chimney/)
- Macro Commons (chimney-macro-commons/)

b) Integration Components:
- Cats Integration (chimney-cats/)
- Java Collections Integration (chimney-java-collections/)
- Protobuf Integration (chimney-protobufs/)

**┌─────────────────────── Public API Layer ───────────────────────┐**

- Transformers  |  Patchers  |  Codecs  |  Isos  |  DSL       │

- Integration Layer ──────────────────────────┤

- Cats  |  Java Collections  |  Protobufs                      │

- Core Engine Layer ──────────────────────────┤

- Derivation Engine  |  Macro Commons  |  Runtime Utils        │

- ┘

##### Important Details

a) Cross-Platform Support:
- JVM/Scala.js/Scala Native compatibility
- Scala version support (2.12, 2.13, 3.3+)

b) Transformation Types:
- Total Transformers
- Partial Transformers
- Patchers
- Codecs
- Isos

c) Key Features:
- Compile-time derivation
- Runtime transformation
- Integration capabilities

##### Implementation Notes

- Version information and platform support as metadata
- Notes about macro expansion and compilation phases

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef core fill:#b3d9ff,stroke:#333
    classDef integration fill:#90EE90,stroke:#333
    classDef api fill:#FFE5B4,stroke:#333
    classDef common fill:#E6E6E6,stroke:#333

    %% Public API Layer
    subgraph PublicAPI["Public API Layer"]
        Transformers["Transformers"]:::api
        Patchers["Patchers"]:::api
        Codecs["Codecs"]:::api
        Isos["Isos"]:::api
        DSL["DSL"]:::api
    end

    %% Integration Layer
    subgraph Integration["Integration Layer"]
        Cats["Cats"]:::integration
        JavaCollections["Java Collections"]:::integration
        Protobufs["Protobufs"]:::integration
    end

    %% Core Engine Layer
    subgraph CoreEngine["Core Engine Layer"]
        DerivationEngine["Derivation Engine"]:::core
        MacroCommons["Macro Commons"]:::common
        RuntimeUtils["Runtime Utils"]:::common
    end

    %% Relationships
    Transformers --> DerivationEngine
    Patchers --> DerivationEngine
    Codecs --> DerivationEngine
    Isos --> DerivationEngine
    DSL --> DerivationEngine

    DerivationEngine --> MacroCommons
    DerivationEngine --> RuntimeUtils

    Cats -.-> Transformers
    JavaCollections -.-> Transformers
    Protobufs -.-> Transformers

    %% Click Events
    click Transformers "https://github.com/scalalandio/chimney/blob/master/chimney/src/main/scala/io/scalaland/chimney/Transformer.scala"
    click Patchers "https://github.com/scalalandio/chimney/blob/master/chimney/src/main/scala/io/scalaland/chimney/Patcher.scala"
    click Codecs "https://github.com/scalalandio/chimney/blob/master/chimney/src/main/scala/io/scalaland/chimney/Codec.scala"
    click Isos "https://github.com/scalalandio/chimney/blob/master/chimney/src/main/scala/io/scalaland/chimney/Iso.scala"
    click DSL "https://github.com/scalalandio/chimney/tree/master/chimney/src/main/scala/io/scalaland/chimney/dsl"
    click Cats "https://github.com/scalalandio/chimney/tree/master/chimney-cats/src/main/scala/io/scalaland/chimney/cats"
    click JavaCollections "https://github.com/scalalandio/chimney/tree/master/chimney-java-collections/src/main/scala/io/scalaland/chimney/javacollections"
    click Protobufs "https://github.com/scalalandio/chimney/tree/master/chimney-protobufs/src/main/scala/io/scalaland/chimney/protobufs"
    click DerivationEngine "https://github.com/scalalandio/chimney/blob/master/chimney-engine/src/main/scala/io/scalaland/chimney/internal/compiletime/DerivationEngine.scala"
    click MacroCommons "https://github.com/scalalandio/chimney/tree/master/chimney-macro-commons/src/main/scala/io/scalaland/chimney/internal/compiletime"
    click RuntimeUtils "https://github.com/scalalandio/chimney/tree/master/chimney/src/main/scala/io/scalaland/chimney/internal/runtime"

    %% Legend
    subgraph Legend
        CoreComponent["Core Component"]:::core
        IntegrationComponent["Integration Component"]:::integration
        APIComponent["API Component"]:::api
        CommonComponent["Common Component"]:::common
    end
```
