# huacnlee/rails-settings-cached architecture

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

- Interactive diagram: https://gitdiagram.com/huacnlee/rails-settings-cached
- Repository: https://github.com/huacnlee/rails-settings-cached

## Overview

##### Main Components Identification

The system consists of these primary components:
- Settings Model Layer
- Caching Layer
- Storage Layer
- Field Type System
- Rails Integration Layer

**┌─────────────────────────────────────────┐**
- RailsSettings::Base          │
- (Core Settings Management Component)   │
- ┘

**┌─────────────────┐**
- Field Types    │
- ┤
- String        │
- Integer       │
- Boolean       │
- Array         │
- Hash          │
- Float         │
- BigDecimal    │
- Custom Types  │
- ┘

**┌─────────────────┐**
- Database Layer │
- (ActiveRecord)│
- ┘

**┌─────────────────┐**
- Cache Layer    │
- (Rails.cache or │
- Custom Store)  │
- ┘

**┌─────────────────┐**
- Rails App       │
- Integration     │
- ┘

##### Connection Flows

- Rails App → RailsSettings::Base (Setting access)
- RailsSettings::Base → Cache Layer (Check cache first)
- RailsSettings::Base → Database Layer (If cache miss)
- Field Types → RailsSettings::Base (Type conversion)

##### Important Elements

**Request → Cache Check → Cache Hit → Return Value**
- ↓
- Cache Miss
- ↓
- Database Query → Cache Update → Return Value

**Field Configuration**
- Key
- Type
- Default Value
- Validation Rules
- Readonly Flag

##### Additional Notes

- A note about the request-scoped caching using ActiveSupport::CurrentAttributes
- Validation flow for fields
- Configuration points (cache_prefix, cache_store)
- Readonly fields with a special indicator

##### Implementation Details

- The generator system for initial setup
- The middleware integration
- The railtie for Rails integration
- The configuration options
- The validation system

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Legend
        L1[Component]:::component --- L2[Inheritance]
        L2 --> L3[Data Flow]
        style L1 fill:#a8d1f0
        style L2 fill:#d1f0a8
        style L3 fill:#f0a8d1
    end

    subgraph Rails["Rails Integration Layer"]
        RailsApp["Rails Application"]:::rails
        Railtie["Railtie"]:::rails
        Generator["Install Generator"]:::rails
        Middleware["Middleware"]:::rails
    end

    subgraph Core["Core Settings Management"]
        Base["RailsSettings::Base"]:::core
        Config["Configuration"]:::core
    end

    subgraph Types["Field Types System"]
        direction TB
        FieldBase["Base Field Type"]:::field
        String["String Type"]:::field
        Integer["Integer Type"]:::field
        Boolean["Boolean Type"]:::field
        Array["Array Type"]:::field
        Hash["Hash Type"]:::field
        Float["Float Type"]:::field
        BigDecimal["BigDecimal Type"]:::field
    end

    subgraph Cache["Caching Layer"]
        RequestCache["Request Cache"]:::cache
        RailsCache["Rails.cache"]:::cache
    end

    subgraph Storage["Storage Layer"]
        Migration["Database Migration"]:::storage
        Model["Settings Model"]:::storage
        DB[(Database)]:::storage
    end

    %% Relationships
    RailsApp --> Railtie
    RailsApp --> Generator
    RailsApp --> Middleware
    Railtie --> Base
    Base --> RequestCache
    RequestCache --> RailsCache
    Base --> Model
    Model --> DB
    
    %% Field Type Inheritance
    FieldBase --> String
    FieldBase --> Integer
    FieldBase --> Boolean
    FieldBase --> Array
    FieldBase --> Hash
    FieldBase --> Float
    FieldBase --> BigDecimal
    
    %% Field Types to Core
    Types --> Base
    
    %% Configuration Flow
    Config --> Base

    %% Click Events
    click Base "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/base.rb"
    click Config "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/configuration.rb"
    click RequestCache "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/request_cache.rb"
    click Railtie "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/railtie.rb"
    click Middleware "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/middleware.rb"
    click Generator "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/generators/settings/install_generator.rb"
    click Migration "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/generators/settings/templates/migration.rb"
    click Model "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/generators/settings/templates/model.rb"
    click FieldBase "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/fields/base.rb"
    click String "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/fields/string.rb"
    click Integer "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/fields/integer.rb"
    click Boolean "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/fields/boolean.rb"
    click Array "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/fields/array.rb"
    click Hash "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/fields/hash.rb"
    click Float "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/fields/float.rb"
    click BigDecimal "https://github.com/huacnlee/rails-settings-cached/blob/main/lib/rails-settings/fields/big_decimal.rb"

    %% Styling
    classDef core fill:#a8d1f0
    classDef field fill:#f0d1a8
    classDef cache fill:#d1f0a8
    classDef storage fill:#f0a8d1
    classDef rails fill:#d1a8f0
    classDef component fill:#gray
    
    %% Notes
    note["Note: Request-scoped caching using ActiveSupport::CurrentAttributes"]
    note --> RequestCache
```
