The kata uses:

• Docker
• Docker compose plugin
• GNU make

Recommended:

• Git

See GitHub cloning a repository for details on how to create a local copy of this project on your computer.

git clone [email protected]:Redominus/crafters15-php.git

or

git clone https://github.com/Redominus/crafters15-php.git

Install all the dependencies using docker

cd ./crafters15-php
make install

Everything is handled by docker!

• src - contains the two classes:
  • Item.php - this class should not be changed
  • GildedRose.php - this class needs to be refactored, and the new feature added
• tests - contains the tests
  • GildedRoseTest.php - starter test.
    • Tip: ApprovalTests has been included as a dev dependency, see the PHP version of the Theatrical Players Refactoring Kata for an example
• Fixture
  • texttest_fixture.php this could be used by an ApprovalTests, or run from the command line

To run the fixture from the php directory:

make run-fixture days=10

Change 10 to the required days.

PHPUnit is configured for testing, a composer script has been provided. To run the unit tests, from the root of the PHP project run:

make tests

To run all test and generate a html coverage report run:

make test-coverage

The test-coverage report will be created in /builds, it is best viewed by opening /builds/index.html in your browser.

Easy Coding Standard (ECS) is configured for style and code standards, PSR-12 is used. The current code is not upto standard!

To check code, but not fix errors:

make check-cs

ECS provides may code fixes, automatically, if advised to run --fix, the following script can be run:

make fix-cs

PHPStan is used to run static analysis checks:

make phpstan

Happy coding!