# jjdonov/intermodal_containers architecture

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

- Interactive diagram: https://gitdiagram.com/jjdonov/intermodal_containers
- Repository: https://github.com/jjdonov/intermodal_containers

## Overview

##### Project Type Analysis
This is a specialized domain-specific library written in Elixir that handles parsing and validation of intermodal container identifiers. It's not a full-stack application but rather a focused utility library.

##### Main Components

Core Components:
a. Container Number Module
- Alphabet handling
- Category identification
- Checksum calculation
- Parser implementation

b. Container Code Module
- External dimensions
- Size and type codes
- Range code handling
- Parser implementation

**Top Level:**
**[IntermodalContainers Core]**

- ┐
- ↓                 ↓
**[Container Number]  [Container Code]**

**[Container Number]**
- Alphabet Handler
- Category Identifier
- Checksum Calculator
- Parser

**[Container Code]**
- External Dimensions
- Size Codes
- Type Codes
- Range Codes
- Parser

##### Important Details

- A note about ISO 6346 compliance
- Parsing flow for container numbers
- Checksum validation process
- Relationship between size and type codes

##### Implementation Details

- The separation between Container Number and Container Code concerns
- The parser implementations for both major components
- The validation and verification processes
- Error handling through ParseError module

##### Specific Recommendations

- Use a top-down layout to show the hierarchical nature of the components
- Annotations for key ISO 6346 requirements
- Relationship between test files and their corresponding implementations

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Legend
        L1[Module]:::module
        L2([Parser]):::parser
        L3{{Validator}}:::validator
        L4[(Error Handler)]:::error
    end

    subgraph Core["IntermodalContainers Core"]
        Entry[IntermodalContainers]:::module
    end

    subgraph CN["Container Number Components"]
        ContNum[Container Number]:::module
        Alphabet[Alphabet Handler]:::validator
        Category[Category Identifier]:::validator
        Checksum[Checksum Calculator]:::validator
        CNParser([Number Parser]):::parser
    end

    subgraph CC["Container Code Components"]
        ContCode[Container Code]:::module
        ExtDim[External Dimensions]:::module
        SizeCodes[Size Codes]:::validator
        TypeCodes[Type Codes]:::validator
        RangeCodes[Range Codes]:::validator
        CCParser([Code Parser]):::parser
        SizeBounds[Size Bounds]:::validator
    end

    subgraph Error["Error Handling"]
        ParseError[(ParseError)]:::error
    end

    %% Relationships
    Entry --> ContNum
    Entry --> ContCode
    
    ContNum --> Alphabet
    ContNum --> Category
    ContNum --> Checksum
    ContNum --> CNParser
    
    ContCode --> ExtDim
    ContCode --> SizeCodes
    ContCode --> TypeCodes
    ContCode --> RangeCodes
    ContCode --> CCParser
    ContCode --> SizeBounds
    
    CNParser --> ParseError
    CCParser --> ParseError

    %% Styles
    classDef module fill:#a8d1ff,stroke:#333,stroke-width:2px
    classDef parser fill:#90EE90,stroke:#333,stroke-width:2px
    classDef validator fill:#FFE5B4,stroke:#333,stroke-width:2px
    classDef error fill:#FFB6C1,stroke:#333,stroke-width:2px

    %% Click Events
    click Entry "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers.ex"
    click ContNum "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_number.ex"
    click Alphabet "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_number/alphabet.ex"
    click Category "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_number/category.ex"
    click Checksum "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_number/checksum.ex"
    click CNParser "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_number/parser.ex"
    click ContCode "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_code.ex"
    click ExtDim "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_code/external_dimensions.ex"
    click SizeCodes "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_code/size_codes.ex"
    click TypeCodes "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_code/type_codes.ex"
    click RangeCodes "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_code/range_code.ex"
    click CCParser "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_code/parser.ex"
    click SizeBounds "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/container_code/size_bound.ex"
    click ParseError "https://github.com/jjdonov/intermodal_containers/blob/master/lib/intermodal_containers/parse_error.ex"
```
