17279562118

Committed 27 Aug 2025 09:47PM UTC coverage: 94.693%. Remained the same

Build # 17279562118

Build Type

push

github

Committed by

keradus

Commit Message

CS

Run Details

28316 of 29903 relevant lines covered (94.69%)

45.61 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

91.89

/src/Fixer/FunctionNotation/NoUselessSprintfFixer.php

<?php

declare(strict_types=1);

/*
 * This file is part of PHP CS Fixer.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace PhpCsFixer\Fixer\FunctionNotation;

use PhpCsFixer\AbstractFixer;
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;

/**
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise.
 */
final class NoUselessSprintfFixer extends AbstractFixer
{
    public function getDefinition(): FixerDefinitionInterface
    {
        return new FixerDefinition(
            'There must be no `sprintf` calls with only the first argument.',
            [
                new CodeSample(
                    "<?php\n\$foo = sprintf('bar');\n"
                ),
            ],
            null,
            'Risky when if the `sprintf` function is overridden.'
        );
    }

    public function isCandidate(Tokens $tokens): bool
    {
        return $tokens->isTokenKindFound(\T_STRING);
    }

    public function isRisky(): bool
    {
        return true;
    }

    /**
     * {@inheritdoc}
     *
     * Must run before MethodArgumentSpaceFixer, NativeFunctionCasingFixer, NoEmptyStatementFixer, NoExtraBlankLinesFixer, NoSpacesInsideParenthesisFixer, SpacesInsideParenthesesFixer.
     */
    public function getPriority(): int
    {
        return 42;
    }

    protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
    {
        $functionAnalyzer = new FunctionsAnalyzer();
        $argumentsAnalyzer = new ArgumentsAnalyzer();

        for ($index = \count($tokens) - 1; $index > 0; --$index) {
            if (!$tokens[$index]->isGivenKind(\T_STRING)) {
                continue;
            }

            if ('sprintf' !== strtolower($tokens[$index]->getContent())) {
                continue;
            }

            if (!$functionAnalyzer->isGlobalFunctionCall($tokens, $index)) {
                continue;
            }

            $openParenthesisIndex = $tokens->getNextTokenOfKind($index, ['(']);

            if ($tokens[$tokens->getNextMeaningfulToken($openParenthesisIndex)]->isGivenKind(\T_ELLIPSIS)) {
                continue;
            }

            $closeParenthesisIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $openParenthesisIndex);

            if (1 !== $argumentsAnalyzer->countArguments($tokens, $openParenthesisIndex, $closeParenthesisIndex)) {
                continue;
            }

            $tokens->clearTokenAndMergeSurroundingWhitespace($closeParenthesisIndex);

            $prevMeaningfulTokenIndex = $tokens->getPrevMeaningfulToken($closeParenthesisIndex);

            if ($tokens[$prevMeaningfulTokenIndex]->equals(',')) {
                $tokens->clearTokenAndMergeSurroundingWhitespace($prevMeaningfulTokenIndex);
            }

            $tokens->clearTokenAndMergeSurroundingWhitespace($openParenthesisIndex);
            $tokens->clearTokenAndMergeSurroundingWhitespace($index);

            $prevMeaningfulTokenIndex = $tokens->getPrevMeaningfulToken($index);

            if ($tokens[$prevMeaningfulTokenIndex]->isGivenKind(\T_NS_SEPARATOR)) {
                $tokens->clearTokenAndMergeSurroundingWhitespace($prevMeaningfulTokenIndex);
            }
        }
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/*
6	* This file is part of PHP CS Fixer.
7	*
8	* (c) Fabien Potencier <fabien@symfony.com>
9	* Dariusz Rumiński <dariusz.ruminski@gmail.com>
10	*
11	* This source file is subject to the MIT license that is bundled
12	* with this source code in the file LICENSE.
13	*/
14
15	namespace PhpCsFixer\Fixer\FunctionNotation;
16
17	use PhpCsFixer\AbstractFixer;
18	use PhpCsFixer\FixerDefinition\CodeSample;
19	use PhpCsFixer\FixerDefinition\FixerDefinition;
20	use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
21	use PhpCsFixer\Tokenizer\Analyzer\ArgumentsAnalyzer;
22	use PhpCsFixer\Tokenizer\Analyzer\FunctionsAnalyzer;
23	use PhpCsFixer\Tokenizer\Tokens;
24
25	/**
26	* @no-named-arguments Parameter names are not covered by the backward compatibility promise.
27	*/
28	final class NoUselessSprintfFixer extends AbstractFixer
29	{
30	public function getDefinition(): FixerDefinitionInterface
31	{
32	return new FixerDefinition(	3✔
33	'There must be no `sprintf` calls with only the first argument.',	3✔
34	[	3✔
35	new CodeSample(	3✔
36	"<?php\n\$foo = sprintf('bar');\n"	3✔
37	),	3✔
38	],	3✔
39	null,	3✔
40	'Risky when if the `sprintf` function is overridden.'	3✔
41	);	3✔
42	}
43
44	public function isCandidate(Tokens $tokens): bool
45	{
46	return $tokens->isTokenKindFound(\T_STRING);	13✔
47	}
48
49	public function isRisky(): bool
50	{
51	return true;	1✔
52	}
53
54	/**
55	* {@inheritdoc}
56	*
57	* Must run before MethodArgumentSpaceFixer, NativeFunctionCasingFixer, NoEmptyStatementFixer, NoExtraBlankLinesFixer, NoSpacesInsideParenthesisFixer, SpacesInsideParenthesesFixer.
58	*/
59	public function getPriority(): int
60	{
61	return 42;	1✔
62	}
63
64	protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
65	{
66	$functionAnalyzer = new FunctionsAnalyzer();	13✔
67	$argumentsAnalyzer = new ArgumentsAnalyzer();	13✔
68
69	for ($index = \count($tokens) - 1; $index > 0; --$index) {	13✔
70	if (!$tokens[$index]->isGivenKind(\T_STRING)) {	13✔
71	continue;	13✔
72	}
73
74	if ('sprintf' !== strtolower($tokens[$index]->getContent())) {	13✔
75	continue;	4✔
76	}
77
78	if (!$functionAnalyzer->isGlobalFunctionCall($tokens, $index)) {	12✔
79	continue;	3✔
80	}
81
82	$openParenthesisIndex = $tokens->getNextTokenOfKind($index, ['(']);	9✔
83
84	if ($tokens[$tokens->getNextMeaningfulToken($openParenthesisIndex)]->isGivenKind(\T_ELLIPSIS)) {	9✔
85	continue;	×
86	}
87
88	$closeParenthesisIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $openParenthesisIndex);	9✔
89
90	if (1 !== $argumentsAnalyzer->countArguments($tokens, $openParenthesisIndex, $closeParenthesisIndex)) {	9✔
91	continue;	×
92	}
93
94	$tokens->clearTokenAndMergeSurroundingWhitespace($closeParenthesisIndex);	9✔
95
96	$prevMeaningfulTokenIndex = $tokens->getPrevMeaningfulToken($closeParenthesisIndex);	9✔
97
98	if ($tokens[$prevMeaningfulTokenIndex]->equals(',')) {	9✔
99	$tokens->clearTokenAndMergeSurroundingWhitespace($prevMeaningfulTokenIndex);	1✔
100	}
101
102	$tokens->clearTokenAndMergeSurroundingWhitespace($openParenthesisIndex);	9✔
103	$tokens->clearTokenAndMergeSurroundingWhitespace($index);	9✔
104
105	$prevMeaningfulTokenIndex = $tokens->getPrevMeaningfulToken($index);	9✔
106
107	if ($tokens[$prevMeaningfulTokenIndex]->isGivenKind(\T_NS_SEPARATOR)) {	9✔
108	$tokens->clearTokenAndMergeSurroundingWhitespace($prevMeaningfulTokenIndex);	×
109	}
110	}
111	}
112	}

keradus / PHP-CS-Fixer / 17279562118

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous