Merge pull request #420 from cakephp/phpcs-v4

markstory · web-flow · commit 3fab702d7a10 · 2025-09-19T11:12:13.000-04:00
Update to phpcs v4
diff --git a/.gitattributes b/.gitattributes
@@ -19,3 +19,5 @@ phpunit.xml.dist export-ignore
 /CakePHP/Tests export-ignore
 phpstan.neon export-ignore
 .phive export-ignore
+/tests export-ignore
+/docs export-ignore
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@ composer.lock
 vendor/
 /.idea/
 /tools/
+/.phpunit.cache/
diff --git a/CakePHP/Sniffs/NamingConventions/ValidFunctionNameSniff.php b/CakePHP/Sniffs/NamingConventions/ValidFunctionNameSniff.php
@@ -63,7 +63,7 @@ public function __construct()
     protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope)
     {
         $methodName = $phpcsFile->getDeclarationName($stackPtr);
-        if ($methodName === null) {
+        if ($methodName === '') {
             return;
         }
 
diff --git a/CakePHP/Tests/Classes/ReturnTypeHintUnitTest.php b/CakePHP/Tests/Classes/ReturnTypeHintUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\Classes;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class ReturnTypeHintUnitTest extends AbstractSniffUnitTest
+class ReturnTypeHintUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/Commenting/DocBlockAlignmentUnitTest.php b/CakePHP/Tests/Commenting/DocBlockAlignmentUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\Commenting;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class DocBlockAlignmentUnitTest extends AbstractSniffUnitTest
+class DocBlockAlignmentUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/Commenting/FunctionCommentUnitTest.php b/CakePHP/Tests/Commenting/FunctionCommentUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\Commenting;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class FunctionCommentUnitTest extends AbstractSniffUnitTest
+class FunctionCommentUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/Commenting/InheritDocUnitTest.php b/CakePHP/Tests/Commenting/InheritDocUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\Commenting;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class InheritDocUnitTest extends AbstractSniffUnitTest
+class InheritDocUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/Commenting/TypeHintUnitTest.php b/CakePHP/Tests/Commenting/TypeHintUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\Commenting;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class TypeHintUnitTest extends AbstractSniffUnitTest
+class TypeHintUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/ControlStructures/ControlStructuresUnitTest.php b/CakePHP/Tests/ControlStructures/ControlStructuresUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\ControlStructures;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class ControlStructuresUnitTest extends AbstractSniffUnitTest
+class ControlStructuresUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/ControlStructures/ElseIfDeclarationUnitTest.php b/CakePHP/Tests/ControlStructures/ElseIfDeclarationUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\ControlStructures;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class ElseIfDeclarationUnitTest extends AbstractSniffUnitTest
+class ElseIfDeclarationUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/ControlStructures/WhileStructuresUnitTest.php b/CakePHP/Tests/ControlStructures/WhileStructuresUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\ControlStructures;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class WhileStructuresUnitTest extends AbstractSniffUnitTest
+class WhileStructuresUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/Formatting/BlankLineBeforeReturnUnitTest.php b/CakePHP/Tests/Formatting/BlankLineBeforeReturnUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\Formatting;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class BlankLineBeforeReturnUnitTest extends AbstractSniffUnitTest
+class BlankLineBeforeReturnUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/NamingConventions/ValidFunctionNameUnitTest.php b/CakePHP/Tests/NamingConventions/ValidFunctionNameUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\NamingConventions;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class ValidFunctionNameUnitTest extends AbstractSniffUnitTest
+class ValidFunctionNameUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/NamingConventions/ValidTraitNameUnitTest.php b/CakePHP/Tests/NamingConventions/ValidTraitNameUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\NamingConventions;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class ValidTraitNameUnitTest extends AbstractSniffUnitTest
+class ValidTraitNameUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/PHP/DisallowShortOpenTagUnitTest.php b/CakePHP/Tests/PHP/DisallowShortOpenTagUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\PHP;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class DisallowShortOpenTagUnitTest extends AbstractSniffUnitTest
+class DisallowShortOpenTagUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/WhiteSpace/EmptyLinesUnitTest.php b/CakePHP/Tests/WhiteSpace/EmptyLinesUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\WhiteSpace;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class EmptyLinesUnitTest extends AbstractSniffUnitTest
+class EmptyLinesUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/WhiteSpace/FunctionCallSpacingUnitTest.php b/CakePHP/Tests/WhiteSpace/FunctionCallSpacingUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\WhiteSpace;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class FunctionCallSpacingUnitTest extends AbstractSniffUnitTest
+class FunctionCallSpacingUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/WhiteSpace/FunctionClosingBraceSpaceUnitTest.php b/CakePHP/Tests/WhiteSpace/FunctionClosingBraceSpaceUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\WhiteSpace;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class FunctionClosingBraceSpaceUnitTest extends AbstractSniffUnitTest
+class FunctionClosingBraceSpaceUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/WhiteSpace/FunctionOpeningBraceSpaceUnitTest.php b/CakePHP/Tests/WhiteSpace/FunctionOpeningBraceSpaceUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\WhiteSpace;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class FunctionOpeningBraceSpaceUnitTest extends AbstractSniffUnitTest
+class FunctionOpeningBraceSpaceUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/Tests/WhiteSpace/TabAndSpaceUnitTest.php b/CakePHP/Tests/WhiteSpace/TabAndSpaceUnitTest.php
@@ -2,9 +2,9 @@
 
 namespace CakePHP\Tests\WhiteSpace;
 
-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;
 
-class TabAndSpaceUnitTest extends AbstractSniffUnitTest
+class TabAndSpaceUnitTest extends AbstractSniffTestCase
 {
     /**
      * @inheritDoc
diff --git a/CakePHP/ruleset.xml b/CakePHP/ruleset.xml
@@ -1,17 +1,22 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<ruleset name="CakePHP">
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    name="CakePHP"
+    namespace="CakePHP"
+    xsi:noNamespaceSchemaLocation="https://schema.phpcodesniffer.com/phpcs.xsd"
+>
     <description>CakePHP coding standard</description>
 
-    <config name="installed_paths" value="../../slevomat/coding-standard,../../../slevomat/coding-standard,../vendor/slevomat/coding-standard"/>
-
     <exclude-pattern>\.git</exclude-pattern>
     <exclude-pattern>/*/tmp/</exclude-pattern>
     <exclude-pattern>tests/*/templates/*</exclude-pattern>
 
     <!-- PSR12 Standard -->
     <rule ref="PSR12">
-        <exclude name="PSR12.Files.FileHeader.SpacingAfterBlock"/>
+        <exclude name="PSR12.Files.FileHeader.SpacingAfterTagBlock"/>
+        <exclude name="PSR12.Files.FileHeader.SpacingAfterDocblockBlock"/>
         <exclude name="PSR12.Files.FileHeader.IncorrectOrder"/>
+        <exclude name="PSR12.Files.FileHeader.SpacingAfterUseBlock"/>
+        <exclude name="PSR12.Files.FileHeader.SpacingAfterUseFunctionBlock"/>
         <!--
         Property and method names with underscore prefix are allowed in CakePHP.
         Not using underscore prefix is a recommendation of PSR2, not a requirement.
diff --git a/composer.json b/composer.json
@@ -18,13 +18,14 @@
         "source": "https://github.com/cakephp/cakephp-codesniffer"
     },
     "require": {
-        "php": ">=8.1.0",
-        "phpstan/phpdoc-parser": "^2.1.0",
-        "slevomat/coding-standard": "^8.16",
-        "squizlabs/php_codesniffer": "^3.9"
+        "php": ">=8.1",
+        "dealerdirect/phpcodesniffer-composer-installer": "^1.1.2",
+        "phpstan/phpdoc-parser": "^2.1",
+        "slevomat/coding-standard": "^8.23",
+        "squizlabs/php_codesniffer": "^4.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^9.3.4"
+        "phpunit/phpunit": "^10.5.32 || ^11.3.3"
     },
     "autoload": {
         "psr-4": {
@@ -38,7 +39,7 @@
     },
     "scripts": {
         "add-standard" : "phpcs --config-set installed_paths $(pwd)",
-        "phpunit": "phpunit vendor/squizlabs/php_codesniffer/tests/AllTests.php --filter CakePHP --no-configuration --bootstrap=vendor/squizlabs/php_codesniffer/tests/bootstrap.php --dont-report-useless-tests",
+        "phpunit": "phpunit",
         "test": [
           "@add-standard",
           "@phpunit"
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd"
+    backupGlobals="true"
+    beStrictAboutOutputDuringTests="true"
+    beStrictAboutTestsThatDoNotTestAnything="false"
+    bootstrap="tests/bootstrap.php"
+    cacheDirectory=".phpunit.cache"
+    displayDetailsOnTestsThatTriggerErrors="true"
+    displayDetailsOnTestsThatTriggerWarnings="true"
+    displayDetailsOnTestsThatTriggerNotices="true"
+    displayDetailsOnTestsThatTriggerDeprecations="true"
+    displayDetailsOnPhpunitDeprecations="true"
+    failOnWarning="true"
+    failOnNotice="true"
+    failOnDeprecation="true"
+    failOnPhpunitDeprecation="true"
+    >
+    <testsuites>
+        <testsuite name="CakePHP coding standard">
+            <directory>./CakePHP/Tests/</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -0,0 +1,3 @@
+<?php
+
+require_once __DIR__ . '/../vendor/squizlabs/php_codesniffer/tests/bootstrap.php';

-Original file line number
+Diff line change
 vendor/
 /.idea/
 /tools/
 +/.phpunit.cache/
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public function __construct()`
`63`	`63`	`protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope)`
`64`	`64`	`{`
`65`	`65`	`$methodName = $phpcsFile->getDeclarationName($stackPtr);`
`66`		`- if ($methodName === null) {`
	`66`	`+ if ($methodName === '') {`
`67`	`67`	`return;`
`68`	`68`	`}`
`69`	`69`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace CakePHP\Tests\Classes;`
`4`	`4`
`5`		`-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;`
	`5`	`+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;`
`6`	`6`
`7`		`-class ReturnTypeHintUnitTest extends AbstractSniffUnitTest`
	`7`	`+class ReturnTypeHintUnitTest extends AbstractSniffTestCase`
`8`	`8`	`{`
`9`	`9`	`/**`
`10`	`10`	`* @inheritDoc`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace CakePHP\Tests\Commenting;`
`4`	`4`
`5`		`-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;`
	`5`	`+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;`
`6`	`6`
`7`		`-class DocBlockAlignmentUnitTest extends AbstractSniffUnitTest`
	`7`	`+class DocBlockAlignmentUnitTest extends AbstractSniffTestCase`
`8`	`8`	`{`
`9`	`9`	`/**`
`10`	`10`	`* @inheritDoc`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`
`3`	`3`	`namespace CakePHP\Tests\ControlStructures;`
`4`	`4`
`5`		`-use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;`
	`5`	`+use PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase;`
`6`	`6`
`7`		`-class ControlStructuresUnitTest extends AbstractSniffUnitTest`
	`7`	`+class ControlStructuresUnitTest extends AbstractSniffTestCase`
`8`	`8`	`{`
`9`	`9`	`/**`
`10`	`10`	`* @inheritDoc`