Merge pull request #641 from rodrigoprimo/test-coverage-abstract-class-name-prefix

Generic/AbstractClassNamePrefix: improve code coverage

Author: jrfnl

src/Standards/Generic/Sniffs/NamingConventions/AbstractClassNamePrefixSniff.php

@@ -45,7 +45,7 @@ public function process(File $phpcsFile, $stackPtr)
 
         $className = $phpcsFile->getDeclarationName($stackPtr);
         if ($className === null) {
-            // We are not interested in anonymous classes.
+            // Live coding or parse error.
             return;
         }
 

src/Standards/Generic/Tests/NamingConventions/AbstractClassNamePrefixUnitTest.1.inc

@@ -0,0 +1,45 @@
+<?php
+
+abstract class IncorrectName {} // Error.
+
+abstract class AbstractCorrectName {}
+
+abstract class IncorrectNameAbstract {} // Error.
+
+abstract
+    /*comment*/
+    class
+    InvalidNameabstract
+    extends
+    BarClass {} // Error.
+
+abstract class /*comment*/ IncorrectAbstractName {} // Error.
+
+// Anonymous classes can't be declared as abstract (and don't have a name anyhow).
+$anon = new class {};
+
+// Make sure that if the class is not abstract, the sniff does not check the name.
+class AbstractClassName {}
+
+// Class name is always checked, doesn't matter if the class is declared conditionally.
+if (!class_exists('AbstractClassCorrectName')) {
+    abstract class AbstractClassCorrectName {}
+}
+if (!class_exists('ClassAbstractIncorrectName')) {
+    abstract class ClassAbstractIncorrectName implements FooInterface {} // Error.
+}
+
+$var = 'abstract class TextStringsAreDisregarded';
+
+class NotAnAbstractClassSoNoPrefixRequired {}
+
+abstract class abstractOkCaseOfPrefixIsNotEnforced {}
+
+final class FinalClassShouldNotTriggerWarning {}
+
+readonly class ReadonlyClassShouldNotTriggerWarning {}
+
+abstract readonly class AbstractReadonlyClassWithPrefixShouldNotTriggerWarning {}
+
+abstract readonly class ReadonlyAbstractClassShouldTriggerWarningWhenPrefixIsMissingA {} // Error.
+readonly abstract class ReadonlyAbstractClassShouldTriggerWarningWhenPrefixIsMissingB {} // Error.

src/Standards/Generic/Tests/NamingConventions/AbstractClassNamePrefixUnitTest.2.inc

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

src/Standards/Generic/Tests/NamingConventions/AbstractClassNamePrefixUnitTest.inc

@@ -25,17 +25,26 @@ final class AbstractClassNamePrefixUnitTest 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.
+     *
      * @return array<int, int>
      */
-    public function getErrorList()
+    public function getErrorList($testFile='')
     {
-        return [
-            3  => 1,
-            13 => 1,
-            18 => 1,
-            23 => 1,
-            42 => 1,
-        ];
+        switch ($testFile) {
+        case 'AbstractClassNamePrefixUnitTest.1.inc':
+            return [
+                3  => 1,
+                7  => 1,
+                11 => 1,
+                16 => 1,
+                29 => 1,
+                44 => 1,
+                45 => 1,
+            ];
+        default:
+            return [];
+        }
 
     }//end getErrorList()