feat(rules): Add AbstractMixedTypeRule for node processing

guanguans · guanguans · commit 8372569197c4 · 2026-01-18T02:23:59.000+08:00
- Introduced AbstractMixedTypeRule as a base class for handling mixed types in PHPStan rules.
- Implemented methods for node type retrieval and processing.
- Provides a structure for derived rules to define specific node types and processing logic.
diff --git a/src/Rule/AbstractMixedTypeRule.php b/src/Rule/AbstractMixedTypeRule.php
@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2026 guanguans<ityaozm@gmail.com>
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ *
+ * @see https://github.com/guanguans/phpstan-rules
+ */
+
+namespace Guanguans\PHPStanRules\Rule;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\IdentifierRuleError;
+use function Guanguans\PHPStanRules\Support\is_instance_of_any;
+
+/**
+ * @template TNodeType of Node
+ *
+ * @extends AbstractRule<Node>
+ */
+abstract class AbstractMixedTypeRule extends AbstractRule
+{
+    /**
+     * @return class-string<TNodeType>
+     */
+    final public function getNodeType(): string
+    {
+        return Node::class;
+    }
+
+    /**
+     * @param TNodeType $node
+     * @param \PHPStan\Analyser\NodeCallbackInvoker&\PHPStan\Analyser\Scope $scope
+     *
+     * @return list<IdentifierRuleError>
+     */
+    final public function processNode(Node $node, Scope $scope): array
+    {
+        return is_instance_of_any($node, $this->getNodeTypes()) ? $this->rawProcessNode($node, $scope) : [];
+    }
+
+    /**
+     * @return list<class-string<TNodeType>>
+     */
+    abstract protected function getNodeTypes(): array;
+
+    /**
+     * @param TNodeType $node
+     * @param \PHPStan\Analyser\NodeCallbackInvoker&\PHPStan\Analyser\Scope $scope
+     *
+     * @return list<IdentifierRuleError>
+     */
+    abstract protected function rawProcessNode(Node $node, Scope $scope): array;
+}
diff --git a/src/Rule/Class_/ExceptionMustImplementNativeThrowableRule.php b/src/Rule/Class_/ExceptionMustImplementNativeThrowableRule.php
@@ -13,7 +13,7 @@
 
 namespace Guanguans\PHPStanRules\Rule\Class_;
 
-use Guanguans\PHPStanRules\Rule\AbstractRule;
+use Guanguans\PHPStanRules\Rule\AbstractMixedTypeRule;
 use PhpParser\Node;
 use PhpParser\Node\Expr\New_;
 use PhpParser\Node\Identifier;
@@ -29,9 +29,9 @@
  * @see https://github.com/symfony/ai/blob/main/.phpstan/ForbidNativeExceptionRule.php
  * @see https://github.com/thecodingmachine/phpstan-strict-rules/tree/master/src/Rules/Exceptions/
  *
- * @extends AbstractRule<Class_|New_>
+ * @extends AbstractMixedTypeRule<Class_|New_>
  */
-final class ExceptionMustImplementNativeThrowableRule extends AbstractRule
+final class ExceptionMustImplementNativeThrowableRule extends AbstractMixedTypeRule
 {
     private string $nativeThrowable;
 
@@ -44,17 +44,20 @@ public function __construct(string $nativeThrowable)
         $this->nativeThrowable = $nativeThrowable;
     }
 
-    public function getNodeType(): string
+    protected function getNodeTypes(): array
     {
-        return Node::class;
+        return [
+            Class_::class,
+            New_::class,
+        ];
     }
 
     /**
      * @param \PhpParser\Node\Expr\New_|\PhpParser\Node\Stmt\Class_ $node
      *
      * @throws \PHPStan\ShouldNotHappenException
      */
-    public function processNode(Node $node, Scope $scope): array
+    protected function rawProcessNode(Node $node, Scope $scope): array
     {
         /** @var list<null|Identifier|Name> $classNameNodes */
         $classNameNodes = [];
@@ -67,10 +70,6 @@ public function processNode(Node $node, Scope $scope): array
             $classNameNodes = array_merge($classNameNodes, [$node->class]);
         }
 
-        if ([] === $classNameNodes) {
-            return [];
-        }
-
         return array_reduce(
             array_filter($classNameNodes),
             /**
diff --git a/tests/Rule/Class_/ExceptionMustImplementNativeThrowableRule/ExceptionMustImplementNativeThrowableRuleTest.php b/tests/Rule/Class_/ExceptionMustImplementNativeThrowableRule/ExceptionMustImplementNativeThrowableRuleTest.php
@@ -24,6 +24,8 @@
 use Guanguans\PHPStanRulesTests\Rule\Class_\ExceptionMustImplementNativeThrowableRule\Fixtures\NonImplementedNativeThrowableException;
 
 /**
+ * @covers \Guanguans\PHPStanRules\Rule\AbstractMixedTypeRule
+ * @covers \Guanguans\PHPStanRules\Rule\AbstractRule
  * @covers \Guanguans\PHPStanRules\Rule\Class_\ExceptionMustImplementNativeThrowableRule
  */
 final class ExceptionMustImplementNativeThrowableRuleTest extends AbstractRuleTestCase
diff --git a/tests/Rule/File/ForbiddenSideEffectsRule/ForbiddenSideEffectsRuleTest.php b/tests/Rule/File/ForbiddenSideEffectsRule/ForbiddenSideEffectsRuleTest.php
@@ -23,7 +23,6 @@
 use Guanguans\PHPStanRulesTests\Rule\AbstractRuleTestCase;
 
 /**
- * @covers \Guanguans\PHPStanRules\Rule\AbstractRule
  * @covers \Guanguans\PHPStanRules\Rule\File\ForbiddenSideEffectsRule
  */
 final class ForbiddenSideEffectsRuleTest extends AbstractRuleTestCase
