123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136 |
- <?php
- declare(strict_types=1);
- /*
- * This file is part of PHP CS Fixer.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- * Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * This source file is subject to the MIT license that is bundled
- * with this source code in the file LICENSE.
- */
- namespace PhpCsFixer\Tests;
- use PhpCsFixer\AbstractDoctrineAnnotationFixer;
- use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
- use PhpCsFixer\Tests\Test\AbstractFixerTestCase;
- /**
- * @internal
- *
- * @template TFixer of AbstractDoctrineAnnotationFixer
- *
- * @extends AbstractFixerTestCase<TFixer>
- */
- abstract class AbstractDoctrineAnnotationFixerTestCase extends AbstractFixerTestCase
- {
- /**
- * @param array<string, mixed> $configuration
- *
- * @dataProvider provideConfigureWithInvalidConfigurationCases
- */
- public function testConfigureWithInvalidConfiguration(array $configuration): void
- {
- $this->expectException(InvalidFixerConfigurationException::class);
- $this->fixer->configure($configuration);
- }
- /**
- * @return iterable<array{array<string, mixed>}>
- */
- public static function provideConfigureWithInvalidConfigurationCases(): iterable
- {
- yield [['foo' => 'bar']];
- yield [['ignored_tags' => 'foo']];
- }
- /**
- * @param list<array{0: string, 1?: string}> $commentCases
- *
- * @return iterable<array{0: string, 1?: string}>
- */
- protected static function createTestCases(array $commentCases): iterable
- {
- $noFixCases = [];
- foreach ($commentCases as $commentCase) {
- yield [
- self::withClassDocBlock($commentCase[0]),
- isset($commentCase[1]) ? self::withClassDocBlock($commentCase[1]) : null,
- ];
- yield [
- self::withPropertyDocBlock($commentCase[0]),
- isset($commentCase[1]) ? self::withPropertyDocBlock($commentCase[1]) : null,
- ];
- yield [
- self::withMethodDocBlock($commentCase[0]),
- isset($commentCase[1]) ? self::withMethodDocBlock($commentCase[1]) : null,
- ];
- $noFixCases[$commentCase[0]] = [
- self::withWrongElementDocBlock($commentCase[0]),
- ];
- }
- yield from array_values($noFixCases);
- }
- private static function withClassDocBlock(string $comment): string
- {
- return self::with('<?php
- %s
- class FooClass
- {
- }', $comment, false);
- }
- private static function withPropertyDocBlock(string $comment): string
- {
- return self::with('<?php
- class FooClass
- {
- %s
- private $foo;
- }', $comment, true);
- }
- private static function withMethodDocBlock(string $comment): string
- {
- return self::with('<?php
- class FooClass
- {
- %s
- public function foo()
- {
- }
- }', $comment, true);
- }
- private static function withWrongElementDocBlock(string $comment): string
- {
- return self::with('<?php
- %s
- $foo = bar();', $comment, false);
- }
- private static function with(string $php, string $comment, bool $indent): string
- {
- $comment = trim($comment);
- if ($indent) {
- $comment = str_replace("\n", "\n ", $comment);
- }
- return \sprintf($php, preg_replace('/^\n+/', '', $comment));
- }
- }
|