Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature #4328 Add PhpUnitDedicateAssertInternalTypeFixer (Slamdunk)
This PR was squashed before being merged into the 2.15-dev branch (closes #4328). Discussion ---------- Add PhpUnitDedicateAssertInternalTypeFixer Closes #4144 - [x] Update `RuleSet` - [x] Add integration test with `PhpUnitDedicateAssertInternalTypeFixer` I intentionally created a new fixer instead of updating [PhpUnitDedicateAssertInternalTypeFixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer/blob/v2.14.2/src/Fixer/PhpUnit/PhpUnitDedicateAssertFixer.php) because the codes need too different logics. I don't really like the names, they may confuse the users, any suggestion is welcome, but I would like to keep the two fixers in two different classes. Commits ------- f721b4b Add PhpUnitDedicateAssertInternalTypeFixer
- Loading branch information
Showing
7 changed files
with
438 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
200 changes: 200 additions & 0 deletions
200
src/Fixer/PhpUnit/PhpUnitDedicateAssertInternalTypeFixer.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * 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\Fixer\PhpUnit; | ||
|
|
||
| use PhpCsFixer\AbstractFixer; | ||
| use PhpCsFixer\Fixer\ConfigurationDefinitionFixerInterface; | ||
| use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver; | ||
| use PhpCsFixer\FixerConfiguration\FixerOptionBuilder; | ||
| use PhpCsFixer\FixerDefinition\CodeSample; | ||
| use PhpCsFixer\FixerDefinition\FixerDefinition; | ||
| use PhpCsFixer\Indicator\PhpUnitTestCaseIndicator; | ||
| use PhpCsFixer\Tokenizer\Token; | ||
| use PhpCsFixer\Tokenizer\Tokens; | ||
| use PhpCsFixer\Tokenizer\TokensAnalyzer; | ||
|
|
||
| /** | ||
| * @author Filippo Tessarotto <zoeslam@gmail.com> | ||
| */ | ||
| final class PhpUnitDedicateAssertInternalTypeFixer extends AbstractFixer implements ConfigurationDefinitionFixerInterface | ||
| { | ||
| /** | ||
| * @var array | ||
| */ | ||
| private $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', | ||
| ]; | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getDefinition() | ||
| { | ||
| return new FixerDefinition( | ||
| 'PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`.', | ||
| [ | ||
| new CodeSample( | ||
| '<?php | ||
| final class MyTest extends \PHPUnit\Framework\TestCase | ||
| { | ||
| public function testMe() | ||
| { | ||
| $this->assertInternalType("array", $var); | ||
| $this->assertInternalType("boolean", $var); | ||
| } | ||
| } | ||
| ' | ||
| ), | ||
| ], | ||
| null, | ||
| 'Risky when PHPUnit methods are overridden or when project has PHPUnit incompatibilities.' | ||
| ); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function isCandidate(Tokens $tokens) | ||
| { | ||
| return $tokens->isAllTokenKindsFound([T_CLASS, T_FUNCTION]); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function isRisky() | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getPriority() | ||
| { | ||
| // should be run after the PhpUnitDedicateAssertFixer | ||
| return -16; | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function applyFix(\SplFileInfo $file, Tokens $tokens) | ||
| { | ||
| $phpUnitTestCaseIndicator = new PhpUnitTestCaseIndicator(); | ||
| foreach ($phpUnitTestCaseIndicator->findPhpUnitClasses($tokens) as $indexes) { | ||
| $this->updateAssertInternalTypeMethods($tokens, $indexes[0], $indexes[1]); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| protected function createConfigurationDefinition() | ||
| { | ||
| 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(), | ||
| ]); | ||
| } | ||
|
|
||
| /** | ||
| * @param Tokens $tokens | ||
| * @param int $startIndex | ||
| * @param int $endIndex | ||
| */ | ||
| private function updateAssertInternalTypeMethods(Tokens $tokens, $startIndex, $endIndex) | ||
| { | ||
| $anonymousClassIndexes = []; | ||
| $tokenAnalyzer = new TokensAnalyzer($tokens); | ||
| for ($index = $startIndex; $index < $endIndex; ++$index) { | ||
| if (!$tokens[$index]->isClassy() || !$tokenAnalyzer->isAnonymousClass($index)) { | ||
| continue; | ||
| } | ||
|
|
||
| $openingBraceIndex = $tokens->getNextTokenOfKind($index, ['{']); | ||
| $closingBraceIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_CURLY_BRACE, $openingBraceIndex); | ||
|
|
||
| $anonymousClassIndexes[$closingBraceIndex] = $openingBraceIndex; | ||
| } | ||
|
|
||
| for ($index = $endIndex - 1; $index > $startIndex; --$index) { | ||
| if (isset($anonymousClassIndexes[$index])) { | ||
| $index = $anonymousClassIndexes[$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->equals([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('('), | ||
| ]); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.