Merge pull request #394 from rodrigoprimo/test-coverage-call-time-pass-by-reference

Generic/CallTimePassByReference: support anonymous classes and improve code coverage

Author: jrfnl

src/Standards/Generic/Sniffs/Functions/CallTimePassByReferenceSniff.php

@@ -27,6 +27,7 @@ public function register()
         return [
             T_STRING,
             T_VARIABLE,
+            T_ANON_CLASS,
         ];
 
     }//end register()
@@ -50,12 +51,12 @@ public function process(File $phpcsFile, $stackPtr)
 
         $prev = $phpcsFile->findPrevious($findTokens, ($stackPtr - 1), null, true);
 
-        // Skip tokens that are the names of functions or classes
+        // Skip tokens that are the names of functions
         // within their definitions. For example: function myFunction...
         // "myFunction" is T_STRING but we should skip because it is not a
         // function or method *call*.
         $prevCode = $tokens[$prev]['code'];
-        if ($prevCode === T_FUNCTION || $prevCode === T_CLASS) {
+        if ($prevCode === T_FUNCTION) {
             return;
         }
 
@@ -69,7 +70,7 @@ public function process(File $phpcsFile, $stackPtr)
             true
         );
 
-        if ($tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
+        if ($openBracket === false || $tokens[$openBracket]['code'] !== T_OPEN_PARENTHESIS) {
             return;
         }
 
@@ -86,10 +87,6 @@ public function process(File $phpcsFile, $stackPtr)
         ];
 
         while (($nextSeparator = $phpcsFile->findNext($find, ($nextSeparator + 1), $closeBracket)) !== false) {
-            if (isset($tokens[$nextSeparator]['nested_parenthesis']) === false) {
-                continue;
-            }
-
             if ($tokens[$nextSeparator]['code'] === T_OPEN_SHORT_ARRAY) {
                 $nextSeparator = $tokens[$nextSeparator]['bracket_closer'];
                 continue;

src/Standards/Generic/Tests/Functions/CallTimePassByReferenceUnitTest.inc renamed to src/Standards/Generic/Tests/Functions/CallTimePassByReferenceUnitTest.1.inc

@@ -37,3 +37,18 @@ myfunc(MY_CONST&$myvar);
 
 efg( true == &$b );
 efg( true === &$b );
+
+foo($a, bar(&$b));
+foo($a, array(&$b));
+
+enum Foo {}
+interface Foo {}
+trait Foo {}
+
+$instance = new $var($a);
+$instance = new MyClass($a);
+$instance = new $var(&$a);
+$instance = new MyClass(&$a);
+
+$anon = new class($a) {};
+$anon = new class(&$a) {};

src/Standards/Generic/Tests/Functions/CallTimePassByReferenceUnitTest.2.inc

@@ -0,0 +1,7 @@
+<?php
+
+// Intentional parse error.
+// This should be the only test in this file.
+// Testing that the sniff is *not* triggered when there are only empty tokens after a variable and nothing else.
+
+$var

src/Standards/Generic/Tests/Functions/CallTimePassByReferenceUnitTest.3.inc

@@ -0,0 +1,7 @@
+<?php
+
+// Intentional parse error (missing closing parenthesis).
+// This should be the only test in this file.
+// Testing that the sniff is *not* triggered.
+
+foo(

src/Standards/Generic/Tests/Functions/CallTimePassByReferenceUnitTest.php

@@ -26,18 +26,30 @@ final class CallTimePassByReferenceUnitTest extends AbstractSniffUnitTest
      * The key of the array should represent the line number and the value
      * should represent the number of errors that should occur on that line.
      *
+     * @param string $testFile The name of the test file to process.
+     *
      * @return array<int, int>
      */
-    public function getErrorList()
+    public function getErrorList($testFile='CallTimePassByReferenceUnitTest.1.inc')
     {
-        return [
-            9  => 1,
-            12 => 1,
-            15 => 1,
-            18 => 2,
-            23 => 1,
-            30 => 1,
-        ];
+        switch ($testFile) {
+        case 'CallTimePassByReferenceUnitTest.1.inc':
+            return [
+                9  => 1,
+                12 => 1,
+                15 => 1,
+                18 => 2,
+                23 => 1,
+                30 => 1,
+                41 => 1,
+                50 => 1,
+                51 => 1,
+                54 => 1,
+            ];
+
+        default:
+            return [];
+        }
 
     }//end getErrorList()