implement acronyms

Author: klausi

coder_sniffer/Drupal/Sniffs/NamingConventions/ValidClassNameSniff.php

@@ -72,10 +72,10 @@ public function process(File $phpcsFile, $stackPtr)
             $phpcsFile->addError($error, $stackPtr, 'NoUnderscores', $errorData);
         }
 
-        // Ensure the name is not all uppercase.
-        if (strtoupper($name) === $name) {
-            $error = '%s name must use UpperCamel naming and not be all uppercase';
-            $phpcsFile->addError($error, $stackPtr, 'NotAllUppercase', $errorData);
+        // Ensure the name does not contain acronyms.
+        if (preg_match('|[A-Z]{2}|', $name) === 1) {
+            $error = '%s name must use UpperCamel naming and not contain multiple upper case letters in a row';
+            $phpcsFile->addError($error, $stackPtr, 'NoUpperAcronyms', $errorData);
         }
 
     }//end process()

tests/Drupal/NamingConventions/ValidClassNameUnitTest.inc

@@ -1,25 +1,25 @@
 <?php
 
 class CorrectClassName {}
-class CorrectJSONClassName {}
+class IncorrectJSONClassName {}
 class INCORRECT_CLASS_NAME {}
 class INCORRECTCLASSNAME {}
 class incorrectLowercaseClassName {}
 
 interface CorrectInterfaceName {}
-interface CorrectJSONInterfaceName {}
+interface IncorrectJSONInterfaceName {}
 interface INCORRECT_INTERFACE_NAME {}
 interface INCORRECTINTERFACENAME {}
 interface incorrectLowercaseInterfaceName {}
 
 trait CorrectTraitName {}
-trait CorrectJSONTraitName {}
+trait IncorrectJSONTraitName {}
 trait INCORRECT_TRAIT_NAME {}
 trait INCORRECTTRAITNAME {}
 trait incorrectLowercaseTraitName {}
 
 enum CorrectEnumName {}
-enum CorrectJSONEnumName {}
+enum IncorrectJSONEnumName {}
 enum INCORRECT_ENUM_NAME {}
 enum INCORRECTENUMNAME {}
 enum incorrectLowercaseEnumName {}

tests/Drupal/NamingConventions/ValidClassNameUnitTest.php

@@ -21,15 +21,19 @@ class ValidClassNameUnitTest extends CoderSniffUnitTest
     protected function getErrorList(string $testFile): array
     {
         return [
+            4  => 1,
             5  => 2,
             6  => 1,
             7  => 1,
+            10 => 1,
             11 => 2,
             12 => 1,
             13 => 1,
+            16 => 1,
             17 => 2,
             18 => 1,
             19 => 1,
+            22 => 1,
             23 => 2,
             24 => 1,
             25 => 1,

tests/Drupal/NamingConventions/ValidEnumCaseUnitTest.inc

@@ -7,6 +7,7 @@ enum Test: int {
   case TWO_TEST = 2;
   // Must not contain only upper case.
   case THREE = 3;
-  // Some upper case parts are allowed for now.
+  // Upper case parts are not allowed.
   case FourJSONCase = 4;
+  case FiveCorrect = 5;
 }

tests/Drupal/NamingConventions/ValidEnumCaseUnitTest.php

@@ -21,9 +21,10 @@ class ValidEnumCaseUnitTest extends CoderSniffUnitTest
     protected function getErrorList(string $testFile): array
     {
         return [
-            5 => 1,
-            7 => 2,
-            9 => 1,
+            5  => 1,
+            7  => 2,
+            9  => 1,
+            11 => 1,
         ];
 
     }//end getErrorList()