# brahimdahmani/simplecov-markdown-pr architecture

> Architecture diagram of the GitHub repository brahimdahmani/simplecov-markdown-pr, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/brahimdahmani/simplecov-markdown-pr
- Repository: https://github.com/brahimdahmani/simplecov-markdown-pr

## Overview

SimpleCov Markdown Pro is a small Ruby formatter gem: SimpleCov supplies a coverage result, and the formatter returns a Markdown report while optionally writing it to the coverage directory or printing it to stdout. Its core stages are report assembly, group/file presentation, missing-line compression, and output. Configuration, table rendering, and versioning are internal modules. Relationships are based on the formatter excerpt and README; the README documents the SimpleCov API workflow and major reporting features.

Main entry points: [`lib/simplecov/formatter/markdown_pro_formatter.rb`](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro_formatter.rb) (Markdown formatter), [`lib/simplecov-markdown-pro.rb`](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov-markdown-pro.rb) (Gem entrypoint), [`lib/simplecov/formatter/markdown_pro/table_builder.rb`](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro/table_builder.rb) (Markdown tables), [`lib/simplecov/formatter/markdown_pro/configuration.rb`](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro/configuration.rb) (Configuration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_integration["SimpleCov integration"]
  node_entry["Gem entrypoint"]
  node_formatter["Markdown formatter"]
end

subgraph group_reporting["Report generation"]
  node_assembly["Report assembly"]
  node_groups["Group sections"]
  node_filetable["File coverage tables"]
  node_output["Report output"]
end

subgraph group_support["Formatter support"]
  node_configuration["Configuration<br/>[configuration.rb]"]
  node_version["Version<br/>[version.rb]"]
  node_line_ranges["Missing-line ranges<br/>[line_ranges.rb]"]
  node_table_builder["Markdown tables<br/>[table_builder.rb]"]
end

node_user(("Formatter user"))
node_simplecov["SimpleCov"]
node_result["Coverage result"]
node_file["Markdown file"]
node_stdout["Standard output"]

node_user -->|"requires gem"| node_entry
node_entry -->|"loads"| node_formatter
node_user -->|"configures formatter"| node_simplecov
node_simplecov -->|"calls format"| node_formatter
node_formatter -->|"uses settings"| node_configuration
node_formatter -->|"requires"| node_version
node_formatter -->|"builds report"| node_assembly
node_simplecov -->|"provides result"| node_result
node_formatter -->|"reads coverage"| node_result
node_assembly -->|"assembles groups"| node_groups
node_assembly -->|"builds summary table"| node_table_builder
node_groups -->|"builds file tables"| node_filetable
node_filetable -->|"compresses missing lines"| node_line_ranges
node_filetable -->|"renders tables"| node_table_builder
node_formatter -->|"returns report"| node_output
node_formatter -->|"writes report"| node_file
node_formatter -->|"prints report"| node_stdout

click node_entry "https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov-markdown-pro.rb"
click node_formatter "https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro_formatter.rb"
click node_configuration "https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro/configuration.rb"
click node_version "https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro/version.rb"
click node_assembly "https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro_formatter.rb"
click node_groups "https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro_formatter.rb"
click node_filetable "https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro_formatter.rb"
click node_line_ranges "https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro/line_ranges.rb"
click node_table_builder "https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro/table_builder.rb"
click node_output "https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro_formatter.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_entry,node_formatter,node_user toneBlue
class node_assembly,node_groups,node_filetable,node_output toneAmber
class node_configuration,node_version,node_line_ranges,node_table_builder toneMint
class node_simplecov,node_result,node_file,node_stdout toneIndigo
```

## Components

### SimpleCov integration

- [Gem entrypoint](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov-markdown-pro.rb): `lib/simplecov-markdown-pro.rb`
- [Markdown formatter](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro_formatter.rb): `lib/simplecov/formatter/markdown_pro_formatter.rb`

### Report generation

- [Report assembly](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro_formatter.rb): `lib/simplecov/formatter/markdown_pro_formatter.rb`
- [Group sections](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro_formatter.rb): `lib/simplecov/formatter/markdown_pro_formatter.rb`
- [File coverage tables](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro_formatter.rb): `lib/simplecov/formatter/markdown_pro_formatter.rb`
- [Report output](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro_formatter.rb): `lib/simplecov/formatter/markdown_pro_formatter.rb`

### Formatter support

- [Configuration](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro/configuration.rb): `lib/simplecov/formatter/markdown_pro/configuration.rb`
- [Version](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro/version.rb): `lib/simplecov/formatter/markdown_pro/version.rb`
- [Missing-line ranges](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro/line_ranges.rb): `lib/simplecov/formatter/markdown_pro/line_ranges.rb`
- [Markdown tables](https://github.com/brahimdahmani/simplecov-markdown-pr/blob/main/lib/simplecov/formatter/markdown_pro/table_builder.rb): `lib/simplecov/formatter/markdown_pro/table_builder.rb`

### Other components

- **Formatter user**
- **SimpleCov**
- **Coverage result**
- **Markdown file**
- **Standard output**

## Connections

- Formatter user → Gem entrypoint: requires gem (evidence: `README.md`)
- Gem entrypoint → Markdown formatter: loads (evidence: `lib/simplecov-markdown-pro.rb`)
- Formatter user → SimpleCov: configures formatter (evidence: `README.md`)
- SimpleCov → Markdown formatter: calls format (evidence: `README.md`)
- Markdown formatter → Configuration: uses settings (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
- Markdown formatter → Version: requires (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
- Markdown formatter → Report assembly: builds report (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
- SimpleCov → Coverage result: provides result (evidence: `README.md`)
- Markdown formatter → Coverage result: reads coverage (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
- Report assembly → Group sections: assembles groups (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
- Report assembly → Markdown tables: builds summary table (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
- Group sections → File coverage tables: builds file tables (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
- File coverage tables → Missing-line ranges: compresses missing lines (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
- File coverage tables → Markdown tables: renders tables (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
- Markdown formatter → Report output: returns report (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
- Markdown formatter → Markdown file: writes report (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
- Markdown formatter → Standard output: prints report (evidence: `lib/simplecov/formatter/markdown_pro_formatter.rb`)
