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

Skip to content

[Tests] New iteration of removing $this occurrences in future static data providers #48988

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 1, 2023
Merged

[Tests] New iteration of removing $this occurrences in future static data providers #48988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 40 additions & 39 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/AbstractDescriptorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ public function testDescribeRouteCollection(RouteCollection $routes, $expectedDe
$this->assertDescription($expectedDescription, $routes);
}

public function getDescribeRouteCollectionTestData()
public static function getDescribeRouteCollectionTestData(): array
{
return $this->getDescriptionTestData(ObjectsProvider::getRouteCollections());
return static::getDescriptionTestData(ObjectsProvider::getRouteCollections());
}

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

public function getDescribeRouteTestData()
public static function getDescribeRouteTestData(): array
{
return $this->getDescriptionTestData(ObjectsProvider::getRoutes());
return static::getDescriptionTestData(ObjectsProvider::getRoutes());
}

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

public function getDescribeContainerParametersTestData()
public static function getDescribeContainerParametersTestData(): array
{
return $this->getDescriptionTestData(ObjectsProvider::getContainerParameters());
return static::getDescriptionTestData(ObjectsProvider::getContainerParameters());
}

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

public function getDescribeContainerBuilderTestData()
public static function getDescribeContainerBuilderTestData(): array
{
return $this->getContainerBuilderDescriptionTestData(ObjectsProvider::getContainerBuilders());
return static::getContainerBuilderDescriptionTestData(ObjectsProvider::getContainerBuilders());
}

/**
Expand All @@ -91,9 +91,9 @@ public function testDescribeContainerExistingClassDefinition(Definition $definit
$this->assertDescription($expectedDescription, $definition);
}

public function getDescribeContainerExistingClassDefinitionTestData()
public static function getDescribeContainerExistingClassDefinitionTestData(): array
{
return $this->getDescriptionTestData(ObjectsProvider::getContainerDefinitionsWithExistingClasses());
return static::getDescriptionTestData(ObjectsProvider::getContainerDefinitionsWithExistingClasses());
}

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

public function getDescribeContainerDefinitionTestData()
public static function getDescribeContainerDefinitionTestData(): array
{
return $this->getDescriptionTestData(ObjectsProvider::getContainerDefinitions());
return static::getDescriptionTestData(ObjectsProvider::getContainerDefinitions());
}

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

public function getDescribeContainerDefinitionWithArgumentsShownTestData()
public static function getDescribeContainerDefinitionWithArgumentsShownTestData(): array
{
$definitions = ObjectsProvider::getContainerDefinitions();
$definitionsWithArgs = [];
Expand All @@ -126,7 +126,7 @@ public function getDescribeContainerDefinitionWithArgumentsShownTestData()
$definitionsWithArgs['definition_arguments_with_enum'] = (new Definition('definition_with_enum'))->setArgument(0, FooUnitEnum::FOO);
}

return $this->getDescriptionTestData($definitionsWithArgs);
return static::getDescriptionTestData($definitionsWithArgs);
}

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

public function getDescribeContainerAliasTestData()
public static function getDescribeContainerAliasTestData(): array
{
return $this->getDescriptionTestData(ObjectsProvider::getContainerAliases());
return static::getDescriptionTestData(ObjectsProvider::getContainerAliases());
}

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

public function getDescribeContainerDefinitionWhichIsAnAliasTestData()
public static function getDescribeContainerDefinitionWhichIsAnAliasTestData(): array
{
$builder = current(ObjectsProvider::getContainerBuilders());
$builder->setDefinition('service_1', $builder->getDefinition('definition_1'));
Expand All @@ -159,7 +159,7 @@ public function getDescribeContainerDefinitionWhichIsAnAliasTestData()
}

$i = 0;
$data = $this->getDescriptionTestData($aliasesWithDefinitions);
$data = static::getDescriptionTestData($aliasesWithDefinitions);
foreach ($aliases as $name => $alias) {
$file = array_pop($data[$i]);
$data[$i][] = $builder;
Expand All @@ -177,9 +177,9 @@ public function testDescribeContainerParameter($parameter, $expectedDescription,
$this->assertDescription($expectedDescription, $parameter, $options);
}

public function getDescribeContainerParameterTestData()
public static function getDescribeContainerParameterTestData(): array
{
$data = $this->getDescriptionTestData(ObjectsProvider::getContainerParameter());
$data = static::getDescriptionTestData(ObjectsProvider::getContainerParameter());

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

public function getDescribeEventDispatcherTestData()
public static function getDescribeEventDispatcherTestData(): array
{
return $this->getEventDispatcherDescriptionTestData(ObjectsProvider::getEventDispatchers());
return static::getEventDispatcherDescriptionTestData(ObjectsProvider::getEventDispatchers());
}

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

public function getDescribeCallableTestData(): array
public static function getDescribeCallableTestData(): array
{
return $this->getDescriptionTestData(ObjectsProvider::getCallables());
return static::getDescriptionTestData(ObjectsProvider::getCallables());
}

/**
* @group legacy
*
* @dataProvider getDescribeDeprecatedCallableTestData
*/
public function testDescribeDeprecatedCallable($callable, $expectedDescription)
{
$this->assertDescription($expectedDescription, $callable);
}

public function getDescribeDeprecatedCallableTestData(): array
public static function getDescribeDeprecatedCallableTestData(): array
{
return $this->getDescriptionTestData(ObjectsProvider::getDeprecatedCallables());
return static::getDescriptionTestData(ObjectsProvider::getDeprecatedCallables());
}

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

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

public function getDeprecationsTestData()
public static function getDeprecationsTestData(): array
{
return $this->getDescriptionTestData(ObjectsProvider::getContainerDeprecations());
return static::getDescriptionTestData(ObjectsProvider::getContainerDeprecations());
}

abstract protected function getDescriptor();
abstract protected static function getDescriptor();

abstract protected function getFormat();
abstract protected static function getFormat();

private function assertDescription($expectedDescription, $describedObject, array $options = [])
{
Expand All @@ -280,19 +281,19 @@ private function assertDescription($expectedDescription, $describedObject, array
}
}

private function getDescriptionTestData(iterable $objects)
private static function getDescriptionTestData(iterable $objects): array
{
$data = [];
foreach ($objects as $name => $object) {
$file = sprintf('%s.%s', trim($name, '.'), $this->getFormat());
$file = sprintf('%s.%s', trim($name, '.'), static::getFormat());
$description = file_get_contents(__DIR__.'/../../Fixtures/Descriptor/'.$file);
$data[] = [$object, $description, $file];
}

return $data;
}

private function getContainerBuilderDescriptionTestData(array $objects)
private static function getContainerBuilderDescriptionTestData(array $objects): array
{
$variations = [
'services' => ['show_hidden' => true],
Expand All @@ -305,7 +306,7 @@ private function getContainerBuilderDescriptionTestData(array $objects)
$data = [];
foreach ($objects as $name => $object) {
foreach ($variations as $suffix => $options) {
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, $this->getFormat());
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, static::getFormat());
$description = file_get_contents(__DIR__.'/../../Fixtures/Descriptor/'.$file);
$data[] = [$object, $description, $options, $file];
}
Expand All @@ -314,7 +315,7 @@ private function getContainerBuilderDescriptionTestData(array $objects)
return $data;
}

private function getEventDispatcherDescriptionTestData(array $objects)
private static function getEventDispatcherDescriptionTestData(array $objects): array
{
$variations = [
'events' => [],
Expand All @@ -324,7 +325,7 @@ private function getEventDispatcherDescriptionTestData(array $objects)
$data = [];
foreach ($objects as $name => $object) {
foreach ($variations as $suffix => $options) {
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, $this->getFormat());
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, static::getFormat());
$description = file_get_contents(__DIR__.'/../../Fixtures/Descriptor/'.$file);
$data[] = [$object, $description, $options, $file];
}
Expand All @@ -339,13 +340,13 @@ public function testDescribeContainerBuilderWithPriorityTags(ContainerBuilder $b
$this->assertDescription($expectedDescription, $builder, $options);
}

public function getDescribeContainerBuilderWithPriorityTagsTestData(): array
public static function getDescribeContainerBuilderWithPriorityTagsTestData(): array
{
$variations = ['priority_tag' => ['tag' => 'tag1']];
$data = [];
foreach (ObjectsProvider::getContainerBuildersWithPriorityTags() as $name => $object) {
foreach ($variations as $suffix => $options) {
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, $this->getFormat());
$file = sprintf('%s_%s.%s', trim($name, '.'), $suffix, static::getFormat());
$description = file_get_contents(__DIR__.'/../../Fixtures/Descriptor/'.$file);
$data[] = [$object, $description, $options];
}
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/JsonDescriptorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@

class JsonDescriptorTest extends AbstractDescriptorTest
{
protected function getDescriptor()
protected static function getDescriptor()
{
return new JsonDescriptor();
}

protected function getFormat()
protected static function getFormat()
{
return 'json';
}
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/MarkdownDescriptorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@

class MarkdownDescriptorTest extends AbstractDescriptorTest
{
protected function getDescriptor()
protected static function getDescriptor()
{
return new MarkdownDescriptor();
}

protected function getFormat()
protected static function getFormat()
{
return 'md';
}
Expand Down
14 changes: 7 additions & 7 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/TextDescriptorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,21 @@

class TextDescriptorTest extends AbstractDescriptorTest
{
private $fileLinkFormatter = null;
private static $fileLinkFormatter = null;

protected function getDescriptor()
protected static function getDescriptor()
{
return new TextDescriptor($this->fileLinkFormatter);
return new TextDescriptor(static::$fileLinkFormatter);
}

protected function getFormat()
protected static function getFormat()
{
return 'txt';
}

public function getDescribeRouteWithControllerLinkTestData()
public static function getDescribeRouteWithControllerLinkTestData()
{
$getDescribeData = $this->getDescribeRouteTestData();
$getDescribeData = static::getDescribeRouteTestData();

foreach ($getDescribeData as $key => &$data) {
$routeStub = $data[0];
Expand All @@ -48,7 +48,7 @@ public function getDescribeRouteWithControllerLinkTestData()
/** @dataProvider getDescribeRouteWithControllerLinkTestData */
public function testDescribeRouteWithControllerLink(Route $route, $expectedDescription)
{
$this->fileLinkFormatter = new FileLinkFormatter('myeditor://open?file=%f&line=%l');
static::$fileLinkFormatter = new FileLinkFormatter('myeditor://open?file=%f&line=%l');
parent::testDescribeRoute($route, str_replace('[:file:]', __FILE__, $expectedDescription));
}
}
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/XmlDescriptorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,12 @@

class XmlDescriptorTest extends AbstractDescriptorTest
{
protected function getDescriptor()
protected static function getDescriptor()
{
return new XmlDescriptor();
}

protected function getFormat()
protected static function getFormat()
{
return 'xml';
}
Expand Down
16 changes: 8 additions & 8 deletions src/Symfony/Component/Asset/Tests/VersionStrategy/JsonManifestVersionStrategyTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,22 +82,22 @@ public function testRemoteManifestFileWithoutHttpClient()
new JsonManifestVersionStrategy('https://cdn.example.com/manifest.json');
}

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

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

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

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

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

Expand Down
Loading