Revert "Common::getSniffCode(): be more lenient about sniffs not following naming conventions"

This reverts commit 71b4524.

Includes further enhancements to strictly apply the naming conventions by:
1. Making sure that the FQN contains a `Sniffs` or `Tests` sub-namespace in the correct position.
2. Making sure that the category is not called `Sniffs`.
3. Making sure that a class ends on `Sniff` or `UnitTest`, and that that is a suffix, not the sole name of the class.

Includes updating the tests.

Includes an update to the `Fixer` class, which uses the `Common::getSniffCode()` method to ensure that fixer debug information will continue to be informative.

Related to 689
Related to 6

Author: jrfnl

src/Runner.php

@@ -643,7 +643,6 @@ public function processFile($file)
                 try {
                     if (empty($nextStack) === false
                         && isset($nextStack['class']) === true
-                        && substr($nextStack['class'], -5) === 'Sniff'
                     ) {
                         $sniffCode = 'the '.Common::getSniffCode($nextStack['class']).' sniff';
                     }

src/Util/Common.php

@@ -532,7 +532,7 @@ public static function suggestType($varType)
      * @return string
      *
      * @throws \InvalidArgumentException When $sniffClass is not a non-empty string.
-     * @throws \InvalidArgumentException When $sniffClass is not a FQN for a sniff(test) class.
+     * @throws \InvalidArgumentException When $sniffClass is not a valid FQN for a sniff(test) class.
      */
     public static function getSniffCode($sniffClass)
     {
@@ -542,12 +542,22 @@ public static function getSniffCode($sniffClass)
 
         $parts      = explode('\\', $sniffClass);
         $partsCount = count($parts);
-        $sniff      = $parts[($partsCount - 1)];
+        if ($partsCount < 4
+            || ($parts[($partsCount - 3)] !== 'Sniffs'
+            && $parts[($partsCount - 3)] !== 'Tests')
+            || $parts[($partsCount - 2)] === 'Sniffs'
+        ) {
+            throw new InvalidArgumentException(
+                'The $sniffClass parameter was not passed a fully qualified sniff(test) class name. Received: '.$sniffClass
+            );
+        }
+
+        $sniff = $parts[($partsCount - 1)];
 
-        if (substr($sniff, -5) === 'Sniff') {
+        if ($sniff !== 'Sniff' && substr($sniff, -5) === 'Sniff') {
             // Sniff class name.
             $sniff = substr($sniff, 0, -5);
-        } else if (substr($sniff, -8) === 'UnitTest') {
+        } else if ($sniff !== 'UnitTest' && substr($sniff, -8) === 'UnitTest') {
             // Unit test class name.
             $sniff = substr($sniff, 0, -8);
         } else {
@@ -556,16 +566,8 @@ public static function getSniffCode($sniffClass)
             );
         }
 
-        $standard = '';
-        if (isset($parts[($partsCount - 4)]) === true) {
-            $standard = $parts[($partsCount - 4)];
-        }
-
-        $category = '';
-        if (isset($parts[($partsCount - 2)]) === true) {
-            $category = $parts[($partsCount - 2)];
-        }
-
+        $standard = $parts[($partsCount - 4)];
+        $category = $parts[($partsCount - 2)];
         return $standard.'.'.$category.'.'.$sniff;
 
     }//end getSniffCode()

tests/Core/Util/Common/GetSniffCodeTest.php

@@ -105,9 +105,16 @@ public function testGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass(
     public static function dataGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass()
     {
         return [
-            'Unqualified class name'                                        => ['ClassName'],
-            'Fully qualified class name, not enough parts'                  => ['Fully\\Qualified\\ClassName'],
+            'Unqualified class name'                                        => ['ClassNameSniff'],
+            'Fully qualified sniff class name, not enough parts [1]'        => ['Fully\\Qualified\\ClassNameSniff'],
+            'Fully qualified sniff class name, not enough parts [2]'        => ['CompanyName\\CheckMeSniff'],
+            'Fully qualified test class name, not enough parts'             => ['Fully\\Qualified\\ClassNameUnitTest'],
             'Fully qualified class name, doesn\'t end on Sniff or UnitTest' => ['Fully\\Sniffs\\Qualified\\ClassName'],
+            'Fully qualified class name, ends on Sniff, but isn\'t'         => ['Fully\\Sniffs\\AbstractSomethingSniff'],
+            'Fully qualified class name, last part *is* Sniff'              => ['CompanyName\\Sniffs\\Category\\Sniff'],
+            'Fully qualified class name, last part *is* UnitTest'           => ['CompanyName\\Tests\\Category\\UnitTest'],
+            'Fully qualified class name, no Sniffs or Tests leaf'           => ['CompanyName\\CustomSniffs\\Whatever\\CheckMeSniff'],
+            'Fully qualified class name, category called Sniffs'            => ['CompanyName\\Sniffs\\Sniffs\\InvalidCategorySniff'],
         ];
 
     }//end dataGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass()
@@ -140,70 +147,30 @@ public function testGetSniffCode($fqnClass, $expected)
     public static function dataGetSniffCode()
     {
         return [
-            'PHPCS native sniff'                                                              => [
+            'PHPCS native sniff'                                  => [
                 'fqnClass' => 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\Arrays\\ArrayIndentSniff',
                 'expected' => 'Generic.Arrays.ArrayIndent',
             ],
-            'Class is a PHPCS native test class'                                              => [
+            'Class is a PHPCS native test class'                  => [
                 'fqnClass' => 'PHP_CodeSniffer\\Standards\\Generic\\Tests\\Arrays\\ArrayIndentUnitTest',
                 'expected' => 'Generic.Arrays.ArrayIndent',
             ],
-            'Sniff in external standard without namespace prefix'                             => [
+            'Sniff in external standard without namespace prefix' => [
                 'fqnClass' => 'MyStandard\\Sniffs\\PHP\\MyNameSniff',
                 'expected' => 'MyStandard.PHP.MyName',
             ],
-            'Test in external standard without namespace prefix'                              => [
+            'Test in external standard without namespace prefix'  => [
                 'fqnClass' => 'MyStandard\\Tests\\PHP\\MyNameUnitTest',
                 'expected' => 'MyStandard.PHP.MyName',
             ],
-            'Sniff in external standard with namespace prefix'                                => [
+            'Sniff in external standard with namespace prefix'    => [
                 'fqnClass' => 'Vendor\\Package\\MyStandard\\Sniffs\\Category\\AnalyzeMeSniff',
                 'expected' => 'MyStandard.Category.AnalyzeMe',
             ],
-            'Test in external standard with namespace prefix'                                 => [
+            'Test in external standard with namespace prefix'     => [
                 'fqnClass' => 'Vendor\\Package\\MyStandard\\Tests\\Category\\AnalyzeMeUnitTest',
                 'expected' => 'MyStandard.Category.AnalyzeMe',
             ],
-
-            /*
-             * These are not valid sniff codes and is an undesirable result, but can't be helped
-             * as changing this would be a BC-break.
-             * Supporting these to allow for <rule> tags directly including sniff files.
-             * See: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/675
-             */
-
-            'Fully qualified class name, ends on Sniff, but isn\'t'                           => [
-                'fqnClass' => 'Fully\\Sniffs\\AbstractSomethingSniff',
-                'expected' => '.Sniffs.AbstractSomething',
-            ],
-            'Sniff provided via file include and doesn\'t comply with naming conventions [1]' => [
-                'fqnClass' => 'CheckMeSniff',
-                'expected' => '..CheckMe',
-            ],
-            'Sniff provided via file include and doesn\'t comply with naming conventions [2]' => [
-                'fqnClass' => 'CompanyName\\CheckMeSniff',
-                'expected' => '.CompanyName.CheckMe',
-            ],
-            'Sniff provided via file include and doesn\'t comply with naming conventions [3]' => [
-                'fqnClass' => 'CompanyName\\Sniffs\\CheckMeSniff',
-                'expected' => '.Sniffs.CheckMe',
-            ],
-            'Sniff provided via file include and doesn\'t comply with naming conventions [4]' => [
-                'fqnClass' => 'CompanyName\\CustomSniffs\\Whatever\\CheckMeSniff',
-                'expected' => 'CompanyName.Whatever.CheckMe',
-            ],
-            'Sniff provided via file include and doesn\'t comply with naming conventions [5]' => [
-                'fqnClass' => 'CompanyName\\Sniffs\\Category\\Sniff',
-                'expected' => 'CompanyName.Category.',
-            ],
-            'Sniff provided via file include and doesn\'t comply with naming conventions [6]' => [
-                'fqnClass' => 'CompanyName\\Tests\\Category\\UnitTest',
-                'expected' => 'CompanyName.Category.',
-            ],
-            'Sniff provided via file include and doesn\'t comply with naming conventions [7]' => [
-                'fqnClass' => 'Sniffs\\Category\\NamedSniff',
-                'expected' => '.Category.Named',
-            ],
         ];
 
     }//end dataGetSniffCode()