Download the PHP package php-kitchen/code-specs without Composer
On this page you can find all versions of the php package php-kitchen/code-specs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download php-kitchen/code-specs
More information about php-kitchen/code-specs
Files in php-kitchen/code-specs
Package code-specs
Short Description BDD extension for PHPUnit that allows to write tests as a specifications in a human-readable format.
License MIT
Homepage https://github.com/php-kitchen/code-specs
Informations about the package code-specs
NOTICE: Library is under refactoring for release of V5.0.0 and docs reflect the new style of specs
Code Specs isn't just another tests library - it's the way you design your solutions. The Specs Way.
Code Specs is built as a PHPUnit plugin(with Codeception support as well) for writing BDD style Unit tests in a specification way using human-readable format.
Goal of Code Specs is to add a bunch of cool tools for unit testing and show a way of representing unit tests as a behavior specifications that describes specific class behavior in variety of use-cases.
The min hero of Code Specs that does the magic is Tester. Tester represents an actor who ensures you code pass specifications(yes, like in Codeception - this library expired by Codeception). See iy by yourself:
CodeSpecs also decorates errors output so, for example, if "IncomeCalculator" service from example above will incorrectly calculate income the error output will include following message(example of output in PHPStorm):
Requirements
PHP >= 7.4
is required.
PHPUnit >= 9.1
is required.
Getting Started
Run the following command to add CodeSpecs to your project's composer.json
. See Packagist for specific versions.
Or you can copy this library from:
Then you can use CodeSpecs in your test simply extending from Specification
class. Example:
Note: If you want to use CodeSpecs with Codeception read Codeception integration guide
For additional information and guides go to the project documentation See update guide for information about upgrading to a next major version.
Contributing
If you want to ask any questions, suggest improvements or just to talk with community and developers, join our server at Discord Read organization contributing rules for additional information.
Spreading the Word
Acknowledging or citing CodeSpecs is as important as direct contributions.
If you are using CodeSpecs as part of an OpenSource project, a way to acknowledge it is to use a special badge in your README:
If your code is hosted at GitHub, you can place the following in your README.md file to get the badge:
or use regular HTML: