/
SimplifiedIfReturnFixer.php
147 lines (127 loc) · 4.37 KB
/
SimplifiedIfReturnFixer.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
<?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\ControlStructure;
use PhpCsFixer\AbstractFixer;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
/**
* @author Filippo Tessarotto <zoeslam@gmail.com>
*/
final class SimplifiedIfReturnFixer extends AbstractFixer
{
/**
* @var array[]
*/
private $sequences = [
[
'isNegative' => false,
'sequence' => [
'{', [T_RETURN], [T_STRING, 'true'], ';', '}',
[T_RETURN], [T_STRING, 'false'], ';',
],
],
[
'isNegative' => true,
'sequence' => [
'{', [T_RETURN], [T_STRING, 'false'], ';', '}',
[T_RETURN], [T_STRING, 'true'], ';',
],
],
[
'isNegative' => false,
'sequence' => [
[T_RETURN], [T_STRING, 'true'], ';',
[T_RETURN], [T_STRING, 'false'], ';',
],
],
[
'isNegative' => true,
'sequence' => [
[T_RETURN], [T_STRING, 'false'], ';',
[T_RETURN], [T_STRING, 'true'], ';',
],
],
];
/**
* {@inheritdoc}
*/
public function getDefinition(): FixerDefinitionInterface
{
return new FixerDefinition(
'Simplify `if` control structures that return the boolean result of their condition.',
[new CodeSample("<?php\nif (\$foo) { return true; } return false;\n")]
);
}
/**
* {@inheritdoc}
*
* Must run before MultilineWhitespaceBeforeSemicolonsFixer, NoSinglelineWhitespaceBeforeSemicolonsFixer.
* Must run after NoSuperfluousElseifFixer, NoUnneededCurlyBracesFixer, NoUselessElseFixer, SemicolonAfterInstructionFixer.
*/
public function getPriority(): int
{
return 1;
}
/**
* {@inheritdoc}
*/
public function isCandidate(Tokens $tokens): bool
{
return $tokens->isAllTokenKindsFound([T_IF, T_RETURN, T_STRING]);
}
/**
* {@inheritdoc}
*/
protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
{
for ($ifIndex = $tokens->count() - 1; 0 <= $ifIndex; --$ifIndex) {
if (!$tokens[$ifIndex]->isGivenKind([T_IF, T_ELSEIF])) {
continue;
}
if ($tokens[$tokens->getPrevMeaningfulToken($ifIndex)]->equals(')')) {
continue; // in a loop without braces
}
$startParenthesisIndex = $tokens->getNextTokenOfKind($ifIndex, ['(']);
$endParenthesisIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $startParenthesisIndex);
$firstCandidateIndex = $tokens->getNextMeaningfulToken($endParenthesisIndex);
foreach ($this->sequences as $sequenceSpec) {
$sequenceFound = $tokens->findSequence($sequenceSpec['sequence'], $firstCandidateIndex);
if (null === $sequenceFound) {
continue;
}
$firstSequenceIndex = key($sequenceFound);
if ($firstSequenceIndex !== $firstCandidateIndex) {
continue;
}
$indicesToClear = array_keys($sequenceFound);
array_pop($indicesToClear); // Preserve last semicolon
rsort($indicesToClear);
foreach ($indicesToClear as $index) {
$tokens->clearTokenAndMergeSurroundingWhitespace($index);
}
$newTokens = [
new Token([T_RETURN, 'return']),
new Token([T_WHITESPACE, ' ']),
];
if ($sequenceSpec['isNegative']) {
$newTokens[] = new Token('!');
} else {
$newTokens[] = new Token([T_BOOL_CAST, '(bool)']);
}
$tokens->overrideRange($ifIndex, $ifIndex, $newTokens);
}
}
}
}