wexample-wex-addon-dev-php 0.0.41__tar.gz → 0.1.1__tar.gz

wexample_wex_addon_dev_php-0.1.1/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.1
+Name: wexample-wex-addon-dev-php
+Version: 0.1.1
+Summary: Python dev addon for wex
+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>=0.1.0
+Requires-Dist: wexample-wex-addon-app>=1.1.0
+Requires-Dist: wexample-wex-addon-dev-javascript>=0.1.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: 0.1.1
+
+Python dev addon for wex
+
+## Table of Contents
+
+- [Tests](#tests)
+- [Suite Integration](#suite-integration)
+- [Dependencies](#dependencies)
+- [Versioning](#versioning)
+- [License](#license)
+- [Suite Integration](#suite-integration)
+- [Suite Signature](#suite-signature)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+- [Migration Notes](#migration-notes)
+
+## 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%.
+
+## Integration in the Suite
+
+This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
+
+### Related Packages
+
+The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
+
+Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
+
+## Dependencies
+
+- attrs: >=23.1.0
+- cattrs: >=23.1.0
+- wexample-filestate-php: >=0.1.0
+- wexample-wex-addon-app: >=1.1.0
+- wexample-wex-addon-dev-javascript: >=0.1.0
+
+## Versioning & Compatibility Policy
+
+Wexample packages follow **Semantic Versioning** (SemVer):
+
+- **MAJOR**: Breaking changes
+- **MINOR**: New features, backward compatible
+- **PATCH**: Bug fixes, backward compatible
+
+We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+Free to use in both personal and commercial projects.
+
+## Integration in the Suite
+
+This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
+
+### Related Packages
+
+The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
+
+Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
+
+# About us
+
+[Wexample](https://wexample.com) stands as a cornerstone of the digital ecosystem — a collective of seasoned engineers, researchers, and creators driven by a relentless pursuit of technological excellence. More than a media platform, it has grown into a vibrant community where innovation meets craftsmanship, and where every line of code reflects a commitment to clarity, durability, and shared intelligence.
+
+This packages suite embodies this spirit. Trusted by professionals and enthusiasts alike, it delivers a consistent, high-quality foundation for modern development — open, elegant, and battle-tested. Its reputation is built on years of collaboration, refinement, and rigorous attention to detail, making it a natural choice for those who demand both robustness and beauty in their tools.
+
+Wexample cultivates a culture of mastery. Each package, each contribution carries the mark of a community that values precision, ethics, and innovation — a community proud to shape the future of digital craftsmanship.
+
+## 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
+- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
+- **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/wex_addon_dev_php](https://pypi.org/project/wex_addon_dev_php/)
+
+## Migration Notes
+
+When upgrading between major versions, refer to the migration guides in the documentation.
+
+Breaking changes are clearly documented with upgrade paths and examples.

wexample_wex_addon_dev_php-0.1.1/README.md

@@ -0,0 +1,150 @@
+# wex_addon_dev_php
+
+Version: 0.1.1
+
+Python dev addon for wex
+
+## Table of Contents
+
+- [Tests](#tests)
+- [Suite Integration](#suite-integration)
+- [Dependencies](#dependencies)
+- [Versioning](#versioning)
+- [License](#license)
+- [Suite Integration](#suite-integration)
+- [Suite Signature](#suite-signature)
+- [Roadmap](#roadmap)
+- [Status Compatibility](#status-compatibility)
+- [Useful Links](#useful-links)
+- [Migration Notes](#migration-notes)
+
+## 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%.
+
+## Integration in the Suite
+
+This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
+
+### Related Packages
+
+The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
+
+Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
+
+## Dependencies
+
+- attrs: >=23.1.0
+- cattrs: >=23.1.0
+- wexample-filestate-php: >=0.1.0
+- wexample-wex-addon-app: >=1.1.0
+- wexample-wex-addon-dev-javascript: >=0.1.0
+
+## Versioning & Compatibility Policy
+
+Wexample packages follow **Semantic Versioning** (SemVer):
+
+- **MAJOR**: Breaking changes
+- **MINOR**: New features, backward compatible
+- **PATCH**: Bug fixes, backward compatible
+
+We maintain backward compatibility within major versions and provide clear migration guides for breaking changes.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+Free to use in both personal and commercial projects.
+
+## Integration in the Suite
+
+This package is part of the Wexample Suite — a collection of high-quality, modular tools designed to work seamlessly together across multiple languages and environments.
+
+### Related Packages
+
+The suite includes packages for configuration management, file handling, prompts, and more. Each package can be used independently or as part of the integrated suite.
+
+Visit the [Wexample Suite documentation](https://docs.wexample.com) for the complete package ecosystem.
+
+# About us
+
+[Wexample](https://wexample.com) stands as a cornerstone of the digital ecosystem — a collective of seasoned engineers, researchers, and creators driven by a relentless pursuit of technological excellence. More than a media platform, it has grown into a vibrant community where innovation meets craftsmanship, and where every line of code reflects a commitment to clarity, durability, and shared intelligence.
+
+This packages suite embodies this spirit. Trusted by professionals and enthusiasts alike, it delivers a consistent, high-quality foundation for modern development — open, elegant, and battle-tested. Its reputation is built on years of collaboration, refinement, and rigorous attention to detail, making it a natural choice for those who demand both robustness and beauty in their tools.
+
+Wexample cultivates a culture of mastery. Each package, each contribution carries the mark of a community that values precision, ethics, and innovation — a community proud to shape the future of digital craftsmanship.
+
+## 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
+- **Documentation**: [docs.wexample.com](https://docs.wexample.com)
+- **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/wex_addon_dev_php](https://pypi.org/project/wex_addon_dev_php/)
+
+## Migration Notes
+
+When upgrading between major versions, refer to the migration guides in the documentation.
+
+Breaking changes are clearly documented with upgrade paths and examples.

{wexample_wex_addon_dev_php-0.0.41 → wexample_wex_addon_dev_php-0.1.1}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "pdm.backend"
 
 [project]
 name = "wexample-wex-addon-dev-php"
-version = "0.0.41"
+version = "0.1.1"
 description = "Python dev addon for wex"
 authors = [
     { name = "weeger", email = "contact@wexample.com" },
@@ -18,8 +18,11 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 dependencies = [
-    "pydantic>=2,<3",
-    "wexample-wex-core==6.0.43",
+    "attrs>=23.1.0",
+    "cattrs>=23.1.0",
+    "wexample-filestate-php>=0.1.0",
+    "wexample-wex-addon-app>=1.1.0",
+    "wexample-wex-addon-dev-javascript>=0.1.0",
 ]
 
 [project.readme]
@@ -35,16 +38,51 @@ homepage = "https://github.com/wexample/python-wex-dev-python"
 [project.optional-dependencies]
 dev = [
     "pytest",
+    "pytest-cov",
+]
+
+[tool.setuptools.packages.find]
+include = [
+    "*",
+]
+exclude = [
+    "wexample_wex_addon_dev_php.testing*",
 ]
 
 [tool.pdm]
 distribution = true
 
 [tool.pdm.build]
-includes = [
-    "src/wexample_wex_addon_dev_php/py.typed",
-]
 package-dir = "src"
 packages = [
     { include = "wexample_wex_addon_dev_php", from = "src" },
 ]
+
+[tool.pytest.ini_options]
+testpaths = [
+    "tests",
+]
+pythonpath = [
+    "src",
+]
+
+[tool.coverage.run]
+source = [
+    "wexample_wex_addon_dev_php",
+]
+omit = [
+    "*/tests/*",
+    "*/.venv/*",
+    "*/venv/*",
+]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "@abstractmethod",
+]

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/config_value/php_package_readme_config_value.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from wexample_helpers.decorator.base_class import base_class
+from wexample_wex_addon_app.config_value.app_readme_config_value import (
+    AppReadmeConfigValue,
+)
+
+
+@base_class
+class PhpPackageReadmeContentConfigValue(AppReadmeConfigValue):
+    """README generation for Php packages."""
+
+    def _get_app_description(self) -> str:
+        return self.workdir.get_app_config().get("description", "")

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/file/php_composer_json_file.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from wexample_filestate.item.file.json_file import JsonFile
+from wexample_helpers.decorator.base_class import base_class
+from wexample_wex_addon_app.item.file.mixin.app_dependencies_config_file_mixin import (
+    AppDependenciesConfigFileMixin,
+)
+
+
+@base_class
+class PhpComposerJsonFile(AppDependenciesConfigFileMixin, JsonFile):
+    def add_dependency(
+        self,
+        # In composer, no operator says ==
+        operator: str = "",
+        **kwargs,
+    ) -> bool:
+        return super().add_dependency(operator=operator, **kwargs)
+
+    def add_dependency_from_string(
+        self,
+        package_name: str,
+        version: str,
+        operator: str = "",
+        optional: bool = False,
+        group: None | str = None,
+    ) -> bool:
+        """
+        Add or update a Composer dependency using raw package name + version.
+        Returns True if the dependency list changed.
+        """
+        # Composer group
+        group_key = "require-dev" if group == "dev" else "require"
+
+        # Composer uses simple version constraints (no pip-style operators)
+        constraint = f"{operator}{version}".strip()
+
+        config = self.read_config()
+
+        # Extract or create dependency dictionary
+        deps_node = config.search(path=group_key, default={})
+        deps = deps_node.to_dict() if deps_node else {}
+
+        old = deps.get(package_name)
+
+        # No change needed
+        if old == constraint:
+            return False
+
+        # Apply change
+        deps[package_name] = constraint
+
+        config.update_nested({group_key: deps})
+        self.write_config(config)
+
+        return True
+
+    def dumps(self, content: dict | None = None) -> str:
+        content = content or self.read_parsed()
+
+        workdir = self.get_parent_item()
+        content["name"] = workdir.get_package_name()
+        content["version"] = workdir.get_project_version()
+
+        return super().dumps(content or {})
+
+    def get_dependencies_versions(
+        self, optional: bool = False, group: str = "dev"
+    ) -> dict[str, str]:
+        # Default values is not well managed in nested config value, for now.
+        require = self.read_config().search(path="require")
+
+        if not require:
+            return {}
+
+        return require.get_dict_or_default(default={})

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/php_addon_manager.py

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from typing import Any
+
+from wexample_wex_core.common.abstract_addon_manager import AbstractAddonManager
+
+
+class PhpAddonManager(AbstractAddonManager):
+    @classmethod
+    def get_package_module(cls) -> Any:
+        import wexample_wex_addon_dev_php
+
+        return wexample_wex_addon_dev_php

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/resources/docker/Dockerfile.roave

@@ -0,0 +1,22 @@
+FROM php:8.4-cli
+
+RUN apt-get update && apt-get install -y \
+    git \
+    unzip \
+    libicu-dev \
+    && rm -rf /var/lib/apt/lists/* \
+    && docker-php-ext-install bcmath intl
+
+RUN groupadd -g 1000 appuser && \
+    useradd -m -u 1000 -g 1000 -s /bin/bash appuser
+
+COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+
+USER appuser
+RUN composer global require roave/backward-compatibility-check
+
+ENV PATH="/home/appuser/.composer/vendor/bin:${PATH}"
+
+WORKDIR /var/www/html
+
+CMD ["tail", "-f", "/dev/null"]

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/services/laravel/docker/docker-compose.yml

@@ -0,0 +1,6 @@
+services:
+  laravel:
+    container_name: ${APP_PROJECT_NAME}_laravel
+    extends:
+      file: ${SERVICE_PHP_COMPOSE}
+      service: php

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/services/laravel/samples/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  laravel:
+    extends:
+      file: ${SERVICE_LARAVEL_COMPOSE}
+      service: laravel

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/services/laravel/samples/env/dev/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  laravel:
+    environment:
+      - LETSENCRYPT_HOST=${APP_DOMAINS_STRING}
+      - LETSENCRYPT_EMAIL=${APP_EMAIL}

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/services/laravel/samples/env/prod/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  laravel:
+    environment:
+      - LETSENCRYPT_HOST=${APP_DOMAINS_STRING}
+      - LETSENCRYPT_EMAIL=${APP_EMAIL}

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/services/laravel/service.yml

@@ -0,0 +1,6 @@
+name: laravel
+extends: php
+dependencies:
+  - mysql
+docker:
+  compose: docker/docker-compose.yml

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/services/php/docker/docker-compose.yml

@@ -0,0 +1,19 @@
+services:
+  php:
+    container_name: ${APP_PROJECT_NAME}_php
+    image: wexample/php-8.2:latest
+    expose:
+      - 80
+    environment:
+      - VIRTUAL_HOST=${APP_DOMAINS_STRING}
+      - VIRTUAL_PORT=80
+    volumes:
+      - /var/www/html/.git
+      - /var/www/html/.wex
+      - ${APP_PATH}:/var/www/html
+      - ${BIND_WEB_PHP_INI}:/usr/local/etc/php/conf.d/web.ini:ro
+      - ${BIND_WEB_APACHE_CONF}:/etc/apache2/sites-enabled/000-default.conf:ro
+      - ${APP_SETUP_PATH}env/${APP_ENV}/cron/default.cron:/var/default.cron
+    extends:
+      file: ${SERVICE_DEFAULT_COMPOSE}
+      service: default

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/services/php/samples/apache/web.conf

@@ -0,0 +1,13 @@
+<VirtualHost *:80>
+  DocumentRoot "/var/www/html"
+
+  <Directory "/var/www/html">
+    Options Indexes FollowSymLinks
+    AllowOverride All
+    Require all granted
+  </Directory>
+
+  <FilesMatch ".php$">
+     SetHandler "proxy:unix:/var/run/php/php8.2-fpm.sock|fcgi://localhost/"
+  </FilesMatch>
+</VirtualHost>

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/services/php/samples/docker/docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  php:
+    extends:
+      file: ${SERVICE_PHP_COMPOSE}
+      service: php

wexample_wex_addon_dev_php-0.1.1/src/wexample_wex_addon_dev_php/services/php/samples/env/dev/cron/default.cron

@@ -0,0 +1 @@
+#* * * * * echo "Hello world" > /var/log/cron.log 2>&1