-
Notifications
You must be signed in to change notification settings - Fork 426
/
FunctionReflectionTest.php
205 lines (181 loc) · 5.87 KB
/
FunctionReflectionTest.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
<?php declare(strict_types = 1);
namespace PHPStan\Reflection;
use PhpParser\Node;
use PHPStan\Analyser\Scope;
use PHPStan\Testing\PHPStanTestCase;
use PHPStan\TrinaryLogic;
use const PHP_VERSION_ID;
class FunctionReflectionTest extends PHPStanTestCase
{
public function dataPhpdocFunctions(): iterable
{
yield [
'FunctionReflectionDocTest\\myFunction',
'/** some fn phpdoc */',
];
yield [
'FunctionReflectionDocTest\\noDocFunction',
null,
];
yield [
'FunctionReflectionDocTest\\docViaStub',
'/** fn doc via stub */',
];
yield [
'FunctionReflectionDocTest\\existingDocButStubOverridden',
'/** fn stub overridden phpdoc */',
];
yield [
'\\implode',
'/** php-src native fn stub overridden phpdoc */',
];
}
/**
* @dataProvider dataPhpdocFunctions
*
* @param non-empty-string $functionName
*/
public function testFunctionHasPhpdoc(string $functionName, ?string $expectedDoc): void
{
require_once __DIR__ . '/data/function-with-phpdoc.php';
$reflectionProvider = $this->createReflectionProvider();
$functionReflection = $reflectionProvider->getFunction(new Node\Name($functionName), null);
$this->assertSame($expectedDoc, $functionReflection->getDocComment());
}
public function dataPhpdocMethods(): iterable
{
yield [
'FunctionReflectionDocTest\\ClassWithPhpdoc',
'__construct',
'/** construct doc via stub */',
];
yield [
'FunctionReflectionDocTest\\ClassWithPhpdoc',
'aMethod',
'/** some method phpdoc */',
];
yield [
'FunctionReflectionDocTest\\ClassWithPhpdoc',
'noDocMethod',
null,
];
yield [
'FunctionReflectionDocTest\\ClassWithPhpdoc',
'docViaStub',
'/** method doc via stub */',
];
yield [
'FunctionReflectionDocTest\\ClassWithPhpdoc',
'existingDocButStubOverridden',
'/** stub overridden phpdoc */',
];
yield [
'FunctionReflectionDocTest\\ClassWithInheritedPhpdoc',
'aMethod',
'/** some method phpdoc */',
];
yield [
'FunctionReflectionDocTest\\ClassWithInheritedPhpdoc',
'noDocMethod',
null,
];
yield [
'FunctionReflectionDocTest\\ClassWithInheritedPhpdoc',
'docViaStub',
'/** method doc via stub */',
];
yield [
'FunctionReflectionDocTest\\ClassWithInheritedPhpdoc',
'existingDocButStubOverridden',
'/** stub overridden phpdoc */',
];
yield [
'FunctionReflectionDocTest\\ClassWithInheritedPhpdoc',
'aMethodInheritanceOverridden',
'/** some inheritance overridden method phpdoc */',
];
yield [
'\\DateTime',
'__construct',
'/** php-src native construct stub overridden phpdoc */',
];
yield [
'\\DateTime',
'modify',
'/** php-src native method stub overridden phpdoc */',
];
}
/**
* @dataProvider dataPhpdocMethods
*/
public function testMethodHasPhpdoc(string $className, string $methodName, ?string $expectedDocComment): void
{
$reflectionProvider = $this->createReflectionProvider();
$class = $reflectionProvider->getClass($className);
$scope = $this->createMock(Scope::class);
$scope->method('isInClass')->willReturn(true);
$scope->method('getClassReflection')->willReturn($class);
$scope->method('canAccessProperty')->willReturn(true);
$classReflection = $reflectionProvider->getClass($className);
$methodReflection = $classReflection->getMethod($methodName, $scope);
$this->assertSame($expectedDocComment, $methodReflection->getDocComment());
}
public function dataFunctionReturnsByReference(): iterable
{
yield ['\\implode', TrinaryLogic::createNo()];
yield ['ReturnsByReference\\foo', TrinaryLogic::createNo()];
yield ['ReturnsByReference\\refFoo', TrinaryLogic::createYes()];
}
/**
* @dataProvider dataFunctionReturnsByReference
* @param non-empty-string $functionName
*/
public function testFunctionReturnsByReference(string $functionName, TrinaryLogic $expectedReturnsByRef): void
{
require_once __DIR__ . '/data/returns-by-reference.php';
$reflectionProvider = $this->createReflectionProvider();
$functionReflection = $reflectionProvider->getFunction(new Node\Name($functionName), null);
$this->assertSame($expectedReturnsByRef, $functionReflection->returnsByReference());
}
public function dataMethodReturnsByReference(): iterable
{
yield ['ReturnsByReference\\X', 'foo', TrinaryLogic::createNo()];
yield ['ReturnsByReference\\X', 'refFoo', TrinaryLogic::createYes()];
yield ['ReturnsByReference\\SubX', 'foo', TrinaryLogic::createNo()];
yield ['ReturnsByReference\\SubX', 'refFoo', TrinaryLogic::createYes()];
yield ['ReturnsByReference\\SubX', 'subRefFoo', TrinaryLogic::createYes()];
yield ['ReturnsByReference\\TraitX', 'traitFoo', TrinaryLogic::createNo()];
yield ['ReturnsByReference\\TraitX', 'refTraitFoo', TrinaryLogic::createYes()];
if (PHP_VERSION_ID < 80100) {
return;
}
yield ['ReturnsByReference\\E', 'enumFoo', TrinaryLogic::createNo()];
yield ['ReturnsByReference\\E', 'refEnumFoo', TrinaryLogic::createYes()];
// cases() method cannot be overridden; https://3v4l.org/ebm83
yield ['ReturnsByReference\\E', 'cases', TrinaryLogic::createNo()];
}
/**
* @dataProvider dataMethodReturnsByReference
*/
public function testMethodReturnsByReference(string $className, string $methodName, TrinaryLogic $expectedReturnsByRef): void
{
$reflectionProvider = $this->createReflectionProvider();
$class = $reflectionProvider->getClass($className);
$scope = $this->createMock(Scope::class);
$scope->method('isInClass')->willReturn(true);
$scope->method('getClassReflection')->willReturn($class);
$scope->method('canAccessProperty')->willReturn(true);
$classReflection = $reflectionProvider->getClass($className);
$methodReflection = $classReflection->getMethod($methodName, $scope);
$this->assertSame($expectedReturnsByRef, $methodReflection->returnsByReference());
}
/**
* @return string[]
*/
public static function getAdditionalConfigFiles(): array
{
return [
__DIR__ . '/data/function-reflection.neon',
];
}
}