Skip to content

Generic/InlineControlStructure: stop listening for T_SWITCH #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Dec 20, 2024
Merged

Generic/InlineControlStructure: stop listening for T_SWITCH #595

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a9b6fa0
Generic/InlineControlStructure: stop listening for T_SWITCH tokens
rodrigoprimo Oct 4, 2024
4c92408
Tests/Tokenizer: tests to ensure scope is set correctly for T_SWITCH
rodrigoprimo May 22, 2024
b9809c7
Tests/Tokenizer: tests for T_CASE and T_IF scope condition
rodrigoprimo Jul 26, 2024
9546775
Tests/Tokenizer: scope opener is set correctly for T_SWITCH
rodrigoprimo Aug 12, 2024
82fae8e
Tests/Tokenizer: expand `recurseScopeMap()` tests for the case keyword
rodrigoprimo Aug 12, 2024
61b9e9b
Tests/Tokenizer: test to ensure scope closer is set correctly for T_CASE
rodrigoprimo Aug 13, 2024
105b4be
Tests/Tokenizer: test related to setting the scope for T_CASE
rodrigoprimo Aug 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/Standards/Generic/Sniffs/ControlStructures/InlineControlStructureSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ public function register()
T_FOREACH,
T_WHILE,
T_DO,
T_SWITCH,
T_FOR,
];

Expand Down
64 changes: 32 additions & 32 deletions src/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.1.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,42 +79,42 @@ if ($a)
</div>

<?php
switch ($this->error):
case Shop_Customer :: ERROR_INVALID_GENDER: ?>
Ung&uuml;ltiges Geschlecht!
<?php break;
case Shop_Customer :: ERROR_EMAIL_IN_USE: ?>
Die eingetragene E-Mail-Adresse ist bereits registriert.
<?php break;
endswitch;

if ($this->allowShopping !== true):
if ($this->status != Shop_Cart :: OK):
switch ($this->status):
case Shop_Cart :: NOT_FOUND:
echo 'foo';
endswitch;

if ($error === ERROR_ONE): ?>
Error one!
<?php elseif ($error === ERROR_TWO): ?>
Error two!
<?php endif;



if ($value):
if ($anotherValue):
foreach ($array as $element):
echo (function($element): string { return $element; } )($element);
endforeach;
endif;
else:
echo 'foo';
endif;


// ELSE IF split over multiple lines (not inline)
if ($test) {
} else
if ($test) {
} else {
}

switch($response = \Bar::baz('bat', function ($foo) {
if ((function () {
return 'bar';
})) {
case 1:
return 'test';
})())
echo 'one';





case 2:
return 'other';
}

$stuff = [1,2,3];
foreach($stuff as $num)
Expand Down Expand Up @@ -201,16 +201,16 @@ if (true)
catch(Exception $e) {
}

switch ($num) {
case 0:
if (1 > $num)
return bar(
baz(
"foobarbaz"
)
);
break;
}
for ($i = 0; $i <= 4; $i++)
if ($i % 2)
return bar(
baz(
"foobarbaz"
)
);




do {
$i++;
Expand Down
66 changes: 34 additions & 32 deletions src/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.1.inc.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,43 +91,44 @@ if ($a) {
</div>

<?php
switch ($this->error):
case Shop_Customer :: ERROR_INVALID_GENDER: ?>
Ung&uuml;ltiges Geschlecht!
<?php break;
case Shop_Customer :: ERROR_EMAIL_IN_USE: ?>
Die eingetragene E-Mail-Adresse ist bereits registriert.
<?php break;
endswitch;

if ($this->allowShopping !== true):
if ($this->status != Shop_Cart :: OK):
switch ($this->status):
case Shop_Cart :: NOT_FOUND:
echo 'foo';
endswitch;

if ($error === ERROR_ONE): ?>
Error one!
<?php elseif ($error === ERROR_TWO): ?>
Error two!
<?php endif;



if ($value):
if ($anotherValue):
foreach ($array as $element):
echo (function($element): string { return $element; } )($element);
endforeach;
endif;
else:
echo 'foo';
endif;


// ELSE IF split over multiple lines (not inline)
if ($test) {
} else
if ($test) {
} else {
}

switch($response = \Bar::baz('bat', function ($foo) {
if ((function () {
return 'bar';
})) {
case 1:
return 'test';

case 2:
return 'other';
})()) {
echo 'one';
}






$stuff = [1,2,3];
foreach($stuff as $num) {
if ($num %2 ) {
Expand Down Expand Up @@ -229,18 +230,19 @@ if (true) {
}
}

switch ($num) {
case 0:
if (1 > $num) {
return bar(
baz(
"foobarbaz"
)
);
}
break;
for ($i = 0; $i <= 4; $i++) {
if ($i % 2) {
return bar(
baz(
"foobarbaz"
)
);
}
}




do {
$i++;
}
Expand Down
2 changes: 1 addition & 1 deletion src/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.1.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ do {

do i++; while (i < 5);

SomeClass.prototype.switch = function() {
SomeClass.prototype.for = function() {
// do something
};

Expand Down
2 changes: 1 addition & 1 deletion src/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.1.js.fixed
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ do {
do { i++;
} while (i < 5);

SomeClass.prototype.switch = function() {
SomeClass.prototype.for = function() {
// do something
};

Expand Down
4 changes: 3 additions & 1 deletion src/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ public function getErrorList($testFile='')
62 => 1,
66 => 1,
78 => 1,
109 => 1,
120 => 1,
128 => 1,
134 => 1,
Expand All @@ -69,7 +70,8 @@ public function getErrorList($testFile='')
191 => 1,
195 => 1,
198 => 1,
206 => 1,
204 => 1,
205 => 1,
222 => 1,
232 => 1,
235 => 1,
Expand Down
37 changes: 37 additions & 0 deletions tests/Core/Tokenizers/Tokenizer/RecurseScopeMapCaseKeywordConditionsTest.inc
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this improvement also be done RecurseScopeMapDefaultKeywordConditionsTest tests ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jrfnl, it seems to me that adding the closer markers to RecurseScopeMapDefaultKeywordConditionsTest is not necessary as the tests there are different. The code doesn't look for the scope_closer using AbstractTokenizerTestCase::getTargetToken() and the test marker. Instead, a closerOffset is passed, and it is used to determine the scope_closer:

https://github.com/rodrigoprimo/PHP_CodeSniffer/blob/82fae8e57e10f6a7000daf53910394d109064736/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapDefaultKeywordConditionsTest.php#L130

Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,21 @@ switch (true) {
case CONSTANT = 1:
/* testIsNotEnumCaseIsCaseInsensitive */
cAsE CONSTANT:
/* testCaseConstantCloserMarker */
}

switch ($x) {
/* testCaseInSwitchWhenCreatingEnumInSwitch1 */
case 'a': {
enum Foo {}
break;
/* testCaseInSwitchWhenCreatingEnumInSwitch1CloserMarker */
}

/* testCaseInSwitchWhenCreatingEnumInSwitch2 */
case 'b';
enum Bar {}
/* testCaseInSwitchWhenCreatingEnumInSwitch2CloserMarker */
break;
}

Expand All @@ -93,3 +96,37 @@ enum Foo: string {
/* testKeywordAsEnumCaseNameShouldBeString7 */
case ARRAY = 'array';
}

// Test for https://github.com/squizlabs/PHP_CodeSniffer/issues/497
switch ($value):
/* testSwitchCaseScopeCloserSharedWithSwitch */
case 1:
echo 'one';
endswitch;

// Test for https://github.com/squizlabs/PHP_CodeSniffer/issues/879
switch ($type) {
/* testSwitchCaseNestedIfWithAndWithoutBraces */
case 1:
if ($foo) {
return true;
} elseif ($baz)
return true;
else {
echo 'else';
}
break;
}

// Test for https://github.com/squizlabs/PHP_CodeSniffer/issues/1590
switch ($num) {
/* testSwitchCaseNestedInlineIfWithMoreThanThreeLines */
case 0:
if (1 > $num)
return bar(
baz(
"foobarbaz"
)
);
break;
}
Loading
Loading