Merge pull request #436 from longwave/static-class-concatenation

Allow static::class . '::methodName' concatenation in lazy builders.

Author: mglaman

composer.json

@@ -46,7 +46,8 @@
             "mglaman\\PHPStanDrupal\\Tests\\": "tests/src/"
         },
         "classmap": [
-            "tests/src/Type/data"
+            "tests/src/Type/data",
+            "tests/src/Rules/data"
         ]
     },
     "extra": {

src/Rules/Drupal/RenderCallbackRule.php

@@ -19,6 +19,7 @@
 use PHPStan\Type\Generic\GenericClassStringType;
 use PHPStan\Type\IntersectionType;
 use PHPStan\Type\ObjectType;
+use PHPStan\Type\StaticType;
 use PHPStan\Type\ThisType;
 use PHPStan\Type\Type;
 use PHPStan\Type\UnionType;
@@ -149,6 +150,12 @@ private function doProcessNode(Node\Expr $node, Scope $scope, string $keyChecked
                     ->tip('Change record: https://www.drupal.org/node/2966725.')
                     ->build();
             }
+
+            if (!$trustedCallbackType->isSuperTypeOf($type)->yes()) {
+                return RuleErrorBuilder::message(
+                    sprintf("%s callback class %s at key '%s' does not implement Drupal\Core\Security\TrustedCallbackInterface.", $keyChecked, $type->describe(VerbosityLevel::value()), $pos)
+                )->line($errorLine)->tip('Change record: https://www.drupal.org/node/2966725.')->build();
+            }
         } elseif ($type instanceof ConstantArrayType) {
             if (!$type->isCallable()->yes()) {
                 return RuleErrorBuilder::message(
@@ -185,25 +192,6 @@ private function doProcessNode(Node\Expr $node, Scope $scope, string $keyChecked
                     sprintf("%s callback %s at key '%s' is not callable.", $keyChecked, $type->describe(VerbosityLevel::value()), $pos)
                 )->line($errorLine)->build();
             }
-        } elseif ($type instanceof IntersectionType) {
-            // Try to provide a tip for this weird occurrence.
-            $tip = '';
-            if ($node instanceof Node\Expr\BinaryOp\Concat) {
-                $leftStringType = $scope->getType($node->left)->toString();
-                $rightStringType = $scope->getType($node->right)->toString();
-                if ($leftStringType instanceof GenericClassStringType && $rightStringType instanceof ConstantStringType) {
-                    $methodName = str_replace(':', '', $rightStringType->getValue());
-                    $tip = "Refactor concatenation of `static::class` with method name to an array callback: [static::class, '$methodName']";
-                }
-            }
-
-            if ($tip === '') {
-                $tip = 'If this error is unexpected, open an issue with the error and sample code https://github.com/mglaman/phpstan-drupal/issues/new';
-            }
-
-            return RuleErrorBuilder::message(
-                sprintf("%s value '%s' at key '%s' is invalid.", $keyChecked, $type->describe(VerbosityLevel::value()), $pos)
-            )->line($errorLine)->tip($tip)->build();
         } else {
             return RuleErrorBuilder::message(
                 sprintf("%s value '%s' at key '%s' is invalid.", $keyChecked, $type->describe(VerbosityLevel::value()), $pos)
@@ -217,7 +205,22 @@ private function doProcessNode(Node\Expr $node, Scope $scope, string $keyChecked
     private function getType(Node\Expr $node, Scope $scope):  Type
     {
         $type = $scope->getType($node);
-        if ($type instanceof ConstantStringType) {
+        if ($type instanceof IntersectionType) {
+            // Covers concatenation of static::class . '::methodName'.
+            if ($node instanceof Node\Expr\BinaryOp\Concat) {
+                $leftType = $scope->getType($node->left);
+                $rightType = $scope->getType($node->right);
+                if ($rightType instanceof ConstantStringType && $leftType instanceof GenericClassStringType && $leftType->getGenericType() instanceof StaticType) {
+                    return new ConstantArrayType(
+                        [new ConstantIntegerType(0), new ConstantIntegerType(1)],
+                        [
+                            $leftType->getGenericType(),
+                            new ConstantStringType(ltrim($rightType->getValue(), ':'))
+                        ]
+                    );
+                }
+            }
+        } elseif ($type instanceof ConstantStringType) {
             if ($type->isClassString()) {
                 return $type;
             }
@@ -243,7 +246,7 @@ private function getType(Node\Expr $node, Scope $scope):  Type
                 return new ConstantArrayType(
                     [new ConstantIntegerType(0), new ConstantIntegerType(1)],
                     [
-                        new ConstantStringType($matches[1], true),
+                        new StaticType($this->reflectionProvider->getClass($matches[1])),
                         new ConstantStringType($matches[2])
                     ]
                 );

tests/src/Rules/RenderCallbackRuleTest.php

@@ -52,7 +52,7 @@ public function fileData(): \Generator
                     'Change record: https://www.drupal.org/node/2966725.',
                 ],
                 [
-                    "#pre_render callback class 'Drupal\pre_render_callback_rule\NotTrustedCallback' at key '3' does not implement Drupal\Core\Security\TrustedCallbackInterface.",
+                    "#pre_render callback class 'static(Drupal\pre_render_callback_rule\NotTrustedCallback)' at key '3' does not implement Drupal\Core\Security\TrustedCallbackInterface.",
                     29,
                     'Change record: https://www.drupal.org/node/2966725.',
                 ],
@@ -65,27 +65,15 @@ public function fileData(): \Generator
         ];
         yield [
             __DIR__ . '/../../fixtures/drupal/modules/pre_render_callback_rule/src/RenderArrayWithPreRenderCallback.php',
-            [
-                [
-                    "#pre_render value 'non-empty-string' at key '3' is invalid.",
-                    19,
-                    "Refactor concatenation of `static::class` with method name to an array callback: [static::class, 'preRenderCallback']"
-                ]
-            ]
+            []
         ];
         yield [
             __DIR__ . '/../../fixtures/drupal/modules/pre_render_callback_rule/src/RenderCallbackInterfaceObject.php',
             []
         ];
         yield [
             __DIR__ . '/../../fixtures/drupal/modules/pre_render_callback_rule/src/LazyBuilderWithConstant.php',
-            [
-                [
-                    "#lazy_builder value 'non-empty-string' at key '0' is invalid.",
-                    25,
-                    "Refactor concatenation of `static::class` with method name to an array callback: [static::class, 'lazyBuilder']"
-                ]
-            ]
+            []
         ];
         yield [
             __DIR__ . '/../../fixtures/drupal/modules/pre_render_callback_rule/src/FormWithClosure.php',
@@ -112,9 +100,9 @@ public function fileData(): \Generator
             __DIR__ . '/data/bug-424.php',
             [
                 [
-                    "#lazy_builder value 'non-empty-string' at key '0' is invalid.",
+                    "#lazy_builder callback class 'static(Bug424\Foo)' at key '0' does not implement Drupal\Core\Security\TrustedCallbackInterface.",
                     10,
-                    "Refactor concatenation of `static::class` with method name to an array callback: [static::class, 'contentLazyBuilder']"
+                    "Change record: https://www.drupal.org/node/2966725."
                 ],
                 [
                     "#lazy_builder callback class 'static(Bug424\Foo)' at key '0' does not implement Drupal\Core\Security\TrustedCallbackInterface.",