refactor(ClassFileName): Use upstream Squiz ClassFileName sniff directly

.github/workflows/testing.yml

@@ -86,6 +86,7 @@ jobs:
           sed -i 's/Drupal.Classes.ClassCreateInstance/SlevomatCodingStandard.ControlStructures.NewWithParentheses/g' phpcs.xml.dist
           sed -i 's/Drupal.Classes.UnusedUseStatement/SlevomatCodingStandard.Namespaces.UnusedUses/g' phpcs.xml.dist
           sed -i '/<rule ref="SlevomatCodingStandard.Exceptions.RequireNonCapturingCatch" \/>/a \  <rule ref="SlevomatCodingStandard.Namespaces.UseFromSameNamespace"/>' phpcs.xml.dist
+          sed -i 's@<rule ref="Drupal.Classes.ClassFileName"/>@<rule ref="Squiz.Classes.ClassFileName">\n    <!-- Disable class name to file name matching for *Test.php files. -->\n    <exclude-pattern>*/tests/*/*(Test|TestBase).php</exclude-pattern>\n  </rule>@' phpcs.xml.dist
           find . -type f -name "*.php" -exec sed -i 's#// phpcs:ignore Drupal.Classes.PropertyDeclaration, Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing#// phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName,PSR2.Classes.PropertyDeclaration.Underscore#g' {} +
           find . -type f -name "*.php" -exec sed -i 's#// @codingStandardsIgnoreLine#// phpcs:ignore#g' {} +
           find . -type f -name "*.php" -exec sed -i 's#// @codingStandardsIgnoreFile#// phpcs:ignoreFile#g' {} +
@@ -95,4 +96,4 @@ jobs:
           sed -i '/<rule ref="Drupal.Functions.FunctionDeclaration"\/>/d' phpcs.xml.dist
           sed -i 's/DrupalPractice.CodeAnalysis.VariableAnalysis/VariableAnalysis.CodeAnalysis.VariableAnalysis/g' phpcs.xml.dist
           find .. -type f -name "*.php" -exec sed -i 's#// phpcs:ignore DrupalPractice.CodeAnalysis.VariableAnalysis#// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis#g' {} +
-          ../../vendor/bin/phpcs -p -s --parallel=$(nproc) --ignore=lib/Drupal/Core/Command/GenerateTheme.php,modules/mysql/tests/src/Kernel/mysql/Console/DbDumpCommandTest.php
+          ../../vendor/bin/phpcs -p -s --parallel=$(nproc) --ignore=lib/Drupal/Core/Command/GenerateTheme.php,modules/mysql/tests/src/Kernel/mysql/Console/DbDumpCommandTest.php,modules/big_pipe/tests/modules/big_pipe_test/src/BigPipePlaceholderTestCases.php,tests/fixtures/plugins/CustomPlugin.php,modules/package_manager/tests/modules/package_manager_test_api/src/ApiController.php

coder_sniffer/Drupal/ruleset.xml

@@ -186,6 +186,10 @@
 
   <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
 
+  <rule ref="Squiz.Classes.ClassFileName">
+    <!-- Disable class name to file name matching in Test files. -->
+    <exclude-pattern>*/tests/*/*(Test|TestBase).php</exclude-pattern>
+  </rule>
   <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration"/>
   <!-- Disable some error messages that we already cover. -->
   <rule ref="Squiz.ControlStructures.ForEachLoopDeclaration.AsNotLower">

phpcs.xml.dist

@@ -7,7 +7,7 @@
 
     <!-- Test files that should not be checked. -->
     <exclude-pattern>tests/*\.(inc|api\.php|tpl\.php)$</exclude-pattern>
-    <exclude-pattern>tests/*/(good|bad)\.php$</exclude-pattern>
+    <exclude-pattern>tests/*/(good|bad)/*\.php$</exclude-pattern>
     <exclude-pattern>tests/*/drupal(6|7|8)/*\.php$</exclude-pattern>
 
     <!-- The following comes from the 3.4.2 PHPCS ruleset.xml { -->

phpstan.neon

@@ -7,8 +7,8 @@ parameters:
         # Test files that should not be checked.
         - 'tests/*/*.tpl.php'
         - 'tests/*/*.api.php'
-        - 'tests/*/good.php'
-        - 'tests/*/bad.php'
+        - 'tests/*/good/*.php'
+        - 'tests/*/bad/*.php'
         - 'tests/*/drupal[678]/*.php'
     bootstrapFiles:
         - tests/Drupal/phpunit-bootstrap.php

tests/Drupal/bad/BadUnitTest.php

@@ -30,6 +30,7 @@ protected function getErrorList(string $testFile): array
         case 'bad_crlf.inc':
             return [
                 1 => 1,
+                7 => 1,
                 8 => 1,
             ];
         case 'bad.info':
@@ -245,7 +246,7 @@ protected function getErrorList(string $testFile): array
                 372 => 3,
                 375 => 1,
                 376 => 1,
-                379 => 1,
+                379 => 2,
                 383 => 1,
                 384 => 1,
                 385 => 1,
@@ -265,15 +266,15 @@ protected function getErrorList(string $testFile): array
                 400 => 1,
                 401 => 1,
                 403 => 1,
-                406 => 1,
+                406 => 2,
                 407 => 3,
                 411 => 2,
                 417 => 1,
                 418 => 2,
                 421 => 1,
                 422 => 1,
-                424 => 2,
-                426 => 2,
+                424 => 3,
+                426 => 3,
                 428 => 1,
                 436 => 1,
                 438 => 1,
@@ -341,7 +342,7 @@ protected function getErrorList(string $testFile): array
                 750 => 1,
                 756 => 1,
                 765 => 1,
-                791 => 1,
+                791 => 2,
                 795 => 4,
                 796 => 1,
                 799 => 1,
@@ -352,13 +353,14 @@ protected function getErrorList(string $testFile): array
                 805 => 1,
                 806 => 1,
                 807 => 1,
-                809 => 3,
+                809 => 4,
                 815 => 1,
                 820 => 1,
                 827 => 1,
                 829 => 1,
                 836 => 1,
-                838 => 3,
+                838 => 4,
+                844 => 1,
                 849 => 2,
                 860 => 2,
                 867 => 1,
@@ -402,6 +404,10 @@ protected function getErrorList(string $testFile): array
                 85 => 1,
                 98 => 1,
             ];
+        case 'WrongClassName.php':
+            return [
+                6 => 1,
+            ];
         }//end switch
 
         return [];

tests/Drupal/bad/ClassCreateInstanceUnitTest.inc

@@ -18,7 +18,7 @@ $bar = new $foo[$x + 1][$y + 1];
 /**
  * Test class.
  */
-class Test2 {
+class ClassCreateInstanceUnitTest {
 
   /**
    * Using PHP 7 return type hints is fine.

tests/Drupal/bad/ClassCreateInstanceUnitTest.inc.fixed

@@ -21,7 +21,7 @@ $bar = new $foo[$x + 1][$y + 1]();
 /**
  * Test class.
  */
-class Test2 {
+class ClassCreateInstanceUnitTest {
 
   /**
    * Using PHP 7 return type hints is fine.

tests/Drupal/bad/UnusedUseStatementUnitTest.inc

@@ -25,7 +25,7 @@ use Some\Data\Test10;
 /**
  * Bla.
  */
-class Pum {
+class UnusedUseStatementUnitTest {
   use TraitTest;
   use Test\AnotherTrait;
 

tests/Drupal/bad/UnusedUseStatementUnitTest.inc.fixed

@@ -12,7 +12,7 @@ use MyNamespace\Depth\SomeClass as CoreSomeClass;
 /**
  * Bla.
  */
-class Pum {
+class UnusedUseStatementUnitTest {
   use TraitTest;
   use Test\AnotherTrait;
 

tests/Drupal/bad/WrongClassName.php

@@ -0,0 +1,6 @@
+<?php
+
+/**
+ * Class name does not match file name.
+ */
+class NotMatchingClassName {}

tests/Drupal/good/GoodAlignment.php

@@ -0,0 +1,24 @@
+<?php
+
+/**
+ * Nice alignment is allowed for assignments.
+ */
+class GoodAlignment {
+  const INFO      = 0;
+  const WARNING   = 1;
+  const ERROR     = 2;
+  const EMERGENCY = 3;
+
+  /**
+   * Empty method implementation is allowed.
+   */
+  public function emptyMethod() {}
+
+  /**
+   * Protected functions are allowed.
+   */
+  protected function protectedTest() {
+
+  }
+
+}