feat: document generation

.github/linters/.gherkin-lintrc

@@ -7,7 +7,7 @@
   "no-duplicate-tags": "on",
   "no-empty-background": "on",
   "no-empty-file": "on",
-  "no-files-without-scenarios": "on",
+  "no-files-without-scenarios": "off",
   "no-multiple-empty-lines": "on",
   "no-partially-commented-tag-lines": "on",
   "no-scenario-outlines-without-examples": "on",

.github/workflows/release-build.yml

@@ -90,6 +90,16 @@ jobs:
           GH_TOKEN: ${{ github.token }}
           REPOSITORY_OWNER: ${{ github.repository_owner }}
           REPOSITORY_NAME: ${{ github.event.repository.name }}
+      - uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
+        with:
+          pattern: documents
+      - name: Upload documents to release
+        run: |
+          set -Eeuo pipefail
+          gh release upload "${REF_NAME}" ./*.pdf
+        env:
+          GH_REPO: ${{ github.repository }}
+          GH_TOKEN: ${{ github.token }}
       - name: Update package details in release
         run: |
           set -Eeuo pipefail

.github/workflows/wc-document-generation.yml

@@ -22,17 +22,16 @@ jobs:
           set -Eeuo pipefail
           sudo apt-get update && sudo apt-get install --no-install-recommends -y plantuml
           python -m pip install gherkin-official==35.1.0 sbdl==1.16.4
-      - name: Generate requirements document
+      - name: Generate SRS document
         run: |
           set -Eeuo pipefail
-          python docs/support/gherkin-to-csv.py test/cpp/features/*.feature
-          python -m csv-to-sbdl --identifier 0 --description 1 --skipheader rules.csv
-          sbdl -m template-fill --template docs/templates/requirements.template.md output.sbdl > requirements.md
+          python docs/support/gherkin-to-sbdl.py test/cpp/features/*.feature
+          sbdl -m template-fill --template docs/templates/software-requirements-specification.md.j2 output.sbdl > software-requirements-specification.md
       - uses: docker://pandoc/extra:3.7.0@sha256:a703d335fa237f8fc3303329d87e2555dca5187930da38bfa9010fa4e690933a
         with:
-          args: --template eisvogel --output requirements.pdf requirements.md
+          args: --template eisvogel --listings --number-sections --output software-requirements-specification.pdf software-requirements-specification.md
       - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
         with:
           name: documents
-          path: requirements.pdf
+          path: "*.pdf"
           retention-days: 2

.gitignore

@@ -11,5 +11,6 @@ test-results/
 .env
 *.profdata
 *.profraw
+*.pyc
 **/playwright/.auth/user.json
 CMakeUserPresets.json

.mega-linter.yml

@@ -8,7 +8,6 @@ ENABLE:
   - SPELL
   - YAML
 DISABLE_LINTERS:
-  - MARKDOWN_MARKDOWN_LINK_CHECK
   - REPOSITORY_DEVSKIM
   - REPOSITORY_DUSTILOCK
   - REPOSITORY_KICS
@@ -18,6 +17,8 @@ DISABLE_LINTERS:
 SARIF_REPORTER: true
 PRINT_ALPACA: false
 SHOW_SKIPPED_LINTERS: false
+SPELL_LYCHEE_FILE_EXTENSIONS:
+  [".feature", ".json", ".md", ".md.j2", ".txt", ".yaml", ".yml"]
 FILTER_REGEX_EXCLUDE: (CHANGELOG.md|package-lock.json)
 # tasks.json is wrongfully matched against another schema,
 # and schemas for .vscode/[tasks.json|launch.json] are built

docs/support/gherkin-to-sbdl.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3
+
+import argparse
+import os
+import sys
+
+from gherkin_mapping_config import FEATURE_RULE_CONFIG, FEATURE_RULE_SCENARIO_CONFIG
+from gherkin_sbdl_converter import GherkinConverter
+
+def main():
+    configs = {
+        'feature-rule': FEATURE_RULE_CONFIG,
+        'feature-rule-scenario': FEATURE_RULE_SCENARIO_CONFIG
+    }
+
+    parser = argparse.ArgumentParser(description='Configurable Gherkin to SBDL converter')
+    parser.add_argument('feature_files', nargs='+', help='Paths to feature files')
+    parser.add_argument('--output', '-o', default='output.sbdl', help='Output SBDL file')
+    parser.add_argument('--config', choices=configs.keys(), 
+                        default='feature-rule', help='Conversion configuration preset')
+
+    args = parser.parse_args()
+    config = configs[args.config]
+    converter = GherkinConverter(config)
+    gherkin_elements = []
+
+    for feature_path in args.feature_files:
+        if os.path.isfile(feature_path):
+            print(f"Processing {feature_path}")
+            elements = converter.extract_from_feature_file(feature_path)
+            gherkin_elements.extend(elements)
+        else:
+            print(f"File not found: {feature_path}", file=sys.stderr)
+
+    converter.write_sbdl_output(gherkin_elements, args.output)
+    print(f"Extracted {len(gherkin_elements)} elements to {args.output}")
+
+if __name__ == '__main__':
+    main()

docs/support/gherkin_mapping_config.py

@@ -0,0 +1,106 @@
+#!/usr/bin/env python3
+
+"""
+Configuration-driven Gherkin to SBDL mapping with flexible hierarchy support.
+"""
+
+from dataclasses import dataclass
+from typing import Dict, List, Optional, Union
+from enum import Enum
+
+class GherkinElementType(Enum):
+    """Supported Gherkin element types for conversion."""
+    FEATURE = "feature"
+    RULE = "rule"
+    SCENARIO = "scenario"
+    SCENARIO_OUTLINE = "scenario_outline"
+    EXAMPLE = "example"
+    BACKGROUND = "background"
+
+class SBDLElementType(Enum):
+    """Supported SBDL element types for mapping."""
+    REQUIREMENT = "requirement"
+    ASPECT = "aspect"
+    USECASE = "usecase"
+    DEFINITION = "definition"
+    TEST = "test"
+
+@dataclass
+class HierarchyMapping:
+    """Configuration for mapping Gherkin elements to SBDL with document hierarchy."""
+    gherkin_type: GherkinElementType
+    sbdl_type: SBDLElementType
+
+@dataclass
+class ConversionConfig:
+    """Complete configuration for Gherkin to SBDL conversion."""
+    hierarchy_mappings: List[HierarchyMapping]
+
+    def get_mapping_for_type(self, gherkin_type: GherkinElementType) -> Optional[HierarchyMapping]:
+        """Get the hierarchy mapping for a specific Gherkin element type."""
+        for mapping in self.hierarchy_mappings:
+            if mapping.gherkin_type == gherkin_type:
+                return mapping
+        return None
+
+# Predefined configurations for different use cases
+
+# Current Configuration (Feature -> Rule mapping)
+FEATURE_RULE_CONFIG = ConversionConfig(
+    hierarchy_mappings=[
+        HierarchyMapping(
+            gherkin_type=GherkinElementType.FEATURE,
+            sbdl_type=SBDLElementType.REQUIREMENT
+        ),
+        HierarchyMapping(
+            gherkin_type=GherkinElementType.RULE,
+            sbdl_type=SBDLElementType.REQUIREMENT
+        )
+    ]
+)
+
+# Extended Configuration (Feature -> Rule -> Scenario mapping)
+FEATURE_RULE_SCENARIO_CONFIG = ConversionConfig(
+    hierarchy_mappings=[
+        HierarchyMapping(
+            gherkin_type=GherkinElementType.FEATURE,
+            sbdl_type=SBDLElementType.ASPECT
+        ),
+        HierarchyMapping(
+            gherkin_type=GherkinElementType.RULE,
+            sbdl_type=SBDLElementType.REQUIREMENT
+        ),
+        HierarchyMapping(
+            gherkin_type=GherkinElementType.SCENARIO,
+            sbdl_type=SBDLElementType.TEST
+        )
+    ]
+)
+
+# Flat Configuration (All as requirements at same level)
+FLAT_CONFIG = ConversionConfig(
+    hierarchy_mappings=[
+        HierarchyMapping(
+            gherkin_type=GherkinElementType.FEATURE,
+            sbdl_type=SBDLElementType.REQUIREMENT
+        ),
+        HierarchyMapping(
+            gherkin_type=GherkinElementType.RULE,
+            sbdl_type=SBDLElementType.REQUIREMENT
+        )
+    ]
+)
+
+# Use Case Focused Configuration
+USECASE_CONFIG = ConversionConfig(
+    hierarchy_mappings=[
+        HierarchyMapping(
+            gherkin_type=GherkinElementType.FEATURE,
+            sbdl_type=SBDLElementType.USECASE
+        ),
+        HierarchyMapping(
+            gherkin_type=GherkinElementType.SCENARIO,
+            sbdl_type=SBDLElementType.USECASE
+        )
+    ]
+)