# e257-fi/tackler-ng architecture

> Architecture diagram of the GitHub repository e257-fi/tackler-ng, 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/e257-fi/tackler-ng
- Repository: https://github.com/e257-fi/tackler-ng

## Overview

##### Main Components Identification

a) Core Components:
- tackler-core: The main engine containing parsing, processing, and reporting logic
- tackler-api: Public API definitions and interfaces
- tackler-cli: Command-line interface implementation
- tackler-rs: Shared utilities and components

b) External Integrations:
- Git Storage System
- Filesystem Storage
- Configuration System (TOML based)

**┌─────────────────────────────────────────────┐**
- Client Layer                   │
- (tackler-cli)                    │
- ┤
- API Layer                      │
- (tackler-api)                    │
- ┤
- Core Engine                      │
- (tackler-core)                   │
- ┌─────────────┐  ┌─────────────┐          │
- Parser    │  │   Kernel    │          │
- ┘  └─────────────┘          │
- ┌─────────────┐  ┌─────────────┐          │
- Filter    │  │   Report    │          │
- ┘  └─────────────┘          │
- ┤
- Storage Layer                   │
- ┌─────────────┐    ┌─────────────┐      │
- Git Storage │    │ Filesystem  │      │
- ┘    └─────────────┘      │
- ┘

##### Component Details

- Parser: Transaction parsing (ANTLR-based)
- Kernel: Core processing logic
- Filter: Transaction filtering system
- Report: Report generation (Balance, Register, etc.)

- Git Storage integration
- Filesystem storage

- Input flow: Configuration → Storage → Parser → Kernel
- Processing flow: Kernel ↔ Filter
- Output flow: Kernel → Report → CLI

##### Key Features to Highlight

Specific callouts for:
- Transaction filtering capabilities
- GIS/Geo-location support
- Multiple report types
- Commodity handling
- Audit functionality

##### Integration Points

External system connections:
- Git SCM integration
- Configuration file handling
- Input/Output streams

##### Technical Details

Annotations for:
- Rust implementation
- ANTLR parser usage
- SHA-256 checksum verification
- TOML configuration support

## Diagram (Mermaid)

```mermaid
graph TB
    %% Client Layer
    subgraph CL[Client Layer]
        CLI[Command Line Interface]:::client
        CLIARGS[CLI Arguments]:::client
    end

    %% API Layer
    subgraph AL[API Layer]
        FILTERS[Filter Definitions]:::api
        TXNHEAD[Transaction Headers]:::api
        LOC[Location Support]:::api
    end

    %% Core Engine
    subgraph CE[Core Engine]
        %% Parser
        subgraph PS[Parser Components]
            ANTLR[ANTLR Parser]:::core
            PARSER[Parser Implementation]:::core
        end

        %% Kernel
        subgraph KS[Kernel Components]
            ACCUM[Accumulator]:::core
            BAL[Balance]:::core
            HASH[Hash]:::core
        end

        %% Filter
        subgraph FS[Filter Components]
            TXNF[Transaction Filters]:::core
            POSTF[Posting Filters]:::core
            LOGICF[Logic Filters]:::core
        end

        %% Report
        subgraph RS[Report Components]
            BALREP[Balance Reporter]:::core
            REGREP[Register Reporter]:::core
        end

        %% Model
        subgraph MS[Model Components]
            TXN[Transaction Model]:::core
            POST[Posting Model]:::core
            ACCT[Account Tree]:::core
        end
    end

    %% Storage Layer
    subgraph SL[Storage Layer]
        GIT[(Git Storage)]:::storage
        FS[(Filesystem Storage)]:::storage
    end

    %% Configuration
    subgraph CF[Configuration System]
        CONFIG[Configuration Items]:::config
        RAWCFG[Raw Configuration]:::config
    end

    %% Relationships
    CLI --> CLIARGS
    CLIARGS --> FILTERS
    FILTERS --> TXNF
    TXNHEAD --> TXN
    LOC --> TXN

    CONFIG --> RAWCFG
    RAWCFG --> GIT
    RAWCFG --> FS

    GIT --> ANTLR
    FS --> ANTLR
    ANTLR --> PARSER
    PARSER --> TXN

    TXN --> POST
    POST --> ACCT
    
    TXN --> TXNF
    POST --> POSTF
    TXNF & POSTF --> LOGICF

    LOGICF --> ACCUM
    ACCUM --> BAL
    BAL --> HASH

    BAL --> BALREP
    BAL --> REGREP

    BALREP & REGREP --> CLI

    %% Styles
    classDef client fill:#f9f,stroke:#333
    classDef api fill:#aaf,stroke:#333
    classDef core fill:#9cf,stroke:#333
    classDef storage fill:#ff9,stroke:#333
    classDef config fill:#bfb,stroke:#333

    %% Click Events
    click ANTLR "https://github.com/e257-fi/tackler-ng/tree/main/tackler-core/src/parser/txn_antlr/"
    click PARSER "https://github.com/e257-fi/tackler-ng/blob/main/tackler-core/src/parser/tackler_parser.rs"
    click ACCUM "https://github.com/e257-fi/tackler-ng/blob/main/tackler-core/src/kernel/accumulator.rs"
    click BAL "https://github.com/e257-fi/tackler-ng/blob/main/tackler-core/src/kernel/balance.rs"
    click HASH "https://github.com/e257-fi/tackler-ng/blob/main/tackler-core/src/kernel/hash.rs"
    click TXNF "https://github.com/e257-fi/tackler-ng/tree/main/tackler-core/src/filter/txn/"
    click POSTF "https://github.com/e257-fi/tackler-ng/tree/main/tackler-core/src/filter/posting/"
    click LOGICF "https://github.com/e257-fi/tackler-ng/tree/main/tackler-core/src/filter/logic/"
    click BALREP "https://github.com/e257-fi/tackler-ng/blob/main/tackler-core/src/report/balance_reporter.rs"
    click REGREP "https://github.com/e257-fi/tackler-ng/blob/main/tackler-core/src/report/register_reporter.rs"
    click FILTERS "https://github.com/e257-fi/tackler-ng/tree/main/tackler-api/src/filters/"
    click TXNHEAD "https://github.com/e257-fi/tackler-ng/blob/main/tackler-api/src/txn_header.rs"
    click LOC "https://github.com/e257-fi/tackler-ng/blob/main/tackler-api/src/location.rs"
    click CLI "https://github.com/e257-fi/tackler-ng/blob/main/tackler-cli/src/main.rs"
    click CLIARGS "https://github.com/e257-fi/tackler-ng/blob/main/tackler-cli/src/cli_args.rs"
    click CONFIG "https://github.com/e257-fi/tackler-ng/blob/main/tackler-core/src/config/items.rs"
    click RAWCFG "https://github.com/e257-fi/tackler-ng/blob/main/tackler-core/src/config/raw_items.rs"
    click TXN "https://github.com/e257-fi/tackler-ng/blob/main/tackler-core/src/model/transaction.rs"
    click POST "https://github.com/e257-fi/tackler-ng/blob/main/tackler-core/src/model/posting.rs"
    click ACCT "https://github.com/e257-fi/tackler-ng/blob/main/tackler-core/src/model/account_tree_node.rs"
```
