AbstractFixerTest.php 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  1. <?php
  2. declare(strict_types=1);
  3. /*
  4. * This file is part of PHP CS Fixer.
  5. *
  6. * (c) Fabien Potencier <fabien@symfony.com>
  7. * Dariusz Rumiński <dariusz.ruminski@gmail.com>
  8. *
  9. * This source file is subject to the MIT license that is bundled
  10. * with this source code in the file LICENSE.
  11. */
  12. namespace PhpCsFixer\Tests;
  13. use PhpCsFixer\AbstractFixer;
  14. use PhpCsFixer\AccessibleObject\AccessibleObject;
  15. use PhpCsFixer\Fixer\WhitespacesAwareFixerInterface;
  16. use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
  17. use PhpCsFixer\Tokenizer\Tokens;
  18. use PhpCsFixer\WhitespacesFixerConfig;
  19. /**
  20. * @internal
  21. *
  22. * @covers \PhpCsFixer\AbstractFixer
  23. */
  24. final class AbstractFixerTest extends TestCase
  25. {
  26. public function testDefaults(): void
  27. {
  28. $fixer = $this->createUnconfigurableFixerDouble();
  29. self::assertFalse($fixer->isRisky());
  30. self::assertTrue($fixer->supports(new \SplFileInfo(__FILE__)));
  31. }
  32. public function testConfigureUnconfigurable(): void
  33. {
  34. $fixer = $this->createUnconfigurableFixerDouble();
  35. self::assertSame(0, $fixer->getPriority());
  36. $this->expectException(\LogicException::class);
  37. $this->expectExceptionMessage('Cannot configure using Abstract parent, child not implementing "PhpCsFixer\Fixer\ConfigurableFixerInterface".');
  38. $fixer->configure(['foo' => 'bar']);
  39. }
  40. public function testGetConfigurationDefinitionUnconfigurable(): void
  41. {
  42. $fixer = $this->createUnconfigurableFixerDouble();
  43. $this->expectException(\LogicException::class);
  44. $this->expectExceptionMessage(sprintf('Cannot get configuration definition using Abstract parent, child "%s" not implementing "PhpCsFixer\Fixer\ConfigurableFixerInterface".', \get_class($fixer)));
  45. $fixer->getConfigurationDefinition();
  46. }
  47. public function testCreateConfigurationDefinitionUnconfigurable(): void
  48. {
  49. $fixer = $this->createUnconfigurableFixerDouble();
  50. $this->expectException(\LogicException::class);
  51. $this->expectExceptionMessage('Cannot create configuration definition using Abstract parent, child not implementing "PhpCsFixer\Fixer\ConfigurableFixerInterface".');
  52. AccessibleObject::create($fixer)->createConfigurationDefinition();
  53. }
  54. public function testSetWhitespacesConfigUnconfigurable(): void
  55. {
  56. $fixer = $this->createUnconfigurableFixerDouble();
  57. $this->expectException(\LogicException::class);
  58. $this->expectExceptionMessage('Cannot run method for class not implementing "PhpCsFixer\Fixer\WhitespacesAwareFixerInterface".');
  59. $fixer->setWhitespacesConfig(new WhitespacesFixerConfig());
  60. }
  61. public function testGetWhitespacesFixerConfig(): void
  62. {
  63. $fixer = $this->createWhitespacesAwareFixerDouble();
  64. $config = AccessibleObject::create($fixer)->whitespacesConfig;
  65. self::assertSame(' ', $config->getIndent());
  66. self::assertSame("\n", $config->getLineEnding());
  67. $newConfig = new WhitespacesFixerConfig("\t", "\r\n");
  68. $fixer->setWhitespacesConfig($newConfig);
  69. $config = AccessibleObject::create($fixer)->whitespacesConfig;
  70. self::assertSame("\t", $config->getIndent());
  71. self::assertSame("\r\n", $config->getLineEnding());
  72. }
  73. private function createWhitespacesAwareFixerDouble(): WhitespacesAwareFixerInterface
  74. {
  75. return new class() extends AbstractFixer implements WhitespacesAwareFixerInterface {
  76. public function getDefinition(): FixerDefinitionInterface
  77. {
  78. throw new \BadMethodCallException('Not implemented.');
  79. }
  80. public function isCandidate(Tokens $tokens): bool
  81. {
  82. throw new \BadMethodCallException('Not implemented.');
  83. }
  84. protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
  85. {
  86. throw new \BadMethodCallException('Not implemented.');
  87. }
  88. };
  89. }
  90. private function createUnconfigurableFixerDouble(): AbstractFixer
  91. {
  92. return new class() extends AbstractFixer {
  93. public function getDefinition(): FixerDefinitionInterface
  94. {
  95. throw new \LogicException('Not implemented.');
  96. }
  97. public function isCandidate(Tokens $tokens): bool
  98. {
  99. return true;
  100. }
  101. protected function applyFix(\SplFileInfo $file, Tokens $tokens): void {}
  102. };
  103. }
  104. }