Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 81de559

Browse files
nicolas-grekasnicolas-grekas
committed
minor #48988 [Tests] New iteration of removing $this occurrences in future static data providers (alexandre-daubois)
This PR was merged into the 5.4 branch. Discussion ---------- [Tests] New iteration of removing `$this` occurrences in future static data providers | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes-ish | New feature? | no <!-- please update src/**/CHANGELOG.md files --> | Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files --> | Tickets | Easing #48668 (comment) | License | MIT | Doc PR | _NA_ Follow-up of #48980 Commits ------- 1386ac2 [Tests] New iteration of removing `$this` occurrences in future static data providers
2 parents d0b723e + 1386ac2 commit 81de559

32 files changed

+333
-293
lines changed

‎src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/AbstractDescriptorTest.php

Lines changed: 40 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ public function testDescribeRouteCollection(RouteCollection $routes, $expectedDe
4545
$this->assertDescription($expectedDescription, $routes);
4646
}
4747

48-
public function getDescribeRouteCollectionTestData()
48+
public static function getDescribeRouteCollectionTestData(): array
4949
{
50-
return $this->getDescriptionTestData(ObjectsProvider::getRouteCollections());
50+
return static::getDescriptionTestData(ObjectsProvider::getRouteCollections());
5151
}
5252

5353
/** @dataProvider getDescribeRouteTestData */
@@ -56,9 +56,9 @@ public function testDescribeRoute(Route $route, $expectedDescription)
5656
$this->assertDescription($expectedDescription, $route);
5757
}
5858

59-
public function getDescribeRouteTestData()
59+
public static function getDescribeRouteTestData(): array
6060
{
61-
return $this->getDescriptionTestData(ObjectsProvider::getRoutes());
61+
return static::getDescriptionTestData(ObjectsProvider::getRoutes());
6262
}
6363

6464
/** @dataProvider getDescribeContainerParametersTestData */
@@ -67,9 +67,9 @@ public function testDescribeContainerParameters(ParameterBag $parameters, $expec
6767
$this->assertDescription($expectedDescription, $parameters);
6868
}
6969

70-
public function getDescribeContainerParametersTestData()
70+
public static function getDescribeContainerParametersTestData(): array
7171
{
72-
return $this->getDescriptionTestData(ObjectsProvider::getContainerParameters());
72+
return static::getDescriptionTestData(ObjectsProvider::getContainerParameters());
7373
}
7474

7575
/** @dataProvider getDescribeContainerBuilderTestData */
@@ -78,9 +78,9 @@ public function testDescribeContainerBuilder(ContainerBuilder $builder, $expecte
7878
$this->assertDescription($expectedDescription, $builder, $options);
7979
}
8080

81-
public function getDescribeContainerBuilderTestData()
81+
public static function getDescribeContainerBuilderTestData(): array
8282
{
83-
return $this->getContainerBuilderDescriptionTestData(ObjectsProvider::getContainerBuilders());
83+
return static::getContainerBuilderDescriptionTestData(ObjectsProvider::getContainerBuilders());
8484
}
8585

8686
/**
@@ -91,9 +91,9 @@ public function testDescribeContainerExistingClassDefinition(Definition $definit
9191
$this->assertDescription($expectedDescription, $definition);
9292
}
9393

94-
public function getDescribeContainerExistingClassDefinitionTestData()
94+
public static function getDescribeContainerExistingClassDefinitionTestData(): array
9595
{
96-
return $this->getDescriptionTestData(ObjectsProvider::getContainerDefinitionsWithExistingClasses());
96+
return static::getDescriptionTestData(ObjectsProvider::getContainerDefinitionsWithExistingClasses());
9797
}
9898

9999
/** @dataProvider getDescribeContainerDefinitionTestData */
@@ -102,9 +102,9 @@ public function testDescribeContainerDefinition(Definition $definition, $expecte
102102
$this->assertDescription($expectedDescription, $definition);
103103
}
104104

105-
public function getDescribeContainerDefinitionTestData()
105+
public static function getDescribeContainerDefinitionTestData(): array
106106
{
107-
return $this->getDescriptionTestData(ObjectsProvider::getContainerDefinitions());
107+
return static::getDescriptionTestData(ObjectsProvider::getContainerDefinitions());
108108
}
109109

110110
/** @dataProvider getDescribeContainerDefinitionWithArgumentsShownTestData */
@@ -113,7 +113,7 @@ public function testDescribeContainerDefinitionWithArgumentsShown(Definition $de
113113
$this->assertDescription($expectedDescription, $definition, ['show_arguments' => true]);
114114
}
115115

116-
public function getDescribeContainerDefinitionWithArgumentsShownTestData()
116+
public static function getDescribeContainerDefinitionWithArgumentsShownTestData(): array
117117
{
118118
$definitions = ObjectsProvider::getContainerDefinitions();
119119
$definitionsWithArgs = [];
@@ -126,7 +126,7 @@ public function getDescribeContainerDefinitionWithArgumentsShownTestData()
126126
$definitionsWithArgs['definition_arguments_with_enum'] = (new Definition('definition_with_enum'))->setArgument(0, FooUnitEnum::FOO);
127127
}
128128

129-
return $this->getDescriptionTestData($definitionsWithArgs);
129+
return static::getDescriptionTestData($definitionsWithArgs);
130130
}
131131

132132
/** @dataProvider getDescribeContainerAliasTestData */
@@ -135,9 +135,9 @@ public function testDescribeContainerAlias(Alias $alias, $expectedDescription)
135135
$this->assertDescription($expectedDescription, $alias);
136136
}
137137

138-
public function getDescribeContainerAliasTestData()
138+
public static function getDescribeContainerAliasTestData(): array
139139
{
140-
return $this->getDescriptionTestData(ObjectsProvider::getContainerAliases());
140+
return static::getDescriptionTestData(ObjectsProvider::getContainerAliases());
141141
}
142142

143143
/** @dataProvider getDescribeContainerDefinitionWhichIsAnAliasTestData */
@@ -146,7 +146,7 @@ public function testDescribeContainerDefinitionWhichIsAnAlias(Alias $alias, $exp
146146
$this->assertDescription($expectedDescription, $builder, $options);
147147
}
148148

149-
public function getDescribeContainerDefinitionWhichIsAnAliasTestData()
149+
public static function getDescribeContainerDefinitionWhichIsAnAliasTestData(): array
150150
{
151151
$builder = current(ObjectsProvider::getContainerBuilders());
152152
$builder->setDefinition('service_1', $builder->getDefinition('definition_1'));
@@ -159,7 +159,7 @@ public function getDescribeContainerDefinitionWhichIsAnAliasTestData()
159159
}
160160

161161
$i = 0;
162-
$data = $this->getDescriptionTestData($aliasesWithDefinitions);
162+
$data = static::getDescriptionTestData($aliasesWithDefinitions);
163163
foreach ($aliases as $name => $alias) {
164164
$file = array_pop($data[$i]);
165165
$data[$i][] = $builder;
@@ -177,9 +177,9 @@ public function testDescribeContainerParameter($parameter, $expectedDescription,
177177
$this->assertDescription($expectedDescription, $parameter, $options);
178178
}
179179

180-
public function getDescribeContainerParameterTestData()
180+
public static function getDescribeContainerParameterTestData(): array
181181
{
182-
$data = $this->getDescriptionTestData(ObjectsProvider::getContainerParameter());
182+
$data = static::getDescriptionTestData(ObjectsProvider::getContainerParameter());
183183

184184
$file = array_pop($data[0]);
185185
$data[0][] = ['parameter' => 'database_name'];
@@ -197,9 +197,9 @@ public function testDescribeEventDispatcher(EventDispatcher $eventDispatcher, $e
197197
$this->assertDescription($expectedDescription, $eventDispatcher, $options);
198198
}
199199

200-
public function getDescribeEventDispatcherTestData()
200+
public static function getDescribeEventDispatcherTestData(): array
201201
{
202-
return $this->getEventDispatcherDescriptionTestData(ObjectsProvider::getEventDispatchers());
202+
return static::getEventDispatcherDescriptionTestData(ObjectsProvider::getEventDispatchers());
203203
}
204204

205205
/** @dataProvider getDescribeCallableTestData */
@@ -208,23 +208,24 @@ public function testDescribeCallable($callable, $expectedDescription)
208208
$this->assertDescription($expectedDescription, $callable);
209209
}
210210

211-
public function getDescribeCallableTestData(): array
211+
public static function getDescribeCallableTestData(): array
212212
{
213-
return $this->getDescriptionTestData(ObjectsProvider::getCallables());
213+
return static::getDescriptionTestData(ObjectsProvider::getCallables());
214214
}
215215

216216
/**
217217
* @group legacy
218+
*
218219
* @dataProvider getDescribeDeprecatedCallableTestData
219220
*/
220221
public function testDescribeDeprecatedCallable($callable, $expectedDescription)
221222
{
222223
$this->assertDescription($expectedDescription, $callable);
223224
}
224225

225-
public function getDescribeDeprecatedCallableTestData(): array
226+
public static function getDescribeDeprecatedCallableTestData(): array
226227
{
227-
return $this->getDescriptionTestData(ObjectsProvider::getDeprecatedCallables());
228+
return static::getDescriptionTestData(ObjectsProvider::getDeprecatedCallables());
228229
}
229230

230231
/** @dataProvider getClassDescriptionTestData */
@@ -233,7 +234,7 @@ public function testGetClassDescription($object, $expectedDescription)
233234
$this->assertEquals($expectedDescription, $this->getDescriptor()->getClassDescription($object));
234235
}
235236

236-
public function getClassDescriptionTestData()
237+
public static function getClassDescriptionTestData(): array
237238
{
238239
return [
239240
[ClassWithDocCommentOnMultipleLines::class, 'This is the first line of the description. This is the second line.'],
@@ -251,14 +252,14 @@ public function testGetDeprecations(ContainerBuilder $builder, $expectedDescript
251252
$this->assertDescription($expectedDescription, $builder, ['deprecations' => true]);
252253
}
253254

254-
public function getDeprecationsTestData()
255+
public static function getDeprecationsTestData(): array
255256
{
256-
return $this->getDescriptionTestData(ObjectsProvider::getContainerDeprecations());
257+
return static::getDescriptionTestData(ObjectsProvider::getContainerDeprecations());
257258
}
258259

259-
abstract protected function getDescriptor();
260+
abstract protected static function getDescriptor();
260261

261-
abstract protected function getFormat();
262+
abstract protected static function getFormat();
262263

263264
private function assertDescription($expectedDescription, $describedObject, array $options = [])
264265
{
@@ -280,19 +281,19 @@ private function assertDescription($expectedDescription, $describedObject, array
280281
}
281282
}
282283

283-
private function getDescriptionTestData(iterable $objects)
284+
private static function getDescriptionTestData(iterable $objects): array
284285
{
285286
$data = [];
286287
foreach ($objects as $name => $object) {
287-
$file = sprintf('%s.%s', trim($name, '.'), $this->getFormat());
288+
$file = sprintf('%s.%s', trim($name, '.'), static::getFormat());
288289
$description = file_get_contents(__DIR__.'/../../Fixtures/Descriptor/'.$file);
289290
$data[] = [$object, $description, $file];
290291
}
291292

292293
return $data;
293294
}
294295

295-
private function getContainerBuilderDescriptionTestData(array $objects)
296+
private static function getContainerBuilderDescriptionTestData(array $objects): array
296297
{
297298
$variations = [
298299
'services' => ['show_hidden' => true],
@@ -305,7 +306,7 @@ private function getContainerBuilderDescriptionTestData(array $objects)
305306
$data = [];
306307
foreach ($objects as $name => $object) {
307308
foreach ($variations as $suffix => $options) {
308-
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, $this->getFormat());
309+
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, static::getFormat());
309310
$description = file_get_contents(__DIR__.'/../../Fixtures/Descriptor/'.$file);
310311
$data[] = [$object, $description, $options, $file];
311312
}
@@ -314,7 +315,7 @@ private function getContainerBuilderDescriptionTestData(array $objects)
314315
return $data;
315316
}
316317

317-
private function getEventDispatcherDescriptionTestData(array $objects)
318+
private static function getEventDispatcherDescriptionTestData(array $objects): array
318319
{
319320
$variations = [
320321
'events' => [],
@@ -324,7 +325,7 @@ private function getEventDispatcherDescriptionTestData(array $objects)
324325
$data = [];
325326
foreach ($objects as $name => $object) {
326327
foreach ($variations as $suffix => $options) {
327-
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, $this->getFormat());
328+
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, static::getFormat());
328329
$description = file_get_contents(__DIR__.'/../../Fixtures/Descriptor/'.$file);
329330
$data[] = [$object, $description, $options, $file];
330331
}
@@ -339,13 +340,13 @@ public function testDescribeContainerBuilderWithPriorityTags(ContainerBuilder $b
339340
$this->assertDescription($expectedDescription, $builder, $options);
340341
}
341342

342-
public function getDescribeContainerBuilderWithPriorityTagsTestData(): array
343+
public static function getDescribeContainerBuilderWithPriorityTagsTestData(): array
343344
{
344345
$variations = ['priority_tag' => ['tag' => 'tag1']];
345346
$data = [];
346347
foreach (ObjectsProvider::getContainerBuildersWithPriorityTags() as $name => $object) {
347348
foreach ($variations as $suffix => $options) {
348-
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, $this->getFormat());
349+
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, static::getFormat());
349350
$description = file_get_contents(__DIR__.'/../../Fixtures/Descriptor/'.$file);
350351
$data[] = [$object, $description, $options];
351352
}

‎src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/JsonDescriptorTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@
1515

1616
class JsonDescriptorTest extends AbstractDescriptorTest
1717
{
18-
protected function getDescriptor()
18+
protected static function getDescriptor()
1919
{
2020
return new JsonDescriptor();
2121
}
2222

23-
protected function getFormat()
23+
protected static function getFormat()
2424
{
2525
return 'json';
2626
}

‎src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/MarkdownDescriptorTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@
1515

1616
class MarkdownDescriptorTest extends AbstractDescriptorTest
1717
{
18-
protected function getDescriptor()
18+
protected static function getDescriptor()
1919
{
2020
return new MarkdownDescriptor();
2121
}
2222

23-
protected function getFormat()
23+
protected static function getFormat()
2424
{
2525
return 'md';
2626
}

‎src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/TextDescriptorTest.php

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,21 @@
1717

1818
class TextDescriptorTest extends AbstractDescriptorTest
1919
{
20-
private $fileLinkFormatter = null;
20+
private static $fileLinkFormatter = null;
2121

22-
protected function getDescriptor()
22+
protected static function getDescriptor()
2323
{
24-
return new TextDescriptor($this->fileLinkFormatter);
24+
return new TextDescriptor(static::$fileLinkFormatter);
2525
}
2626

27-
protected function getFormat()
27+
protected static function getFormat()
2828
{
2929
return 'txt';
3030
}
3131

32-
public function getDescribeRouteWithControllerLinkTestData()
32+
public static function getDescribeRouteWithControllerLinkTestData()
3333
{
34-
$getDescribeData = $this->getDescribeRouteTestData();
34+
$getDescribeData = static::getDescribeRouteTestData();
3535

3636
foreach ($getDescribeData as $key => &$data) {
3737
$routeStub = $data[0];
@@ -48,7 +48,7 @@ public function getDescribeRouteWithControllerLinkTestData()
4848
/** @dataProvider getDescribeRouteWithControllerLinkTestData */
4949
public function testDescribeRouteWithControllerLink(Route $route, $expectedDescription)
5050
{
51-
$this->fileLinkFormatter = new FileLinkFormatter('myeditor://open?file=%f&line=%l');
51+
static::$fileLinkFormatter = new FileLinkFormatter('myeditor://open?file=%f&line=%l');
5252
parent::testDescribeRoute($route, str_replace('[:file:]', __FILE__, $expectedDescription));
5353
}
5454
}

‎src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/XmlDescriptorTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@
1515

1616
class XmlDescriptorTest extends AbstractDescriptorTest
1717
{
18-
protected function getDescriptor()
18+
protected static function getDescriptor()
1919
{
2020
return new XmlDescriptor();
2121
}
2222

23-
protected function getFormat()
23+
protected static function getFormat()
2424
{
2525
return 'xml';
2626
}

‎src/Symfony/Component/Asset/Tests/VersionStrategy/JsonManifestVersionStrategyTest.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -82,22 +82,22 @@ public function testRemoteManifestFileWithoutHttpClient()
8282
new JsonManifestVersionStrategy('https://cdn.example.com/manifest.json');
8383
}
8484

85-
public function provideValidStrategies()
85+
public static function provideValidStrategies(): \Generator
8686
{
87-
yield from $this->provideStrategies('manifest-valid.json');
87+
yield from static::provideStrategies('manifest-valid.json');
8888
}
8989

90-
public function provideInvalidStrategies()
90+
public static function provideInvalidStrategies(): \Generator
9191
{
92-
yield from $this->provideStrategies('manifest-invalid.json');
92+
yield from static::provideStrategies('manifest-invalid.json');
9393
}
9494

95-
public function provideMissingStrategies()
95+
public static function provideMissingStrategies(): \Generator
9696
{
97-
yield from $this->provideStrategies('non-existent-file.json');
97+
yield from static::provideStrategies('non-existent-file.json');
9898
}
9999

100-
public function provideStrategies(string $manifestPath)
100+
public static function provideStrategies(string $manifestPath): \Generator
101101
{
102102
$httpClient = new MockHttpClient(function ($method, $url, $options) {
103103
$filename = __DIR__.'/../fixtures/'.basename($url);
@@ -114,7 +114,7 @@ public function provideStrategies(string $manifestPath)
114114
yield [new JsonManifestVersionStrategy(__DIR__.'/../fixtures/'.$manifestPath)];
115115
}
116116

117-
public function provideStrictStrategies()
117+
public static function provideStrictStrategies(): \Generator
118118
{
119119
$strategy = new JsonManifestVersionStrategy(__DIR__.'/../fixtures/manifest-valid.json', null, true);
120120

0 commit comments

Comments
 (0)