* Dariusz RumiƄski * * This source file is subject to the MIT license that is bundled * with this source code in the file LICENSE. */ namespace PhpCsFixer\Fixer\PhpUnit; use PhpCsFixer\Fixer\AbstractPhpUnitFixer; 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; use PhpCsFixer\Tokenizer\Token; use PhpCsFixer\Tokenizer\Tokens; use PhpCsFixer\Tokenizer\TokensAnalyzer; /** * @author Filippo Tessarotto */ final class PhpUnitDedicateAssertInternalTypeFixer extends AbstractPhpUnitFixer implements ConfigurableFixerInterface { /** * @var array */ private array $typeToDedicatedAssertMap = [ 'array' => 'assertIsArray', 'boolean' => 'assertIsBool', 'bool' => 'assertIsBool', 'double' => 'assertIsFloat', 'float' => 'assertIsFloat', 'integer' => 'assertIsInt', 'int' => 'assertIsInt', 'null' => 'assertNull', 'numeric' => 'assertIsNumeric', 'object' => 'assertIsObject', 'real' => 'assertIsFloat', 'resource' => 'assertIsResource', 'string' => 'assertIsString', 'scalar' => 'assertIsScalar', 'callable' => 'assertIsCallable', 'iterable' => 'assertIsIterable', ]; public function getDefinition(): FixerDefinitionInterface { return new FixerDefinition( 'PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`.', [ new CodeSample( 'assertInternalType("array", $var); $this->assertInternalType("boolean", $var); } } ' ), new CodeSample( 'assertInternalType("array", $var); $this->assertInternalType("boolean", $var); } } ', ['target' => PhpUnitTargetVersion::VERSION_7_5] ), ], null, 'Risky when PHPUnit methods are overridden or when project has PHPUnit incompatibilities.' ); } public function isRisky(): bool { return true; } /** * {@inheritdoc} * * Must run after NoBinaryStringFixer, NoUselessConcatOperatorFixer, PhpUnitDedicateAssertFixer. */ public function getPriority(): int { return -16; } protected function createConfigurationDefinition(): FixerConfigurationResolverInterface { return new FixerConfigurationResolver([ (new FixerOptionBuilder('target', 'Target version of PHPUnit.')) ->setAllowedTypes(['string']) ->setAllowedValues([PhpUnitTargetVersion::VERSION_7_5, PhpUnitTargetVersion::VERSION_NEWEST]) ->setDefault(PhpUnitTargetVersion::VERSION_NEWEST) ->getOption(), ]); } protected function applyPhpUnitClassFix(Tokens $tokens, int $startIndex, int $endIndex): void { $anonymousClassIndices = []; $tokenAnalyzer = new TokensAnalyzer($tokens); for ($index = $startIndex; $index < $endIndex; ++$index) { if (!$tokens[$index]->isGivenKind(T_CLASS) || !$tokenAnalyzer->isAnonymousClass($index)) { continue; } $openingBraceIndex = $tokens->getNextTokenOfKind($index, ['{']); $closingBraceIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_CURLY_BRACE, $openingBraceIndex); $anonymousClassIndices[$closingBraceIndex] = $openingBraceIndex; } for ($index = $endIndex - 1; $index > $startIndex; --$index) { if (isset($anonymousClassIndices[$index])) { $index = $anonymousClassIndices[$index]; continue; } if (!$tokens[$index]->isGivenKind(T_STRING)) { continue; } $functionName = strtolower($tokens[$index]->getContent()); if ('assertinternaltype' !== $functionName && 'assertnotinternaltype' !== $functionName) { continue; } $bracketTokenIndex = $tokens->getNextMeaningfulToken($index); if (!$tokens[$bracketTokenIndex]->equals('(')) { continue; } $expectedTypeTokenIndex = $tokens->getNextMeaningfulToken($bracketTokenIndex); $expectedTypeToken = $tokens[$expectedTypeTokenIndex]; if (!$expectedTypeToken->isGivenKind(T_CONSTANT_ENCAPSED_STRING)) { continue; } $expectedType = trim($expectedTypeToken->getContent(), '\'"'); if (!isset($this->typeToDedicatedAssertMap[$expectedType])) { continue; } $commaTokenIndex = $tokens->getNextMeaningfulToken($expectedTypeTokenIndex); if (!$tokens[$commaTokenIndex]->equals(',')) { continue; } $newAssertion = $this->typeToDedicatedAssertMap[$expectedType]; if ('assertnotinternaltype' === $functionName) { $newAssertion = str_replace('Is', 'IsNot', $newAssertion); $newAssertion = str_replace('Null', 'NotNull', $newAssertion); } $nextMeaningfulTokenIndex = $tokens->getNextMeaningfulToken($commaTokenIndex); $tokens->overrideRange($index, $nextMeaningfulTokenIndex - 1, [ new Token([T_STRING, $newAssertion]), new Token('('), ]); } } }