Setup rector config

Author: GromNaN

CONTRIBUTING.md

@@ -151,6 +151,17 @@ possible it can be added to the baseline using `set-baseline`:
 $ vendor/bin/psalm --set-baseline=psalm-baseline.xml
 ```
 
+## Automatic code refactoring
+
+The library uses [rector](https://getrector.com/) to refactor the code for new features.
+To run automatic refactoring, use the `rector` command:
+
+```
+$ vendor/bin/rector
+```
+
+New rules can be added to the `rector.php` configuration file.
+
 ## Documentation
 
 Documentation for the library lives in the `docs/` directory and is built with

composer.json

@@ -18,8 +18,9 @@
         "symfony/polyfill-php80": "^1.27"
     },
     "require-dev": {
-        "squizlabs/php_codesniffer": "^3.7",
         "doctrine/coding-standard": "^11.1",
+        "rector/rector": "^0.16.0",
+        "squizlabs/php_codesniffer": "^3.7",
         "symfony/phpunit-bridge": "^5.2",
         "vimeo/psalm": "^4.28"
     },
@@ -39,6 +40,7 @@
     "config": {
         "allow-plugins": {
             "dealerdirect/phpcodesniffer-composer-installer": true
-        }
+        },
+        "sort-packages": true
     }
 }

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);

rector.php

@@ -0,0 +1,16 @@
+<?php
+
+use Rector\Config\RectorConfig;
+use Rector\Set\ValueObject\LevelSetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/examples',
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+        __DIR__ . '/tools',
+    ]);
+
+    // define sets of rules
+    $rectorConfig->sets([LevelSetList::UP_TO_PHP_72]);
+};

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->openDownloadStream($filename);
     }
 
     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/SpecTests/ClientSideEncryptionSpecTest.php

@@ -2017,6 +2017,7 @@ private function createTestCollection(?stdClass $encryptedFields = null, ?stdCla
 
     private function encryptCorpusValue(string $fieldName, stdClass $data, ClientEncryption $clientEncryption)
     {
+        $encrypted = null;
         $encryptionOptions = [
             'algorithm' => $data->algo === 'rand' ? ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM : ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC,
         ];

tests/UnifiedSpecTests/Operation.php

@@ -172,6 +172,7 @@ public function assert(bool $rethrowExceptions = false): void
 
     private function execute()
     {
+        $result = null;
         $this->context->setActiveClient(null);
 
         if ($this->isTestRunnerOperation) {