From 3756f11efafcc49ac770a40b7b3228897a6982ac Mon Sep 17 00:00:00 2001 From: jrfnl Date: Sat, 17 Feb 2024 07:48:28 +0100 Subject: [PATCH 1/3] CS: alphabetically order import use statements Follow up on squizlabs/PHP_CodeSniffer 2714 Note: sniffs which have been removed in 4.0 have been excluded from this commit. --- src/Files/DummyFile.php | 2 +- src/Files/File.php | 6 +++--- src/Files/FileList.php | 4 ++-- src/Files/LocalFile.php | 2 +- src/Filters/Filter.php | 4 ++-- src/Generators/Generator.php | 2 +- src/Sniffs/AbstractPatternSniff.php | 4 ++-- src/Sniffs/AbstractScopeSniff.php | 2 +- src/Standards/Zend/Sniffs/Files/ClosingTagSniff.php | 2 +- .../Sniffs/NamingConventions/ValidVariableNameSniff.php | 2 +- tests/Core/AbstractMethodUnitTest.php | 2 +- tests/Core/AllTests.php | 2 +- tests/Core/ErrorSuppressionTest.php | 2 +- tests/Core/Tokenizer/AbstractTokenizerTestCase.php | 2 +- tests/Standards/AbstractSniffUnitTest.php | 2 +- tests/Standards/AllSniffs.php | 4 ++-- tests/TestSuite.php | 2 +- tests/TestSuite7.php | 2 +- 18 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/Files/DummyFile.php b/src/Files/DummyFile.php index eb947fd2a9..f5dc7cc7ac 100644 --- a/src/Files/DummyFile.php +++ b/src/Files/DummyFile.php @@ -14,8 +14,8 @@ namespace PHP_CodeSniffer\Files; -use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Config; +use PHP_CodeSniffer\Ruleset; class DummyFile extends File { diff --git a/src/Files/File.php b/src/Files/File.php index 7b54bea179..f40d9f7f2a 100644 --- a/src/Files/File.php +++ b/src/Files/File.php @@ -9,12 +9,12 @@ namespace PHP_CodeSniffer\Files; -use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Config; -use PHP_CodeSniffer\Fixer; -use PHP_CodeSniffer\Util; use PHP_CodeSniffer\Exceptions\RuntimeException; use PHP_CodeSniffer\Exceptions\TokenizerException; +use PHP_CodeSniffer\Fixer; +use PHP_CodeSniffer\Ruleset; +use PHP_CodeSniffer\Util; class File { diff --git a/src/Files/FileList.php b/src/Files/FileList.php index 13357ecdef..9589b4369d 100644 --- a/src/Files/FileList.php +++ b/src/Files/FileList.php @@ -12,10 +12,10 @@ namespace PHP_CodeSniffer\Files; use PHP_CodeSniffer\Autoload; -use PHP_CodeSniffer\Util; -use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Config; use PHP_CodeSniffer\Exceptions\DeepExitException; +use PHP_CodeSniffer\Ruleset; +use PHP_CodeSniffer\Util; use ReturnTypeWillChange; class FileList implements \Iterator, \Countable diff --git a/src/Files/LocalFile.php b/src/Files/LocalFile.php index c2af77c42a..babfe69c31 100644 --- a/src/Files/LocalFile.php +++ b/src/Files/LocalFile.php @@ -9,8 +9,8 @@ namespace PHP_CodeSniffer\Files; -use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Config; +use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Util\Cache; use PHP_CodeSniffer\Util\Common; diff --git a/src/Filters/Filter.php b/src/Filters/Filter.php index c72518c660..af88a59668 100644 --- a/src/Filters/Filter.php +++ b/src/Filters/Filter.php @@ -9,9 +9,9 @@ namespace PHP_CodeSniffer\Filters; -use PHP_CodeSniffer\Util; -use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Config; +use PHP_CodeSniffer\Ruleset; +use PHP_CodeSniffer\Util; use ReturnTypeWillChange; class Filter extends \RecursiveFilterIterator diff --git a/src/Generators/Generator.php b/src/Generators/Generator.php index 483cae800f..3b69ddf27b 100644 --- a/src/Generators/Generator.php +++ b/src/Generators/Generator.php @@ -12,8 +12,8 @@ namespace PHP_CodeSniffer\Generators; -use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Autoload; +use PHP_CodeSniffer\Ruleset; abstract class Generator { diff --git a/src/Sniffs/AbstractPatternSniff.php b/src/Sniffs/AbstractPatternSniff.php index 86dc10d408..e895365688 100644 --- a/src/Sniffs/AbstractPatternSniff.php +++ b/src/Sniffs/AbstractPatternSniff.php @@ -9,10 +9,10 @@ namespace PHP_CodeSniffer\Sniffs; +use PHP_CodeSniffer\Exceptions\RuntimeException; use PHP_CodeSniffer\Files\File; -use PHP_CodeSniffer\Util\Tokens; use PHP_CodeSniffer\Tokenizers\PHP; -use PHP_CodeSniffer\Exceptions\RuntimeException; +use PHP_CodeSniffer\Util\Tokens; abstract class AbstractPatternSniff implements Sniff { diff --git a/src/Sniffs/AbstractScopeSniff.php b/src/Sniffs/AbstractScopeSniff.php index 74201ab8eb..86a140781b 100644 --- a/src/Sniffs/AbstractScopeSniff.php +++ b/src/Sniffs/AbstractScopeSniff.php @@ -26,8 +26,8 @@ namespace PHP_CodeSniffer\Sniffs; -use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Exceptions\RuntimeException; +use PHP_CodeSniffer\Files\File; abstract class AbstractScopeSniff implements Sniff { diff --git a/src/Standards/Zend/Sniffs/Files/ClosingTagSniff.php b/src/Standards/Zend/Sniffs/Files/ClosingTagSniff.php index 5ae72362d4..24ea495b48 100644 --- a/src/Standards/Zend/Sniffs/Files/ClosingTagSniff.php +++ b/src/Standards/Zend/Sniffs/Files/ClosingTagSniff.php @@ -9,8 +9,8 @@ namespace PHP_CodeSniffer\Standards\Zend\Sniffs\Files; -use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Sniffs\Sniff; use PHP_CodeSniffer\Util\Tokens; class ClosingTagSniff implements Sniff diff --git a/src/Standards/Zend/Sniffs/NamingConventions/ValidVariableNameSniff.php b/src/Standards/Zend/Sniffs/NamingConventions/ValidVariableNameSniff.php index 2dfeb39aa6..41b1948101 100644 --- a/src/Standards/Zend/Sniffs/NamingConventions/ValidVariableNameSniff.php +++ b/src/Standards/Zend/Sniffs/NamingConventions/ValidVariableNameSniff.php @@ -9,9 +9,9 @@ namespace PHP_CodeSniffer\Standards\Zend\Sniffs\NamingConventions; +use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Sniffs\AbstractVariableSniff; use PHP_CodeSniffer\Util\Common; -use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Util\Tokens; class ValidVariableNameSniff extends AbstractVariableSniff diff --git a/tests/Core/AbstractMethodUnitTest.php b/tests/Core/AbstractMethodUnitTest.php index b8522bf4bb..5d625891c9 100644 --- a/tests/Core/AbstractMethodUnitTest.php +++ b/tests/Core/AbstractMethodUnitTest.php @@ -9,9 +9,9 @@ namespace PHP_CodeSniffer\Tests\Core; -use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Files\DummyFile; use PHP_CodeSniffer\Files\File; +use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Tests\ConfigDouble; use PHPUnit\Framework\TestCase; diff --git a/tests/Core/AllTests.php b/tests/Core/AllTests.php index 60547bb363..a5465f9878 100644 --- a/tests/Core/AllTests.php +++ b/tests/Core/AllTests.php @@ -11,8 +11,8 @@ namespace PHP_CodeSniffer\Tests\Core; use PHP_CodeSniffer\Tests\FileList; -use PHPUnit\TextUI\TestRunner; use PHPUnit\Framework\TestSuite; +use PHPUnit\TextUI\TestRunner; class AllTests { diff --git a/tests/Core/ErrorSuppressionTest.php b/tests/Core/ErrorSuppressionTest.php index e8b7935cc1..ccd9f479e7 100644 --- a/tests/Core/ErrorSuppressionTest.php +++ b/tests/Core/ErrorSuppressionTest.php @@ -9,8 +9,8 @@ namespace PHP_CodeSniffer\Tests\Core; -use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Files\DummyFile; +use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Tests\ConfigDouble; use PHPUnit\Framework\TestCase; diff --git a/tests/Core/Tokenizer/AbstractTokenizerTestCase.php b/tests/Core/Tokenizer/AbstractTokenizerTestCase.php index 3225fe6fa2..aa2dc18d1d 100644 --- a/tests/Core/Tokenizer/AbstractTokenizerTestCase.php +++ b/tests/Core/Tokenizer/AbstractTokenizerTestCase.php @@ -12,8 +12,8 @@ namespace PHP_CodeSniffer\Tests\Core\Tokenizer; -use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Files\DummyFile; +use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Tests\ConfigDouble; use PHP_CodeSniffer\Tests\Core\AbstractMethodUnitTest; use PHPUnit\Framework\TestCase; diff --git a/tests/Standards/AbstractSniffUnitTest.php b/tests/Standards/AbstractSniffUnitTest.php index c400758468..6e28aac912 100644 --- a/tests/Standards/AbstractSniffUnitTest.php +++ b/tests/Standards/AbstractSniffUnitTest.php @@ -14,8 +14,8 @@ namespace PHP_CodeSniffer\Tests\Standards; use PHP_CodeSniffer\Exceptions\RuntimeException; -use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Files\LocalFile; +use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Tests\ConfigDouble; use PHP_CodeSniffer\Util\Common; use PHPUnit\Framework\TestCase; diff --git a/tests/Standards/AllSniffs.php b/tests/Standards/AllSniffs.php index e355d90dab..8c734064e4 100644 --- a/tests/Standards/AllSniffs.php +++ b/tests/Standards/AllSniffs.php @@ -9,10 +9,10 @@ namespace PHP_CodeSniffer\Tests\Standards; -use PHP_CodeSniffer\Util\Standards; use PHP_CodeSniffer\Autoload; -use PHPUnit\TextUI\TestRunner; +use PHP_CodeSniffer\Util\Standards; use PHPUnit\Framework\TestSuite; +use PHPUnit\TextUI\TestRunner; class AllSniffs { diff --git a/tests/TestSuite.php b/tests/TestSuite.php index ff7bde7e43..4598a85623 100644 --- a/tests/TestSuite.php +++ b/tests/TestSuite.php @@ -9,8 +9,8 @@ namespace PHP_CodeSniffer\Tests; -use PHPUnit\Framework\TestSuite as PHPUnit_TestSuite; use PHPUnit\Framework\TestResult; +use PHPUnit\Framework\TestSuite as PHPUnit_TestSuite; class TestSuite extends PHPUnit_TestSuite { diff --git a/tests/TestSuite7.php b/tests/TestSuite7.php index a4dabf5fc2..fd1977a8ca 100644 --- a/tests/TestSuite7.php +++ b/tests/TestSuite7.php @@ -9,8 +9,8 @@ namespace PHP_CodeSniffer\Tests; -use PHPUnit\Framework\TestSuite as PHPUnit_TestSuite; use PHPUnit\Framework\TestResult; +use PHPUnit\Framework\TestSuite as PHPUnit_TestSuite; class TestSuite extends PHPUnit_TestSuite { From 8974f2662ac60cc2d6a545eda35e41c6f0fb62e8 Mon Sep 17 00:00:00 2001 From: jrfnl Date: Sun, 18 Feb 2024 02:02:39 +0100 Subject: [PATCH 2/3] CS: always import all used classes [1] ... instead of using fully qualified global/PHP native classes inline. --- src/Config.php | 10 ++++++---- src/Exceptions/DeepExitException.php | 4 +++- src/Exceptions/RuntimeException.php | 4 +++- src/Exceptions/TokenizerException.php | 4 +++- src/Files/FileList.php | 16 +++++++++++----- src/Filters/Filter.php | 7 +++++-- src/Generators/Generator.php | 8 +++++--- src/Generators/HTML.php | 12 +++++++----- src/Generators/Markdown.php | 10 ++++++---- src/Generators/Text.php | 10 ++++++---- src/Reports/Checkstyle.php | 3 ++- src/Reports/Code.php | 3 ++- src/Reports/Junit.php | 3 ++- src/Reports/Xml.php | 3 ++- src/Ruleset.php | 9 ++++++--- src/Runner.php | 3 ++- .../Sniffs/PHP/DeprecatedFunctionsSniff.php | 4 +++- .../Sniffs/Classes/PropertyDeclarationSniff.php | 3 ++- src/Util/Cache.php | 12 ++++++++---- src/Util/Common.php | 4 +++- src/Util/Standards.php | 5 +++-- tests/FileList.php | 16 ++++++++++------ tests/Standards/AbstractSniffUnitTest.php | 3 ++- tests/Standards/AllSniffs.php | 4 +++- 24 files changed, 105 insertions(+), 55 deletions(-) diff --git a/src/Config.php b/src/Config.php index 6f1dc2d5b6..31540ae714 100644 --- a/src/Config.php +++ b/src/Config.php @@ -12,6 +12,8 @@ namespace PHP_CodeSniffer; +use Exception; +use Phar; use PHP_CodeSniffer\Exceptions\DeepExitException; use PHP_CodeSniffer\Exceptions\RuntimeException; use PHP_CodeSniffer\Util\Common; @@ -812,7 +814,7 @@ public function processLongArgument($arg, $pos) try { $this->setConfigData($key, $value); - } catch (\Exception $e) { + } catch (Exception $e) { throw new DeepExitException($e->getMessage().PHP_EOL, 3); } @@ -840,7 +842,7 @@ public function processLongArgument($arg, $pos) } else { try { $this->setConfigData($key, null); - } catch (\Exception $e) { + } catch (Exception $e) { throw new DeepExitException($e->getMessage().PHP_EOL, 3); } @@ -1608,7 +1610,7 @@ public static function setConfigData($key, $value, $temp=false) if ($temp === false) { $path = ''; if (is_callable('\Phar::running') === true) { - $path = \Phar::running(false); + $path = Phar::running(false); } if ($path !== '') { @@ -1679,7 +1681,7 @@ public static function getAllConfigData() $path = ''; if (is_callable('\Phar::running') === true) { - $path = \Phar::running(false); + $path = Phar::running(false); } if ($path !== '') { diff --git a/src/Exceptions/DeepExitException.php b/src/Exceptions/DeepExitException.php index 7732c6da48..6943e033ed 100644 --- a/src/Exceptions/DeepExitException.php +++ b/src/Exceptions/DeepExitException.php @@ -12,7 +12,9 @@ namespace PHP_CodeSniffer\Exceptions; -class DeepExitException extends \Exception +use Exception; + +class DeepExitException extends Exception { }//end class diff --git a/src/Exceptions/RuntimeException.php b/src/Exceptions/RuntimeException.php index a3d590984c..25eacd0b18 100644 --- a/src/Exceptions/RuntimeException.php +++ b/src/Exceptions/RuntimeException.php @@ -9,7 +9,9 @@ namespace PHP_CodeSniffer\Exceptions; -class RuntimeException extends \RuntimeException +use RuntimeException as PHPRuntimeException; + +class RuntimeException extends PHPRuntimeException { }//end class diff --git a/src/Exceptions/TokenizerException.php b/src/Exceptions/TokenizerException.php index ad25ace198..1cf53d6237 100644 --- a/src/Exceptions/TokenizerException.php +++ b/src/Exceptions/TokenizerException.php @@ -9,7 +9,9 @@ namespace PHP_CodeSniffer\Exceptions; -class TokenizerException extends \Exception +use Exception; + +class TokenizerException extends Exception { }//end class diff --git a/src/Files/FileList.php b/src/Files/FileList.php index 9589b4369d..f11d1c34b9 100644 --- a/src/Files/FileList.php +++ b/src/Files/FileList.php @@ -11,14 +11,20 @@ namespace PHP_CodeSniffer\Files; +use Countable; +use FilesystemIterator; +use Iterator; use PHP_CodeSniffer\Autoload; use PHP_CodeSniffer\Config; use PHP_CodeSniffer\Exceptions\DeepExitException; use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Util; +use RecursiveArrayIterator; +use RecursiveDirectoryIterator; +use RecursiveIteratorIterator; use ReturnTypeWillChange; -class FileList implements \Iterator, \Countable +class FileList implements Iterator, Countable { /** @@ -80,9 +86,9 @@ public function __construct(Config $config, Ruleset $ruleset) $filterClass = $this->getFilterClass(); - $di = new \RecursiveDirectoryIterator($path, (\RecursiveDirectoryIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS)); + $di = new RecursiveDirectoryIterator($path, (RecursiveDirectoryIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS)); $filter = new $filterClass($di, $path, $config, $ruleset); - $iterator = new \RecursiveIteratorIterator($filter); + $iterator = new RecursiveIteratorIterator($filter); foreach ($iterator as $file) { $this->files[$file->getPathname()] = null; @@ -121,9 +127,9 @@ public function addFile($path, $file=null) $filterClass = $this->getFilterClass(); - $di = new \RecursiveArrayIterator([$path]); + $di = new RecursiveArrayIterator([$path]); $filter = new $filterClass($di, $path, $this->config, $this->ruleset); - $iterator = new \RecursiveIteratorIterator($filter); + $iterator = new RecursiveIteratorIterator($filter); foreach ($iterator as $path) { $this->files[$path] = $file; diff --git a/src/Filters/Filter.php b/src/Filters/Filter.php index af88a59668..a37ef4684c 100644 --- a/src/Filters/Filter.php +++ b/src/Filters/Filter.php @@ -9,12 +9,15 @@ namespace PHP_CodeSniffer\Filters; +use FilesystemIterator; use PHP_CodeSniffer\Config; use PHP_CodeSniffer\Ruleset; use PHP_CodeSniffer\Util; +use RecursiveDirectoryIterator; +use RecursiveFilterIterator; use ReturnTypeWillChange; -class Filter extends \RecursiveFilterIterator +class Filter extends RecursiveFilterIterator { /** @@ -137,7 +140,7 @@ public function getChildren() { $filterClass = get_called_class(); $children = new $filterClass( - new \RecursiveDirectoryIterator($this->current(), (\RecursiveDirectoryIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS)), + new RecursiveDirectoryIterator($this->current(), (RecursiveDirectoryIterator::SKIP_DOTS | FilesystemIterator::FOLLOW_SYMLINKS)), $this->basedir, $this->config, $this->ruleset diff --git a/src/Generators/Generator.php b/src/Generators/Generator.php index 3b69ddf27b..af0e0f5c40 100644 --- a/src/Generators/Generator.php +++ b/src/Generators/Generator.php @@ -12,6 +12,8 @@ namespace PHP_CodeSniffer\Generators; +use DOMDocument; +use DOMNode; use PHP_CodeSniffer\Autoload; use PHP_CodeSniffer\Ruleset; @@ -70,7 +72,7 @@ public function __construct(Ruleset $ruleset) * * @return string */ - protected function getTitle(\DOMNode $doc) + protected function getTitle(DOMNode $doc) { return $doc->getAttribute('title'); @@ -90,7 +92,7 @@ protected function getTitle(\DOMNode $doc) public function generate() { foreach ($this->docFiles as $file) { - $doc = new \DOMDocument(); + $doc = new DOMDocument(); $doc->load($file); $documentation = $doc->getElementsByTagName('documentation')->item(0); $this->processSniff($documentation); @@ -111,7 +113,7 @@ public function generate() * @return void * @see generate() */ - abstract protected function processSniff(\DOMNode $doc); + abstract protected function processSniff(DOMNode $doc); }//end class diff --git a/src/Generators/HTML.php b/src/Generators/HTML.php index 55acd9e172..a042f36be9 100644 --- a/src/Generators/HTML.php +++ b/src/Generators/HTML.php @@ -13,6 +13,8 @@ namespace PHP_CodeSniffer\Generators; +use DOMDocument; +use DOMNode; use PHP_CodeSniffer\Config; class HTML extends Generator @@ -32,7 +34,7 @@ public function generate() $this->printToc(); foreach ($this->docFiles as $file) { - $doc = new \DOMDocument(); + $doc = new DOMDocument(); $doc->load($file); $documentation = $doc->getElementsByTagName('documentation')->item(0); $this->processSniff($documentation); @@ -145,7 +147,7 @@ protected function printToc() echo '