GildedRose-Refactoring-Kata/README.md

# 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:

• 8.0+
• Composer

Recommended:

• Git

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

git clone git@github.com:thang-tran-nfq/GildedRose-Refactoring-Kata.git

or

git clone https://github.com/thang-tran-nfq/GildedRose-Refactoring-Kata.git

Install all the dependencies using composer

cd ./GildedRose-Refactoring-Kata
composer install

Dependencies

The project uses composer to install:

• PHPUnit
• ApprovalTests.PHP
• PHPStan
• Easy Coding Standard (ECS)

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
  • Items - This folder contains all Items Class
    • Abstract - This folder store Abstract of all Item Class
    • Interface - This folder store Interface of all Item Class
    • Factory - This folder store Factory, create Item instance
    • AgedBrieItem.php
    • BackstagePassItem.php
    • ConjuredItem.php
    • NormalItem.php
    • SulfurasItem.php
• 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

Fixture

To run the fixture from the php directory:

php .\fixtures\texttest_fixture.php 10

Change 10 to the required days.

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 tests

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

pu.bat

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.

The XDEbug extension is required for generating the coverage report.

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.bat

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.bat

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.bat

Happy coding!