Method that works like stream_resolve_include_path but for a specific directory

Author: Bellangelo

src/Rules/Keywords/RequireFileExistsRule.php

@@ -5,13 +5,20 @@
 use PhpParser\Node;
 use PhpParser\Node\Expr\Include_;
 use PHPStan\Analyser\Scope;
+use PHPStan\File\FileHelper;
 use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
+use function dirname;
+use function explode;
+use function get_include_path;
+use function getcwd;
+use function is_file;
+use function is_string;
 use function sprintf;
 use function str_replace;
-use function stream_resolve_include_path;
+use const PATH_SEPARATOR;
 
 /**
  * @implements Rule<Include_>
@@ -30,7 +37,7 @@ public function processNode(Node $node, Scope $scope): array
 		$paths = $this->resolveFilePaths($node, $scope);
 
 		foreach ($paths as $path) {
-			if (stream_resolve_include_path($path) !== false) {
+			if ($this->doesFileExist($path, $scope)) {
 				continue;
 			}
 
@@ -40,6 +47,40 @@ public function processNode(Node $node, Scope $scope): array
 		return $errors;
 	}
 
+	/**
+	 * We cannot use `stream_resolve_include_path` as it works based on the calling script.
+	 * This method simulates the behavior of `stream_resolve_include_path` but for the given scope.
+	 * The priority order is the following:
+	 * 	1. The current working directory.
+	 * 	2. The include path.
+	 *  3. The path of the script that is being executed.
+	 */
+	private function doesFileExist(string $path, Scope $scope): bool
+	{
+		$directories = [
+			getcwd(),
+			...explode(PATH_SEPARATOR, get_include_path()),
+			dirname($scope->getFile()),
+		];
+
+		foreach ($directories as $directory) {
+			if (is_string($directory) && $this->doesFileExistForDirectory($path, $directory)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	private function doesFileExistForDirectory(string $path, string $workingDirectory): bool
+	{
+		$fileHelper = new FileHelper($workingDirectory);
+		$normalisedPath = $fileHelper->normalizePath($path);
+		$absolutePath = $fileHelper->absolutizePath($normalisedPath);
+
+		return is_file($absolutePath);
+	}
+
 	private function getErrorMessage(Include_ $node, string $filePath): IdentifierRuleError
 	{
 		$message = 'Path in %s() "%s" is not a file or it does not exist.';

tests/PHPStan/Rules/Keywords/RequireFileExistsRuleTest.php

@@ -4,7 +4,9 @@
 
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
+use function chdir;
 use function get_include_path;
+use function getcwd;
 use function implode;
 use function realpath;
 use function set_include_path;
@@ -72,24 +74,24 @@ public function testFileDoesNotExistConditionally(): void
 		]);
 	}
 
-	public function testRelativePathWithoutIncludePath(): void
+	public function testRelativePath(): void
 	{
 		$this->analyse([__DIR__ . '/data/require-file-relative-path.php'], [
 			[
-				'Path in include() "RequireFileExistsRuleTest.php" is not a file or it does not exist.',
-				3,
+				'Path in include() "data/include-me-to-prove-you-work.txt" is not a file or it does not exist.',
+				8,
 			],
 			[
-				'Path in include_once() "RequireFileExistsRuleTest.php" is not a file or it does not exist.',
-				4,
+				'Path in include_once() "data/include-me-to-prove-you-work.txt" is not a file or it does not exist.',
+				9,
 			],
 			[
-				'Path in require() "RequireFileExistsRuleTest.php" is not a file or it does not exist.',
-				5,
+				'Path in require() "data/include-me-to-prove-you-work.txt" is not a file or it does not exist.',
+				10,
 			],
 			[
-				'Path in require_once() "RequireFileExistsRuleTest.php" is not a file or it does not exist.',
-				6,
+				'Path in require_once() "data/include-me-to-prove-you-work.txt" is not a file or it does not exist.',
+				11,
 			],
 		]);
 	}
@@ -108,4 +110,16 @@ public function testRelativePathWithIncludePath(): void
 		}
 	}
 
+	public function testRelativePathWithSameWorkingDirectory(): void
+	{
+		$originalWorkingDirectory = getcwd();
+		chdir(__DIR__);
+
+		try {
+			$this->analyse([__DIR__ . '/data/require-file-relative-path.php'], []);
+		} finally {
+			chdir((string) $originalWorkingDirectory);
+		}
+	}
+
 }

tests/PHPStan/Rules/Keywords/data/require-file-relative-path.php

@@ -1,6 +1,11 @@
 <?php declare(strict_types=1);
 
-include 'RequireFileExistsRuleTest.php';
-include_once 'RequireFileExistsRuleTest.php';
-require 'RequireFileExistsRuleTest.php';
-require_once 'RequireFileExistsRuleTest.php';
+include 'include-me-to-prove-you-work.txt';
+include_once 'include-me-to-prove-you-work.txt';
+require 'include-me-to-prove-you-work.txt';
+require_once 'include-me-to-prove-you-work.txt';
+
+include 'data/include-me-to-prove-you-work.txt';
+include_once 'data/include-me-to-prove-you-work.txt';
+require 'data/include-me-to-prove-you-work.txt';
+require_once 'data/include-me-to-prove-you-work.txt';