ekvedaras / laravel-test-helpers

src/Traits/Helpers/BuildsMocks.php

<?php

declare(strict_types=1);

namespace Ekvedaras\LaravelTestHelpers\Traits\Helpers;

use Mockery;
use ReflectionClass;
use ReflectionException;
use Mockery\Instantiator;
use Mockery\MockInterface;
use Illuminate\Foundation\Application;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit_Framework_MockObject_MockObject;
use PHPUnit\Framework\MockObject\MockBuilder;
use Ekvedaras\LaravelTestHelpers\Helpers\TestHelpersMock;
use Ekvedaras\LaravelTestHelpers\Exceptions\MockInjectionException;

/**
 * Trait BuildsMocks.
 *
 * @property-read Application $app
 * @method MockBuilder getMockBuilder(string $mockClass)
 */
trait BuildsMocks
{
    /**
     * @param string $mockClass
     * @param string|null $injectorClass
     * @param array|null|bool $methods
     * @param array|null $constructorArgs
     * @param bool $onlyForInjector
     * @return PHPUnit_Framework_MockObject_MockObject|TestHelpersMock
     */
    protected function mock(
        string $mockClass,
        string $injectorClass = null,
        $methods = false,
        array $constructorArgs = null,
        bool $onlyForInjector = false
    ): PHPUnit_Framework_MockObject_MockObject {
        $this->forgetInstances($mockClass, $injectorClass);
        $mock = $this->createPHPUnitMock($mockClass, $constructorArgs, $methods);
        $this->injectMockToLaravel($mockClass, $mock, $onlyForInjector, $injectorClass);

        return $mock;
    }

    /**
     * @param string $mockClass
     * @param string|null $injectorClass
     * @param bool $onlyForInjector
     * @return MockInterface
     */
    protected function mockery(
        string $mockClass,
        string $injectorClass = null,
        bool $onlyForInjector = false
    ): MockInterface {
        $this->forgetInstances($mockClass, $injectorClass);
        $mock = Mockery::mock($mockClass);
        $this->injectMockToLaravel($mockClass, $mock, $onlyForInjector, $injectorClass);

        return $mock;
    }

    /**
     * @param string $mockClass
     * @param string|null $injectorClass
     * @param bool $onlyForInjector
     * @return MockInterface
     */
    protected function spy(
        string $mockClass,
        string $injectorClass = null,
        bool $onlyForInjector = false
    ): MockInterface {
        $this->forgetInstances($mockClass, $injectorClass);
        $mock = Mockery::spy($mockClass);
        $this->injectMockToLaravel($mockClass, $mock, $onlyForInjector, $injectorClass);

        return $mock;
    }

    /**
     * @param string $mockClass
     * @param string|null $injectorClass
     */
    private function forgetInstances(string $mockClass, string $injectorClass = null): void
    {
        $this->app->forgetInstance($mockClass);

        if (isset($injectorClass)) {
            $this->app->forgetInstance($injectorClass);
        }
    }

    /**
     * @param string $mockClass
     * @param array|null $constructorArgs
     * @param array|null|bool $methods
     * @return PHPUnit_Framework_MockObject_MockObject|TestHelpersMock
     * @throws ReflectionException
     */
    private function createPHPUnitMock(
        string $mockClass,
        array $constructorArgs = null,
        $methods = false
    ): PHPUnit_Framework_MockObject_MockObject {
        $builder = $this->getMockBuilder($mockClass);

        if (isset($constructorArgs)) {
            $builder->setConstructorArgs($constructorArgs);
        } else {
            $builder->disableOriginalConstructor();
        }

        if ($methods !== false) {
            $builder->setMethods($methods);

It seems like $methods defined by parameter $methods on line 108 can also be of type boolean; however, PHPUnit\Framework\MockObject\MockBuilder::setMethods() does only seem to accept null|array, maybe add an additional type check?

        }

        $mock = $builder->getMock();
        $mockedClass = get_class($mock);
        $helperClass = $this->getClassShortName(TestHelpersMock::class);
        $wrapperClass = $helperClass.'_'.$mockedClass.'_'.str_random();

        $template = file_get_contents(__DIR__.'/../../Helpers/TestHelpersMock.php');
        $template = str_replace("class $helperClass", "class $wrapperClass extends $mockedClass", $template);
        $template = substr($template, strpos($template, "class $wrapperClass"));

        return $this->getObject(
            $template,
            $wrapperClass,
            $mock,
            $mockClass,
            ! is_null($constructorArgs),
            (array) $constructorArgs
        );
    }

    /**
     * @param string $code
     * @param string $className
     * @param object $proxyTarget
     * @param array|string $type
     * @param bool $callOriginalConstructor
     * @param array $arguments
     * @param bool $callAutoload
     * @param bool $returnValueGeneration
     *
     * @return TestHelpersMock|MockObject
     * @throws ReflectionException
     */
    private function getObject(
        string $code,
        string $className,
        $proxyTarget,
        string $type = '',
        bool $callOriginalConstructor = false,
        array $arguments = [],
        bool $callAutoload = false,
        bool $returnValueGeneration = true
    ) {
        $this->evalClass($code, $className);

        if ($callOriginalConstructor &&
            is_string($type) &&
            ! interface_exists($type, $callAutoload)) {
            if (count($arguments) === 0) {
                $object = new $className;
            } else {
                $class = new ReflectionClass($className);
                $object = $class->newInstanceArgs($arguments);
            }
        } else {
            $instantiator = new Instantiator;
            $object = $instantiator->instantiate($className);
        }

        $object->__phpunit_setOriginalObject($proxyTarget);

        if ($object instanceof MockObject) {
            $object->__phpunit_setReturnValueGeneration($returnValueGeneration);
        }

        return $object;
    }

    /**
     * @param string $code
     * @param string $className
     */
    private function evalClass(string $code, string $className): void
    {
        if (! class_exists($className, false)) {
            eval($code);
        }
    }

    /**
     * @param string $mockClass
     * @param PHPUnit_Framework_MockObject_MockObject|MockInterface $mock
     * @param bool $onlyForInjector
     * @param string|null $injectorClass
     * @throws MockInjectionException
     */
    private function injectMockToLaravel(
        string $mockClass,
        $mock,
        bool $onlyForInjector = false,
        string $injectorClass = null
    ): void {
        if ($onlyForInjector) {
            if (! isset($injectorClass)) {
                throw MockInjectionException::injectorNotGiven();
            }

            $this->app->when($injectorClass)->needs($mockClass)->give(function () use ($mock) {
                return $mock;
            });
        } else {
            $this->app->instance($mockClass, $mock);
        }
    }

    /**
     * @param string $class
     * @return string
     */
    private function getClassShortName(string $class): string
    {
        return substr(strrchr($class, '\\'), 1);
    }
}