# demondis/bdd_generator architecture

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

- Interactive diagram: https://gitdiagram.com/demondis/bdd_generator
- Repository: https://github.com/demondis/bdd_generator

## Overview

This Python library turns a GitLab epic or issue into a local Cucumber `.feature` file. Its main workflow fetches the selected item, prepares its description, and creates or updates the feature; update handling compares cached content and records cache data. An optional test-generation path is present in the implementation. The README provides little product detail, so the map follows the sampled source; the GitHub adapter and BDD generator were not implemented in the excerpts.

Main entry points: [`generator_cucumber/create_file.py`](https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/create_file.py) (Feature manager), [`generator_cucumber/api_gitlab.py`](https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/api_gitlab.py) (GitLab adapter), [`generator_cucumber/cache_file.py`](https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/cache_file.py) (Cache helpers), [`generator_cucumber/cucumber_text.py`](https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/cucumber_text.py) (Gherkin renderer)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_fetch["GitLab retrieval"]
  node_gitlab_adapter["GitLab adapter<br/>[api_gitlab.py]"]
end

subgraph group_feature["Feature generation"]
  node_feature_manager["Feature manager<br/>[create_file.py]"]
  node_text_renderer["Gherkin renderer<br/>[cucumber_text.py]"]
  node_feature_file["Feature output"]
  node_test_generator["Test generator<br/>[generator.py]"]
end

subgraph group_state["Local state"]
  node_cache_helpers["Cache helpers<br/>[cache_file.py]"]
  node_feature_cache[("Feature cache")]
  node_change_cache[("Change log")]
end

node_user(("Library caller"))
node_gitlab["GitLab API"]

node_user -.->|"requests generation"| node_gitlab_adapter
node_gitlab_adapter -->|"fetches item"| node_gitlab
node_gitlab -->|"returns item"| node_gitlab_adapter
node_gitlab_adapter -->|"passes item data"| node_feature_manager
node_feature_manager -->|"renders feature"| node_text_renderer
node_text_renderer -->|"writes output"| node_feature_file
node_feature_manager -->|"updates cache"| node_cache_helpers
node_cache_helpers -->|"writes content"| node_feature_cache
node_cache_helpers -->|"appends changes"| node_change_cache
node_feature_manager -->|"optionally invokes"| node_test_generator

click node_gitlab_adapter "https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/api_gitlab.py"
click node_feature_manager "https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/create_file.py"
click node_text_renderer "https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/cucumber_text.py"
click node_test_generator "https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/generator.py"
click node_cache_helpers "https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/cache_file.py"

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_gitlab_adapter toneBlue
class node_feature_manager,node_text_renderer,node_feature_file,node_test_generator toneAmber
class node_cache_helpers,node_feature_cache,node_change_cache,node_gitlab toneMint
class node_user toneIndigo
```

## Components

### GitLab retrieval

- [GitLab adapter](https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/api_gitlab.py): `generator_cucumber/api_gitlab.py`

### Feature generation

- [Feature manager](https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/create_file.py): `generator_cucumber/create_file.py`
- [Gherkin renderer](https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/cucumber_text.py): `generator_cucumber/cucumber_text.py`
- **Feature output**
- [Test generator](https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/generator.py): `generator_cucumber/generator.py`

### Local state

- [Cache helpers](https://github.com/demondis/bdd_generator/blob/main/generator_cucumber/cache_file.py): `generator_cucumber/cache_file.py`
- **Feature cache**
- **Change log**

### Other components

- **Library caller**
- **GitLab API**

## Connections

- Library caller → GitLab adapter: requests generation
- GitLab adapter → GitLab API: fetches item (evidence: `generator_cucumber/api_gitlab.py`)
- GitLab API → GitLab adapter: returns item (evidence: `generator_cucumber/api_gitlab.py`)
- GitLab adapter → Feature manager: passes item data (evidence: `generator_cucumber/api_gitlab.py`)
- Feature manager → Gherkin renderer: renders feature (evidence: `generator_cucumber/create_file.py`)
- Gherkin renderer → Feature output: writes output (evidence: `generator_cucumber/cucumber_text.py`)
- Feature manager → Cache helpers: updates cache (evidence: `generator_cucumber/create_file.py`)
- Cache helpers → Feature cache: writes content (evidence: `generator_cucumber/cache_file.py`)
- Cache helpers → Change log: appends changes (evidence: `generator_cucumber/cache_file.py`)
- Feature manager → Test generator: optionally invokes (evidence: `generator_cucumber/create_file.py`)
