wexample-wex-addon-dev-php 12.10.0__tar.gz → 12.11.1__tar.gz

wexample_wex_addon_dev_php-12.11.1/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.1
+Name: wexample-wex-addon-dev-php
+Version: 12.11.1
+Summary: Extends wex with PHP-specific development commands for Composer, Laravel, Symfony, and WordPress services running in Docker containers
+Author-Email: weeger <contact@wexample.com>
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Project-URL: homepage, https://github.com/wexample/python-wex-dev-python
+Requires-Python: >=3.10
+Requires-Dist: attrs>=23.1.0
+Requires-Dist: cattrs>=23.1.0
+Requires-Dist: wexample-filestate-php>=6.5.0
+Requires-Dist: wexample-filestate-symfony>=2.1.0
+Requires-Dist: wexample-wex-addon-ai>=19.0.0
+Requires-Dist: wexample-wex-addon-app>=34.3.0
+Requires-Dist: wexample-wex-addon-dev-javascript>=8.6.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Description-Content-Type: text/markdown
+
+# wex_addon_dev_php
+
+Version: 12.11.1
+
+Extends wex with PHP-specific development commands for Composer, Laravel, Symfony, and WordPress services running in Docker containers
+
+## Table of Contents
+
+- [Install](#install)
+- [Tests](#tests)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+
+## Installation
+
+```bash
+pip install wexample-wex-addon-dev-php
+```
+
+Requires Python >=3.10.
+
+## Tests
+
+This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
+
+### Installation
+
+First, install the required testing dependencies:
+```bash
+.venv/bin/python -m pip install pytest pytest-cov
+```
+
+### Basic Usage
+
+Run all tests with coverage:
+```bash
+.venv/bin/python -m pytest --cov --cov-report=html
+```
+
+### Common Commands
+```bash
+# Run tests with coverage for a specific module
+.venv/bin/python -m pytest --cov=your_module
+
+# Show which lines are not covered
+.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
+
+# Generate an HTML coverage report
+.venv/bin/python -m pytest --cov=your_module --cov-report=html
+
+# Combine terminal and HTML reports
+.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
+
+# Run specific test file with coverage
+.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
+```
+
+### Viewing HTML Reports
+
+After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
+
+### Coverage Threshold
+
+To enforce a minimum coverage percentage:
+```bash
+.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
+```
+
+This will cause the test suite to fail if coverage drops below 80%.
+
+## Known Limitations & Roadmap
+
+Current limitations and planned features are tracked in the GitHub issues.
+
+See the [project roadmap](https://github.com/wexample/python-wex_addon_dev_php/issues) for upcoming features and improvements.
+
+## Status & Compatibility
+
+**Maturity**: Production-ready
+
+**Python Support**: >=3.10
+
+**OS Support**: Linux, macOS, Windows
+
+**Status**: Actively maintained
+
+## Useful Links
+
+- **Homepage**: https://github.com/wexample/python-wex-addon-dev-php
+- **Issue Tracker**: https://github.com/wexample/python-wex-addon-dev-php/issues
+- **Discussions**: https://github.com/wexample/python-wex-addon-dev-php/discussions
+- **PyPI**: [pypi.org/project/wexample-wex-addon-dev-php](https://pypi.org/project/wexample-wex-addon-dev-php/)

wexample_wex_addon_dev_php-12.11.1/README.md

@@ -0,0 +1,93 @@
+# wex_addon_dev_php
+
+Version: 12.11.1
+
+Extends wex with PHP-specific development commands for Composer, Laravel, Symfony, and WordPress services running in Docker containers
+
+## Table of Contents
+
+- [Install](#install)
+- [Tests](#tests)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+
+## Installation
+
+```bash
+pip install wexample-wex-addon-dev-php
+```
+
+Requires Python >=3.10.
+
+## Tests
+
+This project uses `pytest` for testing and `pytest-cov` for code coverage analysis.
+
+### Installation
+
+First, install the required testing dependencies:
+```bash
+.venv/bin/python -m pip install pytest pytest-cov
+```
+
+### Basic Usage
+
+Run all tests with coverage:
+```bash
+.venv/bin/python -m pytest --cov --cov-report=html
+```
+
+### Common Commands
+```bash
+# Run tests with coverage for a specific module
+.venv/bin/python -m pytest --cov=your_module
+
+# Show which lines are not covered
+.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing
+
+# Generate an HTML coverage report
+.venv/bin/python -m pytest --cov=your_module --cov-report=html
+
+# Combine terminal and HTML reports
+.venv/bin/python -m pytest --cov=your_module --cov-report=term-missing --cov-report=html
+
+# Run specific test file with coverage
+.venv/bin/python -m pytest tests/test_file.py --cov=your_module --cov-report=term-missing
+```
+
+### Viewing HTML Reports
+
+After generating an HTML report, open `htmlcov/index.html` in your browser to view detailed line-by-line coverage information.
+
+### Coverage Threshold
+
+To enforce a minimum coverage percentage:
+```bash
+.venv/bin/python -m pytest --cov=your_module --cov-fail-under=80
+```
+
+This will cause the test suite to fail if coverage drops below 80%.
+
+## Known Limitations & Roadmap
+
+Current limitations and planned features are tracked in the GitHub issues.
+
+See the [project roadmap](https://github.com/wexample/python-wex_addon_dev_php/issues) for upcoming features and improvements.
+
+## Status & Compatibility
+
+**Maturity**: Production-ready
+
+**Python Support**: >=3.10
+
+**OS Support**: Linux, macOS, Windows
+
+**Status**: Actively maintained
+
+## Useful Links
+
+- **Homepage**: https://github.com/wexample/python-wex-addon-dev-php
+- **Issue Tracker**: https://github.com/wexample/python-wex-addon-dev-php/issues
+- **Discussions**: https://github.com/wexample/python-wex-addon-dev-php/discussions
+- **PyPI**: [pypi.org/project/wexample-wex-addon-dev-php](https://pypi.org/project/wexample-wex-addon-dev-php/)

{wexample_wex_addon_dev_php-12.10.0 → wexample_wex_addon_dev_php-12.11.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
 
 [project]
 name = "wexample-wex-addon-dev-php"
-version = "12.10.0"
+version = "12.11.1"
 description = "Extends wex with PHP-specific development commands for Composer, Laravel, Symfony, and WordPress services running in Docker containers"
 authors = [
     { name = "weeger", email = "contact@wexample.com" },
@@ -23,8 +23,8 @@ dependencies = [
     "wexample-filestate-php>=6.5.0",
     "wexample-filestate-symfony>=2.1.0",
     "wexample-wex-addon-ai>=19.0.0",
-    "wexample-wex-addon-app>=34.0.0",
-    "wexample-wex-addon-dev-javascript>=8.5.0",
+    "wexample-wex-addon-app>=34.3.0",
+    "wexample-wex-addon-dev-javascript>=8.6.0",
 ]
 
 [project.readme]

wexample_wex_addon_dev_php-12.11.1/src/wexample_wex_addon_dev_php/resources/package_gitlab_ci.yml

@@ -0,0 +1,4 @@
+include:
+  - remote: 'https://gitlab.wexample.com/wexample-public/ci-cd/-/raw/main/.gitlab-ci.type.composer.package.yml'
+variables:
+  MAIN_BRANCH_NAME: main

{wexample_wex_addon_dev_php-12.10.0 → wexample_wex_addon_dev_php-12.11.1}/src/wexample_wex_addon_dev_php/workdir/php_package_workdir.py

@@ -18,6 +18,7 @@ from wexample_wex_addon_app.workdir.mixin.with_runner_workdir_mixin import (
 from wexample_wex_addon_dev_php.workdir.php_workdir import PhpWorkdir
 
 if TYPE_CHECKING:
+    from wexample_config.const.types import DictConfig
     from wexample_filestate.config_value.readme_content_config_value import (
         ReadmeContentConfigValue,
     )
@@ -67,6 +68,34 @@ class PhpPackageWorkdir(WithRunnerWorkdirMixin, PhpWorkdir):
             )
         }
 
+    def prepare_value(self, raw_value: DictConfig | None = None) -> DictConfig:
+        from wexample_filestate.const.disk import DiskItemType
+        from wexample_helpers.helper.file import file_read
+        from wexample_helpers.helper.module import module_get_path
+
+        import wexample_wex_addon_dev_php
+
+        raw_value = super().prepare_value(raw_value=raw_value)
+
+        # Every package is tested by GitLab at each push, the way a consumer
+        # installs it. The file is only an include: the job itself lives in
+        # the ci-cd repository, one place to change for every package. Created
+        # when absent, never rewritten: a package may add to it.
+        raw_value["children"].append(
+            {
+                "name": ".gitlab-ci.yml",
+                "type": DiskItemType.FILE,
+                "should_exist": True,
+                "default_content": lambda _: file_read(
+                    module_get_path(wexample_wex_addon_dev_php)
+                    / "resources"
+                    / "package_gitlab_ci.yml"
+                ),
+            }
+        )
+
+        return raw_value
+
     def search_imports_in_codebase(
         self, searched_package: PhpPackageWorkdir
     ) -> list[SearchResult]: