yann-bauduin / kata-tp

Racing Car Katas

This is the PHP version of the Racing Car Katas.

Installation

The project uses:

• PHP 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 [e-mail]:emilybache/Racing-Car-Katas.git

or

git clone https://github.com/emilybache/Racing-Car-Katas.git

Install all the dependencies using composer

cd ./Racing-Car-Katas/php
composer install

Run all the tests

composer tests

Dependencies

The project uses composer to install:

• PHPUnit
• PHPStan
• Easy Coding Standard (ECS)

Folders

• src - Contains the five exercise:
  • TirePressureMonitoringSystem
  • TextConverter
  • TicketDispenser
  • TelemetrySystem
  • Leaderboard
• tests - Contains the corresponding tests

Testing

PHPUnit is used to run tests, to help this can be run using a composer script. To run the unit tests, from the root of the project run:

composer tests

On Windows a batch file has been created, similar to an alias on Linux/Mac (e.g. alias pu="composer tests"), the same 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 coverage report is created in /builds, it is best viewed by opening /builds/index.html in your browser.

The XDEbug extension is required for coverage report generating.

Code Standard

Easy Coding Standard (ECS) is used to check for style and code standards, PSR-12 is used.

Check Code

To check code, but not fix errors:

composer check-cs

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

cc.bat

Fix Code

Many code fixes are automatically provided by ECS, if advised to run --fix, the following script can be run:

composer fix-cs

On Windows a batch file has been created, similar to an alias on Linux/Mac (e.g. alias fc="composer fix-cs"), the same 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, similar to an alias on Linux/Mac (e.g. alias ps="composer phpstan"), the same composer phpstan can be run:

ps.bat

Happy coding!