Refactor config() calls to use type-specific methods when the expected type is known (#399)

* Refactor `config()` calls to use type-specific methods when the expected type is known

* Code style fixes

---------

Co-authored-by: Geni Jaho <[email protected]>

Author: imliam

docs/rector_rules_overview.md

@@ -555,6 +555,27 @@ Refactor `whereDate()` queries to include both date and time comparisons with Ca
 
 <br>
 
+## ConfigToTypedConfigMethodCallRector
+
+Refactor `config()` calls to use type-specific methods when the expected type is known
+
+- class: [`RectorLaravel\Rector\FuncCall\ConfigToTypedConfigMethodCallRector`](../src/Rector/FuncCall/ConfigToTypedConfigMethodCallRector.php)
+
+```diff
+-$name = (string) config('app.name');
+-$lifetime = (int) config('session.lifetime');
+-$debug = (bool) config('app.debug');
+-$version = (float) config('app.version');
+-$connections = (array) config('database.connections');
++$name = config()->string('app.name');
++$lifetime = config()->integer('session.lifetime');
++$debug = config()->boolean('app.debug');
++$version = config()->float('app.version');
++$connections = config()->array('database.connections');
+```
+
+<br>
+
 ## ContainerBindConcreteWithClosureOnlyRector
 
 Drop the specified abstract class from the bind method and replace it with a closure that returns the abstract class.

src/Rector/FuncCall/ConfigToTypedConfigMethodCallRector.php

@@ -0,0 +1,100 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Rector\FuncCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\Cast;
+use PhpParser\Node\Expr\Cast\Array_;
+use PhpParser\Node\Expr\Cast\Bool_;
+use PhpParser\Node\Expr\Cast\Double;
+use PhpParser\Node\Expr\Cast\Int_;
+use PhpParser\Node\Expr\Cast\String_;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Name;
+use RectorLaravel\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \RectorLaravel\Tests\Rector\FuncCall\ConfigToTypedConfigMethodCallRector\ConfigToTypedConfigMethodCallRectorTest
+ */
+final class ConfigToTypedConfigMethodCallRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Refactor config() calls to use type-specific methods when the expected type is known',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+$name = (string) config('app.name');
+$lifetime = (int) config('session.lifetime');
+$debug = (bool) config('app.debug');
+$version = (float) config('app.version');
+$connections = (array) config('database.connections');
+CODE_SAMPLE,
+                    <<<'CODE_SAMPLE'
+$name = config()->string('app.name');
+$lifetime = config()->integer('session.lifetime');
+$debug = config()->boolean('app.debug');
+$version = config()->float('app.version');
+$connections = config()->array('database.connections');
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Cast::class];
+    }
+
+    /**
+     * @param  Cast  $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $node->expr instanceof FuncCall) {
+            return null;
+        }
+
+        $funcCall = $node->expr;
+
+        if (! $this->isName($funcCall->name, 'config')) {
+            return null;
+        }
+
+        if (count($funcCall->args) !== 1) {
+            return null;
+        }
+
+        $methodName = $this->getMethodNameForCast($node);
+        if ($methodName === null) {
+            return null;
+        }
+
+        $configCall = new FuncCall(new Name('config'));
+
+        return new MethodCall($configCall, new Identifier($methodName), $funcCall->args);
+    }
+
+    private function getMethodNameForCast(Cast $cast): ?string
+    {
+        return match (true) {
+            $cast instanceof String_ => 'string',
+            $cast instanceof Int_ => 'integer',
+            $cast instanceof Bool_ => 'boolean',
+            $cast instanceof Double => 'float',
+            $cast instanceof Array_ => 'array',
+            default => null,
+        };
+    }
+}

tests/Rector/FuncCall/ConfigToTypedConfigMethodCallRector/ConfigToTypedConfigMethodCallRectorTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Tests\Rector\FuncCall\ConfigToTypedConfigMethodCallRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class ConfigToTypedConfigMethodCallRectorTest extends AbstractRectorTestCase
+{
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    /**
+     * @test
+     */
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

tests/Rector/FuncCall/ConfigToTypedConfigMethodCallRector/Fixture/complex_config_casts.php.inc

@@ -0,0 +1,53 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\FuncCall\ConfigToTypedConfigMethodCallRector\Fixture;
+
+class ComplexConfigCasts
+{
+    public function run()
+    {
+        // Multiple casts in one method
+        $appName = (string) config('app.name');
+        $appDebug = (bool) config('app.debug');
+
+        // Nested in expressions
+        $url = 'https://' . (string) config('app.domain');
+
+        // In conditionals
+        if ((bool) config('feature.enabled')) {
+            return true;
+        }
+
+        // In return statements
+        return (int) config('cache.ttl');
+    }
+}
+
+?>
+-----
+<?php
+
+namespace RectorLaravel\Tests\Rector\FuncCall\ConfigToTypedConfigMethodCallRector\Fixture;
+
+class ComplexConfigCasts
+{
+    public function run()
+    {
+        // Multiple casts in one method
+        $appName = config()->string('app.name');
+        $appDebug = config()->boolean('app.debug');
+
+        // Nested in expressions
+        $url = 'https://' . config()->string('app.domain');
+
+        // In conditionals
+        if (config()->boolean('feature.enabled')) {
+            return true;
+        }
+
+        // In return statements
+        return config()->integer('cache.ttl');
+    }
+}
+
+?>

tests/Rector/FuncCall/ConfigToTypedConfigMethodCallRector/Fixture/config_casts.php.inc

@@ -0,0 +1,35 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\FuncCall\ConfigToTypedConfigMethodCallRector\Fixture;
+
+class ConfigCasts
+{
+    public function run()
+    {
+        $name = (string) config('app.name');
+        $lifetime = (int) config('session.lifetime');
+        $debug = (bool) config('app.debug');
+        $version = (float) config('app.version');
+        $connections = (array) config('database.connections');
+    }
+}
+
+?>
+-----
+<?php
+
+namespace RectorLaravel\Tests\Rector\FuncCall\ConfigToTypedConfigMethodCallRector\Fixture;
+
+class ConfigCasts
+{
+    public function run()
+    {
+        $name = config()->string('app.name');
+        $lifetime = config()->integer('session.lifetime');
+        $debug = config()->boolean('app.debug');
+        $version = config()->float('app.version');
+        $connections = config()->array('database.connections');
+    }
+}
+
+?>

tests/Rector/FuncCall/ConfigToTypedConfigMethodCallRector/Fixture/skip_non_config_calls.php.inc

@@ -0,0 +1,21 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\FuncCall\ConfigToTypedConfigMethodCallRector\Fixture;
+
+class SkipNonConfigCalls
+{
+    public function run()
+    {
+        // Should skip: config() without arguments
+        $config = config();
+
+        // Should skip: config() with array argument (setting values)
+        config(['app.name' => 'My App']);
+
+        // Should skip: config() without cast
+        $value = config('app.name');
+
+        // Should skip: other function casts
+        $other = (string) someOtherFunc('key');
+    }
+}

tests/Rector/FuncCall/ConfigToTypedConfigMethodCallRector/config/configured_rule.php

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