Merge pull request #3 from hirokinoue/name-node-holder-find-rule

カスタムルールのサンプルを追加する

Author: hirokinoue

Rules/NameNodeHolderFindRule.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Rules;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Node\InClassNode;
+use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\ObjectType;
+
+class NameNodeHolderFindRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return InClassNode::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (!$node instanceof InClassNode) {
+            return [];
+        }
+
+        $classLike = $node->getOriginalNode();
+        $properties = $classLike->getProperties();
+        $classReflection = $scope->getClassReflection();
+        foreach ($properties as $property) {
+            foreach($property->props as $prop) {
+                $propertyName = $prop->name->toString();
+                $propertyReflection = $classReflection->getNativeProperty($propertyName);
+                $propertyType = $propertyReflection->getReadableType();
+                $trinary = $propertyType->isSuperTypeOf(new ObjectType('PhpParser\Node\Name'));
+                if (!$trinary->no()) {
+                    return [
+                        RuleErrorBuilder::message(
+                            $classLike->namespacedName->toString()
+                        )->build(),
+                    ];
+                }
+            }
+        }
+        return [];
+    }
+}

Tests/NameNodeHolderFindRuleTest/NameNodeHolderFindRuleTest.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types = 1);
+
+namespace Tests\NameNodeHolderFindRuleTest;
+
+use Rules\NameNodeHolderFindRule;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<NameNodeHolderFindRuleTest>
+ */
+class NameNodeHolderFindRuleTest extends RuleTestCase
+{
+    protected function getRule(): Rule
+    {
+        return new NameNodeHolderFindRule();
+    }
+
+    /**
+     * @dataProvider data
+     */
+    public function testRule(string $file, array $expected): void
+    {
+        $this->analyse([$file], $expected);
+    }
+
+    public function data(): array
+    {
+        return [
+            [__DIR__ . '/data/name-holder.php', [['App\DummyFuncCall', 8]]],
+            [__DIR__ . '/data/non-name-holder.php', []],
+        ];
+    }
+}

Tests/NameNodeHolderFindRuleTest/data/name-holder.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\CallLike;
+
+class DummyFuncCall extends CallLike
+{
+    /** @var Node\Name|Expr Function name */
+    public $name;
+    /** @var array<Node\Arg|Node\VariadicPlaceholder> Arguments */
+    public $args;
+
+    /**
+     * Constructs a function call node.
+     *
+     * @param Node\Name|Expr                           $name       Function name
+     * @param array<Node\Arg|Node\VariadicPlaceholder> $args       Arguments
+     * @param array                                    $attributes Additional attributes
+     */
+    public function __construct($name, array $args = [], array $attributes = []) {
+        $this->attributes = $attributes;
+        $this->name = $name;
+        $this->args = $args;
+    }
+
+    public function getSubNodeNames() : array {
+        return ['name', 'args'];
+    }
+
+    public function getType() : string {
+        return 'Expr_FuncCall';
+    }
+
+    public function getRawArgs(): array {
+        return $this->args;
+    }
+}
+

Tests/NameNodeHolderFindRuleTest/data/non-name-holder.php

@@ -0,0 +1,34 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+use PhpParser\Node\Expr;
+
+class DummyArrayDimFetch extends Expr
+{
+    /** @var Expr Variable */
+    public $var;
+    /** @var null|Expr Array index / dim */
+    public $dim;
+
+    /**
+     * Constructs an array index fetch node.
+     *
+     * @param Expr      $var        Variable
+     * @param null|Expr $dim        Array index / dim
+     * @param array     $attributes Additional attributes
+     */
+    public function __construct(Expr $var, Expr $dim = null, array $attributes = []) {
+        $this->attributes = $attributes;
+        $this->var = $var;
+        $this->dim = $dim;
+    }
+
+    public function getSubNodeNames() : array {
+        return ['var', 'dim'];
+    }
+
+    public function getType() : string {
+        return 'Expr_ArrayDimFetch';
+    }
+}

phpstan.neon

@@ -1,3 +1,4 @@
 rules:
     - Rules\MyRule
     - Rules\CallStaticMethodInClassRule
+    - Rules\NameNodeHolderFindRule