Tests/Tokenizer: scope opener is set correctly for T_SWITCH

This commit copies, with some modifications, a sniff test to the
tokenizer tests. It ensures that the scope opener is set correctly for
T_SWITCH when there is a closure in the condition. This safeguards
against regressions related to 30c618e, which fixed https://github
.com/squizlabs/PHP_CodeSniffer/issues/543. 30c618e originally added a
test to InlineControlStructureUnitTest.php as there were no Tokenizer
tests back then.

Since the InlineControlStructure sniff doesn't listen for the `T_SWITCH`
token anymore (see baa4f65), the original test added in 30c618e became
useless and thus was refactored to use a different control structure.
This new version of the sniff test was kept as testing code that uses
a closure in the condition is still an interesting case and is not
covered in other tests.

Author: rodrigoprimo

src/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.1.inc

@@ -106,15 +106,15 @@ 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)

src/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.1.inc.fixed

@@ -118,16 +118,17 @@ 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 ) {

src/Standards/Generic/Tests/ControlStructures/InlineControlStructureUnitTest.php

@@ -48,6 +48,7 @@ public function getErrorList($testFile='')
                 62  => 1,
                 66  => 1,
                 78  => 1,
+                109 => 1,
                 120 => 1,
                 128 => 1,
                 134 => 1,

tests/Core/Tokenizers/Tokenizer/RecurseScopeMapSwitchTokenScopeTest.inc

@@ -22,3 +22,12 @@ switch ($value):
         break;
 /* testSwitchAlternativeSyntaxEnd */
 endswitch;
+
+// Test for https://github.com/squizlabs/PHP_CodeSniffer/issues/543
+/* testSwitchClosureWithinCondition */
+switch((function () {
+    return 'bar';
+})()) /* testSwitchClosureWithinConditionScopeOpener */ {
+    case 1:
+        return 'test';
+}

tests/Core/Tokenizers/Tokenizer/RecurseScopeMapSwitchTokenScopeTest.php

@@ -20,6 +20,8 @@ final class RecurseScopeMapSwitchTokenScopeTest extends AbstractTokenizerTestCas
      *
      * @param string                    $testMarker       The comment which prefaces the target token in the test file.
      * @param array<string, int|string> $expectedTokens   The expected token codes for the scope opener/closer.
+     * @param string|null               $testOpenerMarker Optional. The comment which prefaces the scope opener if different
+     *                                                    from the test marker.
      * @param string|null               $testCloserMarker Optional. The comment which prefaces the scope closer if different
      *                                                    from the test marker.
      *
@@ -30,19 +32,24 @@ final class RecurseScopeMapSwitchTokenScopeTest extends AbstractTokenizerTestCas
      *
      * @return void
      */
-    public function testSwitchScope($testMarker, $expectedTokens, $testCloserMarker=null)
+    public function testSwitchScope($testMarker, $expectedTokens, $testOpenerMarker=null, $testCloserMarker=null)
     {
         $tokens      = $this->phpcsFile->getTokens();
         $switchIndex = $this->getTargetToken($testMarker, [T_SWITCH]);
         $tokenArray  = $tokens[$switchIndex];
 
+        $scopeOpenerMarker = $testMarker;
+        if (isset($testOpenerMarker) === true) {
+            $scopeOpenerMarker = $testOpenerMarker;
+        }
+
         $scopeCloserMarker = $testMarker;
         if (isset($testCloserMarker) === true) {
             $scopeCloserMarker = $testCloserMarker;
         }
 
         $expectedScopeCondition = $switchIndex;
-        $expectedScopeOpener    = $this->getTargetToken($testMarker, $expectedTokens['scope_opener']);
+        $expectedScopeOpener    = $this->getTargetToken($scopeOpenerMarker, $expectedTokens['scope_opener']);
         $expectedScopeCloser    = $this->getTargetToken($scopeCloserMarker, $expectedTokens['scope_closer']);
 
         $this->assertArrayHasKey('scope_condition', $tokenArray, 'Scope condition not set');
@@ -90,21 +97,31 @@ public function testSwitchScope($testMarker, $expectedTokens, $testCloserMarker=
     public static function dataSwitchScope()
     {
         return [
-            'switch normal syntax'      => [
+            'switch normal syntax'                 => [
                 'testMarker'     => '/* testSwitchNormalSyntax */',
                 'expectedTokens' => [
                     'scope_opener' => T_OPEN_CURLY_BRACKET,
                     'scope_closer' => T_CLOSE_CURLY_BRACKET,
                 ],
             ],
-            'switch alternative syntax' => [
+            'switch alternative syntax'            => [
                 'testMarker'       => '/* testSwitchAlternativeSyntax */',
                 'expectedTokens'   => [
                     'scope_opener' => T_COLON,
                     'scope_closer' => T_ENDSWITCH,
                 ],
+                'testOpenerMarker' => null,
                 'testCloserMarker' => '/* testSwitchAlternativeSyntaxEnd */',
             ],
+            'switch with closure in the condition' => [
+                'testMarker'       => '/* testSwitchClosureWithinCondition */',
+                'expectedTokens'   => [
+                    'scope_opener' => T_OPEN_CURLY_BRACKET,
+                    'scope_closer' => T_CLOSE_CURLY_BRACKET,
+                ],
+                'testOpenerMarker' => '/* testSwitchClosureWithinConditionScopeOpener */',
+                'testCloserMarker' => '/* testSwitchClosureWithinConditionScopeOpener */',
+            ],
         ];
 
     }//end dataSwitchScope()