PHPLIB-1141: Setup rector in CI (#1088)

* Setup rector config
* Setup rector in CI
* Merge rector into static analysis job
* Disable bugged rules
* Fix BucketFunctionalTest::testOpenDownloadStreamByNameShouldRequireFilenameAndRevisionToExist

Author: GromNaN

.github/workflows/static-analysis.yml

@@ -65,3 +65,6 @@ jobs:
 
       - name: "Run Psalm"
         run: "vendor/bin/psalm --show-info=false --stats --output-format=github --threads=$(nproc)"
+
+      - name: "Run Rector"
+        run: "vendor/bin/rector --ansi --dry-run"

examples/aggregate.php

@@ -11,7 +11,7 @@
 use function MongoDB\BSON\fromPHP;
 use function MongoDB\BSON\toRelaxedExtendedJSON;
 use function printf;
-use function rand;
+use function random_int;
 
 require __DIR__ . '/../vendor/autoload.php';
 
@@ -28,7 +28,7 @@ function toJSON(object $document): string
 $documents = [];
 
 for ($i = 0; $i < 100; $i++) {
-    $documents[] = ['randomValue' => rand(0, 1000)];
+    $documents[] = ['randomValue' => random_int(0, 1000)];
 }
 
 $collection->insertMany($documents);

phpcs.xml.dist

@@ -13,6 +13,7 @@
     <file>examples</file>
     <file>tests</file>
     <file>tools</file>
+    <file>rector.php</file>
 
     <!-- Target minimum supported PHP version -->
     <config name="php_version" value="70200"/>

rector.php

@@ -2,6 +2,9 @@
 
 use Rector\Config\RectorConfig;
 use Rector\DeadCode\Rector\ClassLike\RemoveAnnotationRector;
+use Rector\Php56\Rector\FunctionLike\AddDefaultValueForUndefinedVariableRector;
+use Rector\Php71\Rector\FuncCall\RemoveExtraParametersRector;
+use Rector\Set\ValueObject\LevelSetList;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->paths([
@@ -11,13 +14,20 @@
         __DIR__ . '/tools',
     ]);
 
-    /**
-     * All classes are public API by default, unless marked with @internal.
-     */
-    $rectorConfig->ruleWithConfiguration(RemoveAnnotationRector::class, ['api']);
+    // Modernize code
+    $rectorConfig->sets([LevelSetList::UP_TO_PHP_72]);
+
+    $rectorConfig->skip([
+        // Falsely detect unassigned variables in code paths stopped by PHPUnit\Framework\Assert::markTestSkipped()
+        AddDefaultValueForUndefinedVariableRector::class => [
+            __DIR__ . '/tests/',
+        ],
+        // @see https://github.com/phpstan/phpstan-src/pull/2429
+        RemoveExtraParametersRector::class => [
+            __DIR__ . '/src/Operation/',
+        ],
+    ]);
 
-    // define sets of rules
-    //    $rectorConfig->sets([
-    //        LevelSetList::UP_TO_PHP_72
-    //    ]);
+    // All classes are public API by default, unless marked with @internal.
+    $rectorConfig->ruleWithConfiguration(RemoveAnnotationRector::class, ['api']);
 };

tests/FunctionsTest.php

@@ -210,7 +210,7 @@ public function provideTypeMapValues()
             'Array field path converted to array' => [
                 [
                     'root' => 'object',
-                    'array' => 'MongoDB\Model\BSONArray',
+                    'array' => BSONArray::class,
                     'fieldPaths' => [
                         'field' => 'array',
                         'field.$' => 'object',
@@ -219,22 +219,22 @@ public function provideTypeMapValues()
                 ],
                 [
                     'root' => 'object',
-                    'array' => 'MongoDB\Model\BSONArray',
+                    'array' => BSONArray::class,
                     'fieldPaths' => ['nested' => 'array'],
                 ],
                 'field.$',
             ],
             'Array field path without root key' => [
                 [
                     'root' => 'object',
-                    'array' => 'MongoDB\Model\BSONArray',
+                    'array' => BSONArray::class,
                     'fieldPaths' => [
                         'field' => 'array',
                         'field.$.nested' => 'array',
                     ],
                 ],
                 [
-                    'array' => 'MongoDB\Model\BSONArray',
+                    'array' => BSONArray::class,
                     'fieldPaths' => ['nested' => 'array'],
                 ],
                 'field.$',

tests/GridFS/BucketFunctionalTest.php

@@ -549,7 +549,7 @@ public function testOpenDownloadStreamByNameShouldRequireFilenameAndRevisionToEx
         $this->bucket->uploadFromStream('filename', $this->createStream('bar'));
 
         $this->expectException(FileNotFoundException::class);
-        $this->bucket->openDownloadStream($filename, ['revision' => $revision]);
+        $this->bucket->openDownloadStreamByName($filename, ['revision' => $revision]);
     }
 
     public function testOpenUploadStream(): void

tests/GridFS/UnusableStream.php

@@ -20,7 +20,7 @@ public static function register($protocol = 'unusable'): void
             stream_wrapper_unregister($protocol);
         }
 
-        stream_wrapper_register($protocol, static::class, STREAM_IS_URL);
+        stream_wrapper_register($protocol, self::class, STREAM_IS_URL);
     }
 
     public function stream_close(): void

tests/Operation/WatchFunctionalTest.php

@@ -1107,8 +1107,7 @@ public function testResumeTokenNotFoundDoesNotAdvanceKey(): void
         try {
             $changeStream->next();
             $this->fail('Exception for missing resume token was not thrown');
-        } catch (ResumeTokenException $e) {
-        } catch (ServerException $e) {
+        } catch (ResumeTokenException | ServerException $e) {
         }
 
         $this->assertFalse($changeStream->valid());

tests/UnifiedSpecTests/Constraint/Matches.php

@@ -368,6 +368,7 @@ private function doToString()
         return 'matches ' . $this->exporter()->export($this->value);
     }
 
+    /** @psalm-return never-return */
     private static function failAt(string $message, string $keyPath): void
     {
         $prefix = empty($keyPath) ? '' : sprintf('Field path "%s": ', $keyPath);