jlaswell/assert-php

Simple assertion library

v0.1.0 2024-11-08 15:00 UTC

Requires

• php: ^8.2
• vlucas/phpdotenv: ^5.6

Requires (Dev)

• phpunit/phpunit: ^11.4
• psalm/phar: ^5.26

MIT

• John Laswell

• testing
• test
• assert
• assertion
• jlaswell
• John Laswell

README

Assert is a simple set of assertions to help validate inputs, results, and business logic. Inspired by the thoughts of TigerBeatle and NASA’s Power of 10 Rules for Safety-Critical Code, this library aims to painfully enforce the validity in order to fail without the ability to subvert the issue.

Why not just assert()?

assert() is a (deprecated as of 8.3) built-in PHP method, designed for debugging, that will either throw an exception or omit a warning. assert-php is designed to throw exceptions only and to purposefully fail your production code in the cases of invalid expectations.

Usage

Usage of this library is simple: call one of the methods from the Assert class to validate your expectations. Do not attempt to try/catch these assertions, and instead, allow your program to truly fail in these cases. Using the that() method provides the best readability in my opinion.

// assert that the size of the $records array is greater than zero
Assert::that('array' === gettype($records));
Assert::that(sizeof($records) > 0);

Examples

public function fill(array $values): array
{
    Assert::that(sizeof($value) > 0);
    Assert::that(sizeof($values) === sizeof(array_filter($values, fn ($value) => is_int($value))));

    // logic can now perform on an array with values of integers
}

public function save(Contact[] $contacts): int
{
    foreach ($contacts as $contact) {
        Assert::that($contact->isValid());
        Assert::that(null === $contact->id);
    }

    // logic can now perform on an array of valid Contacts without a record id
}

All Assertions

<?php

use Jlaswell/Assert/Assert;

Assert::that('this' !== 'that');
Assert::isTrue(true);
Assert::isFalse(false);