pitchart / phlunit

src/Check.php

<?php declare(strict_types=1);


namespace Pitchart\Phlunit;

use Pitchart\Phlunit\Checks\ArrayCheck;
use Pitchart\Phlunit\Checks\BooleanCheck;
use Pitchart\Phlunit\Checks\CallableCheck;
use Pitchart\Phlunit\Checks\CollectionCheck;
use Pitchart\Phlunit\Checks\DateTimeCheck;
use Pitchart\Phlunit\Checks\ExceptionCheck;
use Pitchart\Phlunit\Checks\FloatCheck;
use Pitchart\Phlunit\Checks\FluentCheck;
use Pitchart\Phlunit\Checks\GenericCheck;
use Pitchart\Phlunit\Checks\IntegerCheck;
use Pitchart\Phlunit\Checks\ResponseCheck;
use Pitchart\Phlunit\Checks\StringCheck;
use Psr\Http\Message\ResponseInterface;

final class Check
{
    /**
     * @var array<string, class-string>

The doc comment array<string, class-string> at position 4 could not be parsed: Unknown type name 'class-string' at position 4 in array<string, class-string>.

     */
    private static $assertionClassesMap = [
        'string' => StringCheck::class,
        'boolean' => BooleanCheck::class,
        'integer' => IntegerCheck::class,
        'float' => FloatCheck::class,
        'double' => FloatCheck::class,
        'array' => ArrayCheck::class,
        'iterable' => CollectionCheck::class,
        'callable' => CallableCheck::class,
        \Throwable::class => ExceptionCheck::class,
        ResponseInterface::class => ResponseCheck::class,
        \DateTimeInterface::class => DateTimeCheck::class,
    ];

    private static function hasAssertionClass(string $type): bool
    {
        return isset(self::$assertionClassesMap[$type]) && \class_exists(self::$assertionClassesMap[$type]);
    }


    /**
     * @template T
     * @param mixed $sut
     * @psalm-param T of mixed
     * @psalm-return FluentCheck<T>
     * @return BooleanCheck|GenericCheck|CallableCheck|CollectionCheck|ResponseCheck|ArrayCheck|DateTimeCheck|StringCheck|ExceptionCheck|FloatCheck|IntegerCheck
     *
     */
    public static function that($sut): FluentCheck
    {
        if (\is_object($sut)) {
            if (self::hasAssertionClass(\get_class($sut))) {
                return new self::$assertionClassesMap[\get_class($sut)]($sut);
            }
            foreach (\array_keys(self::$assertionClassesMap) as $class) {
                if ($sut instanceof $class) {
                    return new self::$assertionClassesMap[$class]($sut);
                }
            }
        }
        if (\is_callable($sut)) {
            return new self::$assertionClassesMap['callable']($sut);
        }
        if (\is_array($sut)) {
            return new self::$assertionClassesMap['array']($sut);
        }
        if (\is_iterable($sut)) {
            return new self::$assertionClassesMap['iterable']($sut);
        }
        $type = \gettype($sut);
        if (self::hasAssertionClass($type)) {
            return new self::$assertionClassesMap[$type]($sut);
        }
        return new GenericCheck($sut);
    }

    /**
     * @param callable $function
     *
     * @return CallableCheck
     */
    public static function thatCall(callable $function): CallableCheck
    {
        return self::that($function);

The expression return self::that($function) returns the type Pitchart\Phlunit\Checks\GenericCheck which is incompatible with the type-hinted return Pitchart\Phlunit\Checks\CallableCheck.

    }

    /**
     * @param string $className
     * @param class-string $assertionClass

The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.

     */
    public static function registerChecksFor(string $className, string $assertionClass): void
    {
        self::$assertionClassesMap[$className] = $assertionClass;
    }
}