/
NoMixedEchoPrintFixerTest.php
373 lines (349 loc) · 9.84 KB
/
NoMixedEchoPrintFixerTest.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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
<?php
/*
* 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\Tests\Fixer\Alias;
use PhpCsFixer\AbstractFixer;
use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
/**
* @author Sullivan Senechal <soullivaneuh@gmail.com>
* @author SpacePossum
*
* @internal
*
* @covers \PhpCsFixer\Fixer\Alias\NoMixedEchoPrintFixer
*/
final class NoMixedEchoPrintFixerTest extends AbstractFixerTestCase
{
/**
* @param string $expected
* @param null|string $input
*
* @dataProvider provideEchoToPrintFixCases
* @dataProvider provideEchoToPrintFixNewCases
*/
public function testFixEchoToPrint($expected, $input = null)
{
$this->fixer->configure(['use' => 'print']);
$this->doTest($expected, $input);
}
public function provideEchoToPrintFixCases()
{
return [
[
'<?php
print "test";
',
],
[
'<?php
print ("test");
',
],
[
'<?php
print("test");
',
],
// `echo` can take multiple parameters (although such usage is rare) while `print` can take only one argument,
// @see https://php.net/manual/en/function.echo.php and @see https://php.net/manual/en/function.print.php
[
'<?php
echo "This ", "string ", "was ", "made ", "with multiple parameters.";
',
],
[
'<?php
print "test";
',
'<?php
echo "test";
',
],
[
'<?php
print ("test");
',
'<?php
echo ("test");
',
],
[
'<?php
print("test");
',
'<?php
echo("test");
',
],
[
'<?php
print foo(1, 2);
',
'<?php
echo foo(1, 2);
',
],
[
'<?php
print ["foo", "bar", "baz"][$x];
',
'<?php
echo ["foo", "bar", "baz"][$x];
',
],
[
'<?php
print $foo ? "foo" : "bar";
',
'<?php
echo $foo ? "foo" : "bar";
',
],
[
"<?php print 'foo' ?>...<?php echo 'bar', 'baz' ?>",
"<?php echo 'foo' ?>...<?php echo 'bar', 'baz' ?>",
],
[
'<?php
if ($foo) {
print "foo";
}
print "bar";
',
'<?php
if ($foo) {
echo "foo";
}
echo "bar";
',
],
[
'<?=$foo?>',
],
];
}
public static function provideEchoToPrintFixNewCases()
{
foreach (self::getCodeSnippetsToConvertBothWays() as $name => $codeSnippet) {
yield [
sprintf($codeSnippet, 'print'),
sprintf($codeSnippet, 'echo'),
];
}
}
/**
* @param string $expected
* @param null|string $input
*
* @dataProvider providePrintToEchoFixCases
* @dataProvider providePrintToEchoFixNewCases
*/
public function testFixPrintToEcho($expected, $input = null)
{
$this->fixer->configure(['use' => 'echo']);
$this->doTest($expected, $input);
}
public function providePrintToEchoFixCases()
{
return [
[
'<?php
echo "test";
',
],
[
'<?php
echo ("test");
',
],
[
'<?php
echo("test");
',
],
// https://github.com/FriendsOfPHP/PHP-CS-Fixer/issues/1502#issuecomment-156436229
[
'<?php
($some_var) ? print "true" : print "false";
',
],
// echo has no return value while print has a return value of 1 so it can be used in expressions.
// https://www.w3schools.com/php/php_echo_print.asp
[
'<?php
$ret = print "test";
',
],
[
'<?php
@print foo();
',
],
[
'<?php
function testFunction() {
return print("test");
}
$a = testFunction();
$b += print($a);
$c=\'\';
$c .= $b.print($a);
$d = print($c) > 0 ? \'a\' : \'b\';
switch(print(\'a\')) {}
if (1 === print($a)) {}
',
],
[
'<?php
some_function_call();
echo "test";
',
'<?php
some_function_call();
print "test";
',
],
[
'<?php
echo "test";
',
'<?php
print "test";
',
],
[
'<?php
echo ("test");
',
'<?php
print ("test");
',
],
[
'<?php
echo("test");
',
'<?php
print("test");
',
],
[
'<?php
echo foo(1, 2);
',
'<?php
print foo(1, 2);
',
],
[
'<?php
echo $foo ? "foo" : "bar";
',
'<?php
print $foo ? "foo" : "bar";
',
],
[
'<?php
if ($foo) {
echo "foo";
}
echo "bar";
',
'<?php
if ($foo) {
print "foo";
}
print "bar";
',
],
];
}
public static function providePrintToEchoFixNewCases()
{
foreach (self::getCodeSnippetsToConvertBothWays() as $name => $codeSnippet) {
yield [
sprintf($codeSnippet, 'echo'),
sprintf($codeSnippet, 'print'),
];
}
}
/**
* @group legacy
*/
public function testLegacyDefaultConfig()
{
$this->expectDeprecation('Passing NULL to set default configuration is deprecated and will not be supported in 3.0, use an empty array instead.');
$this->fixer->configure(null);
static::assertCandidateTokenType(T_PRINT, $this->fixer);
}
public function testDefaultConfig()
{
$this->fixer->configure([]);
static::assertCandidateTokenType(T_PRINT, $this->fixer);
}
/**
* @dataProvider provideWrongConfigCases
*
* @param mixed $wrongConfig
* @param string $expectedMessage
*/
public function testWrongConfig($wrongConfig, $expectedMessage)
{
$this->expectException(\PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException::class);
$this->expectExceptionMessageMatches($expectedMessage);
$this->fixer->configure($wrongConfig);
}
public function provideWrongConfigCases()
{
return [
[
['a' => 'b'],
'#^\[no_mixed_echo_print\] Invalid configuration: The option "a" does not exist\. (Known|Defined) options are: "use"\.$#',
],
[
['a' => 'b', 'b' => 'c'],
'#^\[no_mixed_echo_print\] Invalid configuration: The options "a", "b" do not exist\. (Known|Defined) options are: "use"\.$#',
],
[
[1],
'#^\[no_mixed_echo_print\] Invalid configuration: The option "0" does not exist\. (Known|Defined) options are: "use"\.$#',
],
[
['use' => '_invalid_'],
'#^\[no_mixed_echo_print\] Invalid configuration: The option "use" with value "_invalid_" is invalid\. Accepted values are: "print", "echo"\.$#',
],
];
}
private static function assertCandidateTokenType($expected, AbstractFixer $fixer)
{
$reflectionProperty = new \ReflectionProperty($fixer, 'candidateTokenType');
$reflectionProperty->setAccessible(true);
static::assertSame($expected, $reflectionProperty->getValue($fixer));
}
private static function getCodeSnippetsToConvertBothWays()
{
yield 'inside of HTML' => '<div><?php %1$s "foo" ?></div>';
yield 'foreach without curly brackets' => '<?php
%1$s "There will be foos: ";
foreach ($foos as $foo)
%1$s $foo;
%1$s "End of foos";
';
yield 'if and else without curly brackets' => '<?php
if ($foo)
%1$s "One";
elseif ($bar)
%1$s "Two";
else
%1$s "Three";
';
}
}