Add constant FilesystemIterator::SKIP_DOTS when flags parameter is used

build/target-repository/docs/rector_rules_overview.md

@@ -48,7 +48,7 @@
 
 - [Php81](#php81) (12)
 
-- [Php82](#php82) (2)
+- [Php82](#php82) (3)
 
 - [Privatization](#privatization) (8)
 
@@ -6570,6 +6570,19 @@ Refactor Spatie enum method calls
 
 ## Php82
 
+### FilesystemIteratorSkipDotsRector
+
+Prior PHP 8.2 FilesystemIterator::SKIP_DOTS was always set and could not be removed, therefore FilesystemIterator::SKIP_DOTS is added in order to keep this behaviour.
+
+- class: [`Rector\Php82\Rector\New_\FilesystemIteratorSkipDotsRector`](../rules/Php82/Rector/New_/FilesystemIteratorSkipDotsRector.php)
+
+```diff
+-new \FilesystemIterator(__DIR__, \FilesystemIterator::KEY_AS_FILENAME);
++new \FilesystemIterator(__DIR__, \FilesystemIterator::KEY_AS_FILENAME | \FilesystemIterator::SKIP_DOTS);
+```
+
+<br>
+
 ### ReadOnlyClassRector
 
 Decorate read-only class with `readonly` attribute

config/set/php82.php

@@ -5,7 +5,12 @@
 use Rector\Config\RectorConfig;
 use Rector\Php82\Rector\Class_\ReadOnlyClassRector;
 use Rector\Php82\Rector\FuncCall\Utf8DecodeEncodeToMbConvertEncodingRector;
+use Rector\Php82\Rector\New_\FilesystemIteratorSkipDotsRector;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->rules([ReadOnlyClassRector::class, Utf8DecodeEncodeToMbConvertEncodingRector::class]);
+    $rectorConfig->rules([
+        ReadOnlyClassRector::class,
+        Utf8DecodeEncodeToMbConvertEncodingRector::class,
+        FilesystemIteratorSkipDotsRector::class,
+    ]);
 };

rules-tests/Php82/Rector/New_/FilesystemIteratorSkipDots/FilesystemIteratorSkipDotsRectorTest.php

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class FilesystemIteratorSkipDotsRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    /**
+     * @return Iterator<array<string>>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/Php82/Rector/New_/FilesystemIteratorSkipDots/Fixture/append_constant_to_flag.php.inc

@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots\Fixture;
+
+use FilesystemIterator;
+
+final class AppendConstantToFlag
+{
+    public function getIterator(): FilesystemIterator
+    {
+        return new FilesystemIterator(__DIR__, FilesystemIterator::KEY_AS_FILENAME);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots\Fixture;
+
+use FilesystemIterator;
+
+final class AppendConstantToFlag
+{
+    public function getIterator(): FilesystemIterator
+    {
+        return new FilesystemIterator(__DIR__, FilesystemIterator::KEY_AS_FILENAME | \FilesystemIterator::SKIP_DOTS);
+    }
+}
+
+?>

rules-tests/Php82/Rector/New_/FilesystemIteratorSkipDots/Fixture/append_constant_to_multiple_flags.php.inc

@@ -0,0 +1,31 @@
+<?php
+
+namespace Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots\Fixture;
+
+use FilesystemIterator;
+
+final class AppendConstantToMultipleFlags
+{
+    public function getIterator(): FilesystemIterator
+    {
+        return new FilesystemIterator(__DIR__, FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::FOLLOW_SYMLINKS | FilesystemIterator::CURRENT_MODE_MASK);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots\Fixture;
+
+use FilesystemIterator;
+
+final class AppendConstantToMultipleFlags
+{
+    public function getIterator(): FilesystemIterator
+    {
+        return new FilesystemIterator(__DIR__, FilesystemIterator::KEY_AS_FILENAME | FilesystemIterator::FOLLOW_SYMLINKS | FilesystemIterator::CURRENT_MODE_MASK | \FilesystemIterator::SKIP_DOTS);
+    }
+}
+
+?>

rules-tests/Php82/Rector/New_/FilesystemIteratorSkipDots/Fixture/append_constant_to_multiple_flags_with_fqn.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots\Fixture;
+
+final class AppendConstantToMultipleFlagsWithFqn
+{
+    public function getIterator(): \FilesystemIterator
+    {
+        return new \FilesystemIterator(__DIR__, \FilesystemIterator::KEY_AS_FILENAME | \FilesystemIterator::FOLLOW_SYMLINKS | \FilesystemIterator::CURRENT_MODE_MASK);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots\Fixture;
+
+final class AppendConstantToMultipleFlagsWithFqn
+{
+    public function getIterator(): \FilesystemIterator
+    {
+        return new \FilesystemIterator(__DIR__, \FilesystemIterator::KEY_AS_FILENAME | \FilesystemIterator::FOLLOW_SYMLINKS | \FilesystemIterator::CURRENT_MODE_MASK | \FilesystemIterator::SKIP_DOTS);
+    }
+}
+
+?>

rules-tests/Php82/Rector/New_/FilesystemIteratorSkipDots/Fixture/constant_present.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots\Fixture;
+
+use FilesystemIterator;
+
+final class ConstantPresent
+{
+    public function getIterator(): FilesystemIterator
+    {
+        return new FilesystemIterator(__DIR__, FilesystemIterator::SKIP_DOTS);
+    }
+}
+
+?>

rules-tests/Php82/Rector/New_/FilesystemIteratorSkipDots/Fixture/constant_present_in_flags.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots\Fixture;
+
+use FilesystemIterator;
+
+final class ConstantPresentInFlags
+{
+    public function getIterator(): FilesystemIterator
+    {
+        return new FilesystemIterator(__DIR__, FilesystemIterator::FOLLOW_SYMLINKS | FilesystemIterator::SKIP_DOTS | FilesystemIterator::KEY_AS_FILENAME);
+    }
+}
+
+?>

rules-tests/Php82/Rector/New_/FilesystemIteratorSkipDots/Fixture/constant_present_with_fqn.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots\Fixture;
+
+final class ConstantPresentWithFqn
+{
+    public function getIterator(): \FilesystemIterator
+    {
+        return new \FilesystemIterator(__DIR__, \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS | \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::KEY_AS_FILENAME);
+    }
+}
+
+?>

rules-tests/Php82/Rector/New_/FilesystemIteratorSkipDots/Fixture/maintain_default_value.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots\Fixture;
+
+use FilesystemIterator;
+
+final class MaintainDefaultValue
+{
+    public function getIterator(): FilesystemIterator
+    {
+        return new FilesystemIterator(__DIR__);
+    }
+}
+
+?>

rules-tests/Php82/Rector/New_/FilesystemIteratorSkipDots/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Php82\Rector\New_\FilesystemIteratorSkipDotsRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(FilesystemIteratorSkipDotsRector::class);
+};

rules/Php82/Rector/New_/FilesystemIteratorSkipDotsRector.php

@@ -0,0 +1,95 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Php82\Rector\New_;
+
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\BinaryOp\BitwiseOr;
+use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Expr\New_;
+use PhpParser\Node\Name\FullyQualified;
+use Rector\Core\Rector\AbstractRector;
+use Rector\Core\ValueObject\PhpVersionFeature;
+use Rector\VersionBonding\Contract\MinPhpVersionInterface;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\Php82\Rector\New_\FilesystemIteratorSkipDots\FilesystemIteratorSkipDotsRectorTest
+ */
+class FilesystemIteratorSkipDotsRector extends AbstractRector implements MinPhpVersionInterface
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Prior PHP 8.2 FilesystemIterator::SKIP_DOTS was always set and could not be removed, therefore FilesystemIterator::SKIP_DOTS is added in order to keep this behaviour.',
+            [new CodeSample(
+                'new \\FilesystemIterator(__DIR__, \\FilesystemIterator::KEY_AS_FILENAME);',
+                'new \\FilesystemIterator(__DIR__, \\FilesystemIterator::KEY_AS_FILENAME | \\FilesystemIterator::SKIP_DOTS);'
+            ),
+            ]
+        );
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [New_::class];
+    }
+
+    /**
+     * Add {@see \FilesystemIterator::SKIP_DOTS} to $node when required.
+     *
+     * @param New_ $node
+     */
+    public function refactor(Node $node): ?New_
+    {
+        if ($node->isFirstClassCallable()) {
+            return null;
+        }
+        if (!array_key_exists(1, $node->args)) {
+            return null;
+        }
+        $flags = $node->args[1]->value;
+        if ($this->isSkipDotsPresent($flags)) {
+            return null;
+        }
+        $skipDots = new ClassConstFetch(new FullyQualified('FilesystemIterator'), 'SKIP_DOTS');
+        $node->args[1] = new Arg(new BitwiseOr($flags, $skipDots));
+        return $node;
+    }
+
+    public function provideMinPhpVersion(): int
+    {
+        return PhpVersionFeature::FILESYSTEM_ITERATOR_SKIP_DOTS;
+    }
+
+    /**
+     * Is the constant {@see \FilesystemIterator::SKIP_DOTS} present within $node?
+     */
+    private function isSkipDotsPresent(Expr $node): bool
+    {
+        if ($this->isSkipDots($node)) {
+            return true;
+        }
+
+        while ($node instanceof BitwiseOr) {
+            if ($this->isSkipDots($node->right)) {
+                return true;
+            }
+            $node = $node->left;
+        }
+
+        return false;
+    }
+
+    /**
+     * Tells if $expr is equal to {@see \FilesystemIterator::SKIP_DOTS}.
+     */
+    protected function isSkipDots(Expr $expr): bool
+    {
+        return ($expr instanceof ClassConstFetch) && (strval($expr->name) === 'SKIP_DOTS');
+    }
+}

src/Application/ApplicationFileProcessor.php

@@ -143,10 +143,8 @@ public function processFiles(array $files, Configuration $configuration): array
      */
     public function configurePHPStanNodeScopeResolver(array $filePaths): void
     {
-        $phpFilePaths = array_filter(
-            $filePaths,
-            static fn (string $filePath): bool => str_ends_with($filePath, '.php')
-        );
+        $phpFilter = static fn (string $filePath): bool => str_ends_with($filePath, '.php');
+        $phpFilePaths = array_filter($filePaths, $phpFilter);
         $this->nodeScopeResolver->setAnalysedFiles($phpFilePaths);
     }
 

src/ValueObject/PhpVersionFeature.php

@@ -607,4 +607,10 @@ final class PhpVersionFeature
      * @var int
      */
     public const DEPRECATE_UTF8_DECODE_ENCODE_FUNCTION = PhpVersion::PHP_82;
+
+    /**
+     * @see https://www.php.net/manual/en/filesystemiterator.construct
+     * @var int
+     */
+    public const FILESYSTEM_ITERATOR_SKIP_DOTS = PhpVersion::PHP_82;
 }