Skip to content

Commit 77a3e75

Browse files
TomasVotrubaTomasVotruba
authored
[type-declarations] Add TypedStaticPropertyInBehatContextRector (#7596)
1 parent b6117cf commit 77a3e75

9 files changed

Lines changed: 250 additions & 0 deletions

File tree

‎rules-tests/TypeDeclaration/Rector/Class_/TypedStaticPropertyInBehatContextRectorTest/Fixture/skip_non_null_default.php.inc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?php
2+
3+
namespace Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest\Fixture;
4+
5+
use Behat\Behat\Context\Context;
6+
use Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest\Source\OptionalBehatProperty;
7+
8+
final class SkipNonNullDefault implements Context
9+
{
10+
/**
11+
* @var OptionalBehatProperty
12+
*/
13+
public static $type = '';
14+
}

‎rules-tests/TypeDeclaration/Rector/Class_/TypedStaticPropertyInBehatContextRectorTest/Fixture/skip_non_static.php.inc‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<?php
2+
3+
namespace Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest\Fixture;
4+
5+
use Behat\Behat\Context\Context;
6+
use Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest\Source\OptionalBehatProperty;
7+
8+
final class SkipNonStatic implements Context
9+
{
10+
/**
11+
* @var OptionalBehatProperty
12+
*/
13+
public $type;
14+
}

‎rules-tests/TypeDeclaration/Rector/Class_/TypedStaticPropertyInBehatContextRectorTest/Fixture/some_class.php.inc‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<?php
2+
3+
namespace Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest\Fixture;
4+
5+
use Behat\Behat\Context\Context;
6+
use Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest\Source\OptionalBehatProperty;
7+
8+
final class SomeClass implements Context
9+
{
10+
/**
11+
* @var OptionalBehatProperty
12+
*/
13+
public static $type;
14+
}
15+
16+
?>
17+
-----
18+
<?php
19+
20+
namespace Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest\Fixture;
21+
22+
use Behat\Behat\Context\Context;
23+
use Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest\Source\OptionalBehatProperty;
24+
25+
final class SomeClass implements Context
26+
{
27+
public static ?\Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest\Source\OptionalBehatProperty $type = null;
28+
}
29+
30+
?>

‎rules-tests/TypeDeclaration/Rector/Class_/TypedStaticPropertyInBehatContextRectorTest/Source/OptionalBehatProperty.php‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?php
2+
3+
namespace Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest\Source;
4+
5+
final class OptionalBehatProperty
6+
{
7+
8+
}

‎rules-tests/TypeDeclaration/Rector/Class_/TypedStaticPropertyInBehatContextRectorTest/TypedStaticPropertyInBehatContextRectorTest.php‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class TypedStaticPropertyInBehatContextRectorTest extends AbstractRectorTestCase
12+
{
13+
#[DataProvider('provideData')]
14+
public function test(string $filePath): void
15+
{
16+
$this->doTestFile($filePath);
17+
}
18+
19+
public static function provideData(): Iterator
20+
{
21+
return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
22+
}
23+
24+
public function provideConfigFilePath(): string
25+
{
26+
return __DIR__ . '/config/configured_rule.php';
27+
}
28+
}

‎rules-tests/TypeDeclaration/Rector/Class_/TypedStaticPropertyInBehatContextRectorTest/config/configured_rule.php‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
use Rector\Config\RectorConfig;
6+
use Rector\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRector;
7+
8+
return static function (RectorConfig $rectorConfig): void {
9+
$rectorConfig->rules([TypedStaticPropertyInBehatContextRector::class]);
10+
};

‎rules/TypeDeclaration/Rector/Class_/TypedStaticPropertyInBehatContextRector.php‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\TypeDeclaration\Rector\Class_;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Expr;
9+
use PhpParser\Node\Name;
10+
use PhpParser\Node\Name\FullyQualified;
11+
use PhpParser\Node\NullableType;
12+
use PhpParser\Node\Stmt\Class_;
13+
use PhpParser\Node\Stmt\Property;
14+
use PHPStan\Type\ObjectType;
15+
use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
16+
use Rector\DeadCode\PhpDoc\TagRemover\VarTagRemover;
17+
use Rector\PhpParser\Node\Value\ValueResolver;
18+
use Rector\PHPUnit\Enum\BehatClassName;
19+
use Rector\Rector\AbstractRector;
20+
use Rector\StaticTypeMapper\ValueObject\Type\ShortenedObjectType;
21+
use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
22+
use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
23+
24+
/**
25+
* @see \Rector\Tests\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRectorTest\TypedStaticPropertyInBehatContextRectorTest
26+
*/
27+
final class TypedStaticPropertyInBehatContextRector extends AbstractRector
28+
{
29+
public function __construct(
30+
private readonly PhpDocInfoFactory $phpDocInfoFactory,
31+
private readonly VarTagRemover $varTagRemover,
32+
private readonly ValueResolver $valueResolver,
33+
) {
34+
}
35+
36+
public function getRuleDefinition(): RuleDefinition
37+
{
38+
return new RuleDefinition('Add known property types to Behat context static properties', [
39+
new CodeSample(
40+
<<<'CODE_SAMPLE'
41+
use Behat\Behat\Context\Context;
42+
43+
final class FeatureContext implements Context
44+
{
45+
/**
46+
* @var SomeObject
47+
*/
48+
public static $someStaticProperty;
49+
}
50+
CODE_SAMPLE
51+
,
52+
<<<'CODE_SAMPLE'
53+
use Behat\Behat\Context\Context;
54+
55+
final class FeatureContext implements Context
56+
{
57+
public static ?SomeObject $someStaticProperty = null;
58+
}
59+
CODE_SAMPLE
60+
),
61+
]);
62+
}
63+
64+
public function getNodeTypes(): array
65+
{
66+
return [Class_::class];
67+
}
68+
69+
/**
70+
* @param Class_ $node
71+
*/
72+
public function refactor(Node $node): ?Node
73+
{
74+
// no parents
75+
if (! $node->extends instanceof Name && $node->implements === []) {
76+
return null;
77+
}
78+
79+
if (! $this->isObjectType($node, new ObjectType(BehatClassName::CONTEXT))) {
80+
return null;
81+
}
82+
83+
$hasChanged = false;
84+
85+
foreach ($node->getProperties() as $property) {
86+
if ($property->type instanceof Node) {
87+
continue;
88+
}
89+
90+
if (! $property->isStatic()) {
91+
continue;
92+
}
93+
94+
if ($this->hasNonNullDefault($property)) {
95+
continue;
96+
}
97+
98+
$propertyPhpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($property);
99+
100+
$varType = $propertyPhpDocInfo->getVarType();
101+
if (! $varType instanceof ObjectType) {
102+
continue;
103+
}
104+
105+
if ($varType instanceof ShortenedObjectType) {
106+
$className = $varType->getFullyQualifiedName();
107+
} else {
108+
$className = $varType->getClassName();
109+
}
110+
111+
$property->type = new NullableType(new FullyQualified($className));
112+
113+
if (! $property->props[0]->default instanceof Node) {
114+
$property->props[0]->default = $this->nodeFactory->createNull();
115+
}
116+
117+
$this->varTagRemover->removeVarTagIfUseless($propertyPhpDocInfo, $property);
118+
$hasChanged = true;
119+
}
120+
121+
if (! $hasChanged) {
122+
return null;
123+
}
124+
125+
return $node;
126+
}
127+
128+
private function hasNonNullDefault(Property $property): bool
129+
{
130+
$soleProperty = $property->props[0];
131+
if (! $soleProperty->default instanceof Expr) {
132+
return false;
133+
}
134+
135+
return ! $this->valueResolver->isNull($soleProperty->default);
136+
}
137+
}

‎src/Config/Level/TypeDeclarationLevel.php‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use Rector\TypeDeclaration\Rector\Class_\TypedPropertyFromCreateMockAssignRector;
1717
use Rector\TypeDeclaration\Rector\Class_\TypedPropertyFromDocblockSetUpDefinedRector;
1818
use Rector\TypeDeclaration\Rector\Class_\TypedPropertyFromJMSSerializerAttributeTypeRector;
19+
use Rector\TypeDeclaration\Rector\Class_\TypedStaticPropertyInBehatContextRector;
1920
use Rector\TypeDeclaration\Rector\ClassMethod\AddMethodCallBasedStrictParamTypeRector;
2021
use Rector\TypeDeclaration\Rector\ClassMethod\AddParamFromDimFetchKeyUseRector;
2122
use Rector\TypeDeclaration\Rector\ClassMethod\AddParamStringTypeFromSprintfUseRector;
@@ -162,5 +163,6 @@ final class TypeDeclarationLevel
162163
AddArrayFunctionClosureParamTypeRector::class,
163164
TypedPropertyFromDocblockSetUpDefinedRector::class,
164165
AddClosureParamTypeFromIterableMethodCallRector::class,
166+
TypedStaticPropertyInBehatContextRector::class,
165167
];
166168
}

‎stubs/Behat/Behat/Context/Context.php‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<?php
2+
3+
namespace Behat\Behat\Context;
4+
5+
interface Context
6+
{
7+
}

0 commit comments

Comments
 (0)