 |
VOOZH | about |
|
VOOZH | about |
This document provides an overview of the Query Translator library's development infrastructure, including package management, testing framework, code quality tools, and the overall testing philosophy. It covers the development environment setup, available tooling, and how to work with the codebase during development.
For detailed information about the test suite structure and organization, see Test Suite. For CI/CD configuration details, see CI/CD Configuration.
The Query Translator library uses Composer for dependency management and autoloading, supporting PHP versions 7.0 through 8.5 to ensure broad compatibility across different environments.
The project configuration is defined in composer.json:
| Configuration | Details |
|---|---|
| PHP Requirement | ^7.0||^8.0 (PHP 7.0+ and 8.0+) |
| License | MIT |
| Type | Library |
| Autoloading | PSR-4: QueryTranslator\ → lib/ |
| Test Autoloading | PSR-4: QueryTranslator\Tests\ → tests/ |
The following development tools are required:
| Package | Version | Purpose |
|---|---|---|
phpunit/phpunit | <10 | Test framework |
symfony/phpunit-bridge | * | PHPUnit compatibility layer |
friendsofphp/php-cs-fixer | ^2.11 | Code style enforcement |
Sources: composer.json25-32 composer.json33-42
Sources: composer.json1-53 .gitignore1-5
The library uses PHPUnit as its primary testing framework, with comprehensive test coverage across all major components.
Tests are executed using the PHPUnit test runner configured in phpunit.xml. The test suite is structured to mirror the library's architecture, with separate test classes for each component.
Execute the test suite using the Composer script:
This command internally calls ./vendor/bin/phpunit as defined in the scripts section of composer.json.
Alternatively, run PHPUnit directly:
Code coverage analysis is enabled during CI runs on PHP 8.2 using Xdebug:
Coverage reports are uploaded to Codecov for tracking coverage trends over time. The coverage data helps identify untested code paths and ensures comprehensive test coverage.
Sources: composer.json43-47 .github/workflows/tests.yml67-73
The Query Translator library follows these testing principles:
Sources: .github/workflows/tests.yml16-39
The library uses PHP-CS-Fixer to enforce consistent code style based on Symfony coding standards. Configuration is defined in .php_cs.dist.
The code style configuration uses the following ruleset:
| Rule Category | Configuration |
|---|---|
| Base Rules | @Symfony, @Symfony:risky |
| Array Syntax | Short array syntax ([]) |
| Concatenation | One space around concatenation operator |
| Import Ordering | Alphabetically ordered imports |
| Class Elements | Ordered class elements (properties, methods) |
| Alignment | No phpdoc alignment |
| Useless Code | Remove useless else/return statements |
Fix code style issues automatically:
The fixer scans all PHP files in the project directory and applies the configured rules.
Sources: .php_cs.dist1-33 composer.json28-32
Sources: .php_cs.dist3-32
The typical development workflow involves:
lib/ directorytests/ directorycomposer test to verify changesphp-cs-fixer fix to ensure code style complianceThe following files are excluded from version control:
| File/Directory | Reason |
|---|---|
composer.lock | Environment-specific dependency resolution |
.php_cs.cache | PHP-CS-Fixer cache file |
.phpunit.result.cache | PHPUnit cache file |
vendor/ | Third-party dependencies |
These files are generated during development and should not be committed to the repository.
Sources: .gitignore1-5
The library employs GitHub Actions for continuous integration, running automated tests on every push and pull request. The CI pipeline ensures:
composer.json is validated for correctnessFor detailed information about the CI/CD configuration, matrix strategy, and coverage reporting, see CI/CD Configuration.
Sources: .github/workflows/tests.yml1-84
Sources: composer.json1-53 .github/workflows/tests.yml1-84 .php_cs.dist1-33
The test suite follows PSR-4 autoloading standards, with test classes organized under the QueryTranslator\Tests\ namespace mirroring the main library structure.
Sources: composer.json33-42
The Query Translator library maintains high code quality through a comprehensive development infrastructure:
This infrastructure ensures the library can be safely integrated into diverse projects while maintaining backward compatibility and code quality standards.
Refresh this wiki