Introduce Rector tests for code quality improvement suggestions (#265)

Author: evansims

.circleci/config.yml

@@ -44,6 +44,12 @@ commands:
           name: Run code quality analysis (PHP Insights)
           command: php -d memory-limit=-1 ./vendor/bin/phpinsights -v --no-interaction --min-quality=100 --min-complexity=50 --min-architecture=100 --min-style=100
 
+  run-rector:
+    steps:
+      - run:
+          name: Run code quality analysis (Rector)
+          command: php -d memory_limit=-1 ./vendor/bin/rector process src --dry-run
+
   run-phpstan:
     steps:
       - run:
@@ -75,6 +81,15 @@ jobs:
     steps:
       - setup
       - run-phpinsights
+  rector:
+    parameters:
+      php:
+        type: string
+    docker:
+      - image: php:<< parameters.php >>-cli-alpine
+    steps:
+      - setup
+      - run-rector
   phpstan:
     parameters:
       php:
@@ -120,6 +135,10 @@ workflows:
           matrix:
             parameters:
               php: ["7.4", "8.0", "8.1"]
+      - rector:
+          matrix:
+            parameters:
+              php: ["7.4", "8.0", "8.1"]
       - phpstan:
           matrix:
             parameters:

composer.json

@@ -51,6 +51,7 @@
     "pestphp/pest-plugin-laravel": "^1.2",
     "phpstan/phpstan-strict-rules": "^1.1",
     "phpunit/phpunit": "^9.5",
+    "rector/rector": "^0.12.16",
     "thecodingmachine/phpstan-strict-rules": "^1.0",
     "wikimedia/composer-merge-plugin": "^2.0"
   },
@@ -93,13 +94,18 @@
   "scripts": {
     "tests": [
       "@tests:phpinsights",
+      "@tests:rector",
       "@tests:phpstan",
       "@tests:pest"
     ],
     "tests:phpinsights": [
       "Composer\\Config::disableProcessTimeout",
       "@php ./vendor/bin/phpinsights -v --no-interaction"
     ],
+    "tests:rector": [
+      "Composer\\Config::disableProcessTimeout",
+      "@php ./vendor/bin/rector process src --dry-run"
+    ],
     "tests:phpstan": [
       "Composer\\Config::disableProcessTimeout",
       "@php ./vendor/bin/phpstan analyse --ansi --memory-limit 512M"

rector.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Core\Configuration\Option;
+use Rector\Set\ValueObject\LevelSetList;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    // get parameters
+    $parameters = $containerConfigurator->parameters();
+    $parameters->set(Option::PATHS, [
+        __DIR__ . '/src',
+    ]);
+
+    // Define what rule sets will be applied
+    $containerConfigurator->import(LevelSetList::UP_TO_PHP_74);
+
+    // get services (needed for register a single rule)
+    // $services = $containerConfigurator->services();
+
+    // register a single rule
+    // $services->set(TypedPropertyRector::class);
+
+    $parameters->set(Option::PHPSTAN_FOR_RECTOR_PATH, getcwd() . '/phpstan.neon.dist');
+};

src/Configuration.php

@@ -20,7 +20,7 @@ public static function stringToArrayOrNull(
             $response = explode($delimiter, $config);
 
             // @phpstan-ignore-next-line
-            if (is_array($response) === true && count($response) >= 1 && strlen(trim($response[0])) !== '') {
+            if (is_array($response) === true && count($response) >= 1 && strlen(trim($response[0])) !== 0) {
                 return $response;
             }
         }

src/ServiceProvider.php

@@ -22,35 +22,23 @@ public function configurePackage(
      */
     public function registeringPackage(): void
     {
-        app()->singleton(Auth0::class, static function (): \Auth0\Laravel\Auth0 {
-            return new Auth0();
-        });
+        app()->singleton(Auth0::class, static fn (): \Auth0\Laravel\Auth0 => new Auth0());
 
-        app()->singleton('auth0', static function (): \Auth0\Laravel\Auth0 {
-            return app()->make(Auth0::class);
-        });
+        app()->singleton('auth0', static fn (): \Auth0\Laravel\Auth0 => app()->make(Auth0::class));
 
-        app()->singleton(StateInstance::class, static function (): \Auth0\Laravel\StateInstance {
-            return new StateInstance();
-        });
+        app()->singleton(StateInstance::class, static fn (): \Auth0\Laravel\StateInstance => new StateInstance());
 
-        app()->singleton(\Auth0\Laravel\Auth\User\Repository::class, static function (): \Auth0\Laravel\Auth\User\Repository {
-            return new \Auth0\Laravel\Auth\User\Repository();
-        });
+        app()->singleton(\Auth0\Laravel\Auth\User\Repository::class, static fn (): \Auth0\Laravel\Auth\User\Repository => new \Auth0\Laravel\Auth\User\Repository());
     }
 
     /**
      * @inheritdoc
      */
     public function bootingPackage(): void
     {
-        auth()->provider('auth0', static function ($app, array $config): \Auth0\Laravel\Auth\User\Provider {
-            return new \Auth0\Laravel\Auth\User\Provider(app()->make($config['repository']));
-        });
+        auth()->provider('auth0', static fn ($app, array $config): \Auth0\Laravel\Auth\User\Provider => new \Auth0\Laravel\Auth\User\Provider(app()->make($config['repository'])));
 
-        auth()->extend('auth0', static function ($app, $name, array $config): \Auth0\Laravel\Auth\Guard {
-            return new \Auth0\Laravel\Auth\Guard(auth()->createUserProvider($config['provider']), $app->make('request'));
-        });
+        auth()->extend('auth0', static fn ($app, $name, array $config): \Auth0\Laravel\Auth\Guard => new \Auth0\Laravel\Auth\Guard(auth()->createUserProvider($config['provider']), $app->make('request')));
 
         $router = app()->make(\Illuminate\Routing\Router::class);
         $router->aliasMiddleware('auth0.authenticate', \Auth0\Laravel\Http\Middleware\Stateful\Authenticate::class);