|
| 1 | +<?php |
| 2 | + |
| 3 | +declare (strict_types=1); |
| 4 | +namespace Rector\PHPUnit\CodeQuality\Rector\ClassMethod; |
| 5 | + |
| 6 | +use PhpParser\Node; |
| 7 | +use PhpParser\Node\Expr\StaticCall; |
| 8 | +use PhpParser\Node\Identifier; |
| 9 | +use PhpParser\Node\Name\FullyQualified; |
| 10 | +use PhpParser\Node\Stmt\ClassMethod; |
| 11 | +use Rector\PHPStan\ScopeFetcher; |
| 12 | +use Rector\PHPUnit\Enum\BehatClassName; |
| 13 | +use Rector\PHPUnit\Enum\PHPUnitClassName; |
| 14 | +use Rector\PHPUnit\Enum\WebmozartClassName; |
| 15 | +use Rector\Rector\AbstractRector; |
| 16 | +use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample; |
| 17 | +use Symplify\RuleDocGenerator\ValueObject\RuleDefinition; |
| 18 | +/** |
| 19 | + * @see \Rector\PHPUnit\Tests\CodeQuality\Rector\ClassMethod\BehatPHPUnitAssertToWebmozzartRector\BehatPHPUnitAssertToWebmozzartRectorTest |
| 20 | + */ |
| 21 | +final class BehatPHPUnitAssertToWebmozzartRector extends AbstractRector |
| 22 | +{ |
| 23 | + /** |
| 24 | + * @var array<string, string> |
| 25 | + */ |
| 26 | + private const PHPUNIT_TO_WEBMOZZART_METHODS = [ |
| 27 | + // Boolean |
| 28 | + 'assertTrue' => 'true', |
| 29 | + 'assertFalse' => 'false', |
| 30 | + // Null / empty |
| 31 | + 'assertNull' => 'null', |
| 32 | + 'assertNotNull' => 'notNull', |
| 33 | + 'assertEmpty' => 'isEmpty', |
| 34 | + 'assertNotEmpty' => 'notEmpty', |
| 35 | + // Type checks |
| 36 | + 'assertIsString' => 'string', |
| 37 | + 'assertIsInt' => 'integer', |
| 38 | + 'assertIsFloat' => 'float', |
| 39 | + 'assertIsBool' => 'boolean', |
| 40 | + 'assertIsArray' => 'isArray', |
| 41 | + 'assertIsObject' => 'object', |
| 42 | + 'assertIsCallable' => 'isCallable', |
| 43 | + 'assertIsResource' => 'resource', |
| 44 | + 'assertIsIterable' => 'isIterable', |
| 45 | + 'assertInstanceOf' => 'isInstanceOf', |
| 46 | + // Comparison / equality |
| 47 | + 'assertSame' => 'same', |
| 48 | + 'assertNotSame' => 'notSame', |
| 49 | + 'assertEquals' => 'eq', |
| 50 | + 'assertNotEquals' => 'notEq', |
| 51 | + 'assertGreaterThan' => 'greaterThan', |
| 52 | + 'assertGreaterThanOrEqual' => 'greaterThanEq', |
| 53 | + 'assertLessThan' => 'lessThan', |
| 54 | + 'assertLessThanOrEqual' => 'lessThanEq', |
| 55 | + // Strings |
| 56 | + 'assertStringContainsString' => 'contains', |
| 57 | + 'assertStringNotContainsString' => 'notContains', |
| 58 | + 'assertStringStartsWith' => 'startsWith', |
| 59 | + 'assertStringStartsNotWith' => 'notStartsWith', |
| 60 | + 'assertStringEndsWith' => 'endsWith', |
| 61 | + 'assertStringEndsNotWith' => 'notEndsWith', |
| 62 | + 'assertMatchesRegularExpression' => 'regex', |
| 63 | + // Arrays / count |
| 64 | + 'assertCount' => 'count', |
| 65 | + 'assertArrayHasKey' => 'keyExists', |
| 66 | + 'assertArrayNotHasKey' => 'keyNotExists', |
| 67 | + // Misc / less direct |
| 68 | + 'assertFileExists' => 'fileExists', |
| 69 | + 'assertFileIsReadable' => 'readable', |
| 70 | + 'assertDirectoryExists' => 'directory', |
| 71 | + ]; |
| 72 | + /** |
| 73 | + * @var string[] |
| 74 | + */ |
| 75 | + private const FLIPPED_ARGS = ['assertSame', 'assertNotSame', 'assertEquals', 'assertNotEquals', 'assertGreaterThan', 'assertGreaterThanOrEqual', 'assertLessThan', 'assertLessThanOrEqual', 'assertCount', 'assertContains', 'assertNotContains']; |
| 76 | + public function getRuleDefinition(): RuleDefinition |
| 77 | + { |
| 78 | + return new RuleDefinition('Change PHPUnit assert in Behat context files to Webmozart Assert, as first require a TestCase instance', [new CodeSample(<<<'CODE_SAMPLE' |
| 79 | +use Behat\Behat\Context\Context; |
| 80 | +use PHPUnit\Framework\Assert; |
| 81 | +
|
| 82 | +final class SomeContext implements Context |
| 83 | +{ |
| 84 | + public function someMethod() |
| 85 | + { |
| 86 | + Assert::assertSame('expected', 'actual'); |
| 87 | + } |
| 88 | +} |
| 89 | +CODE_SAMPLE |
| 90 | +, <<<'CODE_SAMPLE' |
| 91 | +use Behat\Behat\Context\Context; |
| 92 | +use Webmozart\Assert\Assert; |
| 93 | +
|
| 94 | +final class SomeContext implements Context |
| 95 | +{ |
| 96 | + public function someMethod() |
| 97 | + { |
| 98 | + Assert::same('actual', 'expected'); |
| 99 | + } |
| 100 | +} |
| 101 | +CODE_SAMPLE |
| 102 | +)]); |
| 103 | + } |
| 104 | + /** |
| 105 | + * @return array<class-string> |
| 106 | + */ |
| 107 | + public function getNodeTypes(): array |
| 108 | + { |
| 109 | + return [ClassMethod::class]; |
| 110 | + } |
| 111 | + /** |
| 112 | + * @param ClassMethod $node |
| 113 | + */ |
| 114 | + public function refactor(Node $node): ?ClassMethod |
| 115 | + { |
| 116 | + $scope = ScopeFetcher::fetch($node); |
| 117 | + if (!$scope->isInClass()) { |
| 118 | + return null; |
| 119 | + } |
| 120 | + $classReflection = $scope->getClassReflection(); |
| 121 | + if (!$classReflection->is(BehatClassName::CONTEXT)) { |
| 122 | + return null; |
| 123 | + } |
| 124 | + $hasChanged = \false; |
| 125 | + $this->traverseNodesWithCallable($node, function (Node $node) use (&$hasChanged): ?StaticCall { |
| 126 | + if (!$node instanceof StaticCall) { |
| 127 | + return null; |
| 128 | + } |
| 129 | + if (!$this->isName($node->class, PHPUnitClassName::ASSERT)) { |
| 130 | + return null; |
| 131 | + } |
| 132 | + $phpunitMethodName = $this->getName($node->name); |
| 133 | + if ($phpunitMethodName === null) { |
| 134 | + return null; |
| 135 | + } |
| 136 | + // changed method name |
| 137 | + $webmozartMethodName = self::PHPUNIT_TO_WEBMOZZART_METHODS[$phpunitMethodName] ?? null; |
| 138 | + if ($webmozartMethodName === null) { |
| 139 | + return null; |
| 140 | + } |
| 141 | + if (in_array($phpunitMethodName, self::FLIPPED_ARGS, \true) && count($node->args) >= 2) { |
| 142 | + // flip first 2 args |
| 143 | + $temp = $node->args[0]; |
| 144 | + $node->args[0] = $node->args[1]; |
| 145 | + $node->args[1] = $temp; |
| 146 | + } |
| 147 | + $node->class = new FullyQualified(WebmozartClassName::ASSERT); |
| 148 | + $node->name = new Identifier($webmozartMethodName); |
| 149 | + $hasChanged = \true; |
| 150 | + return $node; |
| 151 | + }); |
| 152 | + if (!$hasChanged) { |
| 153 | + return null; |
| 154 | + } |
| 155 | + return $node; |
| 156 | + } |
| 157 | +} |
0 commit comments