Unit\Chekote\Phake\Expectation

Complexity

Total Complexity

5

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__call()	0	7	1
A	verify()	0	12	3
A	__construct()	0	4	1

<?php namespace Unit\Chekote\Phake;

use Phake\IMock;
use Phake\Proxies\AnswerBinderProxy;
use Phake\Proxies\StubberProxy;
use Phake\Proxies\VerifierProxy;
use Unit\Chekote\Phake\Exception\ExpectationException;

/**
 * Combines a Phake Stubber and Verifier to create an expectation.
 *
 * This class is used to accomplish something similar to Prophecy predictions, but without the opinionated restrictions
 * that come with that mocking framework.
 */
class Expectation
{
    /** the mock object */
    protected IMock $mock;

    /** the method expected to be called */
    protected string $method;

    /** the arguments expected to be passed to the method */
    protected array $args;

    /** the number of times the method is expected to be called */
    protected int $count;

    /**
     * Expectation constructor.
     *
     * @param IMock $mock  the mock object
     * @param int   $count number of times the method is expected to be called
     */
    public function __construct(IMock $mock, int $count)
    {
        $this->mock = $mock;
        $this->count = $count;
    }

    /**
     * Verifies that the expected method was called.
     *
     * @throws ExpectationException if a method has not been set for the expectation.
     * @throws ExpectationException if args have not been set for the expectation.
     * @return array|VerifierProxy
     */
    public function verify(): array|VerifierProxy
    {
        if (!isset($this->method)) {
            throw new ExpectationException('Expectation method was not set');
        }

        if (!isset($this->args)) {
            throw new ExpectationException('Expectation args were not set');
        }

        /** @var VerifierProxy $verifier */
        return Phake::verify($this->mock, Phake::times($this->count))->{$this->method}(...$this->args);
    }

    /**
     * Sets the expected method to be called.
     *
     * @param string $method the method that is expected to be called.
     * @param array  $args   the args that are expected to be passed to the method.
     *
     * @return AnswerBinderProxy|StubberProxy
     */
    public function __call(string $method, array $args): AnswerBinderProxy|StubberProxy
    {
        // record the method and args for verification later
        $this->method = $method;
        $this->args = $args;

        return Phake::when($this->mock)->$method(...$args);
    }
}