LazyLoadingGhostFunctionalTest::generateProxy() - Code Metrics - Inspection of "Typed properties (PHP 7.4, hopefully) example supp..." - Ocramius/ProxyManager - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — master (#423)

by Marco
created 2019-02-27 01:53 UTC
LazyLoadingGhostFunctionalTest::generateProxy() A

↳ Parent: LazyLoadingGhostFunctionalTest
Complexity

Conditions	1
Paths	1
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	14
rs	9.7998
c	0
b	0
f	0
cc	1
nc	1
nop	2
<?php

declare(strict_types=1);

namespace ProxyManagerTest\Functional;

use PHPUnit\Framework\TestCase;
use PHPUnit_Framework_MockObject_MockObject as Mock;
use ProxyManager\Generator\ClassGenerator;
use ProxyManager\Generator\Util\UniqueIdentifierGenerator;
use ProxyManager\GeneratorStrategy\EvaluatingGeneratorStrategy;
use ProxyManager\Proxy\GhostObjectInterface;
use ProxyManager\Proxy\LazyLoadingInterface;
use ProxyManager\ProxyGenerator\LazyLoadingGhostGenerator;
use ProxyManager\ProxyGenerator\Util\Properties;
use ProxyManagerTestAsset\BaseClass;
use ProxyManagerTestAsset\ClassWithAbstractPublicMethod;
use ProxyManagerTestAsset\ClassWithCollidingPrivateInheritedProperties;
use ProxyManagerTestAsset\ClassWithCounterConstructor;
use ProxyManagerTestAsset\ClassWithDynamicArgumentsMethod;
use ProxyManagerTestAsset\ClassWithMethodWithByRefVariadicFunction;
use ProxyManagerTestAsset\ClassWithMethodWithVariadicFunction;
use ProxyManagerTestAsset\ClassWithMixedProperties;
use ProxyManagerTestAsset\ClassWithMixedPropertiesAndAccessorMethods;
use ProxyManagerTestAsset\ClassWithMixedTypedProperties;
use ProxyManagerTestAsset\ClassWithParentHint;
use ProxyManagerTestAsset\ClassWithPrivateProperties;
use ProxyManagerTestAsset\ClassWithProtectedProperties;
use ProxyManagerTestAsset\ClassWithPublicArrayProperty;
use ProxyManagerTestAsset\ClassWithPublicProperties;
use ProxyManagerTestAsset\ClassWithSelfHint;
use ProxyManagerTestAsset\EmptyClass;
use ProxyManagerTestAsset\OtherObjectAccessClass;
use ProxyManagerTestAsset\VoidCounter;
use ReflectionClass;
use ReflectionProperty;
use stdClass;
use function array_values;
use function get_class;
use function get_parent_class;
use function random_int;
use function serialize;
use function sprintf;
use function str_replace;
use function uniqid;
use function unserialize;

/**
 * Tests for {@see \ProxyManager\ProxyGenerator\LazyLoadingGhostGenerator} produced objects
 *
 * @group Functional
 * @coversNothing
 */
class LazyLoadingGhostFunctionalTest extends TestCase
{
    /**
     * @dataProvider getProxyInitializingMethods
     *
     * @param mixed[] $params
     * @param mixed   $expectedValue
     */
    public function testMethodCallsThatLazyLoadTheObject(
        string $className,
        object $instance,
        string $method,
        array $params,
        $expectedValue
    ) : void {
        $proxyName = $this->generateProxy($className);

        /** @var GhostObjectInterface $proxy */
        $proxy = $proxyName::staticProxyConstructor($this->createInitializer($className, $instance));

        self::assertFalse($proxy->isProxyInitialized());

        /** @var callable $callProxyMethod */
        $callProxyMethod = [$proxy, $method];
        $parameterValues = array_values($params);

        self::assertInternalType('callable', $callProxyMethod);

        self::assertSame($expectedValue, $callProxyMethod(...$parameterValues));
        self::assertTrue($proxy->isProxyInitialized());
    }

    /**
     * @dataProvider getProxyNonInitializingMethods
     *
     * @param mixed[] $params
     * @param mixed   $expectedValue
     */
    public function testMethodCallsThatDoNotLazyLoadTheObject(
        string $className,
        object $instance,
        string $method,
        array $params,
        $expectedValue
    ) : void {
        $proxyName         = $this->generateProxy($className);
        $initializeMatcher = $this->getMockBuilder(stdClass::class)->setMethods(['__invoke'])->getMock();

        $initializeMatcher->expects(self::never())->method('__invoke'); // should not initialize the proxy

        /** @var GhostObjectInterface $proxy */
        $proxy = $proxyName::staticProxyConstructor(
            $this->createInitializer($className, $instance, $initializeMatcher)
        );

        self::assertFalse($proxy->isProxyInitialized());

        /** @var callable $callProxyMethod */
        $callProxyMethod = [$proxy, $method];
        $parameterValues = array_values($params);

        self::assertInternalType('callable', $callProxyMethod);

        self::assertSame($expectedValue, $callProxyMethod(...$parameterValues));
        self::assertFalse($proxy->isProxyInitialized());
    }

    /**
     * @dataProvider getProxyMethods
     *
     * @param mixed[] $params
     * @param mixed   $expectedValue
     */
    public function testMethodCallsAfterUnSerialization(
        string $className,
        object $instance,
        string $method,
        array $params,
        $expectedValue
    ) : void {
        $proxyName = $this->generateProxy($className);

        /** @var GhostObjectInterface $proxy */
        $proxy = unserialize(serialize($proxyName::staticProxyConstructor(
            $this->createInitializer($className, $instance)
        )));

        self::assertTrue($proxy->isProxyInitialized());

        /** @var callable $callProxyMethod */
        $callProxyMethod = [$proxy, $method];
        $parameterValues = array_values($params);

        self::assertInternalType('callable', $callProxyMethod);

        self::assertSame($expectedValue, $callProxyMethod(...$parameterValues));
    }

    /**
     * @dataProvider getProxyMethods
     *
     * @param mixed[] $params
     * @param mixed   $expectedValue
     */
    public function testMethodCallsAfterCloning(
        string $className,
        object $instance,
        string $method,
        array $params,
        $expectedValue
    ) : void {
        $proxyName = $this->generateProxy($className);

        /** @var GhostObjectInterface $proxy */
        $proxy  = $proxyName::staticProxyConstructor($this->createInitializer($className, $instance));
        $cloned = clone $proxy;

        self::assertTrue($cloned->isProxyInitialized());

        /** @var callable $callProxyMethod */
        $callProxyMethod = [$proxy, $method];
        $parameterValues = array_values($params);

        self::assertInternalType('callable', $callProxyMethod);

        self::assertSame($expectedValue, $callProxyMethod(...$parameterValues));
    }

    /**
     * @dataProvider getPropertyAccessProxies
     *
     * @param mixed $propertyValue
     */
    public function testPropertyReadAccess(
        object $instance,

        GhostObjectInterface $proxy,
        string $publicProperty,
        $propertyValue
    ) : void {
        self::assertSame($propertyValue, $proxy->$publicProperty);
        self::assertTrue($proxy->isProxyInitialized());
    }

    /**
     * @dataProvider getPropertyAccessProxies
     *
     */
    public function testPropertyWriteAccess(object $instance, GhostObjectInterface $proxy, string $publicProperty

    ) : void
    {
        $newValue               = uniqid('', true);
        $proxy->$publicProperty = $newValue;

        self::assertTrue($proxy->isProxyInitialized());
        self::assertSame($newValue, $proxy->$publicProperty);
    }

    /**
     * @dataProvider getPropertyAccessProxies
     *
     */
    public function testPropertyExistence(object $instance, GhostObjectInterface $proxy, string $publicProperty) : void
    {
        self::assertSame(isset($instance->$publicProperty), isset($proxy->$publicProperty));
        self::assertTrue($proxy->isProxyInitialized());
    }

    /**
     * @dataProvider getPropertyAccessProxies
     *
     */
    public function testPropertyAbsence(object $instance, GhostObjectInterface $proxy, string $publicProperty) : void

    {
        $proxy->$publicProperty = null;
        self::assertFalse(isset($proxy->$publicProperty));
        self::assertTrue($proxy->isProxyInitialized());
    }

    /**
     * @dataProvider getPropertyAccessProxies
     *
     */
    public function testPropertyUnset(object $instance, GhostObjectInterface $proxy, string $publicProperty) : void
    {
        unset($proxy->$publicProperty);

        self::assertTrue($proxy->isProxyInitialized());
        self::assertTrue(isset($instance->$publicProperty));
        self::assertFalse(isset($proxy->$publicProperty));
    }

    /**
     * Verifies that accessing a public property containing an array behaves like in a normal context
     */
    public function testCanWriteToArrayKeysInPublicProperty() : void
    {
        $instance    = new ClassWithPublicArrayProperty();
        $className   = get_class($instance);
        $initializer = $this->createInitializer($className, $instance);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $proxyName   = $this->generateProxy($className);
        /** @var ClassWithPublicArrayProperty $proxy */
        $proxy = $proxyName::staticProxyConstructor($initializer);

        $proxy->arrayProperty['foo'] = 'bar';

        self::assertSame('bar', $proxy->arrayProperty['foo']);

        $proxy->arrayProperty = ['tab' => 'taz'];

        self::assertSame(['tab' => 'taz'], $proxy->arrayProperty);
    }

    /**
     * Verifies that public properties retrieved via `__get` don't get modified in the object itself
     */
    public function testWillNotModifyRetrievedPublicProperties() : void
    {
        $instance    = new ClassWithPublicProperties();
        $className   = get_class($instance);
        $initializer = $this->createInitializer($className, $instance);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $proxyName   = $this->generateProxy($className);
        /** @var ClassWithPublicProperties $proxy */
        $proxy    = $proxyName::staticProxyConstructor($initializer);
        $variable = $proxy->property0;

        self::assertSame('property0', $variable);

        $variable = 'foo';

        self::assertSame('property0', $proxy->property0);
        self::assertSame('foo', $variable);
    }

    /**
     * Verifies that public properties references retrieved via `__get` modify in the object state
     */
    public function testWillModifyByRefRetrievedPublicProperties() : void
    {
        $instance    = new ClassWithPublicProperties();
        $className   = get_class($instance);
        $initializer = $this->createInitializer($className, $instance);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $proxyName   = $this->generateProxy($className);
        /** @var ClassWithPublicProperties $proxy */
        $proxy    = $proxyName::staticProxyConstructor($initializer);
        $variable = &$proxy->property0;

        self::assertSame('property0', $variable);

        $variable = 'foo';

        self::assertSame('foo', $proxy->property0);
        self::assertSame('foo', $variable);
    }

    public function testKeepsInitializerWhenNotOverwitten() : void
    {
        $instance    = new BaseClass();
        $proxyName   = $this->generateProxy(get_class($instance));
        $initializer = function () : void {
        };
        /** @var GhostObjectInterface $proxy */
        $proxy = $proxyName::staticProxyConstructor($initializer);

        $proxy->initializeProxy();

        self::assertSame($initializer, $proxy->getProxyInitializer());
    }

    /**
     * Verifies that public properties are not being initialized multiple times
     */
    public function testKeepsInitializedPublicProperties() : void
    {
        $instance    = new BaseClass();
        $proxyName   = $this->generateProxy(get_class($instance));
        $initializer = function (BaseClass $proxy, string $method, $parameters, & $initializer) : void {
            $initializer           = null;
            $proxy->publicProperty = 'newValue';
        };
        /** @var GhostObjectInterface&BaseClass $proxy */

        $proxy = $proxyName::staticProxyConstructor($initializer);

        $proxy->initializeProxy();
        self::assertSame('newValue', $proxy->publicProperty);

        $proxy->publicProperty = 'otherValue';

        $proxy->initializeProxy();

        self::assertSame('otherValue', $proxy->publicProperty);
    }

    /**
     * Verifies that properties' default values are preserved
     */
    public function testPublicPropertyDefaultWillBePreserved() : void
    {
        $instance  = new ClassWithPublicProperties();
        $proxyName = $this->generateProxy(get_class($instance));
        /** @var ClassWithPublicProperties $proxy */
        $proxy = $proxyName::staticProxyConstructor(function () : void {
        });

        self::assertSame('property0', $proxy->property0);
    }

    /**
     * Verifies that protected properties' default values are preserved
     */
    public function testProtectedPropertyDefaultWillBePreserved() : void
    {
        $instance  = new ClassWithProtectedProperties();
        $proxyName = $this->generateProxy(get_class($instance));
        /** @var ClassWithProtectedProperties $proxy */
        $proxy = $proxyName::staticProxyConstructor(function () : void {
        });

        // Check protected property via reflection
        $reflectionProperty = new ReflectionProperty($instance, 'property0');
        $reflectionProperty->setAccessible(true);

        self::assertSame('property0', $reflectionProperty->getValue($proxy));
    }

    /**
     * Verifies that private properties' default values are preserved
     */
    public function testPrivatePropertyDefaultWillBePreserved() : void
    {
        $instance  = new ClassWithPrivateProperties();
        $proxyName = $this->generateProxy(get_class($instance));
        /** @var ClassWithPrivateProperties $proxy */
        $proxy = $proxyName::staticProxyConstructor(function () : void {
        });

        // Check protected property via reflection
        $reflectionProperty = new ReflectionProperty($instance, 'property0');
        $reflectionProperty->setAccessible(true);

        self::assertSame('property0', $reflectionProperty->getValue($proxy));
    }

    /**
     * @group 159
     * @group 192
     */
    public function testMultiLevelPrivatePropertiesDefaultsWillBePreserved() : void
    {
        $instance  = new ClassWithCollidingPrivateInheritedProperties();
        $proxyName = $this->generateProxy(ClassWithCollidingPrivateInheritedProperties::class);
        /** @var ClassWithPrivateProperties $proxy */
        $proxy = $proxyName::staticProxyConstructor(function () : void {
        });

        $childProperty  = new ReflectionProperty($instance, 'property0');
        $parentProperty = new ReflectionProperty(get_parent_class($instance), 'property0');

        $childProperty->setAccessible(true);
        $parentProperty->setAccessible(true);

        self::assertSame('childClassProperty0', $childProperty->getValue($proxy));
        self::assertSame('property0', $parentProperty->getValue($proxy));
    }

    /**
     * @group 159
     * @group 192
     */
    public function testMultiLevelPrivatePropertiesByRefInitialization() : void
    {
        $class     = ClassWithCollidingPrivateInheritedProperties::class;
        $proxyName = $this->generateProxy($class);
        /** @var ClassWithPrivateProperties $proxy */
        $proxy = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer, array $properties) use ($class) : void {
                $initializer                                                 = null;
                $properties["\0" . $class . "\0property0"]                   = 'foo';
                $properties["\0" . get_parent_class($class) . "\0property0"] = 'bar';
            }
        );

        $childProperty  = new ReflectionProperty($class, 'property0');
        $parentProperty = new ReflectionProperty(get_parent_class($class), 'property0');

        $childProperty->setAccessible(true);
        $parentProperty->setAccessible(true);

        self::assertSame('foo', $childProperty->getValue($proxy));
        self::assertSame('bar', $parentProperty->getValue($proxy));
    }

    /**
     * @group 159
     * @group 192
     *
     * Test designed to verify that the cached logic does take into account the fact that
     * proxies are different instances
     */
    public function testGetPropertyFromDifferentProxyInstances() : void
    {
        $class     = ClassWithCollidingPrivateInheritedProperties::class;
        $proxyName = $this->generateProxy($class);

        /** @var ClassWithPrivateProperties $proxy1 */
        $proxy1 = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer, array $properties) use ($class) : void {
                $initializer                                                 = null;
                $properties["\0" . $class . "\0property0"]                   = 'foo';
                $properties["\0" . get_parent_class($class) . "\0property0"] = 'bar';
            }
        );
        /** @var ClassWithPrivateProperties $proxy2 */
        $proxy2 = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer, array $properties) use ($class) : void {
                $initializer                                                 = null;
                $properties["\0" . $class . "\0property0"]                   = 'baz';
                $properties["\0" . get_parent_class($class) . "\0property0"] = 'tab';
            }
        );

        $childProperty  = new ReflectionProperty($class, 'property0');
        $parentProperty = new ReflectionProperty(get_parent_class($class), 'property0');

        $childProperty->setAccessible(true);
        $parentProperty->setAccessible(true);

        self::assertSame('foo', $childProperty->getValue($proxy1));
        self::assertSame('bar', $parentProperty->getValue($proxy1));

        self::assertSame('baz', $childProperty->getValue($proxy2));
        self::assertSame('tab', $parentProperty->getValue($proxy2));
    }

    /**
     * @group 159
     * @group 192
     *
     * Test designed to verify that the cached logic does take into account the fact that
     * proxies are different instances
     */
    public function testSetPrivatePropertyOnDifferentProxyInstances() : void
    {
        $class     = ClassWithMixedPropertiesAndAccessorMethods::class;
        $proxyName = $this->generateProxy($class);

        /** @var ClassWithMixedPropertiesAndAccessorMethods $proxy1 */
        $proxy1 = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer) : void {
                $initializer = null;
            }
        );
        /** @var ClassWithMixedPropertiesAndAccessorMethods $proxy2 */
        $proxy2 = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer) : void {
                $initializer = null;
            }
        );

        $proxy1->set('privateProperty', 'private1');
        $proxy2->set('privateProperty', 'private2');
        self::assertSame('private1', $proxy1->get('privateProperty'));
        self::assertSame('private2', $proxy2->get('privateProperty'));
    }

    /**
     * @group 159
     * @group 192
     *
     * Test designed to verify that the cached logic does take into account the fact that
     * proxies are different instances
     */
    public function testIssetPrivatePropertyOnDifferentProxyInstances() : void
    {
        $class     = ClassWithMixedPropertiesAndAccessorMethods::class;
        $proxyName = $this->generateProxy($class);

        /** @var ClassWithMixedPropertiesAndAccessorMethods $proxy1 */
        $proxy1 = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer) : void {
                $initializer = null;
            }
        );
        /** @var ClassWithMixedPropertiesAndAccessorMethods $proxy2 */
        $proxy2 = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer, array $properties) use ($class) : void {
                $initializer                                     = null;
                $properties["\0" . $class . "\0privateProperty"] = null;
            }
        );

        self::assertTrue($proxy1->has('privateProperty'));
        self::assertFalse($proxy2->has('privateProperty'));
        self::assertTrue($proxy1->has('privateProperty'));
        self::assertFalse($proxy2->has('privateProperty'));
    }

    /**
     * @group 159
     * @group 192
     *
     * Test designed to verify that the cached logic does take into account the fact that
     * proxies are different instances
     */
    public function testUnsetPrivatePropertyOnDifferentProxyInstances() : void
    {
        $class     = ClassWithMixedPropertiesAndAccessorMethods::class;
        $proxyName = $this->generateProxy($class);

        /** @var ClassWithMixedPropertiesAndAccessorMethods $proxy1 */
        $proxy1 = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer) : void {
                $initializer = null;
            }
        );
        /** @var ClassWithMixedPropertiesAndAccessorMethods $proxy2 */
        $proxy2 = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer) : void {
                $initializer = null;
            }
        );

        self::assertTrue($proxy1->has('privateProperty'));
        $proxy2->remove('privateProperty');
        self::assertFalse($proxy2->has('privateProperty'));
        self::assertTrue($proxy1->has('privateProperty'));
        $proxy1->remove('privateProperty');
        self::assertFalse($proxy1->has('privateProperty'));
        self::assertFalse($proxy2->has('privateProperty'));
    }

    /**
     * @group 159
     * @group 192
     *
     * Test designed to verify that the cached logic does take into account the fact that
     * proxies are different instances
     */
    public function testIssetPrivateAndProtectedPropertiesDoesCheckAgainstBooleanFalse() : void
    {
        $class     = ClassWithMixedPropertiesAndAccessorMethods::class;
        $proxyName = $this->generateProxy($class);

        /** @var ClassWithMixedPropertiesAndAccessorMethods $proxy1 */
        $proxy1 = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer, array $properties) use ($class) : void {
                $initializer                                     = null;
                $properties['publicProperty']                    = false;
                $properties["\0*\0protectedProperty"]            = false;
                $properties["\0" . $class . "\0privateProperty"] = false;
            }
        );
        /** @var ClassWithMixedPropertiesAndAccessorMethods $proxy2 */
        $proxy2 = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer, array $properties) use ($class) : void {
                $initializer                                     = null;
                $properties['publicProperty']                    = null;
                $properties["\0*\0protectedProperty"]            = null;
                $properties["\0" . $class . "\0privateProperty"] = null;
            }
        );

        self::assertTrue($proxy1->has('protectedProperty'));
        self::assertTrue($proxy1->has('publicProperty'));
        self::assertTrue($proxy1->has('privateProperty'));

        self::assertFalse($proxy2->has('protectedProperty'));
        self::assertFalse($proxy2->has('publicProperty'));
        self::assertFalse($proxy2->has('privateProperty'));
    }

    public function testByRefInitialization() : void
    {
        $proxyName = $this->generateProxy(ClassWithMixedProperties::class);
        /** @var ClassWithPrivateProperties $proxy */
        $proxy = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer, array $properties) : void {
                $initializer                                                               = null;
                $properties["\0" . ClassWithMixedProperties::class . "\0privateProperty0"] = 'private0';
                $properties["\0" . ClassWithMixedProperties::class . "\0privateProperty1"] = 'private1';
                $properties["\0" . ClassWithMixedProperties::class . "\0privateProperty2"] = 'private2';
                $properties["\0*\0protectedProperty0"]                                     = 'protected0';
                $properties["\0*\0protectedProperty1"]                                     = 'protected1';
                $properties["\0*\0protectedProperty2"]                                     = 'protected2';
                $properties['publicProperty0']                                             = 'public0';
                $properties['publicProperty1']                                             = 'public1';
                $properties['publicProperty2']                                             = 'public2';
            }
        );

        $reflectionClass = new ReflectionClass(ClassWithMixedProperties::class);

        foreach (Properties::fromReflectionClass($reflectionClass)->getInstanceProperties() as $property) {
            $property->setAccessible(true);

            self::assertSame(str_replace('Property', '', $property->getName()), $property->getValue($proxy));
        }
    }

    public function testByRefInitializationOfTypedProperties() : void
    {
        $proxyName = $this->generateProxy(ClassWithMixedTypedProperties::class);
        /* @var $proxy ClassWithMixedTypedProperties */
        $proxy     = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer, array $properties) {
                $initializer = null;
                $properties["\0" . ClassWithMixedTypedProperties::class . "\0privateStringProperty"] = 'private0';
                $properties["\0*\0protectedStringProperty"] = 'protected0';
                $properties['publicStringProperty'] = 'public0';
            }
        );

        $reflectionClass = new ReflectionClass(ClassWithMixedTypedProperties::class);

        $properties = Properties::fromReflectionClass($reflectionClass)->getInstanceProperties();

        $privateProperty   = $properties["\0" . ClassWithMixedTypedProperties::class . "\0privateStringProperty"];
        $protectedProperty = $properties["\0*\0protectedStringProperty"];

        $privateProperty->setAccessible(true);
        $protectedProperty->setAccessible(true);

        self::assertSame('private0', $privateProperty->getValue($proxy));
        self::assertSame('protected0', $properties["\0*\0protectedStringProperty"]->getValue($proxy));
        self::assertSame('public0', $proxy->publicStringProperty);
    }

    /**
     * @group 115
     * @group 175
     */
    public function testWillBehaveLikeObjectWithNormalConstructor() : void
    {
        $instance = new ClassWithCounterConstructor(10);

        self::assertSame(10, $instance->amount, 'Verifying that test asset works as expected');
        self::assertSame(10, $instance->getAmount(), 'Verifying that test asset works as expected');
        $instance->__construct(3);
        self::assertSame(13, $instance->amount, 'Verifying that test asset works as expected');
        self::assertSame(13, $instance->getAmount(), 'Verifying that test asset works as expected');

        $proxyName = $this->generateProxy(get_class($instance));

        /** @var ClassWithCounterConstructor $proxy */
        $proxy = new $proxyName(15);

        self::assertSame(15, $proxy->amount, 'Verifying that the proxy constructor works as expected');
        self::assertSame(15, $proxy->getAmount(), 'Verifying that the proxy constructor works as expected');
        $proxy->__construct(5);
        self::assertSame(20, $proxy->amount, 'Verifying that the proxy constructor works as expected');
        self::assertSame(20, $proxy->getAmount(), 'Verifying that the proxy constructor works as expected');
    }

    public function testInitializeProxyWillReturnTrueOnSuccessfulInitialization() : void
    {
        $proxyName = $this->generateProxy(ClassWithMixedTypedProperties::class);

        /** @var GhostObjectInterface $proxy */
        $proxy = $proxyName::staticProxyConstructor($this->createInitializer(
            ClassWithMixedTypedProperties::class,
            new ClassWithMixedTypedProperties()
        ));

        self::assertTrue($proxy->initializeProxy());
        self::assertTrue($proxy->isProxyInitialized());
        self::assertFalse($proxy->initializeProxy());
    }

    /**
     * Generates a proxy for the given class name, and retrieves its class name
     *
     * @param mixed[] $proxyOptions
     */
    private function generateProxy(string $parentClassName, array $proxyOptions = []) : string
    {
        $generatedClassName = __NAMESPACE__ . '\\' . UniqueIdentifierGenerator::getIdentifier('Foo');
        $generatedClass     = new ClassGenerator($generatedClassName);

        (new LazyLoadingGhostGenerator())->generate(
            new ReflectionClass($parentClassName),
            $generatedClass,
            $proxyOptions
        );
        (new EvaluatingGeneratorStrategy())->generate($generatedClass);

        return $generatedClassName;
    }

    private function createInitializer(string $className, object $realInstance, ?Mock $initializerMatcher = null
    ) : callable
    {
        /** @var callable|Mock $initializerMatcher */
        if (! $initializerMatcher) {
            $initializerMatcher = $this->getMockBuilder(stdClass::class)->setMethods(['__invoke'])->getMock();

            $initializerMatcher
                ->expects(self::once())
                ->method('__invoke')
                ->with(self::logicalAnd(
                    self::isInstanceOf(GhostObjectInterface::class),
                    self::isInstanceOf($className)
                ));
            ;
        }

        self::assertInternalType('callable', $initializerMatcher);


        return function (
            GhostObjectInterface $proxy,
            $method,
            $params,
            & $initializer
        ) use (
            $initializerMatcher,
            $realInstance
        ) : bool {
            $initializer     = null;
            $reflectionClass = new ReflectionClass($realInstance);

            foreach (Properties::fromReflectionClass($reflectionClass)->getInstanceProperties() as $property) {
                if (! self::isPropertyInitialized($realInstance, $property)) {
                    continue;
                }

                $property->setAccessible(true);
                $property->setValue($proxy, $property->getValue($realInstance));
            }

            $initializerMatcher($proxy, $method, $params);

            return true;
        };
    }

    /**
     * Generates a list of object | invoked method | parameters | expected result
     *
     * @return null[][]|string[][]|object[][]|mixed[][][]
     */
    public function getProxyMethods() : array
    {
        $selfHintParam = new ClassWithSelfHint();
        $empty         = new EmptyClass();

        return [
            [
                BaseClass::class,
                new BaseClass(),
                'publicMethod',
                [],
                'publicMethodDefault',
            ],
            [
                BaseClass::class,
                new BaseClass(),
                'publicTypeHintedMethod',
                [new stdClass()],
                'publicTypeHintedMethodDefault',
            ],
            [
                BaseClass::class,
                new BaseClass(),
                'publicByReferenceMethod',
                [],
                'publicByReferenceMethodDefault',
            ],
            [
                ClassWithSelfHint::class,
                new ClassWithSelfHint(),
                'selfHintMethod',
                ['parameter' => $selfHintParam],
                $selfHintParam,
            ],
            [
                ClassWithParentHint::class,
                new ClassWithParentHint(),
                'parentHintMethod',
                ['parameter' => $empty],
                $empty,
            ],
            [
                ClassWithAbstractPublicMethod::class,
                new EmptyClass(), // EmptyClass just used to not make reflection explode when synchronizing properties
                'publicAbstractMethod',
                [],
                null,
            ],
            [
                ClassWithMethodWithByRefVariadicFunction::class,
                new ClassWithMethodWithByRefVariadicFunction(),
                'tuz',
                ['Ocramius', 'Malukenho'],
                ['Ocramius', 'changed'],
            ],
        ];
    }

    /**
     * Generates a list of object | invoked method | parameters | expected result for methods that cause lazy-loading
     * of a ghost object
     *
     * @return string[][]|object[][]|mixed[][][]|null[][]
     */
    public function getProxyInitializingMethods() : array
    {
        return [
            [
                BaseClass::class,
                new BaseClass(),
                'publicPropertyGetter',
                [],
                'publicPropertyDefault',
            ],
            [
                BaseClass::class,
                new BaseClass(),
                'protectedPropertyGetter',
                [],
                'protectedPropertyDefault',
            ],
            [
                BaseClass::class,
                new BaseClass(),
                'privatePropertyGetter',
                [],
                'privatePropertyDefault',
            ],
            [
                ClassWithMethodWithVariadicFunction::class,
                new ClassWithMethodWithVariadicFunction(),
                'foo',
                ['Ocramius', 'Malukenho'],
                null,
            ],
        ];
    }

    /**
     * Generates a list of object | invoked method | parameters | expected result for methods DON'T cause lazy-loading
     *
     * @return null[][]|string[][]|object[][]|mixed[][][]
     */
    public function getProxyNonInitializingMethods() : array
    {
        return $this->getProxyMethods();
    }

    /**
     * Generates proxies and instances with a public property to feed to the property accessor methods
     *
     * @return string[][]|object[][]
     */
    public function getPropertyAccessProxies() : array
    {
        $instance1  = new BaseClass();
        $proxyName1 = $this->generateProxy(get_class($instance1));
        $instance2  = new BaseClass();
        $proxyName2 = $this->generateProxy(get_class($instance2));

        return [
            [
                $instance1,
                new $proxyName1($this->createInitializer(BaseClass::class, $instance1)),
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                'publicProperty',
                'publicPropertyDefault',
            ],
            [
                $instance2,
                unserialize(
                    serialize(new $proxyName2($this->createInitializer(BaseClass::class, $instance2)))
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                ),
                'publicProperty',
                'publicPropertyDefault',
            ],
        ];
    }

    /**
     * @dataProvider skipPropertiesFixture
     *
     * @param mixed   $expected
     * @param mixed[] $proxyOptions
     */
    public function testInitializationIsSkippedForSkippedProperties(
        string $className,
        string $propertyClass,
        string $propertyName,
        array $proxyOptions,
        $expected
    ) : void {
        $proxy       = $this->generateProxy($className, $proxyOptions);
        $ghostObject = $proxy::staticProxyConstructor(function () use ($propertyName) : void {
            self::fail(sprintf('The Property "%s" was not expected to be lazy-loaded', $propertyName));
        });

        $property = new ReflectionProperty($propertyClass, $propertyName);
        $property->setAccessible(true);

        self::assertSame($expected, $property->getValue($ghostObject));
    }

    /**
     * @dataProvider skipPropertiesFixture
     *
     * @param mixed[] $proxyOptions
     */
    public function testSkippedPropertiesAreNotOverwrittenOnInitialization(
        string $className,
        string $propertyClass,
        string $propertyName,
        array $proxyOptions
    ) : void {
        $proxyName = $this->generateProxy($className, $proxyOptions);
        /** @var GhostObjectInterface $ghostObject */
        $ghostObject = $proxyName::staticProxyConstructor(
            function ($proxy, string $method, $params, & $initializer) : bool {
                $initializer = null;

                return true;
            }
        );

        $property = new ReflectionProperty($propertyClass, $propertyName);

        $property->setAccessible(true);

        $value = uniqid('', true);

        $property->setValue($ghostObject, $value);

        self::assertTrue($ghostObject->initializeProxy());

        self::assertSame(
            $value,
            $property->getValue($ghostObject),
            'Property should not be changed by proxy initialization'
        );
    }

    /**
     * @group 265
     */
    public function testWillForwardVariadicByRefArguments() : void
    {
        $proxyName = $this->generateProxy(ClassWithMethodWithByRefVariadicFunction::class);
        /** @var ClassWithMethodWithByRefVariadicFunction $object */
        $object = $proxyName::staticProxyConstructor(function ($proxy, string $method, $params, & $initializer) : bool {
            $initializer = null;

            return true;
        });

        $parameters = ['a', 'b', 'c'];

        // first, testing normal variadic behavior (verifying we didn't screw up in the test asset)
        self::assertSame(['a', 'changed', 'c'], (new ClassWithMethodWithByRefVariadicFunction())->tuz(...$parameters));
        self::assertSame(['a', 'changed', 'c'], $object->tuz(...$parameters));
        self::assertSame(['a', 'changed', 'c'], $parameters, 'by-ref variadic parameter was changed');
    }

    /**
     * @group 265
     */
    public function testWillForwardDynamicArguments() : void
    {
        $proxyName = $this->generateProxy(ClassWithDynamicArgumentsMethod::class);
        /** @var ClassWithDynamicArgumentsMethod $object */
        $object = $proxyName::staticProxyConstructor(function () : void {
        });

        // first, testing normal variadic behavior (verifying we didn't screw up in the test asset)
        self::assertSame(['a', 'b'], (new ClassWithDynamicArgumentsMethod())->dynamicArgumentsMethod('a', 'b'));
        self::assertSame(['a', 'b'], $object->dynamicArgumentsMethod('a', 'b'));
    }

    /**
     * @return mixed[] in order:
     *                  - the class to be proxied
     *                  - the class owning the property to be checked
     *                  - the property name
     *                  - the options to be passed to the generator
     *                  - the expected value of the property
     */
    public function skipPropertiesFixture() : array
    {
        return [
            [
                ClassWithPublicProperties::class,
                ClassWithPublicProperties::class,
                'property9',
                [
                    'skippedProperties' => ['property9'],
                ],
                'property9',
            ],
            [
                ClassWithProtectedProperties::class,
                ClassWithProtectedProperties::class,
                'property9',
                [
                    'skippedProperties' => ["\0*\0property9"],
                ],
                'property9',
            ],
            [
                ClassWithPrivateProperties::class,
                ClassWithPrivateProperties::class,
                'property9',
                [
                    'skippedProperties' => ["\0ProxyManagerTestAsset\\ClassWithPrivateProperties\0property9"],
                ],
                'property9',
            ],
            [
                ClassWithCollidingPrivateInheritedProperties::class,
                ClassWithCollidingPrivateInheritedProperties::class,
                'property0',
                [
                    'skippedProperties' => ["\0ProxyManagerTestAsset\\ClassWithCollidingPrivateInheritedProperties\0property0"],
                ],
                'childClassProperty0',
            ],
            [
                ClassWithCollidingPrivateInheritedProperties::class,
                ClassWithPrivateProperties::class,
                'property0',
                [
                    'skippedProperties' => ["\0ProxyManagerTestAsset\\ClassWithPrivateProperties\0property0"],
                ],
                'property0',
            ],
        ];
    }

    /**
     * @group        276
     *
     * @dataProvider getMethodsThatAccessPropertiesOnOtherObjectsInTheSameScope
     *
     */
    public function testWillLazyLoadMembersOfOtherProxiesWithTheSamePrivateScope(
        object $callerObject,
        string $method,
        string $propertyIndex,
        string $expectedValue
    ) : void {
        $proxyName = $this->generateProxy(get_class($callerObject));
        /** @var OtherObjectAccessClass|LazyLoadingInterface $proxy */
        $proxy = $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer, array $props) use ($propertyIndex, $expectedValue
            ) : void {
                $initializer = null;

                $props[$propertyIndex] = $expectedValue;
            }
        );

        self::assertInstanceOf(LazyLoadingInterface::class, $proxy);

        $accessor = [$callerObject, $method];

        self::assertInternalType('callable', $accessor);


        self::assertFalse($proxy->isProxyInitialized());
        self::assertSame($expectedValue, $accessor($proxy));
        self::assertTrue($proxy->isProxyInitialized());
    }

    /**
     * @group        276
     *
     * @dataProvider getMethodsThatAccessPropertiesOnOtherObjectsInTheSameScope
     *
     */
    public function testWillAccessMembersOfOtherDeSerializedProxiesWithTheSamePrivateScope(
        object $callerObject,
        string $method,
        string $propertyIndex,
        string $expectedValue
    ) : void {
        $proxyName = $this->generateProxy(get_class($callerObject));
        /** @var OtherObjectAccessClass|LazyLoadingInterface $proxy */
        $proxy = unserialize(serialize($proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer, array $props) use ($propertyIndex, $expectedValue
            ) : void {
                $initializer = null;

                $props[$propertyIndex] = $expectedValue;
            }
        )));

        self::assertInstanceOf(LazyLoadingInterface::class, $proxy);

        $accessor = [$callerObject, $method];

        self::assertInternalType('callable', $accessor);


        self::assertTrue($proxy->isProxyInitialized());
        self::assertSame($expectedValue, $accessor($proxy));
    }

    /**
     * @group        276
     *
     * @dataProvider getMethodsThatAccessPropertiesOnOtherObjectsInTheSameScope
     *
     */
    public function testWillAccessMembersOfOtherClonedProxiesWithTheSamePrivateScope(
        object $callerObject,
        string $method,
        string $propertyIndex,
        string $expectedValue
    ) : void {
        $proxyName = $this->generateProxy(get_class($callerObject));
        /** @var OtherObjectAccessClass|LazyLoadingInterface $proxy */
        $proxy = clone $proxyName::staticProxyConstructor(
            function ($proxy, $method, $params, & $initializer, array $props) use ($propertyIndex, $expectedValue
            ) : void {
                $initializer = null;

                $props[$propertyIndex] = $expectedValue;
            }
        );

        self::assertInstanceOf(LazyLoadingInterface::class, $proxy);

        $accessor = [$callerObject, $method];

        self::assertInternalType('callable', $accessor);


        self::assertTrue($proxy->isProxyInitialized());
        self::assertSame($expectedValue, $accessor($proxy));
    }

    /** @return string[][]|object[][] */
    public function getMethodsThatAccessPropertiesOnOtherObjectsInTheSameScope() : array
    {
        $proxyClass = $this->generateProxy(OtherObjectAccessClass::class);

        return [
            OtherObjectAccessClass::class . '#$privateProperty'                => [
                new OtherObjectAccessClass(),
                'getPrivateProperty',
                "\0" . OtherObjectAccessClass::class . "\0privateProperty",
                uniqid('', true),
            ],
            OtherObjectAccessClass::class . '#$protectedProperty'              => [
                new OtherObjectAccessClass(),
                'getProtectedProperty',
                "\0*\0protectedProperty",
                uniqid('', true),
            ],
            OtherObjectAccessClass::class . '#$publicProperty'                 => [
                new OtherObjectAccessClass(),
                'getPublicProperty',
                'publicProperty',
                uniqid('', true),
            ],
            '(proxy) ' . OtherObjectAccessClass::class . '#$privateProperty'   => [
                $proxyClass::staticProxyConstructor(function () : void {
                    self::fail('Should never be initialized, as its values aren\'t accessed');
                }),
                'getPrivateProperty',
                "\0" . OtherObjectAccessClass::class . "\0privateProperty",
                uniqid('', true),
            ],
            '(proxy) ' . OtherObjectAccessClass::class . '#$protectedProperty' => [
                $proxyClass::staticProxyConstructor(function () : void {
                    self::fail('Should never be initialized, as its values aren\'t accessed');
                }),
                'getProtectedProperty',
                "\0*\0protectedProperty",
                uniqid('', true),
            ],
            '(proxy) ' . OtherObjectAccessClass::class . '#$publicProperty'    => [
                $proxyClass::staticProxyConstructor(function () : void {
                    self::fail('Should never be initialized, as its values aren\'t accessed');
                }),
                'getPublicProperty',
                'publicProperty',
                uniqid('', true),
            ],
        ];
    }

    /**
     * @group 276
     */
    public function testFriendObjectWillNotCauseLazyLoadingOnSkippedProperty() : void
    {
        $proxyName = $this->generateProxy(
            OtherObjectAccessClass::class,
            [
                'skippedProperties' => [
                    "\0" . OtherObjectAccessClass::class . "\0privateProperty",
                    "\0*\0protectedProperty",
                    'publicProperty',
                ],
            ]
        );

        /** @var OtherObjectAccessClass|LazyLoadingInterface $proxy */
        $proxy = $proxyName::staticProxyConstructor(function () : void {
            throw new \BadMethodCallException('The proxy should never be initialized, as all properties are skipped');
        });

        self::assertInstanceOf(OtherObjectAccessClass::class, $proxy);
        self::assertInstanceOf(LazyLoadingInterface::class, $proxy);

        $privatePropertyValue   = uniqid('', true);
        $protectedPropertyValue = uniqid('', true);
        $publicPropertyValue    = uniqid('', true);

        $reflectionPrivateProperty = new \ReflectionProperty(OtherObjectAccessClass::class, 'privateProperty');

        $reflectionPrivateProperty->setAccessible(true);
        $reflectionPrivateProperty->setValue($proxy, $privatePropertyValue);

        $reflectionProtectedProperty = new \ReflectionProperty(OtherObjectAccessClass::class, 'protectedProperty');

        $reflectionProtectedProperty->setAccessible(true);
        $reflectionProtectedProperty->setValue($proxy, $protectedPropertyValue);

        $proxy->publicProperty = $publicPropertyValue;

        $friendObject = new OtherObjectAccessClass();

        self::assertInstanceOf(OtherObjectAccessClass::class, $proxy);

        if (! ($proxy instanceof OtherObjectAccessClass)) {
            return;
        }

        self::assertSame($privatePropertyValue, $friendObject->getPrivateProperty($proxy));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        self::assertSame($protectedPropertyValue, $friendObject->getProtectedProperty($proxy));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        self::assertSame($publicPropertyValue, $friendObject->getPublicProperty($proxy));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function testClonedSkippedPropertiesArePreserved() : void
    {
        $proxyName = $this->generateProxy(
            BaseClass::class,
            [
                'skippedProperties' => [
                    "\0" . BaseClass::class . "\0privateProperty",
                    "\0*\0protectedProperty",
                    'publicProperty',
                ],
            ]
        );

        /** @var BaseClass|GhostObjectInterface $proxy */
        $proxy = $proxyName::staticProxyConstructor(function ($proxy) : void {
            $proxy->setProxyInitializer(null);
        });

        self::assertInstanceOf(BaseClass::class, $proxy);
        self::assertInstanceOf(LazyLoadingInterface::class, $proxy);

        $reflectionPrivate   = new \ReflectionProperty(BaseClass::class, 'privateProperty');
        $reflectionProtected = new \ReflectionProperty(BaseClass::class, 'protectedProperty');

        $reflectionPrivate->setAccessible(true);
        $reflectionProtected->setAccessible(true);

        $privateValue   = uniqid('', true);
        $protectedValue = uniqid('', true);
        $publicValue    = uniqid('', true);

        $reflectionPrivate->setValue($proxy, $privateValue);
        $reflectionProtected->setValue($proxy, $protectedValue);
        $proxy->publicProperty = $publicValue;

        self::assertFalse($proxy->isProxyInitialized());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        $clone = clone $proxy;

        self::assertFalse($proxy->isProxyInitialized());
        self::assertTrue($clone->isProxyInitialized());

        self::assertSame($privateValue, $reflectionPrivate->getValue($proxy));
        self::assertSame($privateValue, $reflectionPrivate->getValue($clone));
        self::assertSame($protectedValue, $reflectionProtected->getValue($proxy));
        self::assertSame($protectedValue, $reflectionProtected->getValue($clone));
        self::assertSame($publicValue, $proxy->publicProperty);
        self::assertSame($publicValue, $clone->publicProperty);
    }

    /**
     * @group 327
     */
    public function testWillExecuteLogicInAVoidMethod() : void
    {
        $proxyName = $this->generateProxy(VoidCounter::class);

        $initialCounter = random_int(10, 1000);

        /** @var VoidCounter|LazyLoadingInterface $proxy */
        $proxy = $proxyName::staticProxyConstructor(
            function (VoidCounter $proxy, $method, $params, & $initializer, array $props) use ($initialCounter) : bool {
                $initializer = null;

                $props['counter'] = $initialCounter;

                return true;
            }
        );

        self::assertInstanceOf(VoidCounter::class, $proxy);
        self::assertInstanceOf(LazyLoadingInterface::class, $proxy);

        $increment = random_int(1001, 10000);

        $proxy->increment($increment);
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

        self::assertSame($initialCounter + $increment, $proxy->counter);
    }

    private static function isPropertyInitialized(object $object, ReflectionProperty $property) : bool
    {
        return array_key_exists(
            ($property->isProtected() ? "\0*\0" : '')
            . ($property->isPrivate() ? "\0" . $property->getDeclaringClass()->getName() . "\0" : '')
            . $property->getName(),
            (array) $object
        );
    }
}

Pull Request — master (#423)

LazyLoadingGhostFunctionalTest::generateProxy() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Ocramius / ProxyManager

Pull Request — master (#423)

LazyLoadingGhostFunctionalTest::generateProxy() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
