Add IssetToArrayKeyExistsFixer (#690)

Author: kubawerlos

.php-cs-fixer.php

@@ -18,7 +18,7 @@
  if ($fixer instanceof \PhpCsFixer\Fixer\DeprecatedFixerInterface) {
  continue;
  }
- if (!isset($rules[$fixer->getName()])) {
+ if (!array_key_exists($fixer->getName(), $rules)) {
  $rules[$fixer->getName()] = true;
  }
 }

CHANGELOG.md

@@ -1,6 +1,7 @@
 # CHANGELOG for PHP CS Fixer: custom fixers
 
 ## v3.6.0
+- Add IssetToArrayKeyExistsFixer
 - Add PhpdocVarAnnotationToAssertFixer
 
 ## v3.5.0

README.md

@@ -3,7 +3,7 @@
 [![Latest stable version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg?label=current%20version)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 [![PHP version](https://img.shields.io/packagist/php-v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://php.net)
 [![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](LICENSE)
-![Tests](https://img.shields.io/badge/tests-3167-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3199-brightgreen.svg)
 [![Downloads](https://img.shields.io/packagist/dt/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=main&event=push)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)
@@ -135,6 +135,17 @@ Classes defined internally by extension or core must be referenced with the corr
 +$foo = new stdClass();
 ```
 
+#### IssetToArrayKeyExistsFixer
+Function `array_key_exists` must be used over `isset` when possible.
+ *Risky: when array is not defined, is multi-dimensional or behaviour is relying on the null value.*
+```diff
+ <?php
+-if (isset($array[$key])) {
++if (array_key_exists($key, $array)) {
+ echo $array[$key];
+ }
+```
+
 #### MultilineCommentOpeningClosingAloneFixer
 Multiline comments or PHPDocs must contain an opening and closing line with no additional content.
 ```diff

src/Analyzer/Analysis/ConstructorAnalysis.php

@@ -166,7 +166,7 @@ private function getDuplicatesIndices(array $array): array
  $duplicates = [];
  $values = [];
  foreach ($array as $key => $value) {
- if (isset($values[$value])) {
+ if (\array_key_exists($value, $values)) {
  $duplicates[$values[$value]] = $values[$value];
  $duplicates[$key] = $key;
  }

src/Analyzer/DataProviderAnalyzer.php

@@ -53,7 +53,7 @@ public function getDataProviders(Tokens $tokens, int $startIndex, int $endIndex)
  $dataProviderAnalyses = [];
  foreach ($dataProviders as $dataProviderName => $dataProviderUsages) {
  $lowercaseDataProviderName = \strtolower($dataProviderName);
- if (!isset($methods[$lowercaseDataProviderName])) {
+ if (!\array_key_exists($lowercaseDataProviderName, $methods)) {
  continue;
  }
  $dataProviderAnalyses[$methods[$lowercaseDataProviderName]] = new DataProviderAnalysis(

src/Analyzer/FunctionAnalyzer.php

@@ -67,7 +67,7 @@ public static function getFunctionArguments(Tokens $tokens, int $index): array
  */
  private static function getArgumentsRange(Tokens $tokens, int $index): ?array
  {
- if (!$tokens[$index]->isGivenKind(\T_STRING)) {
+ if (!$tokens[$index]->isGivenKind([\T_ISSET, \T_STRING])) {
  throw new \InvalidArgumentException(\sprintf('Index %d is not a function.', $index));
  }
 

src/Fixer/CommentedOutFunctionFixer.php

@@ -56,7 +56,7 @@ public function getConfigurationDefinition(): FixerConfigurationResolverInterfac
  */
  public function configure(?array $configuration = null): void
  {
- if (isset($configuration['functions'])) {
+ if (\is_array($configuration) && \array_key_exists('functions', $configuration)) {
  $elements = $configuration['functions'];
  $this->functions = $elements;
  }

src/Fixer/DataProviderNameFixer.php

@@ -76,11 +76,11 @@ public function configure(?array $configuration = null): void
  /** @var array<string> $configuration */
  $configuration = $configuration ?? [];
 
- if (isset($configuration['prefix'])) {
+ if (\array_key_exists('prefix', $configuration)) {
  $this->prefix = $configuration['prefix'];
  }
 
- if (isset($configuration['suffix'])) {
+ if (\array_key_exists('suffix', $configuration)) {
  $this->suffix = $configuration['suffix'];
  }
  }

src/Fixer/InternalClassCasingFixer.php

@@ -120,7 +120,7 @@ private function getCorrectCase(string $className): string
 
  $lowercaseClassName = \strtolower($className);
 
- if (!isset($classes[$lowercaseClassName])) {
+ if (!\array_key_exists($lowercaseClassName, $classes)) {
  return $className;
  }
 

src/Fixer/IssetToArrayKeyExistsFixer.php

@@ -0,0 +1,102 @@
+<?php declare(strict_types=1);
+
+/*
+ * This file is part of PHP CS Fixer: custom fixers.
+ *
+ * (c) 2018 Kuba Werłos
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE file that was distributed with this source code.
+ */
+
+namespace PhpCsFixerCustomFixers\Fixer;
+
+use PhpCsFixer\FixerDefinition\CodeSample;
+use PhpCsFixer\FixerDefinition\FixerDefinition;
+use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
+use PhpCsFixer\Tokenizer\Token;
+use PhpCsFixer\Tokenizer\Tokens;
+use PhpCsFixerCustomFixers\Analyzer\FunctionAnalyzer;
+
+final class IssetToArrayKeyExistsFixer extends AbstractFixer
+{
+ public function getDefinition(): FixerDefinitionInterface
+ {
+ return new FixerDefinition(
+ 'Function `array_key_exists` must be used over `isset` when possible.',
+ [
+ new CodeSample(
+ '<?php
+if (isset($array[$key])) {
+ echo $array[$key];
+}
+'
+ ),
+ ],
+ null,
+ 'when array is not defined, is multi-dimensional or behaviour is relying on the null value'
+ );
+ }
+
+ /**
+ * Must run before NativeFunctionInvocationFixer.
+ */
+ public function getPriority(): int
+ {
+ return 2;
+ }
+
+ public function isCandidate(Tokens $tokens): bool
+ {
+ return $tokens->isTokenKindFound(\T_ISSET);
+ }
+
+ public function isRisky(): bool
+ {
+ return true;
+ }
+
+ public function fix(\SplFileInfo $file, Tokens $tokens): void
+ {
+ for ($index = $tokens->count() - 1; $index > 0; $index--) {
+ if (!$tokens[$index]->isGivenKind(\T_ISSET)) {
+ continue;
+ }
+
+ if (\count(FunctionAnalyzer::getFunctionArguments($tokens, $index)) !== 1) {
+ continue;
+ }
+
+ $openParenthesis = $tokens->getNextMeaningfulToken($index);
+ \assert(\is_int($openParenthesis));
+
+ $closeParenthesis = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $openParenthesis);
+
+ $closeBrackets = $tokens->getPrevMeaningfulToken($closeParenthesis);
+ \assert(\is_int($closeBrackets));
+ if (!$tokens[$closeBrackets]->equals(']')) {
+ continue;
+ }
+
+ $openBrackets = $tokens->findBlockStart(Tokens::BLOCK_TYPE_ARRAY_SQUARE_BRACE, $closeBrackets);
+
+ $keyStartIndex = $tokens->getNextMeaningfulToken($openBrackets);
+ \assert(\is_int($keyStartIndex));
+ $keyEndIndex = $tokens->getPrevMeaningfulToken($closeBrackets);
+
+ $keyTokens = [];
+ for ($i = $keyStartIndex; $i <= $keyEndIndex; $i++) {
+ if ($tokens[$i]->equals('')) {
+ continue;
+ }
+ $keyTokens[] = $tokens[$i];
+ }
+ $keyTokens[] = new Token(',');
+ $keyTokens[] = new Token([\T_WHITESPACE, ' ']);
+
+ $tokens->clearRange($openBrackets, $closeBrackets);
+ $tokens->insertAt($openParenthesis + 1, $keyTokens);
+ $tokens[$index] = new Token([\T_STRING, 'array_key_exists']);
+ }
+ }
+}