Merge pull request PHPCSStandards#684 from rodrigoprimo/test-coverage-cyclomatic-complexity

Generic/CyclomaticComplexity: improve code coverage

Author: jrfnl

src/Standards/Generic/Sniffs/Metrics/CyclomaticComplexitySniff.php

@@ -60,8 +60,8 @@ public function process(File $phpcsFile, $stackPtr)
     {
         $tokens = $phpcsFile->getTokens();
 
-        // Ignore abstract methods.
-        if (isset($tokens[$stackPtr]['scope_opener']) === false) {
+        // Ignore abstract and interface methods. Bail early when live coding.
+        if (isset($tokens[$stackPtr]['scope_opener'], $tokens[$stackPtr]['scope_closer']) === false) {
             return;
         }
 

src/Standards/Generic/Tests/Metrics/CyclomaticComplexityUnitTest.inc renamed to src/Standards/Generic/Tests/Metrics/CyclomaticComplexityUnitTest.1.inc

@@ -46,7 +46,7 @@ function complexityEleven()
 {
     while ($condition === true) {
         if ($condition) {
-        } else if ($cond) {
+        } elseif ($cond) {
         }
     }
 
@@ -61,11 +61,11 @@ function complexityEleven()
                 echo 'hi';
             }
         break;
-        case '3':
-        break;
         default:
         break;
     }
+
+    foreach ($array as $element) {}
 }
 
 
@@ -136,14 +136,6 @@ function complexityTwentyOne()
                 echo 'hi';
             }
         break;
-        case '3':
-            switch ($cond) {
-                case '1':
-                break;
-                case '2':
-                break;
-            }
-        break;
         case '4':
             do {
                 if ($condition) {
@@ -159,8 +151,16 @@ function complexityTwentyOne()
             }
         break;
     }
-}
 
+    try {
+        for ($i = 0; $i < 10; $i++) {
+            if ($i % 2) {
+                doSomething();
+            }
+        }
+    } catch (Exception $e) {
+    }
+}
 
 function complexityTenWithTernaries()
 {
@@ -451,4 +451,10 @@ function complexityElevenWithNullSafeOperator()
     $bits = $object5->getX()?->getY()?->getZ();
 }
 
-?>
+abstract class AbstractClass {
+    abstract public function sniffShouldIgnoreAbstractMethods();
+}
+
+interface MyInterface {
+    public function sniffShouldIgnoreInterfaceMethods();
+}

src/Standards/Generic/Tests/Metrics/CyclomaticComplexityUnitTest.2.inc

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

src/Standards/Generic/Tests/Metrics/CyclomaticComplexityUnitTest.3.inc

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

src/Standards/Generic/Tests/Metrics/CyclomaticComplexityUnitTest.php

@@ -26,11 +26,18 @@ final class CyclomaticComplexityUnitTest 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 file being tested.
+     *
      * @return array<int, int>
      */
-    public function getErrorList()
+    public function getErrorList($testFile='')
     {
-        return [118 => 1];
+        switch ($testFile) {
+        case 'CyclomaticComplexityUnitTest.1.inc':
+            return [118 => 1];
+        default:
+            return [];
+        }
 
     }//end getErrorList()
 
@@ -41,21 +48,28 @@ public function getErrorList()
      * The key of the array should represent the line number and the value
      * should represent the number of warnings that should occur on that line.
      *
+     * @param string $testFile The name of the file being tested.
+     *
      * @return array<int, int>
      */
-    public function getWarningList()
+    public function getWarningList($testFile='')
     {
-        return [
-            45  => 1,
-            72  => 1,
-            189 => 1,
-            237 => 1,
-            285 => 1,
-            333 => 1,
-            381 => 1,
-            417 => 1,
-            445 => 1,
-        ];
+        switch ($testFile) {
+        case 'CyclomaticComplexityUnitTest.1.inc':
+            return [
+                45  => 1,
+                72  => 1,
+                189 => 1,
+                237 => 1,
+                285 => 1,
+                333 => 1,
+                381 => 1,
+                417 => 1,
+                445 => 1,
+            ];
+        default:
+            return [];
+        }
 
     }//end getWarningList()