Merge pull request #2 from sidz/teach-to-see-a-different-between-model-and-components

Teach see a difference between Component and Model especially when bo…

Author: sidz

src/ClassComponentsExtension.php

@@ -4,27 +4,103 @@
 
 namespace PHPStanCakePHP2;
 
-final class ClassComponentsExtension extends ClassPropertiesExtension
+use PhpParser\Node\Expr\Array_;
+use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Name\FullyQualified;
+use PhpParser\Node\Scalar\String_;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Reflection\PropertiesClassReflectionExtension;
+use PHPStan\Reflection\PropertyReflection;
+use PHPStan\Reflection\ReflectionProvider;
+
+final class ClassComponentsExtension implements PropertiesClassReflectionExtension
 {
-    protected function getPropertyParentClassName(): string
+    private ReflectionProvider $reflectionProvider;
+
+    public function __construct(ReflectionProvider $reflectionProvider)
     {
-        return 'Component';
+        $this->reflectionProvider = $reflectionProvider;
+    }
+
+    public function hasProperty(ClassReflection $classReflection, string $propertyName): bool
+    {
+        if (!array_filter($this->getContainingClassNames(), [$classReflection, 'is'])) {
+            return false;
+        }
+
+        $isDefinedInComponentsProperty = (bool) array_filter(
+            $this->getDefinedComponentsAsList($classReflection),
+            static fn (string $componentName): bool => $componentName === $propertyName
+        );
+
+        if (!$isDefinedInComponentsProperty) {
+            return false;
+        }
+
+        $propertyClassName = $this->getClassNameFromPropertyName($propertyName);
+
+        return $this->reflectionProvider->hasClass($propertyClassName)
+            && $this->reflectionProvider->getClass($propertyClassName)
+                ->is('Component');
+    }
+
+    public function getProperty(ClassReflection $classReflection, string $propertyName): PropertyReflection
+    {
+        return new PublicReadOnlyPropertyReflection(
+            $this->getClassNameFromPropertyName($propertyName),
+            $classReflection
+        );
     }
 
     /**
      * @return array<string>
      */
-    protected function getContainingClassNames(): array
+    private function getContainingClassNames(): array
     {
         return [
             'Controller',
             'Component',
         ];
     }
 
-    protected function getClassNameFromPropertyName(
-        string $propertyName
-    ): string {
-        return $propertyName . 'Component';
+    private function getClassNameFromPropertyName(string $propertyName): string
+    {
+        return str_contains($propertyName, 'Component') ? $propertyName : $propertyName . 'Component';
+    }
+
+    /**
+     * @return list<string>
+     */
+    private function getDefinedComponentsAsList(ClassReflection $classReflection): array
+    {
+        $definedComponents = [];
+
+        foreach (array_merge([$classReflection], $classReflection->getParents()) as $class) {
+            if (!$class->hasProperty('components')) {
+                continue;
+            }
+
+            $defaultValue = $class->getNativeProperty('components')
+                ->getNativeReflection()
+                ->getDefaultValueExpression();
+
+            if (!$defaultValue instanceof Array_) {
+               continue;
+            }
+
+            foreach ($defaultValue->items as $item) {
+                if ($item->value instanceof String_) {
+                    $definedComponents[] = $item->value->value;
+
+                    continue;
+                }
+
+                if ($item->value instanceof ClassConstFetch && $item->value->class instanceof FullyQualified) {
+                    $definedComponents[] = $item->value->class->toString();
+                }
+            }
+        }
+
+        return $definedComponents;
     }
 }

tests/Feature/ControllerExtensionsTest.php

@@ -16,6 +16,8 @@ public function dataFileAsserts(): iterable
         yield from $this->gatherAssertTypes(__DIR__ . '/data/existing_controller_model.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/existing_controller_component.php');
         yield from $this->gatherAssertTypes(__DIR__ . '/data/invalid_controller_property.php');
+        yield from $this->gatherAssertTypes(__DIR__ . '/data/existing_controller_component_with_same_method_name_as_model.php');
+        yield from $this->gatherAssertTypes(__DIR__ . '/data/existing_controller_component_from_parent_controller.php');
     }
 
     /**

tests/Feature/classes/Controller/BaseController.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+class BaseController extends Controller
+{
+    /**
+     * @var array<array-key, string>
+     */
+    public $components = ['Basic'];
+}

tests/Feature/classes/Controller/BasicController.php

@@ -1,3 +1,9 @@
 <?php
 
-class BasicController extends Controller {}
+class BasicController extends Controller
+{
+    /**
+     * @var array<array-key, string>
+     */
+    public $components = ['Basic'];
+}

tests/Feature/classes/Controller/Component/BasicComponent.php

@@ -1,3 +1,9 @@
 <?php
 
-class BasicComponent extends Component {}
+class BasicComponent extends Component
+{
+    /**
+     * @var array<array-key, string>
+     */
+    public $components = ['Second'];
+}

tests/Feature/classes/Controller/Component/SameAsModelComponent.php

@@ -0,0 +1,9 @@
+<?php
+
+class SameAsModelComponent extends Component
+{
+    public function sameMethod(): int
+    {
+        return 1;
+    }
+}

tests/Feature/classes/Controller/SameAsModelController.php

@@ -0,0 +1,12 @@
+<?php
+
+class SameAsModelController extends BaseController
+{
+    /**
+     * @var array<array-key, string>
+     */
+    public $components = [
+        'SameAsModel',
+        BasicComponent::class,
+    ];
+}

tests/Feature/classes/Model/SameAsModel.php

@@ -0,0 +1,9 @@
+<?php
+
+class SameAsModel extends Model
+{
+    public function sameMethod(): string
+    {
+        return 'test';
+    }
+}

tests/Feature/data/existing_controller_component_from_parent_controller.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types = 1);
+
+use function PHPStan\Testing\assertType;
+
+/** @var SameAsModelController $controller */
+$component = $controller->Basic;
+
+assertType('BasicComponent', $component);

tests/Feature/data/existing_controller_component_with_same_method_name_as_model.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types = 1);
+
+use function PHPStan\Testing\assertType;
+
+/** @var SameAsModelController $controller */
+$component = $controller->SameAsModel->sameMethod();
+
+assertType('int', $component);
+
+/** @var SameAsModelController $controller */
+$component = $controller->BasicComponent;
+
+assertType('BasicComponent', $component);