Merge many Skipper tests to one, cleanup phpstan errors (#4806)

composer.json

@@ -58,7 +58,7 @@
         "symplify/easy-ci": "^11.1.18",
         "symplify/easy-coding-standard": "^12.0.5",
         "symplify/phpstan-extensions": "^11.2",
-        "symplify/phpstan-rules": "^12.0",
+        "symplify/phpstan-rules": "^12.1.4",
         "symplify/rule-doc-generator": "^12.0",
         "symplify/vendor-patches": "^11.2",
         "tomasvotruba/class-leak": "^0.1",

packages-tests/Skipper/Skipper/Fixture/Element/FifthElement.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Skipper\Skipper\Fixture\Element;
+
+final class FifthElement
+{
+}

packages-tests/Skipper/Skipper/Fixture/Element/ThreeMan.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Skipper\Skipper\Fixture\Element;
+
+final class ThreeMan
+{
+}

packages-tests/Skipper/Skipper/SkipperTest.php

@@ -0,0 +1,105 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Skipper\Skipper;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Core\Configuration\Option;
+use Rector\Core\Configuration\Parameter\SimpleParameterProvider;
+use Rector\Skipper\Skipper\Skipper;
+use Rector\Testing\PHPUnit\AbstractLazyTestCase;
+use Rector\Tests\Skipper\Skipper\Fixture\Element\FifthElement;
+use Rector\Tests\Skipper\Skipper\Fixture\Element\ThreeMan;
+use Rector\Tests\Skipper\Skipper\Source\AnotherClassToSkip;
+use Rector\Tests\Skipper\Skipper\Source\NotSkippedClass;
+
+final class SkipperTest extends AbstractLazyTestCase
+{
+    private Skipper $skipper;
+
+    protected function setUp(): void
+    {
+        SimpleParameterProvider::setParameter(Option::SKIP, [
+            // windows like path
+            '*\SomeSkipped\*',
+
+            // file paths
+            __DIR__ . '/Fixture/AlwaysSkippedPath',
+            '*\PathSkippedWithMask\*',
+            __DIR__ . '/Fixture/SomeSkippedPath',
+            __DIR__ . '/Fixture/SomeSkippedPathToFile/any.txt',
+
+            // elements
+            FifthElement::class,
+
+            // classes only in specific paths
+            AnotherClassToSkip::class => ['Fixture/someFile', '*/someDirectory/*'],
+        ]);
+
+        $this->skipper = $this->make(Skipper::class);
+    }
+
+    protected function tearDown(): void
+    {
+        // cleanup configuration
+        SimpleParameterProvider::setParameter(Option::SKIP, []);
+    }
+
+    #[DataProvider('provideDataShouldSkipFilePath')]
+    public function testSkipFilePath(string $filePath, bool $expectedSkip): void
+    {
+        $filePathResultSkip = $this->skipper->shouldSkipFilePath($filePath);
+        $this->assertSame($expectedSkip, $filePathResultSkip);
+    }
+
+    /**
+     * @return Iterator<string[]|bool[]>
+     */
+    public static function provideDataShouldSkipFilePath(): Iterator
+    {
+        yield [__DIR__ . '/Fixture/SomeRandom/file.txt', false];
+        yield [__DIR__ . '/Fixture/SomeSkipped/any.txt', true];
+        yield ['packages-tests/Skipper/Skipper/Fixture/SomeSkippedPath/any.txt', true];
+        yield ['packages-tests/Skipper/Skipper/Fixture/SomeSkippedPathToFile/any.txt', true];
+    }
+
+    /**
+     * @param object|class-string $element
+     */
+    #[DataProvider('provideDataShouldSkipElement')]
+    public function testSkipElement(string|object $element, bool $expectedSkip): void
+    {
+        $resultSkip = $this->skipper->shouldSkipElement($element);
+        $this->assertSame($expectedSkip, $resultSkip);
+    }
+
+    #[DataProvider('provideCheckerAndFile')]
+    public function testSkipElementAndFilePath(string $element, string $filePath, bool $expectedSkip): void
+    {
+        $resolvedSkip = $this->skipper->shouldSkipElementAndFilePath($element, $filePath);
+        $this->assertSame($expectedSkip, $resolvedSkip);
+    }
+
+    public static function provideCheckerAndFile(): Iterator
+    {
+        yield [FifthElement::class, __DIR__ . '/Fixture', true];
+
+        yield [AnotherClassToSkip::class, __DIR__ . '/Fixture/someFile', true];
+        yield [AnotherClassToSkip::class, __DIR__ . '/Fixture/someDirectory/anotherFile.php', true];
+
+        yield [NotSkippedClass::class, __DIR__ . '/Fixture/someFile', false];
+        yield [NotSkippedClass::class, __DIR__ . '/Fixture/someOtherFile', false];
+
+        yield ['anything', __DIR__ . '/Fixture/AlwaysSkippedPath/some_file.txt', true];
+        yield ['anything', __DIR__ . '/Fixture/PathSkippedWithMask/another_file.txt', true];
+    }
+
+    public static function provideDataShouldSkipElement(): Iterator
+    {
+        yield [ThreeMan::class, false];
+        yield [FifthElement::class, true];
+        yield [new FifthElement(), true];
+    }
+}

packages-tests/Skipper/Skipper/Skip/Source/AnotherClassToSkip.php → packages-tests/Skipper/Skipper/Source/AnotherClassToSkip.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\Tests\Skipper\Skipper\Skip\Source;
+namespace Rector\Tests\Skipper\Skipper\Source;
 
 final class AnotherClassToSkip
 {

packages-tests/Skipper/Skipper/Skip/Source/NotSkippedClass.php → packages-tests/Skipper/Skipper/Source/NotSkippedClass.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\Tests\Skipper\Skipper\Skip\Source;
+namespace Rector\Tests\Skipper\Skipper\Source;
 
 final class NotSkippedClass
 {

packages/Caching/ValueObject/Storage/FileCacheStorage.php

@@ -24,7 +24,7 @@ public function __construct(
     ) {
     }
 
-    public function load(string $key, string $variableKey)
+    public function load(string $key, string $variableKey): mixed
     {
         return (function (string $key, string $variableKey) {
             $cacheFilePaths = $this->getCacheFilePaths($key);

packages/Caching/ValueObject/Storage/MemoryCacheStorage.php

@@ -20,7 +20,7 @@ final class MemoryCacheStorage implements CacheStorageInterface
     /**
      * @return null|mixed
      */
-    public function load(string $key, string $variableKey)
+    public function load(string $key, string $variableKey): mixed
     {
         if (! isset($this->storage[$key])) {
             return null;

packages/NodeTypeResolver/PHPStan/Scope/NodeVisitor/StmtKeyNodeVisitor.php

@@ -18,7 +18,7 @@ final class StmtKeyNodeVisitor extends NodeVisitorAbstract implements ScopeResol
     /**
      * @param Node[] $nodes
      */
-    public function beforeTraverse(array $nodes)
+    public function beforeTraverse(array $nodes): ?array
     {
         if ($nodes === []) {
             return null;

packages/PhpDocParser/NodeVisitor/CallableNodeVisitor.php

@@ -28,7 +28,7 @@ public function __construct(callable $callable)
         $this->callable = $callable;
     }
 
-    public function enterNode(Node $node)
+    public function enterNode(Node $node): int|Node|null
     {
         $originalNode = $node;
 

packages/Skipper/Skipper/Skipper.php

@@ -13,7 +13,7 @@
 
 /**
  * @api
- * @see \Rector\Tests\Skipper\Skipper\Skipper\SkipperTest
+ * @see \Rector\Tests\Skipper\Skipper\SkipperTest
  */
 final class Skipper
 {