Generic/LanguageConstructSpacing: don't auto-fix 'yield from' with comment

If there is a comment between the `yield` and the `from` keywords in a `yield from` expression, the sniff should report this, but should not auto-fix it, as it cannot be determined where the comment should be moved to.

Thic commit updates the sniff to throw a non-autofixable error with error code `IncorrectYieldFromWithComment` for that situation.

Includes unit tests.

Author: jrfnl

src/Standards/Generic/Sniffs/WhiteSpace/LanguageConstructSpacingSniff.php

@@ -93,6 +93,10 @@ public function process(File $phpcsFile, $stackPtr)
                         break;
                     }
 
+                    if (isset(Tokens::$commentTokens[$tokens[$i]['code']]) === true) {
+                        $hasComment = true;
+                    }
+
                     $found .= $tokens[$i]['content'];
 
                     if ($tokens[$i]['code'] === T_YIELD_FROM
@@ -107,19 +111,24 @@ public function process(File $phpcsFile, $stackPtr)
 
             $error = 'Language constructs must be followed by a single space; expected 1 space between YIELD FROM found "%s"';
             $data  = [Common::prepareForOutput($found)];
-            $fix   = $phpcsFile->addFixableError($error, $stackPtr, 'IncorrectYieldFrom', $data);
-            if ($fix === true) {
-                preg_match('/yield/i', $found, $yield);
-                preg_match('/from/i', $found, $from);
-                $phpcsFile->fixer->beginChangeset();
-                $phpcsFile->fixer->replaceToken($stackPtr, $yield[0].' '.$from[0]);
 
-                for ($i = ($stackPtr + 1); $i <= $yieldFromEnd; $i++) {
-                    $phpcsFile->fixer->replaceToken($i, '');
-                }
+            if ($hasComment === true) {
+                $phpcsFile->addError($error, $stackPtr, 'IncorrectYieldFromWithComment', $data);
+            } else {
+                $fix = $phpcsFile->addFixableError($error, $stackPtr, 'IncorrectYieldFrom', $data);
+                if ($fix === true) {
+                    preg_match('/yield/i', $found, $yield);
+                    preg_match('/from/i', $found, $from);
+                    $phpcsFile->fixer->beginChangeset();
+                    $phpcsFile->fixer->replaceToken($stackPtr, $yield[0].' '.$from[0]);
 
-                $phpcsFile->fixer->endChangeset();
-            }
+                    for ($i = ($stackPtr + 1); $i <= $yieldFromEnd; $i++) {
+                        $phpcsFile->fixer->replaceToken($i, '');
+                    }
+
+                    $phpcsFile->fixer->endChangeset();
+                }
+            }//end if
 
             return ($yieldFromEnd + 1);
         }//end if

src/Standards/Generic/Tests/WhiteSpace/LanguageConstructSpacingUnitTest.1.inc

@@ -89,3 +89,12 @@ $newLine;
 // The following line must have a single space at the end (after return)
 return 
 $spaceAndNewLine;
+
+// Related to issue #529. These should not be auto-fixed as we don't know what to do with the comment.
+yield    /*comment*/    from $test();
+yield
+    # comment
+    from $test();
+yield
+    // phpcs:ignore Stnd.Category.SniffName
+    from $test();

src/Standards/Generic/Tests/WhiteSpace/LanguageConstructSpacingUnitTest.1.inc.fixed

@@ -83,3 +83,12 @@ return $newLine;
 
 // The following line must have a single space at the end (after return)
 return $spaceAndNewLine;
+
+// Related to issue #529. These should not be auto-fixed as we don't know what to do with the comment.
+yield    /*comment*/    from $test();
+yield
+    # comment
+    from $test();
+yield
+    // phpcs:ignore Stnd.Category.SniffName
+    from $test();

src/Standards/Generic/Tests/WhiteSpace/LanguageConstructSpacingUnitTest.php

@@ -71,6 +71,9 @@ public function getErrorList($testFile='')
                 85 => 1,
                 86 => 1,
                 90 => 1,
+                94 => 1,
+                95 => 1,
+                98 => 1,
             ];
 
         default: