Align repo with latest cases

Author: Bellangelo

README.md

@@ -1,38 +1,15 @@
 # phpstan-require-file-exists
-Weirdly enough, PHPStan does not check if a file exists when used in a
+**UPDATE:** This rule has been merged into PHPStan itself. Here is the PR: https://github.com/phpstan/phpstan-src/pull/3294
+
+~~Weirdly enough, PHPStan does not check if a file exists when used in a
 `require` or `include` statement. This is a PHPStan rule that tries to do
-exactly that.
+exactly that.~~
 
 ## Installation
 ```bash
 composer require --dev bellangelo/phpstan-require-file-exists
 ```
 
-## Configuration
-Add the following to your `phpstan.neon`:
-```neon
-services:
-    -
-        class: Bellangelo\PHPStanRequireFileExists\RequireFileExistsRule
-        arguments:
-           - @reflectionProvider
-        tags: [phpstan.rules.rule]
-```
-
-You can find a `phpstan.neon` example in the `tests` directory, here: [tests/phpstan.neon](tests/phpstan-testing.neon).
-
-## Supported cases
-- `require 'file.php';` - might not find it since the path is relative.
-- `require __DIR__ . '/file.php';` - can find it, if it exists.
-- `require __DIR__ . '/' . MyClass::MY_CONST;` - can find it if the const has the correct value from the start.
-- `require __DIR__ . '/' . MY_CONST;` - can find it if the constant is defined in the bootstrap file.
-
-## Unsupported cases
-- `require $file;` - won't throw an error since it cannot read variables.
-- `require (new MyClass())->file;` - won't throw an error since it cannot read class properties.
-- `require (new MyClass())->getFile();` - won't throw an error since it cannot read class methods.
-- `require getFile();` - won't throw an error since it cannot read functions.
-
 ## Development
 For local development and testing, `composer.json` contains several commands that you can run.
 - `composer run tests ` - runs the PHPUnit tests.

src/RequireFileExistsRule.php

@@ -12,12 +12,14 @@
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
 use PHPStan\ShouldNotHappenException;
+
 use function array_merge;
 use function dirname;
 use function explode;
 use function get_include_path;
 use function is_file;
 use function sprintf;
+
 use const PATH_SEPARATOR;
 
 /**
@@ -57,8 +59,8 @@ public function processNode(Node $node, Scope $scope): array
      * 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.
+     *  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
@@ -80,6 +82,7 @@ private function doesFileExist(string $path, Scope $scope): bool
 
     private function doesFileExistForDirectory(string $path, string $workingDirectory): bool
     {
+        /** @phpstan-ignore-next-line */
         $fileHelper = new FileHelper($workingDirectory);
         $normalisedPath = $fileHelper->normalizePath($path);
         $absolutePath = $fileHelper->absolutizePath($normalisedPath);
@@ -138,5 +141,4 @@ private function resolveFilePaths(Include_ $node, Scope $scope): array
 
         return $paths;
     }
-
-}
+}

tests/RequireFileExistsRuleTest.php

@@ -1,24 +1,25 @@
 <?php
 
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Tests;
 
 use Bellangelo\PHPStanRequireFileExists\RequireFileExistsRule;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
+
 use function get_include_path;
 use function implode;
 use function realpath;
 use function set_include_path;
+
 use const PATH_SEPARATOR;
 
 /**
  * @extends RuleTestCase<RequireFileExistsRule>
  */
 class RequireFileExistsRuleTest extends RuleTestCase
 {
-
     private RequireFileExistsRule $rule;
 
     public function setUp(): void
@@ -135,5 +136,4 @@ public function testRelativePathWithSameWorkingDirectory(): void
             $this->rule = $this->getDefaultRule();
         }
     }
-
-}
+}

tests/data/require-file-conditionally.php

@@ -4,7 +4,7 @@
 
 $path = __DIR__ . '/include-me-to-prove-you-work.txt';
 
-if (rand(0,1)) {
+if (rand(0, 1)) {
     $path = 'a-file-that-does-not-exist.php';
 }
 

tests/data/require-file-relative-path.php

@@ -10,4 +10,4 @@
 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';
+require_once 'data/include-me-to-prove-you-work.txt';

tests/data/require-file-simple-case.php

@@ -1,4 +1,6 @@
-<?php declare(strict_types=1);
+<?php
+
+declare(strict_types=1);
 
 $fileThatExists = __DIR__ . '/include-me-to-prove-you-work.txt';
 $fileThatDoesNotExist = 'a-file-that-does-not-exist.php';
@@ -11,4 +13,4 @@
 include $fileThatDoesNotExist;
 include_once $fileThatDoesNotExist;
 require $fileThatDoesNotExist;
-require_once $fileThatDoesNotExist;
+require_once $fileThatDoesNotExist;