Skip to content

rskuipers/php-assumptions

Repository files navigation

PHP Assumptions

Build Status Scrutinizer Code Quality Code Coverage

Setup

$ composer require --dev rskuipers/php-assumptions

Introduction

PHP Assumptions is the result of a proof of concept inspired by the "From assumptions to assertions" blog post. It's a static code analysis tool doing checks for weak assumptions.

This is an example of an assumption:

if ($user !== null) { $user->logout(); }

Running bin/phpa on this file would yield the following output:

---------------------------------------------- | file | line | message | ============================================== | example.php | 3 | if ($user !== null) { | ---------------------------------------------- 1 out of 1 boolean expressions are assumptions (100%) 

This is an example of an assertion:

if ($user instanceof User) { $user->logout(); }

Tests

This project is built with PHPUnit and Prophecy. In order to run these tests make sure you have dev dependencies installed with composer.

Running PHPUnit:

$ ./vendor/bin/phpunit

About

Tool to detect assumptions

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 11

Languages