Add NoUselessSprintfFixer (#118)

Author: kubawerlos

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Add SingleLineThrowFixer
 - Add PhpUnitNoUselessReturnFixer
 - Add DataProviderNameFixer
+- Add NoUselessSprintfFixer
 - Feature: NoCommentedOutCodeFixer - handle class method
 - Deprecate SingleLineThrowFixer
 

README.md

@@ -8,7 +8,7 @@
 
 [![Build status](https://img.shields.io/travis/kubawerlos/php-cs-fixer-custom-fixers/master.svg)](https://travis-ci.org/kubawerlos/php-cs-fixer-custom-fixers)
 [![Code coverage](https://img.shields.io/coveralls/github/kubawerlos/php-cs-fixer-custom-fixers/master.svg)](https://coveralls.io/github/kubawerlos/php-cs-fixer-custom-fixers?branch=master)
-![Tests](https://img.shields.io/badge/tests-957-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-990-brightgreen.svg)
 [![Mutation testing badge](https://badge.stryker-mutator.io/github.com/kubawerlos/php-cs-fixer-custom-fixers/master)](https://stryker-mutator.github.io)
 
 A set of custom fixers for [PHP CS Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer).
@@ -225,6 +225,14 @@ In your PHP CS Fixer configuration register fixers and use them:
  class FooRepository extends EntityRepository {}
 ```
 
+- **NoUselessSprintfFixer** - function `sprintf` without parameters should not be used.  
+  *Risky: when the function `sprintf` is overridden.*
+```diff
+ <?php
+-$foo = sprintf('Foo');
++$foo = 'Foo';
+```
+
 - **NullableParamStyleFixer** - nullable parameters must be written in the consistent style.
   Configuration options:
   - `style` (`'with_question_mark'`, `'without_question_mark'`): whether nullable parameter type should be prefixed or not with question mark; defaults to `with_question_mark`

src/Fixer/NoUselessSprintfFixer.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PhpCsFixerCustomFixers\Fixer;
+
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
+use PhpCsFixer\Tokenizer\Analyzer\ArgumentsAnalyzer;
+use PhpCsFixer\Tokenizer\Analyzer\FunctionsAnalyzer;
+use PhpCsFixer\Tokenizer\Tokens;
+
+final class NoUselessSprintfFixer extends AbstractFixer
+{
+    public function getDefinition(): FixerDefinitionInterface
+    {
+        return new FixerDefinition(
+            'function `sprintf` without parameters should not be used',
+            [new CodeSample("<?php\n\$foo = sprintf('Foo');\n")],
+            null,
+            'when the function `sprintf` is overridden'
+        );
+    }
+
+    public function isCandidate(Tokens $tokens): bool
+    {
+        return $tokens->isTokenKindFound(T_STRING);
+    }
+
+    public function isRisky(): bool
+    {
+        return true;
+    }
+
+    public function fix(\SplFileInfo $file, Tokens $tokens): void
+    {
+        $argumentsAnalyzer = new ArgumentsAnalyzer();
+        $functionsAnalyzer = new FunctionsAnalyzer();
+
+        foreach ($tokens as $index => $token) {
+            if (!$token->equals([T_STRING, 'sprintf'], false)) {
+                continue;
+            }
+
+            if (!$functionsAnalyzer->isGlobalFunctionCall($tokens, $index)) {
+                continue;
+            }
+
+            /** @var int $openParenthesis */
+            $openParenthesis = $tokens->getNextTokenOfKind($index, ['(']);
+
+            $closeParenthesis = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $openParenthesis);
+
+            if ($argumentsAnalyzer->countArguments($tokens, $openParenthesis, $closeParenthesis) !== 1) {
+                continue;
+            }
+
+            $tokens->clearAt($index);
+            $tokens->clearAt($openParenthesis);
+            if ($tokens[$openParenthesis + 1]->isWhitespace()) {
+                $tokens->clearAt($openParenthesis + 1);
+            }
+            if ($tokens[$closeParenthesis - 1]->isWhitespace()) {
+                $tokens->clearAt($closeParenthesis - 1);
+            }
+            $tokens->clearAt($closeParenthesis);
+        }
+    }
+
+    public function getPriority(): int
+    {
+        return 0;
+    }
+}

tests/Fixer/NoUselessSprintfFixerTest.php

@@ -0,0 +1,92 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Tests\Fixer;
+
+/**
+ * @internal
+ *
+ * @covers \PhpCsFixerCustomFixers\Fixer\NoUselessSprintfFixer
+ */
+final class NoUselessSprintfFixerTest extends AbstractFixerTestCase
+{
+    public function testPriority(): void
+    {
+        static::assertSame(0, $this->fixer->getPriority());
+    }
+
+    public function testIsRisky(): void
+    {
+        static::assertTrue($this->fixer->isRisky());
+    }
+
+    /**
+     * @param string      $expected
+     * @param null|string $input
+     *
+     * @dataProvider provideFixCases
+     */
+    public function testFix(string $expected, ?string $input = null): void
+    {
+        $this->doTest($expected, $input);
+    }
+
+    public function provideFixCases(): iterable
+    {
+        yield ['<?php $foo = sprintf($format, $value);'];
+        yield ['<?php $foo = sprintf("My name is %s.", "Earl");'];
+        yield ['<?php $foo = sprintf("Sum of %d and %d is %d.", 2, 2, 4);'];
+        yield ['<?php $foo = sprintf();'];
+        yield ['<?php $foo = sprintf[0]("Bar");'];
+        yield ['<?php $foo = $printingHelper->sprintf($bar);'];
+        yield ['<?php $foo = PrintingHelper::sprintf($bar);'];
+        yield ['<?php $foo = PrintingHelper\sprintf($bar);'];
+        yield ['<?php define("sprintf", "foo"); sprintf; bar($baz);'];
+        yield ['<?php namespace Foo; function sprintf($bar) { return $baz; }'];
+
+        yield [
+            '<?php $foo;',
+            '<?php sprintf($foo);',
+        ];
+
+        yield [
+            '<?php $foo;',
+            '<?php SPRINTF($foo);',
+        ];
+
+        yield [
+            '<?php $foo;',
+            '<?php sprintf(sprintf(sprintf($foo)));',
+        ];
+
+        yield [
+            '<?php sprintf($foo, 7);',
+            '<?php sprintf(sprintf(sprintf($foo), 7));',
+        ];
+
+        yield [
+            '<?php
+                $foo = "Foo";',
+            '<?php
+                $foo = sprintf(
+                    "Foo"
+                );',
+        ];
+
+        yield [
+            '<?php
+                PrintingHelper::sprintf("Message");
+                $foo = sprintf("Hello, %s!", "Foo");
+                $bar = "Bar";
+                $baz = "Baz";
+            ',
+            '<?php
+                PrintingHelper::sprintf("Message");
+                $foo = sprintf("Hello, %s!", "Foo");
+                $bar = sprintf("Bar");
+                $baz = sprintf("Baz");
+            ',
+        ];
+    }
+}