ConstructorAnalyzer - allow finding all constructors (#649)

Author: kubawerlos

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-2995-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-2996-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)

src/Analyzer/ConstructorAnalyzer.php

@@ -13,6 +13,7 @@
 
 namespace PhpCsFixerCustomFixers\Analyzer;
 
+use PhpCsFixer\Tokenizer\Token;
 use PhpCsFixer\Tokenizer\Tokens;
 use PhpCsFixer\Tokenizer\TokensAnalyzer;
 use PhpCsFixerCustomFixers\Analyzer\Analysis\ConstructorAnalysis;
@@ -22,36 +23,50 @@
  */
 final class ConstructorAnalyzer
 {
- public function findNonAbstractConstructor(Tokens $tokens, int $classIndex): ?ConstructorAnalysis
+ public function findConstructor(Tokens $tokens, int $classIndex, bool $allowAbstract): ?ConstructorAnalysis
  {
  if (!$tokens[$classIndex]->isGivenKind(\T_CLASS)) {
  throw new \InvalidArgumentException(\sprintf('Index %d is not a class.', $classIndex));
  }
 
  $tokensAnalyzer = new TokensAnalyzer($tokens);
 
- /** @var int $index */
+ /**
+ * @var int $index
+ * @var array<string, int|string|Token> $element
+ */
  foreach ($tokensAnalyzer->getClassyElements() as $index => $element) {
  if ($element['classIndex'] !== $classIndex) {
  continue;
  }
- if ($element['type'] !== 'method') {
+
+ if (!$this->isConstructor($tokens, $index, $element)) {
  continue;
  }
 
- /** @var int $functionNameIndex */
- $functionNameIndex = $tokens->getNextMeaningfulToken($index);
-
- if ($tokens[$functionNameIndex]->equals([\T_STRING, '__construct'], false)) {
- $constructorData = $tokensAnalyzer->getMethodAttributes($index);
- if ($constructorData['abstract']) {
- return null;
- }
-
- return new ConstructorAnalysis($tokens, $index);
+ $constructorAttributes = $tokensAnalyzer->getMethodAttributes($index);
+ if (!$allowAbstract && $constructorAttributes['abstract']) {
+ return null;
  }
+
+ return new ConstructorAnalysis($tokens, $index);
  }
 
  return null;
  }
+
+ /**
+ * @param array<string, int|string|Token> $element
+ */
+ private function isConstructor(Tokens $tokens, int $index, array $element): bool
+ {
+ if ($element['type'] !== 'method') {
+ return false;
+ }
+
+ /** @var int $functionNameIndex */
+ $functionNameIndex = $tokens->getNextMeaningfulToken($index);
+
+ return $tokens[$functionNameIndex]->equals([\T_STRING, '__construct'], false);
+ }
 }

src/Fixer/MultilinePromotedPropertiesFixer.php

@@ -82,7 +82,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
  continue;
  }
 
- $constructorAnalysis = $constructorAnalyzer->findNonAbstractConstructor($tokens, $index);
+ $constructorAnalysis = $constructorAnalyzer->findConstructor($tokens, $index, false);
  if ($constructorAnalysis === null) {
  continue;
  }

src/Fixer/PromotedConstructorPropertyFixer.php

@@ -107,7 +107,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
  continue;
  }
 
- $constructorAnalysis = $constructorAnalyzer->findNonAbstractConstructor($tokens, $index);
+ $constructorAnalysis = $constructorAnalyzer->findConstructor($tokens, $index, false);
  if ($constructorAnalysis === null) {
  continue;
  }

tests/Analyzer/ConstructorAnalyzerTest.php

@@ -25,29 +25,29 @@
  */
 final class ConstructorAnalyzerTest extends TestCase
 {
- public function testFindingNonAbstractConstructorWhenNotForClass(): void
+ public function testFindingConstructorWhenNotForClass(): void
  {
  $this->expectException(\InvalidArgumentException::class);
  $this->expectExceptionMessage('Index 2 is not a class.');
 
  $tokens = Tokens::fromCode('<?php $no . $class . $here;');
  $analyzer = new ConstructorAnalyzer();
 
- $analyzer->findNonAbstractConstructor($tokens, 2);
+ $analyzer->findConstructor($tokens, 2, true);
  }
 
  /**
  * @param array<int, null|int> $expected
  *
  * @dataProvider provideFindingNonAbstractConstructorCases
  */
- public function testFindingNonAbstractConstructor(array $expected, string $code): void
+ public function testFindingNonAbstractConstructor(array $expected, bool $allowAbstract, string $code): void
  {
  $tokens = Tokens::fromCode($code);
  $analyzer = new ConstructorAnalyzer();
 
  foreach ($expected as $classIndex => $nonAbstractConstructorIndex) {
- $constructorAnalysis = $analyzer->findNonAbstractConstructor($tokens, $classIndex);
+ $constructorAnalysis = $analyzer->findConstructor($tokens, $classIndex, $allowAbstract);
 
  if ($nonAbstractConstructorIndex === null) {
  self::assertNull($constructorAnalysis);
@@ -59,40 +59,53 @@ public function testFindingNonAbstractConstructor(array $expected, string $code)
  }
 
  /**
- * @return iterable<array{array<int, null|int>, string}>
+ * @return iterable<array{array<int, null|int>, bool, string}>
  */
  public static function provideFindingNonAbstractConstructorCases(): iterable
  {
  yield 'no constructor' => [
  [3 => null],
+ true,
  '<?php abstract class Foo {
  public function notConstructor() {}
  }',
  ];
 
- yield 'abstract constructor' => [
+ yield 'abstract constructor allowed to be found' => [
+ [3 => 13],
+ true,
+ '<?php abstract class Foo {
+ abstract public function __construct() {}
+ }',
+ ];
+
+ yield 'abstract constructor not allowed to be found' => [
  [3 => null],
+ false,
  '<?php abstract class Foo {
  abstract public function __construct() {}
  }',
  ];
 
  yield 'public constructor' => [
  [3 => 11],
+ true,
  '<?php abstract class Foo {
  public function __construct() {}
  }',
  ];
 
  yield 'uppercase constructor' => [
  [3 => 11],
+ true,
  '<?php abstract class Foo {
  public function __CONSTRUCT() {}
  }',
  ];
 
  yield 'class with other elements' => [
  [3 => 29],
+ true,
  '<?php abstract class Foo {
  public $a;
  public static function create() {}
@@ -103,6 +116,7 @@ public function bar() {}
 
  yield 'multiple classes' => [
  [2 => 10, 21 => null, 29 => 37],
+ true,
  '<?php
  class Foo {
  public function __construct() {}