friends-of-phpspec / phpspec-requires
PHPSpec extension that allows you to use the @requires annotation.
Fund package maintenance!
drupol
Requires
- php: >= 7.1
- drupol/phposinfo: ^1
- phpspec/phpspec: ^5 || ^6
Requires (Dev)
- drupol/php-conventions: ^1.6.11
- friends-of-phpspec/phpspec-code-coverage: ^4.3.2
- phpspec/phpspec: ^5 || ^6
- scrutinizer/ocular: ^1.6
This package is auto-updated.
Last update: 2022-03-21 10:51:58 UTC
README
PHPSpec requires extension
A PHPSpec extension that allows you to use the
annotation @requires
.
Installation
composer require friends-of-phpspec/phpspec-requires --dev
Usage
Enable extension in phpspec.yml
(or phpspec.yml.dist
) file:
extensions: FriendsOfPhpspec\PhpspecRequires\PhpspecRequires: ~
Then, you can use the annotation @requires
in the documentation block of your
spec methods.
/** * @requires OS Windows */ public function it_will_be_tested_on_windows_operating_system_only() { // test code here } /** * @requires OSFAMILY bsd */ public function it_will_be_tested_on_bsd_operating_system_family() { // test code here } /** * @requires function customFunction */ public function it_will_be_tested_only_if_the_function_is_found() { // test code here } /** * @requires extension mysqli */ public function it_will_be_tested_only_if_extension_is_found() { // test code here } /** * @requires PHP 7.3 */ public function it_will_be_tested_only_if_php_version_is_equal_or_greater() { // test code here }
Todo
- Tests
Contributing
See the file CONTRIBUTING.md but feel free to contribute to this library by sending Github pull requests.