Merge pull request #61 from Ocramius/hotfix/issue-#55-byref-magic-get

Adding test cases for classes implementing by-ref magic __get
Ocramius · Jun 27, 2013 · 20dbacf · 20dbacf
2 parents f785193 + 09347e2
commit 20dbacf
Show file tree

Hide file tree

Showing 27 changed files with 357 additions and 71 deletions.
diff --git a/src/ProxyManager/Generator/MagicMethodGenerator.php b/src/ProxyManager/Generator/MagicMethodGenerator.php
@@ -0,0 +1,45 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ */
+
+namespace ProxyManager\Generator;
+
+use ReflectionClass;
+
+/**
+ * Method generator for magic methods
+ *
+ * @author Marco Pivetta <ocramius@gmail.com>
+ * @license MIT
+ */
+class MagicMethodGenerator extends MethodGenerator
+{
+    public function __construct(ReflectionClass $originalClass, $name, array $parameters = array())
+    {
+        parent::__construct(
+            $name,
+            $parameters,
+            static::FLAG_PUBLIC,
+            null,
+            $originalClass->hasMethod($name) ? '{@inheritDoc}' : null
+        );
+
+        if ($originalClass->hasMethod($name)) {
+            $this->setReturnsReference($originalClass->getMethod($name)->returnsReference());
+        }
+    }
+}
diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptor/MethodGenerator/MagicWakeup.php b/src/ProxyManager/ProxyGenerator/AccessInterceptor/MethodGenerator/MagicWakeup.php
@@ -18,6 +18,7 @@
 
 namespace ProxyManager\ProxyGenerator\AccessInterceptor\MethodGenerator;
 
+use ProxyManager\Generator\MagicMethodGenerator;
 use ReflectionClass;
 use ReflectionProperty;
 use ProxyManager\Generator\MethodGenerator;
@@ -28,14 +29,14 @@
  * @author Marco Pivetta <ocramius@gmail.com>
  * @license MIT
  */
-class MagicWakeup extends MethodGenerator
+class MagicWakeup extends MagicMethodGenerator
 {
     /**
      * Constructor
      */
     public function __construct(ReflectionClass $originalClass)
     {
-        parent::__construct('__wakeup');
+        parent::__construct($originalClass, '__wakeup');
 
         /* @var $publicProperties \ReflectionProperty[] */
         $publicProperties = $originalClass->getProperties(ReflectionProperty::IS_PUBLIC);
@@ -45,9 +46,6 @@ public function __construct(ReflectionClass $originalClass)
             $unsetProperties[] = '$this->' . $publicProperty->getName();
         }
 
-        $this->setDocblock($originalClass->hasMethod('__wakeup') ? '{@inheritDoc}' : '');
-        $this->setBody(
-            ($unsetProperties ? 'unset(' . implode(', ', $unsetProperties) . ");" : '')
-        );
+        $this->setBody($unsetProperties ? 'unset(' . implode(', ', $unsetProperties) . ");" : '');
     }
 }
diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicClone.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicClone.php
@@ -18,6 +18,7 @@
 
 namespace ProxyManager\ProxyGenerator\AccessInterceptorValueHolder\MethodGenerator;
 
+use ProxyManager\Generator\MagicMethodGenerator;
 use ReflectionClass;
 use ProxyManager\Generator\MethodGenerator;
 use Zend\Code\Generator\PropertyGenerator;
@@ -28,7 +29,7 @@
  * @author Marco Pivetta <ocramius@gmail.com>
  * @license MIT
  */
-class MagicClone extends MethodGenerator
+class MagicClone extends MagicMethodGenerator
 {
     /**
      * Constructor
@@ -39,13 +40,12 @@ public function __construct(
         PropertyGenerator $prefixInterceptors,
         PropertyGenerator $suffixInterceptors
     ) {
-        parent::__construct('__clone');
+        parent::__construct($originalClass, '__clone');
 
         $valueHolder = $valueHolderProperty->getName();
         $prefix      = $prefixInterceptors->getName();
         $suffix      = $suffixInterceptors->getName();
 
-        $this->setDocblock($originalClass->hasMethod('__wakeup') ? '{@inheritDoc}' : '');
         $this->setBody(
             "\$this->$valueHolder = clone \$this->$valueHolder;\n\n"
             . "foreach (\$this->$prefix as \$key => \$value) {\n"

diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicGet.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicGet.php
@@ -18,6 +18,7 @@
 
 namespace ProxyManager\ProxyGenerator\AccessInterceptorValueHolder\MethodGenerator;
 
+use ProxyManager\Generator\MagicMethodGenerator;
 use ProxyManager\ProxyGenerator\AccessInterceptorValueHolder\MethodGenerator\Util\InterceptorGenerator;
 use ReflectionClass;
 use ProxyManager\Generator\MethodGenerator;
@@ -30,7 +31,7 @@
  * @author Marco Pivetta <ocramius@gmail.com>
  * @license MIT
  */
-class MagicGet extends MethodGenerator
+class MagicGet extends MagicMethodGenerator
 {
     /**
      * Constructor
@@ -41,11 +42,11 @@ public function __construct(
         PropertyGenerator $prefixInterceptors,
         PropertyGenerator $suffixInterceptors
     ) {
-        $inheritDoc  = $originalClass->hasMethod('__get') ? "{@inheritDoc}\n" : '';
+        parent::__construct($originalClass, '__get', array(new ParameterGenerator('name')));
+
+        $inheritDoc = $originalClass->hasMethod('__get') ? "{@inheritDoc}\n" : '';
 
-        parent::__construct('__get');
         $this->setDocblock($inheritDoc . '@param string $name');
-        $this->setParameters(array(new ParameterGenerator('name')));
         $this->setBody(
             InterceptorGenerator::createInterceptedMethodBody(
                 '$returnValue = $this->' . $valueHolder->getName() . '->$name;',

diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicIsset.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicIsset.php
@@ -18,6 +18,7 @@
 
 namespace ProxyManager\ProxyGenerator\AccessInterceptorValueHolder\MethodGenerator;
 
+use ProxyManager\Generator\MagicMethodGenerator;
 use ProxyManager\ProxyGenerator\AccessInterceptorValueHolder\MethodGenerator\Util\InterceptorGenerator;
 use ReflectionClass;
 use ProxyManager\Generator\MethodGenerator;
@@ -30,7 +31,7 @@
  * @author Marco Pivetta <ocramius@gmail.com>
  * @license MIT
  */
-class MagicIsset extends MethodGenerator
+class MagicIsset extends MagicMethodGenerator
 {
     /**
      * Constructor
@@ -41,11 +42,11 @@ public function __construct(
         PropertyGenerator $prefixInterceptors,
         PropertyGenerator $suffixInterceptors
     ) {
-        $inheritDoc  = $originalClass->hasMethod('__isset') ? "{@inheritDoc}\n" : '';
+        parent::__construct($originalClass, '__isset', array(new ParameterGenerator('name')));
+
+        $inheritDoc = $originalClass->hasMethod('__isset') ? "{@inheritDoc}\n" : '';
 
-        parent::__construct('__isset');
         $this->setDocblock($inheritDoc . '@param string $name');
-        $this->setParameters(array(new ParameterGenerator('name')));
         $this->setBody(
             InterceptorGenerator::createInterceptedMethodBody(
                 '$returnValue = isset($this->' . $valueHolder->getName() . '->$name);',

diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicSet.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicSet.php
@@ -18,6 +18,7 @@
 
 namespace ProxyManager\ProxyGenerator\AccessInterceptorValueHolder\MethodGenerator;
 
+use ProxyManager\Generator\MagicMethodGenerator;
 use ProxyManager\ProxyGenerator\AccessInterceptorValueHolder\MethodGenerator\Util\InterceptorGenerator;
 use ReflectionClass;
 use ProxyManager\Generator\MethodGenerator;
@@ -30,7 +31,7 @@
  * @author Marco Pivetta <ocramius@gmail.com>
  * @license MIT
  */
-class MagicSet extends MethodGenerator
+class MagicSet extends MagicMethodGenerator
 {
     /**
      * Constructor
@@ -41,11 +42,15 @@ public function __construct(
         PropertyGenerator $prefixInterceptors,
         PropertyGenerator $suffixInterceptors
     ) {
-        $inheritDoc  = $originalClass->hasMethod('__set') ? "{@inheritDoc}\n" : '';
+        parent::__construct(
+            $originalClass,
+            '__set',
+            array(new ParameterGenerator('name'), new ParameterGenerator('value'))
+        );
+
+        $inheritDoc = $originalClass->hasMethod('__set') ? "{@inheritDoc}\n" : '';
 
-        parent::__construct('__set');
         $this->setDocblock($inheritDoc . '@param string $name');
-        $this->setParameters(array(new ParameterGenerator('name'), new ParameterGenerator('value')));
         $this->setBody(
             InterceptorGenerator::createInterceptedMethodBody(
                 '$returnValue = ($this->' . $valueHolder->getName() . '->$name = $value);',

diff --git a/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicUnset.php b/src/ProxyManager/ProxyGenerator/AccessInterceptorValueHolder/MethodGenerator/MagicUnset.php
@@ -18,6 +18,7 @@
 
 namespace ProxyManager\ProxyGenerator\AccessInterceptorValueHolder\MethodGenerator;
 
+use ProxyManager\Generator\MagicMethodGenerator;
 use ProxyManager\ProxyGenerator\AccessInterceptorValueHolder\MethodGenerator\Util\InterceptorGenerator;
 use ReflectionClass;
 use ProxyManager\Generator\MethodGenerator;
@@ -30,7 +31,7 @@
  * @author Marco Pivetta <ocramius@gmail.com>
  * @license MIT
  */
-class MagicUnset extends MethodGenerator
+class MagicUnset extends MagicMethodGenerator
 {
     /**
      * Constructor
@@ -41,11 +42,11 @@ public function __construct(
         PropertyGenerator $prefixInterceptors,
         PropertyGenerator $suffixInterceptors
     ) {
-        $inheritDoc  = $originalClass->hasMethod('__isset') ? "{@inheritDoc}\n" : '';
+        parent::__construct($originalClass, '__unset', array(new ParameterGenerator('name')));
+
+        $inheritDoc = $originalClass->hasMethod('__isset') ? "{@inheritDoc}\n" : '';
 
-        parent::__construct('__unset');
         $this->setDocblock($inheritDoc . '@param string $name');
-        $this->setParameters(array(new ParameterGenerator('name')));
         $this->setBody(
             InterceptorGenerator::createInterceptedMethodBody(
                 'unset($this->' . $valueHolder->getName() . '->$name);' . "\n\n" . '$returnValue = true;',

diff --git a/src/ProxyManager/ProxyGenerator/Hydrator/MethodGenerator/DisabledMagicMethod.php b/src/ProxyManager/ProxyGenerator/Hydrator/MethodGenerator/DisabledMagicMethod.php
@@ -0,0 +1,46 @@
+<?php
+/*
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ */
+
+namespace ProxyManager\ProxyGenerator\Hydrator\MethodGenerator;
+
+use ProxyManager\Exception\DisabledMethodException;
+use ProxyManager\Generator\MagicMethodGenerator;
+use ProxyManager\Generator\MethodGenerator;
+
+/**
+ * Method generator for forcefully disabled methods
+ *
+ * @author Marco Pivetta <ocramius@gmail.com>
+ * @license MIT
+ */
+class DisabledMagicMethod extends MagicMethodGenerator
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function generate()
+    {
+        $this->setBody('throw \\' . DisabledMethodException::NAME . '::disabledMethod(__METHOD__);');
+        $this->setDocblock(
+            "{@inheritDoc}\n\n@internal disabled since this object is not a real proxy\n\n"
+            . "@throws \\ProxyManager\\Exception\\DisabledMethodException"
+        );
+
+        return parent::generate();
+    }
+}
diff --git a/src/ProxyManager/ProxyGenerator/HydratorGenerator.php b/src/ProxyManager/ProxyGenerator/HydratorGenerator.php
@@ -19,6 +19,7 @@
 namespace ProxyManager\ProxyGenerator;
 
 use ProxyManager\Generator\MethodGenerator;
+use ProxyManager\ProxyGenerator\Hydrator\MethodGenerator\DisabledMagicMethod;
 use ProxyManager\ProxyGenerator\Hydrator\MethodGenerator\GetAccessorProperties;
 use ProxyManager\ProxyGenerator\Hydrator\MethodGenerator\SetAccessorProperties;
 use ProxyManager\ProxyGenerator\Hydrator\PropertyGenerator\PropertyAccessor;
@@ -90,13 +91,15 @@ function (ReflectionMethod $method) use ($excluded) {
         }
 
         foreach (array('__clone', '__sleep', '__wakeup') as $magicMethod) {
-            $classGenerator->addMethodFromGenerator(new DisabledMethod($magicMethod));
+            $classGenerator->addMethodFromGenerator(new DisabledMagicMethod($originalClass, $magicMethod));
         }
 
-        $classGenerator->addMethodFromGenerator(new DisabledMethod('__get', array('name')));
-        $classGenerator->addMethodFromGenerator(new DisabledMethod('__set', array('name', 'value')));
-        $classGenerator->addMethodFromGenerator(new DisabledMethod('__isset', array('name')));
-        $classGenerator->addMethodFromGenerator(new DisabledMethod('__unset', array('name')));
+        $classGenerator->addMethodFromGenerator(new DisabledMagicMethod($originalClass, '__get', array('name')));
+        $classGenerator->addMethodFromGenerator(
+            new DisabledMagicMethod($originalClass, '__set', array('name', 'value'))
+        );
+        $classGenerator->addMethodFromGenerator(new DisabledMagicMethod($originalClass, '__isset', array('name')));
+        $classGenerator->addMethodFromGenerator(new DisabledMagicMethod($originalClass, '__unset', array('name')));
 
         $accessibleFlag         = ReflectionProperty::IS_PUBLIC | ReflectionProperty::IS_PROTECTED;
         $accessibleProperties   = $originalClass->getProperties($accessibleFlag);

diff --git a/src/ProxyManager/ProxyGenerator/LazyLoadingGhost/MethodGenerator/MagicClone.php b/src/ProxyManager/ProxyGenerator/LazyLoadingGhost/MethodGenerator/MagicClone.php
@@ -18,6 +18,7 @@
 
 namespace ProxyManager\ProxyGenerator\LazyLoadingGhost\MethodGenerator;
 
+use ProxyManager\Generator\MagicMethodGenerator;
 use ReflectionClass;
 use ProxyManager\Generator\MethodGenerator;
 use Zend\Code\Generator\PropertyGenerator;
@@ -28,23 +29,21 @@
  * @author Marco Pivetta <ocramius@gmail.com>
  * @license MIT
  */
-class MagicClone extends MethodGenerator
+class MagicClone extends MagicMethodGenerator
 {
     /**
      * Constructor
      */
     public function __construct(ReflectionClass $originalClass, PropertyGenerator $initializerProperty)
     {
-        parent::__construct('__clone');
+        parent::__construct($originalClass, '__clone');
 
-        $override    = $originalClass->hasMethod('__clone');
         $initializer = $initializerProperty->getName();
 
-        $this->setDocblock($override ? '{@inheritDoc}' : '');
         $this->setBody(
             '$this->' . $initializer . ' && $this->' . $initializer
             . '->__invoke($this, \'__clone\', array(), $this->' . $initializer . ');'
-            . ($override ? "\n\nparent::__clone();" : '')
+            . ($originalClass->hasMethod('__clone') ? "\n\nparent::__clone();" : '')
         );
     }
 }
diff --git a/src/ProxyManager/ProxyGenerator/LazyLoadingGhost/MethodGenerator/MagicGet.php b/src/ProxyManager/ProxyGenerator/LazyLoadingGhost/MethodGenerator/MagicGet.php
@@ -18,6 +18,7 @@
 
 namespace ProxyManager\ProxyGenerator\LazyLoadingGhost\MethodGenerator;
 
+use ProxyManager\Generator\MagicMethodGenerator;
 use ReflectionClass;
 use ProxyManager\Generator\MethodGenerator;
 use ProxyManager\Generator\ParameterGenerator;
@@ -30,14 +31,14 @@
  * @author Marco Pivetta <ocramius@gmail.com>
  * @license MIT
  */
-class MagicGet extends MethodGenerator
+class MagicGet extends MagicMethodGenerator
 {
     /**
      * Constructor
      */
     public function __construct(ReflectionClass $originalClass, PropertyGenerator $initializerProperty)
     {
-        parent::__construct('__get');
+        parent::__construct($originalClass, '__get', array(new ParameterGenerator('name')));
 
         $override         = $originalClass->hasMethod('__get');
         $initializer      = $initializerProperty->getName();
@@ -49,7 +50,6 @@ function (ReflectionProperty $publicProperty) {
         );
 
         $this->setDocblock(($override ? "{@inheritDoc}\n" : '') . '@param string $name');
-        $this->setParameters(array(new ParameterGenerator('name')));
 
         // @todo can be skipped when no public properties are available
         $callParent = 'if (in_array($name, array(' . implode(', ', $publicProperties) . '))) {' . "\n"