behave-model 1.0.0__tar.gz

behave_model-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install ruff
+      - run: ruff check behave_model/ tests/
+      - run: ruff format --check behave_model/ tests/
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: python -m pytest tests/ --cov=behave_model --cov-report=xml --cov-report=term
+      - uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          fail_ci_if_error: false
+
+  packaging:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install build twine
+      - run: python -m build
+      - run: python -m twine check dist/*

behave_model-1.0.0/.github/workflows/docs.yml

@@ -0,0 +1,52 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - "README.md"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install MkDocs
+        run: pip install mkdocs mkdocs-material
+
+      - name: Build site
+        run: mkdocs build --strict
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: site
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

behave_model-1.0.0/.github/workflows/release.yml

@@ -0,0 +1,85 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: python -m pytest tests/ --cov=behave_model --cov-report=term
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build dependencies
+        run: pip install build twine
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Check distributions
+        run: python -m twine check dist/*
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          generate_release_notes: true
+          files: dist/*

behave_model-1.0.0/.gitignore

@@ -0,0 +1,78 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+.pytest_cache/
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+*.lcov
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDEs
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Type checkers
+.mypy_cache/
+.pyre/
+.pytype/
+
+# Ruff
+.ruff_cache/
+
+# MkDocs
+site/

behave_model-1.0.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.5.0
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

behave_model-1.0.0/CHANGELOG.md

@@ -0,0 +1,54 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0] - 2026-07-02
+
+### Added
+- `Rule` model class for Gherkin v6 `Rule` keyword support.
+- `Feature.rules` list and `Feature.all_scenarios()` now includes rule scenarios.
+- `BehaveParserAdapter._adapt_rule()` to parse Behave Rule objects.
+- `Visitor.visit_rule()` in base visitor, `CountingVisitor`, and `CollectingVisitor`.
+- `Project` DFS/BFS traversal now includes Rule nodes.
+- `DictSerializer.serialize_rule()` and rules in `serialize_feature()`.
+- `PrettyPrinter._print_rule()` with proper indentation for rule scenarios.
+- `Rule` exported in public API (`behave_model.Rule`).
+- Example feature file `examples/rules.feature` demonstrating Gherkin v6 Rules.
+- 31 new tests for Rule support in `tests/test_rules.py`.
+- MkDocs Material documentation site with GitHub Pages deployment.
+- CI/CD workflows: `ci.yml`, `release.yml`, `docs.yml`.
+- `.gitignore`, `.pre-commit-config.yaml`, `tox.ini`, `Makefile`, `conftest.py`.
+
+### Changed
+- Tests moved from `behave_model/tests/` to `tests/` at project root.
+- `pyproject.toml` `testpaths` updated to `["tests"]`.
+- `PrettyPrinter` scenario/outline/examples methods now accept `indent` parameter.
+- `Project.all_scenarios()` delegates to `Feature.all_scenarios()` for rule inclusion.
+- README rewritten with badges, compatibility table, and architecture overview.
+
+### Compatibility
+- Verified full compatibility with Behave 1.3.3.
+- Verified Tag Expression v2 support (both v1 and v2 parsers present in Behave).
+- Verified Gherkin v6 `Rule` keyword parsing and roundtrip.
+
+## [0.1.0] - 2026-07-01
+
+### Added
+- Initial release of `behave-model`.
+- Domain model: `Project`, `Feature`, `Background`, `Scenario`, `ScenarioOutline`,
+  `Examples`, `Step`, `Table`, `Tag`, `DocString`, `Comment`, `Location`, `Metadata`.
+- Parser adapter over Behave's built-in parser with `load_project` and `load_feature`.
+- Visitor pattern with depth-first and breadth-first traversal.
+- Query API: `find_feature`, `find_tag`, `find_steps`, `find_scenarios`.
+- Serializers: dictionary and JSON.
+- Transformations: rename tag, rename scenario, sort tags, sort features,
+  normalize whitespace.
+- Validation framework with pluggable rules.
+- Statistics: feature count, scenario count, step count, average steps per
+  scenario, tag count.
+- Pretty printer that generates valid `.feature` files.
+- Exception hierarchy: `BehaveModelError`, `ParseError`, `ValidationError`,
+  `TransformationError`, `SerializationError`.

behave_model-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mathias Paulenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

behave_model-1.0.0/Makefile

@@ -0,0 +1,37 @@
+.PHONY: install dev test test-verbose lint format coverage build clean docs docs-serve
+
+install:
+	pip install -e .
+
+dev:
+	pip install -e ".[dev]"
+
+test:
+	pytest tests/ -q
+
+test-verbose:
+	pytest tests/ -v --tb=short
+
+lint:
+	ruff check behave_model/ tests/
+	ruff format --check behave_model/ tests/
+
+format:
+	ruff format behave_model/ tests/
+	ruff check --fix behave_model/ tests/
+
+coverage:
+	pytest tests/ --cov=behave_model --cov-report=term-missing --cov-report=html
+
+build:
+	python -m build
+
+docs:
+	mkdocs build --strict
+
+docs-serve:
+	mkdocs serve
+
+clean:
+	rm -rf build/ dist/ *.egg-info/ .coverage .pytest_cache/ htmlcov/ .tox/ .ruff_cache/
+	find . -type d -name __pycache__ -exec rm -rf {} +

behave_model-1.0.0/PKG-INFO

@@ -0,0 +1,273 @@
+Metadata-Version: 2.4
+Name: behave-model
+Version: 1.0.0
+Summary: Canonical object model for Behave projects
+Project-URL: Homepage, https://github.com/MathiasPaulenko/behave-model
+Project-URL: Repository, https://github.com/MathiasPaulenko/behave-model
+Project-URL: Issues, https://github.com/MathiasPaulenko/behave-model/issues
+Project-URL: Documentation, https://mathiaspaulenko.github.io/behave-model/
+Project-URL: Changelog, https://github.com/MathiasPaulenko/behave-model/blob/main/CHANGELOG.md
+Author: Mathias Paulenko
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bdd,behave,cucumber,domain,gherkin,model,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.11
+Requires-Dist: behave>=1.2.6
+Provides-Extra: dev
+Requires-Dist: mkdocs-material>=9.5; extra == 'dev'
+Requires-Dist: mkdocs>=1.6; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# behave-model
+
+**The canonical object model for [Behave](https://github.com/behave/behave) projects.**
+
+[![CI](https://github.com/MathiasPaulenko/behave-model/actions/workflows/ci.yml/badge.svg)](https://github.com/MathiasPaulenko/behave-model/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/behave-model.svg)](https://pypi.org/project/behave-model/)
+[![Python](https://img.shields.io/pypi/pyversions/behave-model.svg)](https://pypi.org/project/behave-model/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Coverage](https://img.shields.io/badge/coverage-95%25-brightgreen)](https://github.com/MathiasPaulenko/behave-model)
+
+[Documentation](https://mathiaspaulenko.github.io/behave-model/) · [Quick Start](https://mathiaspaulenko.github.io/behave-model/quick_start/) · [API Reference](https://mathiaspaulenko.github.io/behave-model/api_reference/)
+
+</div>
+
+---
+
+`behave-model` provides a clean, stable, and extensible Python API that represents every element of a Behave project — features, rules, scenarios, steps, tags, tables, docstrings, and more. It is the foundation for an entire ecosystem of tools: formatters, linters, analyzers, report generators, and anything else that needs to understand `.feature` files.
+
+## Why?
+
+Every Behave tooling project currently parses `.feature` files independently. `behave-model` provides a single, well-tested domain model so that future tools can depend on it instead of reinventing the parser.
+
+- **Compatible with Behave 1.3.x** — Tag Expression v2 and Gherkin v6 (including `Rule` blocks)
+- **Clean domain model** — Pure dataclasses, no external runtime dependencies beyond Behave
+- **Visitor pattern** — Traverse the entire tree with custom visitors
+- **Query API** — Find features, scenarios, steps, and tags by name, tag, or keyword
+- **Serializers** — Dict, JSON, and pretty-printed Gherkin output
+- **Transformations** — Safe in-place modifications (rename tags, sort, normalize)
+- **Validation framework** — Pluggable rules with built-in checks
+- **95% test coverage** — Comprehensive unit, integration, and golden file tests
+
+## Installation
+
+```bash
+pip install behave-model
+```
+
+For development:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+from behave_model import load_project
+
+# Load all .feature files from a directory
+project = load_project("features/")
+
+# Access features, rules, and scenarios
+print(len(project.features))          # number of features
+print(project.features[0].name)       # first feature name
+print(len(project.features[0].rules)) # rules (Gherkin v6)
+
+# Query the model
+for scenario in project.find_scenarios(tag="@smoke"):
+    print(scenario.name)
+
+# Statistics
+stats = project.statistics()
+print(f"{stats['features']} features, {stats['scenarios']} scenarios, {stats['steps']} steps")
+
+# Traverse the tree
+for node in project.walk():
+    print(type(node).__name__)
+```
+
+## Domain Model
+
+```text
+Project
+├── Metadata
+├── Feature
+│   ├── Tag
+│   ├── Background
+│   │   └── Step
+│   ├── Scenario
+│   │   ├── Tag
+│   │   └── Step
+│   ├── ScenarioOutline
+│   │   ├── Tag
+│   │   ├── Step
+│   │   └── Examples
+│   │       └── Table
+│   └── Rule (Gherkin v6)
+│       ├── Tag
+│       ├── Background
+│       │   └── Step
+│       ├── Scenario
+│       └── ScenarioOutline
+└── ...
+```
+
+Every node has a `Location` (filename, line, column) for precise source mapping.
+
+## Features at a Glance
+
+### Loading
+
+```python
+from behave_model import load_project, load_feature
+
+project = load_project("features/")               # all .feature files
+feature = load_feature("features/login.feature")  # single file
+```
+
+### Visitor Pattern
+
+```python
+from behave_model import Visitor
+
+class StepCounter(Visitor):
+    def __init__(self):
+        self.count = 0
+
+    def visit_step(self, step):
+        self.count += 1
+
+visitor = StepCounter()
+project.accept(visitor)
+print(f"Total steps: {visitor.count}")
+```
+
+### Query API
+
+```python
+project.find_feature("Login")
+project.find_tag("@smoke")
+project.find_scenarios(tag="@api")
+project.find_scenarios(name_contains="login")
+project.find_steps(keyword="Given")
+project.find_steps(text_contains="user")
+```
+
+### Serialization
+
+```python
+from behave_model import JsonSerializer, DictSerializer, PrettyPrinter
+
+# JSON
+json_str = JsonSerializer().serialize_project(project)
+
+# Dictionary
+data = DictSerializer().serialize_project(project)
+
+# Pretty-printed Gherkin
+text = PrettyPrinter().print_feature(feature)
+```
+
+### Transformations
+
+```python
+from behave_model import rename_tag, sort_tags, normalize_whitespace
+
+rename_tag(project, "@smoke", "@critical")
+sort_tags(project)
+normalize_whitespace(project)
+```
+
+### Validation
+
+```python
+from behave_model import Validator
+
+validator = Validator()
+issues = validator.validate(project)
+for issue in issues:
+    print(f"[{issue.severity}] {issue.rule_name}: {issue.message}")
+```
+
+## Architecture
+
+```text
+Feature File → Parser Adapter → Domain Model → Visitors → Queries → Transformations → Serializers
+```
+
+The Domain Model never depends on report generation or formatting. Each layer has a single responsibility and can be used independently.
+
+| Layer | Package | Responsibility |
+|-------|---------|----------------|
+| Parser Adapter | `behave_model.parser` | Wraps Behave's parser, adapts to domain model |
+| Domain Model | `behave_model.model` | Pure dataclasses for every Gherkin element |
+| Visitors | `behave_model.visitors` | Generic traversal pattern |
+| Queries | `behave_model.queries` | High-level filtering API |
+| Transformations | `behave_model.transformations` | Safe in-place modifications |
+| Serializers | `behave_model.serializers` | Dict, JSON, Gherkin output |
+| Validation | `behave_model.validation` | Pluggable rule framework |
+
+## Compatibility
+
+| Feature | Supported |
+|---------|-----------|
+| Behave 1.3.x | ✅ |
+| Tag Expression v1 | ✅ |
+| Tag Expression v2 | ✅ |
+| Gherkin v6 (Rules) | ✅ |
+| Scenario Outlines | ✅ |
+| Data Tables | ✅ |
+| DocStrings | ✅ |
+| Background | ✅ |
+| Multi-language features | ✅ |
+
+## Development
+
+```bash
+# Clone and install
+git clone https://github.com/MathiasPaulenko/behave-model.git
+cd behave-model
+pip install -e ".[dev]"
+
+# Run tests
+make test
+
+# Run tests with coverage
+make coverage
+
+# Lint
+make lint
+
+# Format
+make format
+
+# Build
+make build
+```
+
+## Documentation
+
+Full documentation is available at [mathiaspaulenko.github.io/behave-model](https://mathiaspaulenko.github.io/behave-model/).
+
+## Contributing
+
+Contributions are welcome! See [CONTRIBUTING.md](docs/contributing.md) for guidelines.
+
+## License
+
+MIT