# collectiveidea/audited architecture

> Architecture diagram of the GitHub repository collectiveidea/audited, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/collectiveidea/audited
- Repository: https://github.com/collectiveidea/audited

## Overview

Audited is a Rails ActiveRecord extension that records model changes as audit rows, with optional user attribution, comments, associated records, and revision reconstruction. The principal workflow is a model lifecycle event triggering audit creation, persistence, and later inspection or undo. The README also documents install/upgrade migrations and RSpec matchers; these are represented as product-facing branches. Source excerpts show callback and revision behavior, but request attribution wiring is only documented, so that relationship is marked unverified.

Main entry points: [`lib/audited/auditor.rb`](https://github.com/collectiveidea/audited/blob/main/lib/audited/auditor.rb) (Auditor callbacks), [`lib/audited/audit.rb`](https://github.com/collectiveidea/audited/blob/main/lib/audited/audit.rb) (Audit record), [`lib/audited.rb`](https://github.com/collectiveidea/audited/blob/main/lib/audited.rb) (Request context), [`lib/audited/railtie.rb`](https://github.com/collectiveidea/audited/blob/main/lib/audited/railtie.rb) (Rails railtie)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_auditing["Audit capture"]
  node_model["Audited model"]
  node_auditor["Auditor callbacks<br/>[auditor.rb]"]
end

subgraph group_history["Audit history"]
  node_audit["Audit record<br/>[audit.rb]"]
  node_audit_db[("Audits table")]
  node_revisions["Revision APIs<br/>[auditor.rb]"]
end

subgraph group_rails["Rails integration"]
  node_request_context["Request context<br/>[audited.rb]"]
  node_sweeper["Audit sweeper<br/>[sweeper.rb]"]
  node_railtie["Rails railtie<br/>[railtie.rb]"]
end

subgraph group_setup["Schema setup"]
  node_install["Install generator"]
  node_upgrade["Upgrade generator"]
end

subgraph group_matchers["RSpec matchers"]
  node_rspec_matchers["Audit matchers<br/>[rspec_matchers.rb]"]
end

node_application(("Rails application"))
node_request_user(("Request user"))

node_model -->|"triggers callbacks"| node_auditor
node_auditor -->|"creates audit"| node_audit
node_audit -->|"persists rows"| node_audit_db
node_revisions -->|"reads history"| node_audit
node_application -->|"generates schema"| node_install
node_application -->|"generates migrations"| node_upgrade
node_application -.->|"loads integration"| node_railtie
node_request_user -.->|"supplies identity"| node_request_context
node_request_context -.->|"attributes changes"| node_auditor

click node_auditor "https://github.com/collectiveidea/audited/blob/main/lib/audited/auditor.rb"
click node_audit "https://github.com/collectiveidea/audited/blob/main/lib/audited/audit.rb"
click node_revisions "https://github.com/collectiveidea/audited/blob/main/lib/audited/auditor.rb"
click node_request_context "https://github.com/collectiveidea/audited/blob/main/lib/audited.rb"
click node_sweeper "https://github.com/collectiveidea/audited/blob/main/lib/audited/sweeper.rb"
click node_railtie "https://github.com/collectiveidea/audited/blob/main/lib/audited/railtie.rb"
click node_install "https://github.com/collectiveidea/audited/blob/main/lib/generators/audited/install_generator.rb"
click node_upgrade "https://github.com/collectiveidea/audited/blob/main/lib/generators/audited/upgrade_generator.rb"
click node_rspec_matchers "https://github.com/collectiveidea/audited/blob/main/lib/audited/rspec_matchers.rb"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_model,node_auditor,node_request_user toneBlue
class node_audit,node_audit_db,node_revisions toneAmber
class node_request_context,node_sweeper,node_railtie toneMint
class node_install,node_upgrade toneRose
class node_rspec_matchers,node_application toneIndigo
```

## Components

### Audit capture

- **Audited model**
- [Auditor callbacks](https://github.com/collectiveidea/audited/blob/main/lib/audited/auditor.rb): `lib/audited/auditor.rb`

### Audit history

- [Audit record](https://github.com/collectiveidea/audited/blob/main/lib/audited/audit.rb): `lib/audited/audit.rb`
- **Audits table**
- [Revision APIs](https://github.com/collectiveidea/audited/blob/main/lib/audited/auditor.rb): `lib/audited/auditor.rb`

### Rails integration

- [Request context](https://github.com/collectiveidea/audited/blob/main/lib/audited.rb): `lib/audited.rb`
- [Audit sweeper](https://github.com/collectiveidea/audited/blob/main/lib/audited/sweeper.rb): `lib/audited/sweeper.rb`
- [Rails railtie](https://github.com/collectiveidea/audited/blob/main/lib/audited/railtie.rb): `lib/audited/railtie.rb`

### Schema setup

- [Install generator](https://github.com/collectiveidea/audited/blob/main/lib/generators/audited/install_generator.rb): `lib/generators/audited/install_generator.rb`
- [Upgrade generator](https://github.com/collectiveidea/audited/blob/main/lib/generators/audited/upgrade_generator.rb): `lib/generators/audited/upgrade_generator.rb`

### RSpec matchers

- [Audit matchers](https://github.com/collectiveidea/audited/blob/main/lib/audited/rspec_matchers.rb): `lib/audited/rspec_matchers.rb`

### Other components

- **Rails application**
- **Request user**

## Connections

- Audited model → Auditor callbacks: triggers callbacks (evidence: `lib/audited/auditor.rb`)
- Auditor callbacks → Audit record: creates audit (evidence: `lib/audited/auditor.rb`)
- Audit record → Audits table: persists rows (evidence: `README.md`)
- Revision APIs → Audit record: reads history (evidence: `lib/audited/auditor.rb`)
- Rails application → Install generator: generates schema (evidence: `README.md`)
- Rails application → Upgrade generator: generates migrations (evidence: `README.md`)
- Rails application → Rails railtie: loads integration
- Request user → Request context: supplies identity
- Request context → Auditor callbacks: attributes changes
