From e4eeb19c45e40661c209e59b81755e8022d77f1d Mon Sep 17 00:00:00 2001
From: Tomas Votruba <tomas.vot@gmail.com>
Date: Thu, 26 Sep 2019 13:43:26 +0200
Subject: [PATCH] [CodeQuality] Add RemoveSoleValueSprintfRector

---
 config/set/code-quality/code-quality.yaml     |  1 +
 .../FuncCall/RemoveSoleValueSprintfRector.php | 87 +++++++++++++++++++
 .../Fixture/fixture.php.inc                   | 33 +++++++
 .../RemoveSoleValueSprintfRectorTest.php      | 30 +++++++
 4 files changed, 151 insertions(+)
 create mode 100644 packages/CodeQuality/src/Rector/FuncCall/RemoveSoleValueSprintfRector.php
 create mode 100644 packages/CodeQuality/tests/Rector/FuncCall/RemoveSoleValueSprintfRector/Fixture/fixture.php.inc
 create mode 100644 packages/CodeQuality/tests/Rector/FuncCall/RemoveSoleValueSprintfRector/RemoveSoleValueSprintfRectorTest.php

diff --git a/config/set/code-quality/code-quality.yaml b/config/set/code-quality/code-quality.yaml
index 7646201a2bda..0603e2467513 100644
--- a/config/set/code-quality/code-quality.yaml
+++ b/config/set/code-quality/code-quality.yaml
@@ -40,3 +40,4 @@ services:
     Rector\CodeQuality\Rector\FuncCall\StrlenZeroToIdenticalEmptyStringRector: ~
     Rector\CodeQuality\Rector\If_\RemoveAlwaysTrueConditionSetInConstructorRector: ~
     Rector\CodeQuality\Rector\Catch_\ThrowWithPreviousExceptionRector: ~
+    Rector\CodeQuality\Rector\FuncCall\RemoveSoleValueSprintfRector: ~
diff --git a/packages/CodeQuality/src/Rector/FuncCall/RemoveSoleValueSprintfRector.php b/packages/CodeQuality/src/Rector/FuncCall/RemoveSoleValueSprintfRector.php
new file mode 100644
index 000000000000..6922b5a9b134
--- /dev/null
+++ b/packages/CodeQuality/src/Rector/FuncCall/RemoveSoleValueSprintfRector.php
@@ -0,0 +1,87 @@
+<?php declare(strict_types=1);
+
+namespace Rector\CodeQuality\Rector\FuncCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\FuncCall;
+use PHPStan\Type\StringType;
+use Rector\Rector\AbstractRector;
+use Rector\RectorDefinition\CodeSample;
+use Rector\RectorDefinition\RectorDefinition;
+
+/**
+ * @see \Rector\CodeQuality\Tests\Rector\FuncCall\RemoveSoleValueSprintfRector\RemoveSoleValueSprintfRectorTest
+ */
+final class RemoveSoleValueSprintfRector extends AbstractRector
+{
+    public function getDefinition(): RectorDefinition
+    {
+        return new RectorDefinition('Remove sprintf() wrapper if not needed', [
+            new CodeSample(
+                <<<'PHP'
+class SomeClass
+{
+    public function run()
+    {
+        $value = sprintf('%s', 'hi');
+
+        $welcome = 'hello';
+        $value = sprintf('%s', $welcome);
+    }
+}
+PHP
+                ,
+                <<<'PHP'
+class SomeClass
+{
+    public function run()
+    {
+        $value = 'hi';
+
+        $welcome = 'hello';
+        $value = $welcome;
+    }
+}
+PHP
+            ),
+        ]);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getNodeTypes(): array
+    {
+        return [FuncCall::class];
+    }
+
+    /**
+     * @param FuncCall $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $this->isName($node, 'sprintf')) {
+            return null;
+        }
+
+        if (count($node->args) !== 2) {
+            return null;
+        }
+
+        $maskArgument = $node->args[0]->value;
+        if (! $maskArgument instanceof Node\Scalar\String_) {
+            return null;
+        }
+
+        if ($maskArgument->value !== '%s') {
+            return null;
+        }
+
+        $valueArgument = $node->args[1]->value;
+        if (! $this->isStaticType($valueArgument, StringType::class)) {
+            return null;
+        }
+
+        return $valueArgument;
+    }
+}
diff --git a/packages/CodeQuality/tests/Rector/FuncCall/RemoveSoleValueSprintfRector/Fixture/fixture.php.inc b/packages/CodeQuality/tests/Rector/FuncCall/RemoveSoleValueSprintfRector/Fixture/fixture.php.inc
new file mode 100644
index 000000000000..c383986a97c5
--- /dev/null
+++ b/packages/CodeQuality/tests/Rector/FuncCall/RemoveSoleValueSprintfRector/Fixture/fixture.php.inc
@@ -0,0 +1,33 @@
+<?php
+
+namespace Rector\CodeQuality\Tests\Rector\FuncCall\RemoveSoleValueSprintfRector\Fixture;
+
+class SomeClass
+{
+    public function run()
+    {
+        $value = sprintf('%s', 'hi');
+
+        $welcome = 'hello';
+        $value = sprintf('%s', $welcome);
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\CodeQuality\Tests\Rector\FuncCall\RemoveSoleValueSprintfRector\Fixture;
+
+class SomeClass
+{
+    public function run()
+    {
+        $value = 'hi';
+
+        $welcome = 'hello';
+        $value = $welcome;
+    }
+}
+
+?>
diff --git a/packages/CodeQuality/tests/Rector/FuncCall/RemoveSoleValueSprintfRector/RemoveSoleValueSprintfRectorTest.php b/packages/CodeQuality/tests/Rector/FuncCall/RemoveSoleValueSprintfRector/RemoveSoleValueSprintfRectorTest.php
new file mode 100644
index 000000000000..f3b2b38afeb9
--- /dev/null
+++ b/packages/CodeQuality/tests/Rector/FuncCall/RemoveSoleValueSprintfRector/RemoveSoleValueSprintfRectorTest.php
@@ -0,0 +1,30 @@
+<?php declare(strict_types=1);
+
+namespace Rector\CodeQuality\Tests\Rector\FuncCall\RemoveSoleValueSprintfRector;
+
+use Rector\CodeQuality\Rector\FuncCall\RemoveSoleValueSprintfRector;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class RemoveSoleValueSprintfRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideDataForTest()
+     */
+    public function test(string $file): void
+    {
+        $this->doTestFile($file);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function provideDataForTest(): iterable
+    {
+        yield [__DIR__ . '/Fixture/fixture.php.inc'];
+    }
+
+    protected function getRectorClass(): string
+    {
+        return RemoveSoleValueSprintfRector::class;
+    }
+}