AbstractCallHandler: Check data type when setting a property in an object.

Author: ThomasNunninger

src/Magic/AbstractCallHandler.php

@@ -12,10 +12,11 @@
 
 namespace ScaleUpStack\EasyObject\Magic;
 
+use ScaleUpStack\Metadata\FeatureAnalyzers\TypedProperties;
+use ScaleUpStack\Metadata\FeatureAnalyzers\TypedPropertyMetadata;
 use ScaleUpStack\Metadata\FeatureAnalyzers\VirtualMethods;
 use ScaleUpStack\Metadata\FeatureAnalyzers\VirtualMethodMetadata;
 use ScaleUpStack\Metadata\Metadata\ClassMetadata;
-use ScaleUpStack\Metadata\Metadata\PropertyMetadata;
 use ScaleUpStack\Reflection\Reflection;
 
 abstract class AbstractCallHandler implements CallHandler
@@ -94,8 +95,24 @@ protected function propertyName(
         return null;
     }
 
-    protected function setProperty(object $object, string $propertyName, $value, PropertyMetadata $propertyMetadata)
+    protected function setProperty(object $object, string $propertyName, $value, ClassMetadata $classMetadata)
     {
+        /** @var TypedPropertyMetadata $typedPropertyMetadata */
+        $typedPropertyMetadata = $classMetadata->features[TypedProperties::class][$propertyName];
+        $isValid = $typedPropertyMetadata->docBlockDataTypeMetadata()->validateVariable($value, $object);
+
+        if (! $isValid) {
+            throw new \TypeError(
+                sprintf(
+                    "Value for property %s::\$%s must be of the type %s, %s given",
+                    get_class($object),
+                    $propertyName,
+                    $typedPropertyMetadata->docBlockDataTypeMetadata()->declaration(),
+                    gettype($value)
+                )
+            );
+        }
+
         Reflection::setPropertyValue($object, $propertyName, $value);
     }
 }

src/Magic/FixtureBuilder.php

@@ -111,7 +111,7 @@ private function executeBuild(object $object, ClassMetadata $toBeBuildClassMetad
                 $value = eval($phpString);
             }
 
-            $this->setProperty($newObject, $propertyName, $value, $propertyMetadata);
+            $this->setProperty($newObject, $propertyName, $value, $toBeBuildClassMetadata);
         }
 
         return $newObject;

src/Magic/NamedConstructor.php

@@ -97,7 +97,7 @@ public function execute($objectOrClassName, string $methodName, array $arguments
                 $newObject,
                 $propertyMetadata->name,
                 $arguments[$counter],
-                $propertyMetadata
+                $classMetadata
             );
 
             $counter++;

tests/PhpUnit/Magic/AbstractCallHandlerTest.php

@@ -141,7 +141,7 @@ public function it_sets_the_value_of_an_object_when_type_matches()
                 $object,
                 $propertyName,
                 $newValue,
-                $this->classMetadata->propertyMetadata[$propertyName]
+                $this->classMetadata
             );
 
         // then the property of the object is set
@@ -150,4 +150,37 @@ public function it_sets_the_value_of_an_object_when_type_matches()
             Reflection::getPropertyValue($object, 'someProperty')
         );
     }
+
+    /**
+     * @test
+     * @covers ::setProperty()
+     */
+    public function it_throws_an_exception_when_setting_the_property_of_an_object_with_an_invalid_type()
+    {
+        // given a mocked AbstractCallHandler, and ClassMetadata of some object as provided in setUp(),
+        // and some object, a property name, and an invalid value
+        $object = new ClassForAbstractCallHandlerTesting();
+        $propertyName = 'someProperty';
+        $invalidValue = 42;
+
+        // when requesting the property name
+        // then an Exception is thrown
+        $this->expectException(\TypeError::class);
+        $this->expectExceptionMessage(
+            sprintf(
+                "Value for property %s::\$%s must be of the type string, integer given",
+                ClassForAbstractCallHandlerTesting::class,
+                $propertyName
+            )
+        );
+
+        Reflection::methodOfClass(AbstractCallHandler::class, 'setProperty')
+            ->invoke(
+                $this->callHandler,
+                $object,
+                $propertyName,
+                $invalidValue,
+                $this->classMetadata
+            );
+    }
 }

tests/bootstrap.php

@@ -13,9 +13,11 @@
  */
 
 use ScaleUpStack\Metadata\Configuration;
+use ScaleUpStack\Metadata\FeatureAnalyzers\TypedProperties;
 use ScaleUpStack\Metadata\FeatureAnalyzers\VirtualMethods;
 
 require_once __DIR__ . '/../vendor/autoload.php';
 
 // register FeatureAnalyzers in ScaleUpStack\Metadata\Configuration
 Configuration::registerFeatureAnalyzer(new VirtualMethods());
+Configuration::registerFeatureAnalyzer(new TypedProperties());