[DowngradePhp83] Add DowngradeTypedClassConstRector (#213)

* [DowngradePhp83] Add DowngradeTypedClassConstRector

* cs and docs

* implemented

* trigger CI

* rename fixture

Author: samsonasik

config/set/downgrade-php83.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\ValueObject\PhpVersion;
+use Rector\DowngradePhp83\Rector\ClassConst\DowngradeTypedClassConstRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->phpVersion(PhpVersion::PHP_82);
+    $rectorConfig->rules([
+        DowngradeTypedClassConstRector::class,
+    ]);
+};

config/set/level/down-to-php81.php

@@ -3,8 +3,9 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
+use Rector\Set\ValueObject\DowngradeLevelSetList;
 use Rector\Set\ValueObject\DowngradeSetList;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->sets([DowngradeSetList::PHP_82]);
+    $rectorConfig->sets([DowngradeLevelSetList::DOWN_TO_PHP_82, DowngradeSetList::PHP_82]);
 };

config/set/level/down-to-php82.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Set\ValueObject\DowngradeSetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->sets([DowngradeSetList::PHP_83]);
+};

docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 71 Rules Overview
+# 74 Rules Overview
 
 ## ArrowFunctionToAnonymousFunctionRector
 
@@ -403,6 +403,25 @@ Changes `fread()` or `fwrite()` compare to false to negation check
 
 <br>
 
+## DowngradeHashAlgorithmXxHashRector
+
+Downgrade hash algorithm xxh32, xxh64, xxh3 or xxh128 by default to md5. You can configure the algorithm to downgrade.
+
+- class: [`Rector\DowngradePhp81\Rector\FuncCall\DowngradeHashAlgorithmXxHashRector`](../rules/DowngradePhp81/Rector/FuncCall/DowngradeHashAlgorithmXxHashRector.php)
+
+```diff
+ class SomeClass
+ {
+     public function run()
+     {
+-        return hash('xxh128', 'some-data-to-hash');
++        return hash('md5', 'some-data-to-hash');
+     }
+ }
+```
+
+<br>
+
 ## DowngradeIsCountableRector
 
 Downgrade `is_countable()` to former version
@@ -1144,6 +1163,25 @@ Add `setAccessible()` on ReflectionProperty to allow reading private properties
 
 <br>
 
+## DowngradeStandaloneNullTrueFalseReturnTypeRector
+
+Downgrade standalone return null, true, or false
+
+- class: [`Rector\DowngradePhp82\Rector\FunctionLike\DowngradeStandaloneNullTrueFalseReturnTypeRector`](../rules/DowngradePhp82/Rector/FunctionLike/DowngradeStandaloneNullTrueFalseReturnTypeRector.php)
+
+```diff
+ final class SomeClass
+ {
+-    public function run(): null
++    public function run(): mixed
+     {
+         return null;
+     }
+ }
+```
+
+<br>
+
 ## DowngradeStaticTypeDeclarationRector
 
 Remove "static" return and param type, add a `"@param` `$this"` and `"@return` `$this"` tag instead
@@ -1386,6 +1424,25 @@ Remove trailing commas in unset
 
 <br>
 
+## DowngradeTypedClassConstRector
+
+Remove typed class constant
+
+- class: [`Rector\DowngradePhp83\Rector\ClassConst\DowngradeTypedClassConstRector`](../rules/DowngradePhp83/Rector/ClassConst/DowngradeTypedClassConstRector.php)
+
+```diff
+ final class SomeClass
+ {
+-    public string FOO = 'test';
++    /**
++     * @var string
++     */
++    public FOO = 'test';
+ }
+```
+
+<br>
+
 ## DowngradeTypedPropertyRector
 
 Changes property type definition from type definitions to `@var` annotations.

rules-tests/DowngradePhp83/Rector/ClassConst/DowngradeTypedClassConstRector/DowngradeTypedClassConstRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DowngradePhp83\Rector\ClassConst\DowngradeTypedClassConstRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class DowngradeTypedClassConstRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/DowngradePhp83/Rector/ClassConst/DowngradeTypedClassConstRector/Fixture/skip_non_typed_class_const.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DowngradePhp83\Rector\ClassConst\DowngradeTypedClassConstRector;
+
+class SkipNonTypedClassConst
+{
+    public const FOO = 'foo';
+}

rules-tests/DowngradePhp83/Rector/ClassConst/DowngradeTypedClassConstRector/Fixture/typed_class_constant.php.inc

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DowngradePhp83\Rector\ClassConst\DowngradeTypedClassConstRector;
+
+class TypedClassConstant
+{
+    public const string FOO = 'foo';
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\DowngradePhp83\Rector\ClassConst\DowngradeTypedClassConstRector;
+
+class TypedClassConstant
+{
+    /**
+     * @var string
+     */
+    public const FOO = 'foo';
+}
+
+?>

rules-tests/DowngradePhp83/Rector/ClassConst/DowngradeTypedClassConstRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\DowngradePhp83\Rector\ClassConst\DowngradeTypedClassConstRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(DowngradeTypedClassConstRector::class);
+};

rules/DowngradePhp83/Rector/ClassConst/DowngradeTypedClassConstRector.php

@@ -0,0 +1,75 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\DowngradePhp83\Rector\ClassConst;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\ClassConst;
+use Rector\NodeManipulator\PropertyDecorator;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @changelog https://wiki.php.net/rfc/typed_class_constants
+ *
+ * @see \Rector\Tests\DowngradePhp83\Rector\ClassConst\DowngradeTypedClassConstRector\DowngradeTypedClassConstRectorTest
+ */
+final class DowngradeTypedClassConstRector extends AbstractRector
+{
+    public function __construct(
+        private readonly PropertyDecorator $propertyDecorator
+    ) {
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [ClassConst::class];
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Remove typed class constant',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+final class SomeClass
+{
+    public string FOO = 'test';
+}
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+final class SomeClass
+{
+    /**
+     * @var string
+     */
+    public FOO = 'test';
+}
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @param ClassConst $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if (! $node->type instanceof Node) {
+            return null;
+        }
+
+        $this->propertyDecorator->decorateWithDocBlock($node, $node->type);
+
+        $node->type = null;
+        return $node;
+    }
+}

src/NodeManipulator/PropertyDecorator.php

@@ -7,6 +7,7 @@
 use PhpParser\Node\ComplexType;
 use PhpParser\Node\Identifier;
 use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\ClassConst;
 use PhpParser\Node\Stmt\Property;
 use PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode;
 use Rector\BetterPhpDocParser\PhpDocInfo\PhpDocInfoFactory;
@@ -22,7 +23,7 @@ public function __construct(
     ) {
     }
 
-    public function decorateWithDocBlock(Property $property, ComplexType|Identifier|Name $typeNode): void
+    public function decorateWithDocBlock(Property|ClassConst $property, ComplexType|Identifier|Name $typeNode): void
     {
         $phpDocInfo = $this->phpDocInfoFactory->createFromNodeOrEmpty($property);
         if ($phpDocInfo->getVarTagValueNode() instanceof VarTagValueNode) {