Add ConstructorAnalyzer (#619)

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

dev-tools/psalm.xml

@@ -31,6 +31,7 @@
  <errorLevel type='suppress'>
  <file name='./src/Fixer/OrderedClassElementsInternalFixer.php' />
  <file name='../src/Analyzer/Analysis/ArrayElementAnalysis.php' />
+ <file name='../src/Analyzer/Analysis/ConstructorAnalysis.php' />
  <file name='../src/Analyzer/Analysis/SwitchAnalysis.php' />
  </errorLevel>
  </PossiblyUnusedMethod>

src/Analyzer/ConstructorAnalyzer.php

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * 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.
+ */
+
+declare(strict_types=1);
+
+namespace PhpCsFixerCustomFixers\Analyzer;
+
+use PhpCsFixer\Tokenizer\Tokens;
+use PhpCsFixer\Tokenizer\TokensAnalyzer;
+use PhpCsFixerCustomFixers\Analyzer\Analysis\ConstructorAnalysis;
+
+/**
+ * @internal
+ */
+final class ConstructorAnalyzer
+{
+ public function findNonAbstractConstructor(Tokens $tokens, int $classIndex): ?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 */
+ foreach ($tokensAnalyzer->getClassyElements() as $index => $element) {
+ if ($element['classIndex'] !== $classIndex) {
+ continue;
+ }
+ if ($element['type'] !== 'method') {
+ 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);
+ }
+ }
+
+ return null;
+ }
+}

tests/Analyzer/Analysis/ConstructorAnalysisTest.php

@@ -21,8 +21,6 @@
  * @internal
  *
  * @covers \PhpCsFixerCustomFixers\Analyzer\Analysis\ConstructorAnalysis
- *
- * @requires PHP 8.0
  */
 final class ConstructorAnalysisTest extends TestCase
 {
@@ -65,12 +63,14 @@ public function __construct(array $a, bool $b, callable $c1, CALLABLE $c1, int $
  }',
  ];
 
- yield 'some already promoted' => [
- [22 => 'b', 39 => 's'],
- '<?php class Foo {
+ if (\PHP_VERSION_ID >= 80000) {
+ yield 'some already promoted' => [
+ [22 => 'b', 39 => 's'],
+ '<?php class Foo {
  public function __construct(public array $a, bool $b, protected ?Bar\Baz\Qux $q, string $s, private OtherType $t) {}
  }',
- ];
+ ];
+ }
  }
 
  /**

tests/Analyzer/ConstructorAnalyzerTest.php

@@ -0,0 +1,120 @@
+<?php
+
+/*
+ * 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.
+ */
+
+declare(strict_types=1);
+
+namespace Tests\Analyzer;
+
+use PhpCsFixer\Tokenizer\Tokens;
+use PhpCsFixerCustomFixers\Analyzer\Analysis\ConstructorAnalysis;
+use PhpCsFixerCustomFixers\Analyzer\ConstructorAnalyzer;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @internal
+ *
+ * @covers \PhpCsFixerCustomFixers\Analyzer\ConstructorAnalyzer
+ */
+final class ConstructorAnalyzerTest extends TestCase
+{
+ public function testFindingNonAbstractConstructorWhenNotForClass(): 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);
+ }
+
+ /**
+ * @param array<int, null|int> $expected
+ *
+ * @dataProvider provideFindingNonAbstractConstructorCases
+ */
+ public function testFindingNonAbstractConstructor(array $expected, string $code): void
+ {
+ $tokens = Tokens::fromCode($code);
+ $analyzer = new ConstructorAnalyzer();
+
+ foreach ($expected as $classIndex => $nonAbstractConstructorIndex) {
+ $constructorAnalysis = $analyzer->findNonAbstractConstructor($tokens, $classIndex);
+
+ if ($nonAbstractConstructorIndex === null) {
+ self::assertNull($constructorAnalysis);
+ } else {
+ self::assertInstanceOf(ConstructorAnalysis::class, $constructorAnalysis);
+ self::assertSame(
+ \serialize(new ConstructorAnalysis($tokens, $nonAbstractConstructorIndex)),
+ \serialize($constructorAnalysis)
+ );
+ }
+ }
+ }
+
+ /**
+ * @return iterable<array{array<int, null|int>, string}>
+ */
+ public static function provideFindingNonAbstractConstructorCases(): iterable
+ {
+ yield 'no constructor' => [
+ [3 => null],
+ '<?php abstract class Foo {
+ public function notConstructor() {}
+ }',
+ ];
+
+ yield 'abstract constructor' => [
+ [3 => null],
+ '<?php abstract class Foo {
+ abstract public function __construct() {}
+ }',
+ ];
+
+ yield 'public constructor' => [
+ [3 => 11],
+ '<?php abstract class Foo {
+ public function __construct() {}
+ }',
+ ];
+
+ yield 'uppercase constructor' => [
+ [3 => 11],
+ '<?php abstract class Foo {
+ public function __CONSTRUCT() {}
+ }',
+ ];
+
+ yield 'class with other elements' => [
+ [3 => 29],
+ '<?php abstract class Foo {
+ public $a;
+ public static function create() {}
+ public function __construct() {}
+ public function bar() {}
+ }',
+ ];
+
+ yield 'multiple classes' => [
+ [2 => 10, 21 => null, 29 => 37],
+ '<?php
+ class Foo {
+ public function __construct() {}
+ }
+ class Bar {
+ }
+ class Baz {
+ public function __construct() {}
+ }',
+ ];
+ }
+}