Skip to content

Files

Latest commit

10d3cf7 · May 3, 2021

History

History
This branch is 359 commits behind emilybache/GildedRose-Refactoring-Kata:main.

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
May 3, 2021
Jul 23, 2020
May 3, 2021
Jul 23, 2020
Jul 23, 2020
May 3, 2021
Jul 23, 2020
May 3, 2021
May 3, 2021
May 3, 2021
Jul 23, 2020
May 3, 2021
May 3, 2021
Jul 23, 2020
Jul 23, 2020

GildedRose Kata - PHP Version

See the top level readme for general information about this exercise. This is the PHP version of the GildedRose Kata.

Installation

The kata uses:

Recommended:

Clone the repository

git clone [email protected]:emilybache/GildedRose-Refactoring-Kata.git

or

git clone https://github.com/emilybache/GildedRose-Refactoring-Kata.git

Install all the dependencies using composer

cd ./GildedRose-Refactoring-Kata/php
composer install

Dependencies

The project uses composer to install:

Folders

  • 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
  • Fixture
    • texttest_fixture.php this could be used by an ApprovalTests, or run from the command line

Testing

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

composer test

A Windows a batch file has been created, like an alias on Linux/Mac (e.g. alias pu="composer test"), the same PHPUnit composer test can be run:

pu

Tests with Coverage Report

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

composer test-coverage

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

Code Standard

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

Check Code

To check code, but not fix errors:

composer check-cs

On Windows a batch file has been created, like an alias on Linux/Mac (e.g. alias cc="composer check-cs"), the same PHPUnit composer check-cs can be run:

cc

Fix Code

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

composer fix-cs

On Windows a batch file has been created, like an alias on Linux/Mac (e.g. alias fc="composer fix-cs"), the same PHPUnit composer fix-cs can be run:

fc

Static Analysis

PHPStan is used to run static analysis checks:

composer phpstan

On Windows a batch file has been created, like an alias on Linux/Mac (e.g. alias ps="composer phpstan"), the same PHPUnit composer phpstan can be run:

ps

Happy coding!