CS/QA: remove unused variables (#446)

klausi · web-flow · commit d14042488843 · 2024-06-05T19:00:47.000+02:00
* test(phcs): Check for unused variables in PHPCS it self

* Manually fixed all unused varaibles

* Revert Slevomat dependency

* Revert array_keys changes

* revert changes that should stay
diff --git a/src/Config.php b/src/Config.php
@@ -1570,7 +1570,7 @@ public static function setConfigData($key, $value, $temp=false)
         // standards paths are added to the autoloader.
         if ($key === 'installed_paths') {
             $installedStandards = Standards::getInstalledStandardDetails();
-            foreach ($installedStandards as $name => $details) {
+            foreach ($installedStandards as $details) {
                 Autoload::addSearchPath($details['path'], $details['namespace']);
             }
         }
diff --git a/src/Filters/Filter.php b/src/Filters/Filter.php
@@ -179,7 +179,7 @@ protected function shouldProcessFile($path)
         // complete extension list and make sure one is allowed.
         $extensions = [];
         array_shift($fileParts);
-        foreach ($fileParts as $part) {
+        while (empty($fileParts) === false) {
             $extensions[implode('.', $fileParts)] = 1;
             array_shift($fileParts);
         }
diff --git a/src/Runner.php b/src/Runner.php
@@ -333,11 +333,11 @@ public function init()
 
         // Create this class so it is autoloaded and sets up a bunch
         // of PHP_CodeSniffer-specific token type constants.
-        $tokens = new Tokens();
+        new Tokens();
 
         // Allow autoloading of custom files inside installed standards.
         $installedStandards = Standards::getInstalledStandardDetails();
-        foreach ($installedStandards as $name => $details) {
+        foreach ($installedStandards as $details) {
             Autoload::addSearchPath($details['path'], $details['namespace']);
         }
 
diff --git a/src/Standards/Generic/Sniffs/Files/InlineHTMLSniff.php b/src/Standards/Generic/Sniffs/Files/InlineHTMLSniff.php
@@ -54,7 +54,7 @@ public function process(File $phpcsFile, $stackPtr)
     {
         // Allow a byte-order mark.
         $tokens = $phpcsFile->getTokens();
-        foreach ($this->bomDefinitions as $bomName => $expectedBomHex) {
+        foreach ($this->bomDefinitions as $expectedBomHex) {
             $bomByteLength = (strlen($expectedBomHex) / 2);
             $htmlBomHex    = bin2hex(substr($tokens[0]['content'], 0, $bomByteLength));
             if ($htmlBomHex === $expectedBomHex && strlen($tokens[0]['content']) === $bomByteLength) {
diff --git a/src/Standards/Generic/Sniffs/PHP/CharacterBeforePHPOpeningTagSniff.php b/src/Standards/Generic/Sniffs/PHP/CharacterBeforePHPOpeningTagSniff.php
@@ -56,7 +56,7 @@ public function process(File $phpcsFile, $stackPtr)
         if ($stackPtr > 0) {
             // Allow a byte-order mark.
             $tokens = $phpcsFile->getTokens();
-            foreach ($this->bomDefinitions as $bomName => $expectedBomHex) {
+            foreach ($this->bomDefinitions as $expectedBomHex) {
                 $bomByteLength = (strlen($expectedBomHex) / 2);
                 $htmlBomHex    = bin2hex(substr($tokens[0]['content'], 0, $bomByteLength));
                 if ($htmlBomHex === $expectedBomHex) {
diff --git a/src/Standards/Generic/Tests/Debug/JSHintUnitTest.php b/src/Standards/Generic/Tests/Debug/JSHintUnitTest.php
@@ -28,7 +28,6 @@ final class JSHintUnitTest extends AbstractSniffUnitTest
      */
     protected function shouldSkipTest()
     {
-        $rhinoPath  = Config::getExecutablePath('rhino');
         $jshintPath = Config::getExecutablePath('jshint');
         if ($jshintPath === null) {
             return true;
diff --git a/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/FunctionCommentSniff.php
@@ -86,7 +86,7 @@ protected function processReturn(File $phpcsFile, $stackPtr, $commentStart)
                 // Check return type (can be multiple, separated by '|').
                 $typeNames      = explode('|', $returnType);
                 $suggestedNames = [];
-                foreach ($typeNames as $i => $typeName) {
+                foreach ($typeNames as $typeName) {
                     $suggestedName = Common::suggestType($typeName);
                     if (in_array($suggestedName, $suggestedNames, true) === false) {
                         $suggestedNames[] = $suggestedName;
diff --git a/src/Standards/Squiz/Sniffs/Commenting/VariableCommentSniff.php b/src/Standards/Squiz/Sniffs/Commenting/VariableCommentSniff.php
@@ -135,7 +135,7 @@ public function processMemberVar(File $phpcsFile, $stackPtr)
         // Check var type (can be multiple, separated by '|').
         $typeNames      = explode('|', $varType);
         $suggestedNames = [];
-        foreach ($typeNames as $i => $typeName) {
+        foreach ($typeNames as $typeName) {
             $suggestedName = Common::suggestType($typeName);
             if (in_array($suggestedName, $suggestedNames, true) === false) {
                 $suggestedNames[] = $suggestedName;
diff --git a/src/Standards/Squiz/Sniffs/Functions/MultiLineFunctionDeclarationSniff.php b/src/Standards/Squiz/Sniffs/Functions/MultiLineFunctionDeclarationSniff.php
@@ -225,7 +225,6 @@ public function processBracket($phpcsFile, $openBracket, $tokens, $type='functio
         }//end if
 
         // Each line between the brackets should contain a single parameter.
-        $lastComma = null;
         for ($i = ($openBracket + 1); $i < $closeBracket; $i++) {
             // Skip brackets, like arrays, as they can contain commas.
             if (isset($tokens[$i]['bracket_opener']) === true) {
diff --git a/src/Standards/Squiz/Sniffs/PHP/CommentedOutCodeSniff.php b/src/Standards/Squiz/Sniffs/PHP/CommentedOutCodeSniff.php
@@ -238,23 +238,18 @@ public function process(File $phpcsFile, $stackPtr)
         ];
         $emptyTokens += Tokens::$phpcsCommentTokens;
 
-        $numComment       = 0;
-        $numPossible      = 0;
         $numCode          = 0;
         $numNonWhitespace = 0;
 
         for ($i = 0; $i < $numTokens; $i++) {
-            if (isset($emptyTokens[$stringTokens[$i]['code']]) === true) {
-                // Looks like comment.
-                $numComment++;
-            } else if (isset(Tokens::$comparisonTokens[$stringTokens[$i]['code']]) === true
-                || isset(Tokens::$arithmeticTokens[$stringTokens[$i]['code']]) === true
-                || $stringTokens[$i]['code'] === T_GOTO_LABEL
-            ) {
+            // Do not count comments.
+            if (isset($emptyTokens[$stringTokens[$i]['code']]) === false
                 // Commented out HTML/XML and other docs contain a lot of these
                 // characters, so it is best to not use them directly.
-                $numPossible++;
-            } else {
+                && isset(Tokens::$comparisonTokens[$stringTokens[$i]['code']]) === false
+                && isset(Tokens::$arithmeticTokens[$stringTokens[$i]['code']]) === false
+                && $stringTokens[$i]['code'] !== T_GOTO_LABEL
+            ) {
                 // Looks like code.
                 $numCode++;
             }
diff --git a/src/Tokenizers/JS.php b/src/Tokenizers/JS.php
@@ -1188,7 +1188,7 @@ public function processAdditional()
                     }
                 }
             } else if ($this->tokens[$i]['code'] === T_CLOSE_OBJECT) {
-                $opener = array_pop($classStack);
+                array_pop($classStack);
             } else if ($this->tokens[$i]['code'] === T_COLON) {
                 // If it is a scope opener, it belongs to a
                 // DEFAULT or CASE statement.
diff --git a/tests/Core/File/GetMemberPropertiesTest.php b/tests/Core/File/GetMemberPropertiesTest.php
@@ -1146,7 +1146,7 @@ public function testNotClassPropertyException($identifier)
         $this->expectRunTimeException('$stackPtr is not a class member var');
 
         $variable = $this->getTargetToken($identifier, T_VARIABLE);
-        $result   = self::$phpcsFile->getMemberProperties($variable);
+        self::$phpcsFile->getMemberProperties($variable);
 
     }//end testNotClassPropertyException()
 
@@ -1182,8 +1182,8 @@ public function testNotAVariableException()
     {
         $this->expectRunTimeException('$stackPtr must be of type T_VARIABLE');
 
-        $next   = $this->getTargetToken('/* testNotAVariable */', T_RETURN);
-        $result = self::$phpcsFile->getMemberProperties($next);
+        $next = $this->getTargetToken('/* testNotAVariable */', T_RETURN);
+        self::$phpcsFile->getMemberProperties($next);
 
     }//end testNotAVariableException()
 
diff --git a/tests/Core/Ruleset/ExplainTest.php b/tests/Core/Ruleset/ExplainTest.php
@@ -249,8 +249,8 @@ public function testExplainWillExplainEachStandardSeparately()
 
         $this->expectOutputString($expected);
 
-        $runner   = new Runner();
-        $exitCode = $runner->runPHPCS();
+        $runner = new Runner();
+        $runner->runPHPCS();
 
     }//end testExplainWillExplainEachStandardSeparately()
 
diff --git a/tests/Core/Ruleset/RuleInclusionTest.php b/tests/Core/Ruleset/RuleInclusionTest.php
@@ -439,8 +439,6 @@ public function testSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFail
     {
         $this->assertArrayHasKey($sniffClass, self::$ruleset->sniffs, 'Sniff class '.$sniffClass.' not listed in registered sniffs');
 
-        $sniffObject = self::$ruleset->sniffs[$sniffClass];
-
         $hasProperty = (new ReflectionObject(self::$ruleset->sniffs[$sniffClass]))->hasProperty($propertyName);
         $errorMsg    = sprintf('Property %s registered for sniff %s which does not support it', $propertyName, $sniffClass);
         $this->assertFalse($hasProperty, $errorMsg);
diff --git a/tests/Core/Ruleset/SetSniffPropertyTest.php b/tests/Core/Ruleset/SetSniffPropertyTest.php
@@ -148,7 +148,7 @@ public function testSetPropertyThrowsErrorOnInvalidProperty()
         // Set up the ruleset.
         $standard = __DIR__.'/SetPropertyThrowsErrorOnInvalidPropertyTest.xml';
         $config   = new ConfigDouble(["--standard=$standard"]);
-        $ruleset  = new Ruleset($config);
+        new Ruleset($config);
 
     }//end testSetPropertyThrowsErrorOnInvalidProperty()
 
@@ -175,7 +175,7 @@ public function testSetPropertyThrowsErrorWhenPropertyOnlyAllowedViaAttribute()
         // Set up the ruleset.
         $standard = __DIR__.'/SetPropertyNotAllowedViaAttributeTest.xml';
         $config   = new ConfigDouble(["--standard=$standard"]);
-        $ruleset  = new Ruleset($config);
+        new Ruleset($config);
 
     }//end testSetPropertyThrowsErrorWhenPropertyOnlyAllowedViaAttribute()
 
@@ -193,7 +193,7 @@ public function testSetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStand
         // Set up the ruleset.
         $standard = __DIR__.'/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandardTest.xml';
         $config   = new ConfigDouble(["--standard=$standard"]);
-        $ruleset  = new Ruleset($config);
+        new Ruleset($config);
 
     }//end testSetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandard()
 
@@ -211,7 +211,7 @@ public function testSetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCateg
         // Set up the ruleset.
         $standard = __DIR__.'/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategoryTest.xml';
         $config   = new ConfigDouble(["--standard=$standard"]);
-        $ruleset  = new Ruleset($config);
+        new Ruleset($config);
 
     }//end testSetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategory()
 
@@ -383,16 +383,13 @@ public function testDirectCallWithOldArrayFormatThrowsDeprecationNotice()
         }
 
         $name       = 'AllowedAsDeclared';
-        $sniffCode  = "Fixtures.SetProperty.{$name}";
         $sniffClass = 'Fixtures\Sniffs\SetProperty\\'.$name.'Sniff';
 
         // Set up the ruleset.
         $standard = __DIR__."/SetProperty{$name}Test.xml";
         $config   = new ConfigDouble(["--standard=$standard"]);
         $ruleset  = new Ruleset($config);
 
-        $propertyName = 'arbitrarystring';
-
         $ruleset->setSniffProperty(
             $sniffClass,
             'arbitrarystring',
diff --git a/tests/Core/Tokenizer/PHP/BackfillFnTokenTest.php b/tests/Core/Tokenizer/PHP/BackfillFnTokenTest.php
@@ -658,8 +658,6 @@ public function testTernary()
      */
     public function testTernaryWithTypes()
     {
-        $tokens = $this->phpcsFile->getTokens();
-
         $token = $this->getTargetToken('/* testTernaryWithTypes */', T_FN);
         $this->backfillHelper($token);
         $this->scopePositionTestHelper($token, 15, 27);
diff --git a/tests/Core/Tokenizer/PHP/StableCommentWhitespaceTest.php b/tests/Core/Tokenizer/PHP/StableCommentWhitespaceTest.php
@@ -38,7 +38,7 @@ public function testCommentTokenization($testMarker, $expectedTokens)
         $tokens  = $this->phpcsFile->getTokens();
         $comment = $this->getTargetToken($testMarker, Tokens::$commentTokens);
 
-        foreach ($expectedTokens as $key => $tokenInfo) {
+        foreach ($expectedTokens as $tokenInfo) {
             $this->assertSame(
                 constant($tokenInfo['type']),
                 $tokens[$comment]['code'],
diff --git a/tests/Core/Tokenizer/PHP/StableCommentWhitespaceWinTest.php b/tests/Core/Tokenizer/PHP/StableCommentWhitespaceWinTest.php
@@ -35,7 +35,7 @@ public function testCommentTokenization($testMarker, $expectedTokens)
         $tokens  = $this->phpcsFile->getTokens();
         $comment = $this->getTargetToken($testMarker, Tokens::$commentTokens);
 
-        foreach ($expectedTokens as $key => $tokenInfo) {
+        foreach ($expectedTokens as $tokenInfo) {
             $this->assertSame(
                 constant($tokenInfo['type']),
                 $tokens[$comment]['code'],
diff --git a/tests/Core/Tokenizer/PHP/UndoNamespacedNameSingleTokenTest.php b/tests/Core/Tokenizer/PHP/UndoNamespacedNameSingleTokenTest.php
@@ -42,7 +42,7 @@ public function testIdentifierTokenization($testMarker, $expectedTokens)
         $tokens     = $this->phpcsFile->getTokens();
         $identifier = $this->getTargetToken($testMarker, constant($expectedTokens[0]['type']));
 
-        foreach ($expectedTokens as $key => $tokenInfo) {
+        foreach ($expectedTokens as $tokenInfo) {
             $this->assertSame(
                 constant($tokenInfo['type']),
                 $tokens[$identifier]['code'],
diff --git a/tests/Standards/AllSniffs.php b/tests/Standards/AllSniffs.php
@@ -48,8 +48,6 @@ public static function suite()
 
         $suite = new TestSuite('PHP CodeSniffer Standards');
 
-        $isInstalled = !is_file(__DIR__.'/../../autoload.php');
-
         // Optionally allow for ignoring the tests for one or more standards.
         $ignoreTestsForStandards = getenv('PHPCS_IGNORE_TESTS');
         if ($ignoreTestsForStandards === false) {

Original file line number	Diff line number	Diff line change
`@@ -1570,7 +1570,7 @@ public static function setConfigData($key, $value, $temp=false)`
`1570`	`1570`	`// standards paths are added to the autoloader.`
`1571`	`1571`	`if ($key === 'installed_paths') {`
`1572`	`1572`	`$installedStandards = Standards::getInstalledStandardDetails();`
`1573`		`- foreach ($installedStandards as $name => $details) {`
	`1573`	`+ foreach ($installedStandards as $details) {`
`1574`	`1574`	`Autoload::addSearchPath($details['path'], $details['namespace']);`
`1575`	`1575`	`}`
`1576`	`1576`	`}`
Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ protected function shouldProcessFile($path)`
`179`	`179`	`// complete extension list and make sure one is allowed.`
`180`	`180`	`$extensions = [];`
`181`	`181`	`array_shift($fileParts);`
`182`		`- foreach ($fileParts as $part) {`
	`182`	`+ while (empty($fileParts) === false) {`
`183`	`183`	`$extensions[implode('.', $fileParts)] = 1;`
`184`	`184`	`array_shift($fileParts);`
`185`	`185`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ public function process(File $phpcsFile, $stackPtr)`
`54`	`54`	`{`
`55`	`55`	`// Allow a byte-order mark.`
`56`	`56`	`$tokens = $phpcsFile->getTokens();`
`57`		`- foreach ($this->bomDefinitions as $bomName => $expectedBomHex) {`
	`57`	`+ foreach ($this->bomDefinitions as $expectedBomHex) {`
`58`	`58`	`$bomByteLength = (strlen($expectedBomHex) / 2);`
`59`	`59`	`$htmlBomHex = bin2hex(substr($tokens[0]['content'], 0, $bomByteLength));`
`60`	`60`	`if ($htmlBomHex === $expectedBomHex && strlen($tokens[0]['content']) === $bomByteLength) {`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@ final class JSHintUnitTest extends AbstractSniffUnitTest`
`28`	`28`	`*/`
`29`	`29`	`protected function shouldSkipTest()`
`30`	`30`	`{`
`31`		`- $rhinoPath = Config::getExecutablePath('rhino');`
`32`	`31`	`$jshintPath = Config::getExecutablePath('jshint');`
`33`	`32`	`if ($jshintPath === null) {`
`34`	`33`	`return true;`