Fixed bug #1364 : Yield From values are not recognised as returned va…

…lues in Squiz FunctionComment sniff
squizlabs · Mar 8, 2017 · 8a45c82 · 8a45c82
1 parent 922097f
commit 8a45c82
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 1 deletion.
diff --git a/CodeSniffer/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php b/CodeSniffer/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php
@@ -133,6 +133,7 @@ protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $co
 
                             if ($tokens[$returnToken]['code'] === T_RETURN
                                 || $tokens[$returnToken]['code'] === T_YIELD
+                                || $tokens[$returnToken]['code'] === T_YIELD_FROM
                             ) {
                                 break;
                             }
@@ -153,7 +154,7 @@ protected function processReturn(PHP_CodeSniffer_File $phpcsFile, $stackPtr, $co
                     // somewhere in the function that returns something.
                     if (isset($tokens[$stackPtr]['scope_closer']) === true) {
                         $endToken    = $tokens[$stackPtr]['scope_closer'];
-                        $returnToken = $phpcsFile->findNext(array(T_RETURN, T_YIELD), $stackPtr, $endToken);
+                        $returnToken = $phpcsFile->findNext(array(T_RETURN, T_YIELD, T_YIELD_FROM), $stackPtr, $endToken);
                         if ($returnToken === false) {
                             $error = 'Function return type is not void, but function has no return statement';
                             $phpcsFile->addError($error, $return, 'InvalidNoReturn');

diff --git a/CodeSniffer/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc b/CodeSniffer/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc
@@ -867,3 +867,13 @@ function returnTypeWithDescriptionD()
 {
 
 }//end returnTypeWithDescriptionD()
+
+/**
+ * Yield from test
+ *
+ * @return int[]
+ */
+function yieldFromTest()
+{
+    yield from foo();
+}
diff --git a/CodeSniffer/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc.fixed b/CodeSniffer/Standards/Squiz/Tests/Commenting/FunctionCommentUnitTest.inc.fixed
@@ -867,3 +867,13 @@ function returnTypeWithDescriptionD()
 {
 
 }//end returnTypeWithDescriptionD()
+
+/**
+ * Yield from test
+ *
+ * @return int[]
+ */
+function yieldFromTest()
+{
+    yield from foo();
+}
diff --git a/CodeSniffer/Tokens.php b/CodeSniffer/Tokens.php
@@ -152,6 +152,10 @@
     define('T_COALESCE_EQUAL', 'PHPCS_T_COALESCE_EQUAL');
 }
 
+if (defined('T_YIELD_FROM') === false) {
+    define('T_YIELD_FROM', 'PHPCS_T_YIELD_FROM');
+}
+
 // Tokens used for parsing doc blocks.
 define('T_DOC_COMMENT_STAR', 'PHPCS_T_DOC_COMMENT_STAR');
 define('T_DOC_COMMENT_WHITESPACE', 'PHPCS_T_DOC_COMMENT_WHITESPACE');

diff --git a/package.xml b/package.xml
@@ -26,6 +26,7 @@ http://pear.php.net/dtd/package-2.0.xsd">
  </stability>
  <license uri="https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt">BSD 3-Clause License</license>
  <notes>
+  - Fixed bug #1364 : Yield From values are not recognised as returned values in Squiz FunctionComment sniff
   - Fixed bug #1373 : Error in tab expansion results in white-space of incorrect size
     -- Thanks to Mark Clements for the patch
  </notes>