/
PropertyDocumentedTypeChangedTest.php
244 lines (203 loc) · 7.61 KB
/
PropertyDocumentedTypeChangedTest.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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
<?php
declare(strict_types=1);
namespace RoaveTest\BackwardCompatibility\DetectChanges\BCBreak\PropertyBased;
use PHPUnit\Framework\TestCase;
use Roave\BackwardCompatibility\Change;
use Roave\BackwardCompatibility\DetectChanges\BCBreak\PropertyBased\PropertyDocumentedTypeChanged;
use Roave\BetterReflection\BetterReflection;
use Roave\BetterReflection\Reflection\ReflectionProperty;
use Roave\BetterReflection\Reflector\ClassReflector;
use Roave\BetterReflection\SourceLocator\Type\StringSourceLocator;
use RoaveTest\BackwardCompatibility\TypeRestriction;
use function array_combine;
use function array_keys;
use function array_map;
use function iterator_to_array;
/**
* @covers \Roave\BackwardCompatibility\DetectChanges\BCBreak\PropertyBased\PropertyDocumentedTypeChanged
*/
final class PropertyDocumentedTypeChangedTest extends TestCase
{
/**
* @param string[] $expectedMessages
*
* @dataProvider propertiesToBeTested
*/
public function testDiffs(
ReflectionProperty $fromProperty,
ReflectionProperty $toProperty,
array $expectedMessages
): void {
$changes = (new PropertyDocumentedTypeChanged())($fromProperty, $toProperty);
self::assertSame(
$expectedMessages,
array_map(static function (Change $change): string {
return $change->__toString();
}, iterator_to_array($changes))
);
}
/**
* @return array<string, array<int, ReflectionProperty|array<int, string>>>
* @psalm-return array<string, array{0: ReflectionProperty, 1: ReflectionProperty, 2: list<string>}>
*/
public function propertiesToBeTested(): array
{
$astLocator = (new BetterReflection())->astLocator();
$fromLocator = new StringSourceLocator(
<<<'PHP'
<?php
class TheClass {
public $publicNoDocblockToNoDocblock;
public $publicNoDocblockToDocblock;
/**
* Hi
*/
public $publicNoTypeDocblockToDocblock;
/**
* @var int
*/
public $publicDocblockToSameDocblock;
/**
* @var int
*/
public $publicDocblockToDifferentDocblock;
/**
* @var int
*/
public $publicDocblockToNoDocblock;
/**
* @var int|float
*/
public $publicCompositeTypeDocblockToSameTypeDocblock;
/**
* @var int|float
*/
public $publicCompositeTypeDocblockToSameTypeDocblockWithDifferentSorting;
/**
* @var int|float
*/
public $publicCompositeTypeDocblockToDifferentCompositeTypeDocblock;
/**
* @var int
*/
private $privateDocblockToDifferentDocblock;
/**
* @var int|int
*/
private $duplicatePropertyTypesBeingDeduplicatedAreNotBcBreaks;
/**
* @var int
*/
private $propertyTypeBeingDuplicatedAreNotBcBreaks;
/**
* @var GenericType<T1, T2>
*/
public $propertyWithComplexDocblockThatCannotBeParsed;
/**
* @var int
*/
public $propertyWithDocblockTypeHintChangeToNativeTypeHint;
/**
* @var int
*/
public $propertyWithDocblockTypeHintChangeToNativeTypeHintAndTypeChange;
}
PHP
,
$astLocator
);
$toLocator = new StringSourceLocator(
<<<'PHP'
<?php
class TheClass {
public $publicNoDocblockToNoDocblock;
/**
* @var int
*/
public $publicNoDocblockToDocblock;
/**
* @var int
*/
public $publicNoTypeDocblockToDocblock;
/**
* @var int
*/
public $publicDocblockToSameDocblock;
/**
* @var float
*/
public $publicDocblockToDifferentDocblock;
public $publicDocblockToNoDocblock;
/**
* @var int|float
*/
public $publicCompositeTypeDocblockToSameTypeDocblock;
/**
* @var float|int
*/
public $publicCompositeTypeDocblockToSameTypeDocblockWithDifferentSorting;
/**
* @var int|float|string
*/
public $publicCompositeTypeDocblockToDifferentCompositeTypeDocblock;
/**
* @var float
*/
private $privateDocblockToDifferentDocblock;
/**
* @var int
*/
private $duplicatePropertyTypesBeingDeduplicatedAreNotBcBreaks;
/**
* @var int|int
*/
private $propertyTypeBeingDuplicatedAreNotBcBreaks;
/**
* @var GenericType<T1, T2>
*/
public $propertyWithComplexDocblockThatCannotBeParsed;
public int $propertyWithDocblockTypeHintChangeToNativeTypeHint;
public float $propertyWithDocblockTypeHintChangeToNativeTypeHintAndTypeChange;
}
PHP
,
$astLocator
);
$fromClassReflector = new ClassReflector($fromLocator);
$toClassReflector = new ClassReflector($toLocator);
$fromClass = $fromClassReflector->reflect('TheClass');
$toClass = $toClassReflector->reflect('TheClass');
$properties = [
'publicNoDocblockToNoDocblock' => [],
'publicNoDocblockToDocblock' => [],
'publicNoTypeDocblockToDocblock' => ['[BC] CHANGED: Type documentation for property TheClass#$publicNoTypeDocblockToDocblock changed from having no type to int'],
'publicDocblockToSameDocblock' => [],
'publicDocblockToDifferentDocblock' => ['[BC] CHANGED: Type documentation for property TheClass#$publicDocblockToDifferentDocblock changed from int to float'],
'publicDocblockToNoDocblock' => ['[BC] CHANGED: Type documentation for property TheClass#$publicDocblockToNoDocblock changed from int to having no type'],
'publicCompositeTypeDocblockToSameTypeDocblock' => [],
'publicCompositeTypeDocblockToSameTypeDocblockWithDifferentSorting' => [],
'publicCompositeTypeDocblockToDifferentCompositeTypeDocblock' => ['[BC] CHANGED: Type documentation for property TheClass#$publicCompositeTypeDocblockToDifferentCompositeTypeDocblock changed from float|int to float|int|string'],
'privateDocblockToDifferentDocblock' => ['[BC] CHANGED: Type documentation for property TheClass#$privateDocblockToDifferentDocblock changed from int to float'],
'duplicatePropertyTypesBeingDeduplicatedAreNotBcBreaks' => [],
'propertyTypeBeingDuplicatedAreNotBcBreaks' => [],
'propertyWithComplexDocblockThatCannotBeParsed' => [],
'propertyWithDocblockTypeHintChangeToNativeTypeHint' => [],
'propertyWithDocblockTypeHintChangeToNativeTypeHintAndTypeChange' => ['[BC] CHANGED: Type documentation for property TheClass#$propertyWithDocblockTypeHintChangeToNativeTypeHintAndTypeChange changed from int to float'],
];
return array_combine(
array_keys($properties),
array_map(
/** @psalm-param list<string> $errorMessages https://github.com/vimeo/psalm/issues/2772 */
static function (string $property, array $errorMessages) use ($fromClass, $toClass): array {
return [
TypeRestriction::object($fromClass->getProperty($property)),
TypeRestriction::object($toClass->getProperty($property)),
$errorMessages,
];
},
array_keys($properties),
$properties
)
);
}
}