Allow Controller to automatically instantiate classes in $model

Author: natanfelles

src/Controller.php

@@ -12,6 +12,7 @@
 use Framework\HTTP\Request;
 use Framework\HTTP\Response;
 use Framework\Routing\RouteActions;
+use LogicException;
 use ReflectionNamedType;
 use ReflectionProperty;
 
@@ -57,20 +58,19 @@ public function __construct(Request $request, Response $response)
      */
     protected function prepareModel() : static
     {
+        if ( ! \property_exists($this, 'model')) {
+            return $this;
+        }
         $property = new ReflectionProperty($this, 'model');
         $type = $property->getType();
-        // @phpstan-ignore-next-line
-        $types = $type instanceof ReflectionNamedType ? [$type] : $type->getTypes();
-        if (\count($types) > 1) {
-            foreach ($types as $type) {
-                $name = $type->getName();
-                if ($name === ModelInterface::class) {
-                    continue;
-                }
-                $this->model = new $name(); // @phpstan-ignore-line
-                break;
-            }
+        if ( ! $type instanceof ReflectionNamedType || $type->isBuiltin()) {
+            throw new LogicException(
+                'The ' . static::class
+                . '::$model property must have one type to be instantiated'
+            );
         }
+        $name = $type->getName();
+        $this->model = new $name();
         return $this;
     }
 

tests/ControllerMock.php

@@ -12,11 +12,10 @@
 use Framework\HTTP\Request;
 use Framework\HTTP\Response;
 use Framework\MVC\Controller;
-use Framework\MVC\ModelInterface;
 
 class ControllerMock extends Controller
 {
-    public ModelInterface | ModelMock $model;
+    public ModelMock $model;
 
     public function __construct()
     {

tests/ControllerTest.php

@@ -39,6 +39,45 @@ public function testModelInstance() : void
         self::assertInstanceOf(ModelMock::class, $this->controller->model);
     }
 
+    protected function expectModelPropertyException() : void
+    {
+        $this->expectException(\LogicException::class);
+        $this->expectExceptionMessageMatches(
+            '#The (.+)::\$model property must have one type to be instantiated#'
+        );
+    }
+
+    public function testModelPropertyUndefined() : void
+    {
+        $controller = new class(App::request(), App::response()) extends Controller {
+        };
+        self::assertFalse(\property_exists($controller, 'model'));
+    }
+
+    public function testModelPropertyWithoutType() : void
+    {
+        $this->expectModelPropertyException();
+        new class(App::request(), App::response()) extends Controller {
+            protected $model; // @phpstan-ignore-line
+        };
+    }
+
+    public function testModelPropertyWithBuiltinType() : void
+    {
+        $this->expectModelPropertyException();
+        new class(App::request(), App::response()) extends Controller {
+            protected int $model;
+        };
+    }
+
+    public function testModelPropertyWithManyTypes() : void
+    {
+        $this->expectModelPropertyException();
+        new class(App::request(), App::response()) extends Controller {
+            protected ModelMock | \stdClass $model;
+        };
+    }
+
     public function testRender() : void
     {
         self::assertSame(