StrictMethodsConstraint.php

StrictMethodsConstraint.php

<?php

declare(strict_types = 1);

namespace My\Vendor\PhpUnitStrict;

use PHPUnit\Framework\Constraint\Constraint;
use PHPUnit\Framework\MockObject\InvocationMocker;
use PHPUnit\Framework\MockObject\Matcher;
use PHPUnit\Framework\MockObject\MockObject;

/**
 * Usage:
 *
 * $constraint = new StrictMethodsConstraint($mockObject);
 *
 * $mockObject
 *     ->expects(new InvokedCount(0))
 *     ->method($constraint);
 */

class StrictMethodsConstraint extends Constraint
{
    /** @var MockObject */
    private $mockObject;

    /** @var string[] */
    private $methods = [];

    private $isRunning = false;

    public function __construct(MockObject $mockObject, string ...$methods)
    {
        parent::__construct();

        $this->mockObject = $mockObject;
        $this->methods    = $methods;
    }

    public function evaluate($other, $description = '', $returnResult = false)
    {
        if (in_array($other, $this->methods) || $this->isRunning) {
            return false;
        };

        $this->isRunning = true;

        /** @var InvocationMocker $mocker */
        $mocker = $this->mockObject->__phpunit_getInvocationMocker();

        $matcherProperty = new \ReflectionProperty(InvocationMocker::class, 'matchers');
        $matcherProperty->setAccessible(true);

        foreach ($matcherProperty->getValue($mocker) as $matcher) {
            /** @var Matcher $matcher */
            // MethodNameInvocation - is custom Invocation which contain only calling method name
            if ($matcher->getMethodNameMatcher()->matches(new MethodNameInvocation($other))) {
                $this->isRunning = false;

                return false;
            }
        }

        $this->isRunning = false;

        return true;
    }

    public function toString(): string
    {
        return '* is allowed';
    }
}