2 declare(strict_types = 1);
18 use PhpParser\NodeTraverser;
19 use PhpParser\NodeVisitor\NameResolver;
20 use PhpParser\ParserFactory;
22 use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
27 class MethodArgumentRequiredMatcherTest
extends UnitTestCase
32 public function hitsFromFixtureAreFound()
34 $parser = (
new ParserFactory())->create(ParserFactory::PREFER_PHP7);
35 $fixtureFile = __DIR__ .
'/Fixtures/MethodArgumentRequiredMatcherFixture.php';
36 $statements =
$parser->parse(file_get_contents($fixtureFile));
38 $traverser =
new NodeTraverser();
39 $traverser->addVisitor(
new NameResolver());
42 'TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer->searchWhere' => [
43 'numberOfMandatoryArguments' => 3,
44 'maximumNumberOfArguments' => 3,
46 'Breaking-80700-DeprecatedFunctionalityRemoved.rst',
50 $subject =
new MethodArgumentRequiredMatcher($configuration);
51 $traverser->addVisitor($subject);
52 $traverser->traverse($statements);
53 $expectedHitLineNumbers = [
57 $actualHitLineNumbers = [];
58 foreach ($subject->getMatches() as $hit) {
59 $actualHitLineNumbers[] = $hit[
'line'];
61 $this->assertEquals($expectedHitLineNumbers, $actualHitLineNumbers);
67 public function matchesReturnsExpectedRestFilesDataProvider(): array
70 'two rest candidates with same number of arguments' => [
73 'numberOfMandatoryArguments' => 1,
74 'maximumNumberOfArguments' => 2,
81 'numberOfMandatoryArguments' => 2,
82 'maximumNumberOfArguments' => 3,
90 $someVar->aMethod();',
102 'two candidates, only one hits because second candidate needs two arguments' => [
105 'numberOfMandatoryArguments' => 1,
106 'maximumNumberOfArguments' => 3,
112 'numberOfMandatoryArguments' => 2,
113 'maximumNumberOfArguments' => 3,
120 $someVar->aMethod(\'arg1\');',
129 'one candidate, does not hit' => [
132 'numberOfMandatoryArguments' => 1,
133 'maximumNumberOfArguments' => 3,
140 $someVar->aMethod(\'arg1\');',
143 'too many arguments given' => [
146 'numberOfMandatoryArguments' => 1,
147 'maximumNumberOfArguments' => 1,
154 $someVar->aMethod($foo, $bar);',
157 'method call using argument unpacking' => [
160 'numberOfMandatoryArguments' => 2,
161 'maximumNumberOfArguments' => 3,
168 $args = [\'arg1\', \'arg2\', \'arg3\'];
169 $someVar->aMethod(...$args);',
172 'method call using argument unpacking with more than max number of args given arguments' => [
175 'numberOfMandatoryArguments' => 2,
176 'maximumNumberOfArguments' => 2,
183 $args1 = [\'arg1\', \'arg2\', \'arg3\'];
184 $args2 = [\'arg4\', \'arg5\', \'arg6\'];
185 $args3 = [\'arg7\', \'arg8\', \'arg9\'];
186 $someVar->aMethod(...$args1, ...$args2, ...$args3);',
189 'double linked .rst file is returned only once' => [
192 'numberOfMandatoryArguments' => 1,
193 'maximumNumberOfArguments' => 2,
199 'numberOfMandatoryArguments' => 1,
200 'maximumNumberOfArguments' => 2,
207 $someVar->aMethod();',
226 public function matchesReturnsExpectedRestFiles(array $configuration,
string $phpCode, array $expected)
228 $parser = (
new ParserFactory())->create(ParserFactory::ONLY_PHP7);
229 $statements =
$parser->parse($phpCode);
231 $subject =
new MethodArgumentRequiredMatcher($configuration);
233 $traverser =
new NodeTraverser();
234 $traverser->addVisitor($subject);
235 $traverser->traverse($statements);
237 $result = $subject->getMatches();
238 if (isset($expected[0], $result[0])) {
239 $this->assertEquals($expected[0][
'restFiles'], $result[0][
'restFiles']);
241 $this->assertEquals($expected, $result);