Merge pull request #29 from CakeDC/issue/cakephp-rule-accept-set-classname

Issue/cakephp rule accept set classname

Author: steinkel

rules.neon

@@ -16,6 +16,8 @@ parametersSchema:
 	])
 
 conditionalTags:
+	CakeDC\PHPStan\Visitor\AddAssociationSetClassNameVisitor:
+		phpstan.parser.richParserNodeVisitor: %cakeDC.addAssociationExistsTableClassRule%
 	CakeDC\PHPStan\Rule\Model\AddAssociationExistsTableClassRule:
 		phpstan.rules.rule: %cakeDC.addAssociationExistsTableClassRule%
 	CakeDC\PHPStan\Rule\Model\AddAssociationMatchOptionsTypesRule:
@@ -28,6 +30,8 @@ conditionalTags:
 		phpstan.rules.rule: %cakeDC.ormSelectQueryFindMatchOptionsTypesRule%
 
 services:
+	-
+		class: CakeDC\PHPStan\Visitor\AddAssociationSetClassNameVisitor
 	-
 		class: CakeDC\PHPStan\Rule\Model\AddAssociationExistsTableClassRule
 	-

src/Rule/LoadObjectExistsCakeClassRule.php

@@ -66,10 +66,13 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        $inputClassName = $this->getInputClassName(
-            $details['alias']->value,
-            $details['options']
-        );
+        $inputClassName = $this->getInputClassNameFromNode($node);
+        if ($inputClassName === null) {
+            $inputClassName = $this->getInputClassName(
+                $details['alias']->value,
+                $details['options']
+            );
+        }
         if ($this->getTargetClassName($inputClassName)) {
             return [];
         }
@@ -130,4 +133,13 @@ abstract protected function getTargetClassName(string $name): ?string;
      * @return array{'alias': ?\PhpParser\Node\Arg, 'options': ?\PhpParser\Node\Arg, 'sourceMethods':array<string>}|null
      */
     abstract protected function getDetails(string $reference, array $args): ?array;
+
+    /**
+     * @param \PhpParser\Node\Expr\MethodCall $node
+     * @return string|null
+     */
+    protected function getInputClassNameFromNode(MethodCall $node): ?string
+    {
+        return null;
+    }
 }

src/Rule/Model/AddAssociationExistsTableClassRule.php

@@ -16,6 +16,9 @@
 use Cake\ORM\AssociationCollection;
 use CakeDC\PHPStan\Rule\LoadObjectExistsCakeClassRule;
 use CakeDC\PHPStan\Utility\CakeNameRegistry;
+use CakeDC\PHPStan\Visitor\AddAssociationSetClassNameVisitor;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\MethodCall;
 
 class AddAssociationExistsTableClassRule extends LoadObjectExistsCakeClassRule
 {
@@ -69,4 +72,17 @@ protected function getDetails(string $reference, array $args): ?array
 
         return null;
     }
+
+    /**
+     * @inheritDoc
+     */
+    protected function getInputClassNameFromNode(MethodCall $node): ?string
+    {
+        $setClassNameValue = $node->getAttribute(AddAssociationSetClassNameVisitor::ATTRIBUTE_NAME);
+        if ($setClassNameValue instanceof Expr) {
+            return $this->parseClassNameFromExprTrait($setClassNameValue);
+        }
+
+        return null;
+    }
 }

src/Visitor/AddAssociationSetClassNameVisitor.php

@@ -0,0 +1,64 @@
+<?php
+declare(strict_types=1);
+
+namespace CakeDC\PHPStan\Visitor;
+
+use CakeDC\PHPStan\Rule\Traits\ParseClassNameFromArgTrait;
+use PhpParser\Node;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\NodeVisitorAbstract;
+
+class AddAssociationSetClassNameVisitor extends NodeVisitorAbstract
+{
+    use ParseClassNameFromArgTrait;
+
+    public const ATTRIBUTE_NAME = 'addAssociationVisitorOptions';
+
+    /**
+     * @param \PhpParser\Node\Expr|null $optionsSet
+     */
+    public function __construct(protected ?Expr $optionsSet = null)
+    {
+    }
+
+    /**
+     * @param array<\PhpParser\Node> $nodes
+     * @return array<\PhpParser\Node>|null
+     */
+    public function beforeTraverse(array $nodes): ?array
+    {
+        $this->optionsSet = null;
+
+        return null;
+    }
+
+    /**
+     * @param \PhpParser\Node $node
+     * @return \PhpParser\Node|null
+     */
+    public function enterNode(Node $node): ?Node
+    {
+        if (!$node instanceof MethodCall || !$node->name instanceof Node\Identifier) {
+            return null;
+        }
+        if ($this->optionsSet === null && $node->name->name === 'setClassName') {
+            $this->optionsSet = $node->args[0]->value ?? null;
+        }
+        if (in_array($node->name->name, ['load', 'belongsTo', 'belongsToMany', 'hasOne', 'hasMany'])) {
+            $node->setAttribute(self::ATTRIBUTE_NAME, $this->optionsSet);
+        }
+
+        return null;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function leaveNode(Node $node)
+    {
+        $this->optionsSet = null;
+
+        return null;
+    }
+}

tests/TestCase/Rule/Model/AddAssociationExistsTableClassRuleTest.php

@@ -54,6 +54,22 @@ public function testRule(): void
                 'Call to Cake\ORM\AssociationCollection::load could not find the class for "PalUsers"',
                 148,
             ],
+            [
+                'Call to CakeDC\PHPStan\Test\TestCase\Rule\Model\Fake\FailingRuleItemsTable::hasOne could not find the class for "Articles"',
+                187,
+            ],
+            [
+                'Call to CakeDC\PHPStan\Test\TestCase\Rule\Model\Fake\FailingRuleItemsTable::hasOne could not find the class for "SomeArticles"',
+                191,
+            ],
         ]);
     }
+
+    /**
+     * @inheritDoc
+     */
+    public static function getAdditionalConfigFiles(): array
+    {
+        return [__DIR__ . '/../../../../extension.neon'];
+    }
 }

tests/TestCase/Rule/Model/Fake/FailingRuleItemsTable.php

@@ -179,5 +179,21 @@ public function initialize(array $config): void
             'targetTable' => TableRegistry::getTableLocator()->get('Articles'),
         ]);
         $this->associations()->load(HasOne::class, 'Notes');
+        $this->hasOne('BakedArticles', [
+            'cascadeCallbacks' => true,
+            'conditions' => ['BakedArticles.baked' => 1],
+        ])->setClassName(VeryCustomize00009ArticlesTable::class);
+
+        $this->hasOne('CakeArticles', [
+            'cascadeCallbacks' => true,
+            'conditions' => ['CakeArticles.category_id' => 10],
+        ])->setClassName('Articles');
+        $this->hasOne('CakeArticles')
+            ->setFinder('myFinder')
+            ->setClassName('SomeArticles');
+        $this->associations()->load(HasOne::class, 'CleanArticles', [
+            'cascadeCallbacks' => true,
+            'conditions' => ['CleanArticles.clean' => 1],
+        ])->setClassName(VeryCustomize00009ArticlesTable::class);
     }
 }