[paths] Add StringFileAbsolutePathExistsRule (#171)

Author: TomasVotruba

README.md

@@ -122,6 +122,34 @@ class SomeCommand extends Command
 
 :+1:
 
+<br>
+
+### StringFileAbsolutePathExistsRule
+
+Absolute file path must exist. Checked suffixes are "yaml", "yml", "sql", "php" and "json".
+
+```yaml
+rules:
+    - Symplify\PHPStanRules\Rules\StringFileAbsolutePathExistsRule
+```
+
+```php
+// missing file path
+return __DIR__  . '/some_file.yml';
+```
+
+:x:
+
+<br>
+
+```php
+// correct file path
+return __DIR__  . '/../fixtures/some_file.yml';
+```
+
+:+1:
+
+
 <br>
 
 ### NoConstructorOverrideRule

src/Enum/RuleIdentifier.php

@@ -65,4 +65,6 @@ final class RuleIdentifier
     public const FORBIDDEN_NEW_INSTANCE = 'symplify.forbiddenNewInstance';
 
     public const MAXIMUM_IGNORED_ERROR_COUNT = 'symplify.maximumIgnoredErrorCount';
+
+    public const STRING_FILE_ABSOLUTE_PATH_EXISTS = 'symplify.stringFileAbsolutePathExists';
 }

src/Rules/StringFileAbsolutePathExistsRule.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Symplify\PHPStanRules\Rules;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\BinaryOp\Concat;
+use PhpParser\Node\Scalar\MagicConst\Dir;
+use PhpParser\Node\Scalar\String_;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleError;
+use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\RuleIdentifier;
+
+/**
+ * @implements Rule<Concat>
+ *
+ * @see \Symplify\PHPStanRules\Tests\Rules\StringFileAbsolutePathExistsRule\StringFileAbsolutePathExistsRuleTest
+ */
+final class StringFileAbsolutePathExistsRule implements Rule
+{
+    /**
+     * @var string
+     */
+    public const ERROR_MESSAGE = 'File "%s" could not be found. Make sure it exists';
+
+    /**
+     * @var string[]
+     */
+    private const SUFFIXES_TO_CHECK = [
+        '.sql',
+        '.php',
+        '.yml',
+        '.yaml',
+        '.json',
+    ];
+
+    public function getNodeType(): string
+    {
+        return Concat::class;
+    }
+
+    /**
+     * @param Concat $node
+     * @return RuleError[]
+     */
+    public function processNode(Node $node, Scope $scope): array
+    {
+        // look for __DIR__ . '/some_file.<suffix>'
+        if (! $node->left instanceof Dir) {
+            return [];
+        }
+
+        if (! $node->right instanceof String_) {
+            return [];
+        }
+
+        $stringValue = $node->right->value;
+        if (! $this->isDesiredFileSuffix($stringValue)) {
+            return [];
+        }
+
+        $absoluteFilePath = $this->getAbsoluteFilePath($scope, $stringValue);
+        if (file_exists($absoluteFilePath)) {
+            return [];
+        }
+
+        $errorMessage = sprintf(self::ERROR_MESSAGE, $absoluteFilePath);
+
+        $identifierRuleError = RuleErrorBuilder::message($errorMessage)
+            ->identifier(RuleIdentifier::STRING_FILE_ABSOLUTE_PATH_EXISTS)
+            ->build();
+
+        return [$identifierRuleError];
+    }
+
+    private function getAbsoluteFilePath(Scope $scope, string $stringValue): string
+    {
+        $directorPath = dirname($scope->getFile());
+        return $directorPath . $stringValue;
+    }
+
+    private function isDesiredFileSuffix(string $stringValue): bool
+    {
+        foreach (self::SUFFIXES_TO_CHECK as $suffixToCheck) {
+            if (str_ends_with($stringValue, $suffixToCheck)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

tests/Rules/StringFileAbsolutePathExistsRule/Fixture/NonExistingFile.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\StringFileAbsolutePathExistsRule\Fixture;
+
+final class NonExistingFile
+{
+    public function go()
+    {
+        return __DIR__  . '/some_file.yml';
+    }
+}

tests/Rules/StringFileAbsolutePathExistsRule/Fixture/SkipNestedConcats.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\StringFileAbsolutePathExistsRule\Fixture;
+
+final class SkipNestedConcats
+{
+    public function go()
+    {
+        return __DIR__  . '/some_file/' . '.yml';
+    }
+}

tests/Rules/StringFileAbsolutePathExistsRule/Fixture/SkipReferenceToExistingFile.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Symplify\PHPStanRules\Tests\Rules\StringFileAbsolutePathExistsRule\Fixture;
+
+final class SkipReferenceToExistingFile
+{
+    public function go()
+    {
+        return __DIR__  . '/../Source/some_file.yml';
+    }
+}

tests/Rules/StringFileAbsolutePathExistsRule/Source/some_file.yml

@@ -0,0 +1 @@
+key: value

tests/Rules/StringFileAbsolutePathExistsRule/StringFileAbsolutePathExistsRuleTest.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Symplify\PHPStanRules\Tests\Rules\StringFileAbsolutePathExistsRule;
+
+use Iterator;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Symplify\PHPStanRules\Rules\StringFileAbsolutePathExistsRule;
+
+final class StringFileAbsolutePathExistsRuleTest extends RuleTestCase
+{
+    /**
+     * @param mixed[] $expectedErrorMessagesWithLines
+     */
+    #[DataProvider('provideData')]
+    public function testRule(string $filePath, array $expectedErrorMessagesWithLines): void
+    {
+        $this->analyse([$filePath], $expectedErrorMessagesWithLines);
+    }
+
+    public static function provideData(): Iterator
+    {
+        $errorMessage = sprintf(StringFileAbsolutePathExistsRule::ERROR_MESSAGE, __DIR__ . '/Fixture/some_file.yml');
+        yield [__DIR__ . '/Fixture/NonExistingFile.php', [[$errorMessage, 9]]];
+
+        yield [__DIR__ . '/Fixture/SkipReferenceToExistingFile.php', []];
+        yield [__DIR__ . '/Fixture/SkipNestedConcats.php', []];
+    }
+
+    protected function getRule(): Rule
+    {
+        return new StringFileAbsolutePathExistsRule();
+    }
+}

tests/Rules/StringFileAbsolutePathExistsRule/config/configured_rule.neon

@@ -0,0 +1,10 @@
+includes:
+    - ../../../config/included_services.neon
+
+services:
+    -
+        class: Symplify\PHPStanRules\Rules\SeeAnnotationToTestRule
+        tags: [phpstan.rules.rule]
+        arguments:
+            requiredSeeTypes:
+                - PHPStan\Rules\Rule