getConstantStrings() can handle all the manipulation of the path

Author: Bellangelo

src/Rules/Keywords/RequireFileExistsRule.php

@@ -3,21 +3,10 @@
 namespace PHPStan\Rules\Keywords;
 
 use PhpParser\Node;
-use PhpParser\Node\Expr\BinaryOp\Concat;
-use PhpParser\Node\Expr\ClassConstFetch;
-use PhpParser\Node\Expr\ConstFetch;
 use PhpParser\Node\Expr\Include_;
-use PhpParser\Node\Identifier;
-use PhpParser\Node\Name;
-use PhpParser\Node\Scalar\MagicConst\Dir;
-use PhpParser\Node\Scalar\String_;
 use PHPStan\Analyser\Scope;
-use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use function constant;
-use function defined;
-use function dirname;
 use function is_string;
 use function sprintf;
 
@@ -26,11 +15,6 @@
  */
 final class RequireFileExistsRule implements Rule
 {
-
-	public function __construct(private ReflectionProvider $reflectionProvider)
-	{
-	}
-
 	public function getNodeType(): string
 	{
 		return Include_::class;
@@ -39,7 +23,7 @@ public function getNodeType(): string
 	public function processNode(Node $node, Scope $scope): array
 	{
 		if ($this->shouldProcessNode($node)) {
-			$filePath = $this->resolveFilePath($node->expr, $scope);
+			$filePath = $this->resolveFilePath($node, $scope);
 			if (is_string($filePath) && !is_file($filePath)) {
 				return [
 					$this->getErrorMessage($node, $filePath)->build()
@@ -73,67 +57,11 @@ private function getErrorMessage(Include_ $node, string $filePath): RuleErrorBui
 		);
 	}
 
-	private function resolveFilePath(Node $node, Scope $scope): ?string
-	{
-		if ($node instanceof String_) {
-			return $node->value;
-		}
-
-		if ($node instanceof Dir) {
-			return dirname($scope->getFile());
-		}
-
-		if ($node instanceof ClassConstFetch) {
-			return $this->resolveClassConstant($node);
-		}
-
-		if ($node instanceof ConstFetch) {
-			return $this->resolveConstant($node);
-		}
-
-		if ($node instanceof Concat) {
-			$left = $this->resolveFilePath($node->left, $scope);
-			$right = $this->resolveFilePath($node->right, $scope);
-			if ($left !== null && $right !== null) {
-				return $left . $right;
-			}
-		}
-
-		return null;
-	}
-
-	private function resolveClassConstant(ClassConstFetch $node): ?string
+	private function resolveFilePath(Include_ $node, Scope $scope): ?string
 	{
-		if ($node->class instanceof Name && $node->name instanceof Identifier) {
-			$className = (string) $node->class;
-			$constantName = $node->name->toString();
+		$type = $scope->getType($node->expr);
+		$paths = $type->getConstantStrings();
 
-			if ($this->reflectionProvider->hasClass($className)) {
-				$classReflection = $this->reflectionProvider->getClass($className);
-				if ($classReflection->hasConstant($constantName)) {
-					$constantReflection = $classReflection->getConstant($constantName);
-					$constantValue = $constantReflection->getValue();
-					if (is_string($constantValue)) {
-						return $constantValue;
-					}
-				}
-			}
-		}
-		return null;
+		return $paths ? $paths[0]->getValue() : null;
 	}
-
-	private function resolveConstant(ConstFetch $node): ?string
-	{
-		if ($node->name instanceof Name) {
-			$constantName = (string) $node->name;
-			if (defined($constantName)) {
-				$constantValue = constant($constantName);
-				if (is_string($constantValue)) {
-					return $constantValue;
-				}
-			}
-		}
-		return null;
-	}
-
 }

tests/PHPStan/Rules/Keywords/RequireFileExistsRuleTest.php

@@ -83,14 +83,28 @@ public function testFileExistsUsingDIR(): void
 		$this->analyse([__DIR__ . '/data/file-exists-using-DIR.php'], []);
 	}
 
-	public function testFileDoesNotExistButUsesClassProperties(): void
+	public function testFileExistsUsingVariables(): void
 	{
-		$this->analyse([__DIR__ . '/data/file-does-not-exist-but-uses-a-class-property.php'], []);
+		$this->analyse([__DIR__ . '/data/file-exists-using-a-variable.php'], []);
 	}
 
 	public function testFileDoesNotExistButUsesVariables(): void
 	{
-		$this->analyse([__DIR__ . '/data/file-does-not-exist-but-uses-a-variable.php'], []);
+		$this->analyse([__DIR__ . '/data/file-does-not-exist-but-uses-a-variable.php'], [
+			[
+				'Path in require() "a-file-that-does-not-exist.php" is not a file or it does not exist.',
+				7,
+			],
+			[
+				'Path in require_once() "a-file-that-does-not-exist.php" is not a file or it does not exist.',
+				8,
+			],
+		]);
+	}
+
+	public function testFileDoesNotExistButUsesClassProperties(): void
+	{
+		$this->analyse([__DIR__ . '/data/file-does-not-exist-but-uses-a-class-property.php'], []);
 	}
 
 	public function testFileDoesNotExistButUsesClassMethods(): void

tests/PHPStan/Rules/Keywords/data/file-exists-using-a-variable.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+$includedFile = __DIR__ . 'include-me-to-prove-you-work.txt';
+
+include $includedFile;
+include_once $includedFile;
+require $includedFile;
+require_once $includedFile;