Merge pull request #547 from werlos/NoDuplicatedArrayKeyFixer_add_option_allow_duplicated_expressions

NoDuplicatedArrayKeyFixer - add option "ignore_expressions"

Author: kubawerlos

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## v2.6.0
 - Add StringableInterfaceFixer
+- NoDuplicatedArrayKeyFixer - add option "ignore_expressions"
 
 ## v2.5.0 - *2021-05-04*
 - Add PHP CS Fixer v3 support

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-2827-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-2831-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)
@@ -156,6 +156,8 @@ There must be no comment generated by Doctrine Migrations.
 
 #### NoDuplicatedArrayKeyFixer
 Duplicated array keys must be removed.
+Configuration options:
+- `ignore_expressions` (`bool`): whether to keep duplicated expressions (as they might return different values) or not; defaults to `true`
 ```diff
  <?php
  $x = [

src/Fixer/NoDuplicatedArrayKeyFixer.php

@@ -13,6 +13,10 @@
 
 namespace PhpCsFixerCustomFixers\Fixer;
 
+use PhpCsFixer\Fixer\ConfigurableFixerInterface;
+use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
+use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
+use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
 use PhpCsFixer\FixerDefinition\CodeSample;
 use PhpCsFixer\FixerDefinition\FixerDefinition;
 use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
@@ -24,8 +28,11 @@
 use PhpCsFixerCustomFixers\Analyzer\ArrayAnalyzer;
 use PhpCsFixerCustomFixers\TokenRemover;
 
-final class NoDuplicatedArrayKeyFixer extends AbstractFixer
+final class NoDuplicatedArrayKeyFixer extends AbstractFixer implements ConfigurableFixerInterface
 {
+ /** @var bool */
+ private $ignoreExpressions = true;
+
  public function getDefinition(): FixerDefinitionInterface
  {
  return new FixerDefinition(
@@ -40,6 +47,26 @@ public function getDefinition(): FixerDefinitionInterface
  );
  }
 
+ public function getConfigurationDefinition(): FixerConfigurationResolverInterface
+ {
+ return new FixerConfigurationResolver([
+ (new FixerOptionBuilder('ignore_expressions', 'whether to keep duplicated expressions (as they might return different values) or not'))
+ ->setAllowedTypes(['bool'])
+ ->setDefault($this->ignoreExpressions)
+ ->getOption(),
+ ]);
+ }
+
+ /**
+ * @param null|array<string, bool> $configuration
+ */
+ public function configure(?array $configuration = null): void
+ {
+ if (isset($configuration['ignore_expressions'])) {
+ $this->ignoreExpressions = $configuration['ignore_expressions'];
+ }
+ }
+
  public function getPriority(): int
  {
  return 0;
@@ -118,7 +145,7 @@ private function getKeyContentIfPossible(Tokens $tokens, ArrayElementAnalysis $a
  continue;
  }
 
- if ($token->equalsAny([[\T_VARIABLE], '('])) {
+ if ($this->ignoreExpressions && $token->equalsAny([[\T_VARIABLE], '('])) {
  return null;
  }
 

tests/Fixer/NoDuplicatedArrayKeyFixerTest.php

@@ -25,16 +25,25 @@ public function testIsRisky(): void
  self::assertFalse($this->fixer->isRisky());
  }
 
+ public function testConfiguration(): void
+ {
+ $options = $this->fixer->getConfigurationDefinition()->getOptions();
+ self::assertArrayHasKey(0, $options);
+ self::assertSame('ignore_expressions', $options[0]->getName());
+ }
+
  /**
+ * @param null|array<string, bool> $configuration
+ *
  * @dataProvider provideFixCases
  */
- public function testFix(string $expected, ?string $input = null): void
+ public function testFix(string $expected, ?string $input = null, ?array $configuration = null): void
  {
- $this->doTest($expected, $input);
+ $this->doTest($expected, $input, $configuration);
  }
 
  /**
- * @return iterable<array{0: string, 1?: string}>
+ * @return iterable<array{0: string, 1?: null|string, 2?: array<string, bool>}>
  */
  public static function provideFixCases(): iterable
  {
@@ -198,5 +207,32 @@ public static function provideFixCases(): iterable
  ],
  ];',
  ];
+
+ yield [
+ '<?php $x = [
+ "foo" => 1,
+ "FOO" => 2,
+ ];',
+ ];
+
+ yield [
+ '<?php $x = [
+ getRandomIndex() => 1,
+ getRandomIndex() => 2,
+ ];',
+ null,
+ ['ignore_expressions' => true],
+ ];
+
+ yield [
+ '<?php $x = [
+ getRandomIndex() => 2,
+ ];',
+ '<?php $x = [
+ getRandomIndex() => 1,
+ getRandomIndex() => 2,
+ ];',
+ ['ignore_expressions' => false],
+ ];
  }
 }