Add single value concat support to EncapsedStringsToSprintfRector (#4897

)

rules-tests/CodingStyle/Rector/Encapsed/EncapsedStringsToSprintfRector/Fixture/encapsed_strings_to_sprintf_should_escape_percent.php.inc

@@ -9,6 +9,7 @@ final class EncapsedStringsToSprintfShouldEscapePercent
         return "$value%";
     }
 }
+
 ?>
 -----
 <?php
@@ -19,7 +20,8 @@ final class EncapsedStringsToSprintfShouldEscapePercent
 {
     public function run(string $value)
     {
-        return sprintf('%s%%', $value);
+        return $value . '%';
     }
 }
+
 ?>

rules-tests/CodingStyle/Rector/Encapsed/EncapsedStringsToSprintfRector/Fixture/just_value.php.inc

@@ -22,7 +22,7 @@ final class JustValue
     public function testCommand(): void
     {
         $flag = 'hey';
-        $expected = [sprintf('--%s', $flag)];
+        $expected = ['--' . $flag];
     }
 }
 

rules-tests/CodingStyle/Rector/Encapsed/EncapsedStringsToSprintfRector/Fixture/fixture2.php.inc → rules-tests/CodingStyle/Rector/Encapsed/EncapsedStringsToSprintfRector/Fixture/single_encapsed.php.inc

@@ -2,13 +2,13 @@
 
 namespace Rector\Tests\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector\Fixture;
 
-final class Fixture2
+final class SingleEncapsed
 {
     private $format = 'json';
 
     public function run(string $format)
     {
-        return "Unsupported format {$this->format}";
+        return "{$this->format}";
     }
 }
 
@@ -18,13 +18,13 @@ final class Fixture2
 
 namespace Rector\Tests\CodingStyle\Rector\Encapsed\EncapsedStringsToSprintfRector\Fixture;
 
-final class Fixture2
+final class SingleEncapsed
 {
     private $format = 'json';
 
     public function run(string $format)
     {
-        return sprintf('Unsupported format %s', $this->format);
+        return $this->format;
     }
 }
 

rules/CodingStyle/Rector/Encapsed/EncapsedStringsToSprintfRector.php

@@ -53,11 +53,15 @@ public function getRuleDefinition(): RuleDefinition
             [
                 new CodeSample(
                     <<<'CODE_SAMPLE'
-echo "Unsupported format {$format}";
+echo "Unsupported format {$format} - use another";
+
+echo "Try {$allowed}";
 CODE_SAMPLE
                     ,
                     <<<'CODE_SAMPLE'
-echo sprintf('Unsupported format %s', $format);
+echo sprintf('Unsupported format %s - use another', $format);
+
+echo 'Try ' . $allowed;
 CODE_SAMPLE
                 ),
             ]
@@ -152,6 +156,11 @@ private function createSprintfFuncCallOrConcat(string $mask, array $argumentVari
             return $this->nodeFactory->createConcat($argumentVariables);
         }
 
+        $singleValueConcat = $this->createSingleValueEdgeConcat($argumentVariables, $mask);
+        if ($singleValueConcat instanceof Concat) {
+            return $singleValueConcat;
+        }
+
         // checks for windows or linux line ending. \n is contained in both.
         if (\str_contains($mask, "\n")) {
             return null;
@@ -164,4 +173,32 @@ private function createSprintfFuncCallOrConcat(string $mask, array $argumentVari
 
         return new FuncCall(new Name('sprintf'), $arguments);
     }
+
+    /**
+     * @param Expr[] $argumentVariables
+     */
+    private function createSingleValueEdgeConcat(array $argumentVariables, string $mask): ?Concat
+    {
+        if (count($argumentVariables) !== 1) {
+            return null;
+        }
+
+        if (substr_count($mask, '%s') !== 1) {
+            return null;
+        }
+
+        $cleanMask = Strings::replace($mask, '#\%\%#', '%');
+
+        if (str_ends_with($mask, '%s')) {
+            $bareString = new String_(substr($cleanMask, 0, -2));
+            return new Concat($bareString, $argumentVariables[0]);
+        }
+
+        if (str_starts_with($mask, '%s')) {
+            $bareString = new String_(substr($cleanMask, 2));
+            return new Concat($argumentVariables[0], $bareString);
+        }
+
+        return null;
+    }
 }