[type-declaration] Add AddParamStringTypeFromSprintfUseRector

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamStringTypeFromSprintfUseRector/AddParamStringTypeFromSprintfUseRectorTest.php

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

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamStringTypeFromSprintfUseRector/Fixture/pass_sprintf.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamStringTypeFromSprintfUseRector\Fixture;
+
+final class PassSprintf
+{
+    public function test($name)
+    {
+        return sprintf('Hello %s', $name);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamStringTypeFromSprintfUseRector\Fixture;
+
+final class PassSprintf
+{
+    public function test(string $name)
+    {
+        return sprintf('Hello %s', $name);
+    }
+}
+
+?>

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamStringTypeFromSprintfUseRector/Fixture/skip_non_string_mask.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamStringTypeFromSprintfUseRector\Fixture;
+
+final class SkipNonStringMask
+{
+    public function test($name)
+    {
+        return sprintf('Hello %d', $name);
+    }
+}

rules-tests/TypeDeclaration/Rector/ClassMethod/AddParamStringTypeFromSprintfUseRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\TypeDeclaration\Rector\ClassMethod\AddParamStringTypeFromSprintfUseRector;
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(AddParamStringTypeFromSprintfUseRector::class);
+};

rules/Privatization/TypeManipulator/TypeNormalizer.php

@@ -42,15 +42,6 @@ public function __construct(
 
     }
 
-    /**
-     * @deprecated This method is deprecated and will be removed in the next major release.
-     * Use @see generalizeConstantTypes() instead.
-     */
-    public function generalizeConstantBoolTypes(Type $type): Type
-    {
-        return $this->generalizeConstantTypes($type);
-    }
-
     /**
      * Generalize false/true constantArrayType to bool,
      * as mostly default value but accepts both

rules/TypeDeclaration/NodeAnalyzer/VariableInSprintfMaskMatcher.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypeDeclaration\NodeAnalyzer;
+
+use Nette\Utils\Strings;
+use PhpParser\Node\Arg;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Scalar\String_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Function_;
+use Rector\NodeNameResolver\NodeNameResolver;
+use Rector\PhpParser\Node\BetterNodeFinder;
+
+final readonly class VariableInSprintfMaskMatcher
+{
+    public function __construct(
+        private BetterNodeFinder $betterNodeFinder,
+        private NodeNameResolver $nodeNameResolver,
+    ) {
+
+    }
+
+    public function matchMask(ClassMethod|Function_ $functionLike, string $variableName, string $mask): bool
+    {
+        $funcCalls = $this->betterNodeFinder->findInstancesOfScoped((array) $functionLike->stmts, FuncCall::class);
+
+        foreach ($funcCalls as $funcCall) {
+            if (! $this->nodeNameResolver->isName($funcCall->name, 'sprintf')) {
+                continue;
+            }
+
+            if ($funcCall->isFirstClassCallable()) {
+                continue;
+            }
+
+            $args = $funcCall->getArgs();
+            if (count($args) < 2) {
+                continue;
+            }
+
+            /** @var Arg $messageArg */
+            $messageArg = array_shift($args);
+            if (! $messageArg->value instanceof String_) {
+                continue;
+            }
+
+            $string = $messageArg->value;
+
+            // match all %s, %d types by position
+            $masks = Strings::match($string->value, '#%[sd]#');
+
+            foreach ($args as $position => $arg) {
+                if (! $arg->value instanceof Variable) {
+                    continue;
+                }
+
+                if (! $this-> nodeNameResolver->isName($arg->value, $variableName)) {
+                    continue;
+                }
+
+                if (! isset($masks[$position])) {
+                    continue;
+                }
+
+                $knownMaskOnPosition = $masks[$position];
+                if ($knownMaskOnPosition !== $mask) {
+                    continue;
+                }
+
+                return true;
+            }
+        }
+
+        return false;
+    }
+}

rules/TypeDeclaration/Rector/ClassMethod/AddParamStringTypeFromSprintfUseRector.php

@@ -0,0 +1,99 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\TypeDeclaration\Rector\ClassMethod;
+
+use PhpParser\Node\Identifier;
+use PhpParser\Node;
+use PhpParser\Node\Stmt\ClassMethod;
+use PhpParser\Node\Stmt\Function_;
+use Rector\Rector\AbstractRector;
+use Rector\TypeDeclaration\NodeAnalyzer\VariableInSprintfMaskMatcher;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\TypeDeclaration\Rector\ClassMethod\AddParamStringTypeFromSprintfUseRector\AddParamStringTypeFromSprintfUseRectorTest
+ */
+final class AddParamStringTypeFromSprintfUseRector extends AbstractRector
+{
+    public function __construct(
+        private readonly VariableInSprintfMaskMatcher $variableInSprintfMaskMatcher,
+    ) {
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Add string type to parameters used in sprintf calls',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+class SomeClass
+{
+    public function formatMessage($name)
+    {
+        return sprintf('My name is %s', $name);
+    }
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+class SomeClass
+{
+    public function formatMessage(string $name)
+    {
+        return sprintf('My name is %s', $name);
+    }
+}
+CODE_SAMPLE
+                )]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [ClassMethod::class, Function_::class];
+    }
+
+    /**
+     * @param ClassMethod|Function_ $node
+     */
+    public function refactor(Node $node): ClassMethod|Function_|null
+    {
+        if ($node->stmts === null) {
+            return null;
+        }
+
+        if ($node->getParams() === []) {
+            return null;
+        }
+
+        $hasChanged = false;
+        foreach ($node->getParams() as $param) {
+            if ($param->type instanceof Node) {
+                continue;
+            }
+
+            /** @var string $variableName */
+            $variableName = $this->getName($param->var);
+
+            if (! $this->variableInSprintfMaskMatcher->matchMask($node, $variableName, '%s')) {
+                continue;
+            }
+
+            $param->type = new Identifier('string');
+            $hasChanged = true;
+        }
+
+        if (! $hasChanged) {
+            return null;
+        }
+
+        return $node;
+    }
+}

src/Config/Level/TypeDeclarationLevel.php

@@ -17,6 +17,7 @@
 use Rector\TypeDeclaration\Rector\Class_\TypedPropertyFromJMSSerializerAttributeTypeRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddMethodCallBasedStrictParamTypeRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddParamFromDimFetchKeyUseRector;
+use Rector\TypeDeclaration\Rector\ClassMethod\AddParamStringTypeFromSprintfUseRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeBasedOnPHPUnitDataProviderRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddParamTypeFromPropertyTypeRector;
 use Rector\TypeDeclaration\Rector\ClassMethod\AddReturnTypeDeclarationBasedOnParentClassMethodRector;
@@ -148,6 +149,7 @@ final class TypeDeclarationLevel
         // array parameter from dim fetch assign inside
         StrictArrayParamDimFetchRector::class,
         AddParamFromDimFetchKeyUseRector::class,
+        AddParamStringTypeFromSprintfUseRector::class,
 
         // possibly based on docblocks, but also helpful, intentionally last
         AddArrayFunctionClosureParamTypeRector::class,