128 lines
4.5 KiB
PHP
128 lines
4.5 KiB
PHP
<?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\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\Analyzer\ArgumentsAnalyzer;
|
|
use PhpCsFixer\Tokenizer\Token;
|
|
use PhpCsFixer\Tokenizer\Tokens;
|
|
|
|
/**
|
|
* @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
|
|
*/
|
|
final class PhpUnitMockFixer extends AbstractPhpUnitFixer implements ConfigurableFixerInterface
|
|
{
|
|
/**
|
|
* @var bool
|
|
*/
|
|
private $fixCreatePartialMock;
|
|
|
|
public function getDefinition(): FixerDefinitionInterface
|
|
{
|
|
return new FixerDefinition(
|
|
'Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods.',
|
|
[
|
|
new CodeSample(
|
|
'<?php
|
|
final class MyTest extends \PHPUnit_Framework_TestCase
|
|
{
|
|
public function testFoo()
|
|
{
|
|
$mock = $this->getMockWithoutInvokingTheOriginalConstructor("Foo");
|
|
$mock1 = $this->getMock("Foo");
|
|
$mock1 = $this->getMock("Bar", ["aaa"]);
|
|
$mock1 = $this->getMock("Baz", ["aaa"], ["argument"]); // version with more than 2 params is not supported
|
|
}
|
|
}
|
|
'
|
|
),
|
|
new CodeSample(
|
|
'<?php
|
|
final class MyTest extends \PHPUnit_Framework_TestCase
|
|
{
|
|
public function testFoo()
|
|
{
|
|
$mock1 = $this->getMock("Foo");
|
|
$mock1 = $this->getMock("Bar", ["aaa"]); // version with multiple params is not supported
|
|
}
|
|
}
|
|
',
|
|
['target' => PhpUnitTargetVersion::VERSION_5_4]
|
|
),
|
|
],
|
|
null,
|
|
'Risky when PHPUnit classes are overridden or not accessible, or when project has PHPUnit incompatibilities.'
|
|
);
|
|
}
|
|
|
|
public function isRisky(): bool
|
|
{
|
|
return true;
|
|
}
|
|
|
|
public function configure(array $configuration): void
|
|
{
|
|
parent::configure($configuration);
|
|
|
|
$this->fixCreatePartialMock = PhpUnitTargetVersion::fulfills($this->configuration['target'], PhpUnitTargetVersion::VERSION_5_5);
|
|
}
|
|
|
|
protected function applyPhpUnitClassFix(Tokens $tokens, int $startIndex, int $endIndex): void
|
|
{
|
|
$argumentsAnalyzer = new ArgumentsAnalyzer();
|
|
|
|
for ($index = $startIndex; $index < $endIndex; ++$index) {
|
|
if (!$tokens[$index]->isObjectOperator()) {
|
|
continue;
|
|
}
|
|
|
|
$index = $tokens->getNextMeaningfulToken($index);
|
|
|
|
if ($tokens[$index]->equals([T_STRING, 'getMockWithoutInvokingTheOriginalConstructor'], false)) {
|
|
$tokens[$index] = new Token([T_STRING, 'createMock']);
|
|
} elseif ($tokens[$index]->equals([T_STRING, 'getMock'], false)) {
|
|
$openingParenthesis = $tokens->getNextMeaningfulToken($index);
|
|
$closingParenthesis = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_PARENTHESIS_BRACE, $openingParenthesis);
|
|
|
|
$argumentsCount = $argumentsAnalyzer->countArguments($tokens, $openingParenthesis, $closingParenthesis);
|
|
|
|
if (1 === $argumentsCount) {
|
|
$tokens[$index] = new Token([T_STRING, 'createMock']);
|
|
} elseif (2 === $argumentsCount && true === $this->fixCreatePartialMock) {
|
|
$tokens[$index] = new Token([T_STRING, 'createPartialMock']);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
|
|
{
|
|
return new FixerConfigurationResolver([
|
|
(new FixerOptionBuilder('target', 'Target version of PHPUnit.'))
|
|
->setAllowedTypes(['string'])
|
|
->setAllowedValues([PhpUnitTargetVersion::VERSION_5_4, PhpUnitTargetVersion::VERSION_5_5, PhpUnitTargetVersion::VERSION_NEWEST])
|
|
->setDefault(PhpUnitTargetVersion::VERSION_NEWEST)
|
|
->getOption(),
|
|
]);
|
|
}
|
|
}
|