Merge branch 'main' into feature/declare-type-configs

Author: peterfox

README.md

@@ -1,4 +1,8 @@
 # Rector Rules for Laravel
+[![Tests](https://github.com/driftingly/rector-laravel/actions/workflows/tests.yaml/badge.svg)](https://github.com/driftingly/rector-laravel/actions/workflows/tests.yaml)
+[![Code Analysis](https://github.com/driftingly/rector-laravel/actions/workflows/code_analysis.yaml/badge.svg)](https://github.com/driftingly/rector-laravel/actions/workflows/code_analysis.yaml)
+[![Packagist Downloads](https://img.shields.io/packagist/dm/driftingly/rector-laravel)](https://packagist.org/packages/driftingly/rector-laravel/stats)
+[![Packagist Version](https://img.shields.io/packagist/v/driftingly/rector-laravel)](https://packagist.org/packages/driftingly/rector-laravel)
 
 See available [Laravel rules](/docs/rector_rules_overview.md)
 

composer.json

@@ -8,14 +8,15 @@
         "rector/rector": "^1.0.2"
     },
     "require-dev": {
-        "phpunit/phpunit": "^10.5",
+        "nikic/php-parser": "^4.18",
+        "phpstan/extension-installer": "^1.3",
         "phpstan/phpstan": "^1.10",
-        "symplify/phpstan-rules": "^12.4",
+        "phpstan/phpstan-strict-rules": "^1.5",
+        "phpstan/phpstan-webmozart-assert": "^1.2",
+        "phpunit/phpunit": "^10.5",
         "symplify/phpstan-extensions": "^11.4",
+        "symplify/phpstan-rules": "^12.4",
         "symplify/rule-doc-generator": "^12.1",
-        "phpstan/extension-installer": "^1.3",
-        "phpstan/phpstan-webmozart-assert": "^1.2",
-        "phpstan/phpstan-strict-rules": "^1.5",
         "tightenco/duster": "^2.7"
     },
     "autoload": {

config/sets/laravel-container-string-to-fully-qualified-name.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpParser\Node\Expr\ClassConstFetch;
+use PhpParser\Node\Name\FullyQualified;
+use Rector\Config\RectorConfig;
+use RectorLaravel\Rector\MethodCall\ReplaceServiceContainerCallArgRector;
+use RectorLaravel\ValueObject\ReplaceServiceContainerCallArg;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->import(__DIR__ . '/../config.php');
+
+    $servicesMap = [
+        'events' => 'Illuminate\Contracts\Events\Dispatcher',
+        'log' => 'Psr\Log\LoggerInterface',
+        'router' => 'Illuminate\Routing\Router',
+        'url' => 'Illuminate\Contracts\Routing\UrlGenerator',
+        'redirect' => 'Illuminate\Routing\Redirector',
+        'auth' => 'Illuminate\Contracts\Auth\Factory',
+        'auth.driver' => 'Illuminate\Auth\SessionGuard',
+        'cookie' => 'Illuminate\Cookie\CookieJar',
+        'db.factory' => 'Illuminate\Database\Connectors\ConnectionFactory',
+        'db' => 'Illuminate\Database\ConnectionResolverInterface',
+        'db.connection' => 'Illuminate\Database\ConnectionInterface',
+        'db.schema' => 'Illuminate\Database\Schema\SQLiteBuilder',
+        'db.transactions' => 'Illuminate\Database\DatabaseTransactionsManager',
+        'encrypter' => 'Illuminate\Encryption\Encrypter',
+        'files' => 'Illuminate\Filesystem\Filesystem',
+        'filesystem' => 'Illuminate\Contracts\Filesystem\Factory',
+        'session' => 'Illuminate\Session\SessionManager',
+        'session.store' => 'Illuminate\Contracts\Session\Session',
+        'view' => 'Illuminate\Contracts\View\Factory',
+        'view.finder' => 'Illuminate\View\ViewFinderInterface',
+        'blade.compiler' => 'Illuminate\View\Compilers\CompilerInterface',
+        'view.engine.resolver' => 'Illuminate\View\Engines\EngineResolver',
+        'flare.logger' => 'Monolog\Logger',
+        'cache' => 'Illuminate\Contracts\Cache\Factory',
+        'cache.store' => 'Illuminate\Cache\Repository',
+        'memcached.connector' => 'Illuminate\Cache\MemcachedConnector',
+        'queue' => 'Illuminate\Queue\QueueManager',
+        'queue.connection' => 'Illuminate\Contracts\Queue\Queue',
+        'queue.worker' => 'Illuminate\Queue\Worker',
+        'queue.listener' => 'Illuminate\Queue\Listener',
+        'queue.failer' => 'Illuminate\Queue\Failed\DatabaseUuidFailedJobProvider',
+        'migration.repository' => 'Illuminate\Database\Migrations\MigrationRepositoryInterface',
+        'migrator' => 'Illuminate\Database\Migrations\Migrator',
+        'migration.creator' => 'Illuminate\Database\Migrations\MigrationCreator',
+        'composer' => 'Illuminate\Support\Composer',
+        'hash' => 'Illuminate\Contracts\Hashing\Hasher',
+        'hash.driver' => 'Illuminate\Contracts\Hashing\Hasher',
+        'mail.manager' => 'Illuminate\Contracts\Mail\Factory',
+        'mailer' => 'Illuminate\Mail\Mailer',
+        'auth.password' => 'Illuminate\Contracts\Auth\PasswordBrokerFactory',
+        'auth.password.broker' => 'Illuminate\Contracts\Auth\PasswordBroker',
+        'pipeline' => 'Illuminate\Contracts\Pipeline\Pipeline',
+        'redis' => 'Illuminate\Contracts\Redis\Factory',
+        'translation.loader' => 'Illuminate\Contracts\Translation\Loader',
+        'translator' => 'Illuminate\Contracts\Translation\Translator',
+        'validation.presence' => 'Illuminate\Validation\DatabasePresenceVerifier',
+        'validator' => 'Illuminate\Contracts\Validation\Factory',
+        'command.tinker' => 'Laravel\Tinker\Console\TinkerCommand',
+    ];
+
+    $ruleConfig = array_map(
+        fn (string $service, string $interface) => new ReplaceServiceContainerCallArg(
+            $service,
+            new ClassConstFetch(
+                new FullyQualified($interface),
+                'class'
+            )
+        ),
+        array_keys($servicesMap),
+        $servicesMap,
+    );
+
+    $rectorConfig->ruleWithConfiguration(
+        ReplaceServiceContainerCallArgRector::class,
+        $ruleConfig
+    );
+};

config/sets/laravel-if-helpers.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+use Rector\Config\RectorConfig;
+use RectorLaravel\Rector\If_\AbortIfRector;
+use RectorLaravel\Rector\If_\ReportIfRector;
+use RectorLaravel\Rector\If_\ThrowIfRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->import(__DIR__ . '/../config.php');
+
+    $rectorConfig->rule(AbortIfRector::class);
+    $rectorConfig->rule(ReportIfRector::class);
+    $rectorConfig->rule(ThrowIfRector::class);
+};

docs/rector_rules_overview.md

@@ -1,4 +1,23 @@
-# 57 Rules Overview
+# 60 Rules Overview
+
+## AbortIfRector
+
+Change if abort to abort_if
+
+- class: [`RectorLaravel\Rector\If_\AbortIfRector`](../src/Rector/If_/AbortIfRector.php)
+
+```diff
+-if ($condition) {
+-    abort(404);
+-}
+-if (!$condition) {
+-    abort(404);
+-}
++abort_if($condition, 404);
++abort_unless($condition, 404);
+```
+
+<br>
 
 ## AddArgumentDefaultValueRector
 
@@ -450,6 +469,26 @@ Dispatch non ShouldQueue jobs to dispatchSync
 
 <br>
 
+## DispatchToHelperFunctionsRector
+
+Use the event or dispatch helpers instead of the static dispatch method.
+
+- class: [`RectorLaravel\Rector\StaticCall\DispatchToHelperFunctionsRector`](../src/Rector/StaticCall/DispatchToHelperFunctionsRector.php)
+
+```diff
+-ExampleEvent::dispatch($email);
++event(new ExampleEvent($email));
+```
+
+<br>
+
+```diff
+-ExampleJob::dispatch($email);
++dispatch(new ExampleJob($email));
+```
+
+<br>
+
 ## EloquentMagicMethodToQueryBuilderRector
 
 The EloquentMagicMethodToQueryBuilderRule is designed to automatically transform certain magic method calls on Eloquent Models into corresponding Query Builder method calls.
@@ -1049,6 +1088,25 @@ Replace `withoutJobs`, `withoutEvents` and `withoutNotifications` with Facade `f
 
 <br>
 
+## ReportIfRector
+
+Change if report to report_if
+
+- class: [`RectorLaravel\Rector\If_\ReportIfRector`](../src/Rector/If_/ReportIfRector.php)
+
+```diff
+-if ($condition) {
+-    report(new Exception());
+-}
+-if (!$condition) {
+-    report(new Exception());
+-}
++report_if($condition, new Exception());
++report_unless($condition, new Exception());
+```
+
+<br>
+
 ## RequestStaticValidateToInjectRector
 
 Change static `validate()` method to `$request->validate()`

rector.php

@@ -10,6 +10,7 @@
     ->withPaths([
         __DIR__ . '/src',
         __DIR__ . '/tests',
+        __DIR__ . '/config',
     ])
     ->withSkip([
         // for tests

src/Rector/FuncCall/RemoveRedundantValueCallsRector.php

@@ -5,17 +5,16 @@
 use PhpParser\Node;
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Name;
-use PHPStan\Analyser\Scope;
 use PHPStan\Type\ClosureType;
 use PHPStan\Type\MixedType;
-use Rector\Rector\AbstractScopeAwareRector;
+use Rector\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
  * @see \RectorLaravel\Tests\Rector\FuncCall\RemoveRedundantValueCallsRector\RemoveRedundantValueCallsRectorTest
  */
-class RemoveRedundantValueCallsRector extends AbstractScopeAwareRector
+class RemoveRedundantValueCallsRector extends AbstractRector
 {
     public function getRuleDefinition(): RuleDefinition
     {
@@ -32,7 +31,7 @@ public function getNodeTypes(): array
         return [FuncCall::class];
     }
 
-    public function refactorWithScope(Node $node, Scope $scope): ?Node
+    public function refactor(Node $node): ?Node
     {
         if (! $node instanceof FuncCall) {
             return null;
@@ -52,7 +51,7 @@ public function refactorWithScope(Node $node, Scope $scope): ?Node
             return null;
         }
 
-        if ($scope->getType($args[0]->value)->isSuperTypeOf(new ClosureType([], new MixedType, true))->no() === false) {
+        if ($this->getType($args[0]->value)->isSuperTypeOf(new ClosureType([], new MixedType, true))->no() === false) {
             return null;
         }
 

src/Rector/FuncCall/RemoveRedundantWithCallsRector.php

@@ -5,15 +5,14 @@
 use PhpParser\Node;
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Name;
-use PHPStan\Analyser\Scope;
-use Rector\Rector\AbstractScopeAwareRector;
+use Rector\Rector\AbstractRector;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
 /**
  * @see \RectorLaravel\Tests\Rector\FuncCall\RemoveRedundantWithCallsRector\RemoveRedundantWithCallsRectorTest
  */
-class RemoveRedundantWithCallsRector extends AbstractScopeAwareRector
+class RemoveRedundantWithCallsRector extends AbstractRector
 {
     public function getRuleDefinition(): RuleDefinition
     {
@@ -30,7 +29,7 @@ public function getNodeTypes(): array
         return [FuncCall::class];
     }
 
-    public function refactorWithScope(Node $node, Scope $scope): ?Node
+    public function refactor(Node $node): ?Node
     {
         if (! $node instanceof FuncCall) {
             return null;
@@ -51,7 +50,7 @@ public function refactorWithScope(Node $node, Scope $scope): ?Node
         }
 
         if (count($args) === 2) {
-            $secondArgumentType = $scope->getType($args[1]->value);
+            $secondArgumentType = $this->getType($args[1]->value);
 
             if ($secondArgumentType->isCallable()->no() === false) {
                 return null;