Merge pull request #38 from facile-it/hotfix/properties-stub

Fix property stubs

Author: xzhayon

README.md

@@ -186,6 +186,22 @@ Moka::prophecy(FooInterface::class)
     ->willReturn($something);
 ```
 
+**Warning:** this workaround cannot be used with methods having the same name as a previously stubbed property:
+
+```php
+Moka::prophecy(FooInterface::class, 'foo')->stub([
+    '$someName' => true
+]);
+
+var_dump(Moka::prophecy('foo')->someName);
+// bool(true)
+
+Moka::prophecy('foo')
+    ->someName->set(new AnyValuesToken())
+    ->willReturn($something);
+// throws \Exception
+```
+
 ## Plugin development
 
 If you feel a genius and want to create your own mock generator (or add support for an existing one), just implement `Moka\Plugin\PluginInterface` and the relative `Moka\Strategy\MockingStrategyInterface`:

src/Moka/Factory/StubFactory.php

@@ -6,6 +6,7 @@
 use Moka\Exception\InvalidArgumentException;
 use Moka\Stub\MethodStub;
 use Moka\Stub\PropertyStub;
+use Moka\Stub\StubHelper;
 use Moka\Stub\StubInterface;
 use Moka\Stub\StubSet;
 
@@ -26,7 +27,7 @@ public static function fromArray(array $namesWithValues): StubSet
         $stubSet = new StubSet();
         foreach ($namesWithValues as $name => $value) {
             try {
-                $stub = StubInterface::PREFIX_PROPERTY === $name[0]
+                $stub = StubHelper::isPropertyName($name)
                     ? new PropertyStub($name, $value)
                     : new MethodStub($name, $value);
 

src/Moka/Generator/Template/ClassTemplate.php

@@ -12,7 +12,7 @@
  */
 class ClassTemplate implements TemplateInterface
 {
-    const UNSAFE_METHODS = ['__construct', '__destruct', '__call', '__clone'];
+    const UNSAFE_METHODS = ['__construct', '__destruct', '__call', '__get', '__clone'];
 
     const TEMPLATE_FQCN = 'Moka_%s_%s';
 
@@ -28,8 +28,6 @@ public function __construct()
             %s
         }
         
-        %s
-        
         public function __call(%s $name, %s $arguments)
         {
             return $this->doCall($name, $arguments);
@@ -39,6 +37,8 @@ public function __get(%s $name)
         {
             return $this->doGet($name);
         }
+
+        %s
     };
     
     return "%s";
@@ -66,20 +66,16 @@ protected static function doGenerate(\ReflectionClass $class): string
 
         $methods = $class->getMethods(\ReflectionMethod::IS_PUBLIC);
         $methodsCode = [];
-        $methodNames = array_map(function (\ReflectionMethod $method) {
-            return $method->name;
-        }, $methods);
 
         $callParametersTypes = array_fill(0, 2, '');
         $getNameType = '';
 
         foreach ($properties as $property) {
-            if (!in_array($property->name, $methodNames)) {
+            if ($property->isStatic()) {
                 continue;
             }
 
             $propertiesCode[] = PropertyTemplate::generate($property);
-
             $constructorCode[] = PropertyInitializationTemplate::generate($property);
         }
 
@@ -120,10 +116,10 @@ protected static function doGenerate(\ReflectionClass $class): string
             ProxyTrait::class,
             implode(PHP_EOL, $propertiesCode),
             implode(PHP_EOL, $constructorCode),
-            implode(PHP_EOL, $methodsCode),
             $callNameType ?: '',
             $callArgumentsType ?: '',
             $getNameType,
+            implode(PHP_EOL, $methodsCode),
             $proxyClassName
         );
     }

src/Moka/Generator/Template/PropertyInitializationTemplate.php

@@ -10,9 +10,7 @@
 class PropertyInitializationTemplate implements TemplateInterface
 {
     const TEMPLATE = '
-            %s%s = function () {
-                return $this->doGet("%s");
-            };
+            unset(%s%s);
     ';
 
     /**

src/Moka/Plugin/Phake/Matcher/FirstStubMatcher.php

@@ -73,7 +73,7 @@ public function doArgumentsMatch(array &$arguments)
      */
     public function __toString()
     {
-        return '';
+        return get_class($this);
     }
 
     /**

src/Moka/Plugin/Prophecy/Token/AbstractPriorityToken.php

@@ -58,6 +58,6 @@ public function isLast()
      */
     public function __toString()
     {
-        return '';
+        return get_class($this);
     }
 }

src/Moka/Proxy/ProxyInterface.php

@@ -14,11 +14,11 @@
 interface ProxyInterface
 {
     /**
-     * @param array $methodsWithValues
+     * @param array $namesWithValues
      * @return ProxyInterface
      *
      * @throws InvalidArgumentException
      * @throws MockNotCreatedException
      */
-    public function stub(array $methodsWithValues): ProxyInterface;
+    public function stub(array $namesWithValues): ProxyInterface;
 }

src/Moka/Proxy/ProxyTrait.php

@@ -6,6 +6,7 @@
 use Moka\Exception\InvalidArgumentException;
 use Moka\Exception\MockNotCreatedException;
 use Moka\Strategy\MockingStrategyInterface;
+use Moka\Stub\StubHelper;
 
 /**
  * Trait ProxyTrait
@@ -23,6 +24,16 @@ trait ProxyTrait
      */
     private $__moka_mockingStrategy;
 
+    /**
+     * @var array
+     */
+    private $__moka_properties = [];
+
+    /**
+     * @var array
+     */
+    private $__moka_methods = [];
+
     /**
      * @return object
      */
@@ -62,6 +73,16 @@ public function __moka_setMockingStrategy(MockingStrategyInterface $mockingStrat
      */
     public function stub(array $namesWithValues): ProxyInterface
     {
+        foreach ($namesWithValues as $name => $value) {
+            if (StubHelper::isPropertyName($name)) {
+                $this->__moka_properties[] = StubHelper::stripName($name);
+            }
+
+            if (StubHelper::isMethodName($name)) {
+                $this->__moka_methods[] = StubHelper::stripName($name);
+            }
+        }
+
         /** @var $this ProxyInterface */
         $this->__moka_mockingStrategy->decorate($this->__moka_mock, $namesWithValues);
 
@@ -94,6 +115,10 @@ protected function doGet(string $name)
             return null;
         }
 
+        if (in_array($name, $this->__moka_properties)) {
+            return $this->__moka_mockingStrategy->get($this->__moka_mock)->$name;
+        }
+
         return $this->__moka_mockingStrategy->call($this->__moka_mock, $name);
     }
 }

src/Moka/Stub/AbstractStub.php

@@ -11,8 +11,6 @@
  */
 abstract class AbstractStub implements StubInterface
 {
-    const REGEX_NAME = '/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/';
-
     /**
      * @var string
      */
@@ -32,16 +30,7 @@ abstract class AbstractStub implements StubInterface
      */
     public function __construct(string $name, $value)
     {
-        if (!preg_match(self::REGEX_NAME, $name)) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'Name must be a valid variable or method name, "%s" given',
-                    $name
-                )
-            );
-        }
-
-        $this->name = $name;
+        $this->name = StubHelper::stripName($name);
         $this->value = $value;
     }
 

src/Moka/Stub/MethodStub.php

@@ -3,10 +3,25 @@
 
 namespace Moka\Stub;
 
+use Moka\Exception\InvalidArgumentException;
+
 /**
  * Class MethodStub
  * @package Moka\Stub
  */
 class MethodStub extends AbstractStub
 {
+    /**
+     * MethodStub constructor.
+     * @param string $name
+     * @param mixed $value
+     *
+     * @throws InvalidArgumentException
+     */
+    public function __construct(string $name, $value)
+    {
+        StubHelper::validateMethodName($name);
+
+        parent::__construct($name, $value);
+    }
 }