[PHP83] Implements a rule to add types to class constants (#5290)

Co-authored-by: Tomas Votruba <tomas.vot@gmail.com>

build/target-repository/docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 351 Rules Overview
+# 353 Rules Overview
 
 <br>
 
@@ -44,7 +44,7 @@
 
 - [Php82](#php82) (4)
 
-- [Php83](#php83) (1)
+- [Php83](#php83) (2)
 
 - [Privatization](#privatization) (4)
 
@@ -5263,6 +5263,22 @@ Add override attribute to overridden methods
 
 <br>
 
+### AddTypeToConstRector
+
+Add const to type
+
+- class: [`Rector\Php83\Rector\ClassConst\AddTypeToConstRector`](../rules/Php83/Rector/ClassConst/AddTypeToConstRector.php)
+
+```diff
+ final class SomeClass
+ {
+-    public const TYPE = 'some_type';
++    public const string TYPE = 'some_type';
+ }
+```
+
+<br>
+
 ## Privatization
 
 ### FinalizeClassesWithoutChildrenRector

config/set/php83.php

@@ -3,8 +3,10 @@
 declare(strict_types=1);
 
 use Rector\Config\RectorConfig;
-use Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector;
 
 return static function (RectorConfig $rectorConfig): void {
-    $rectorConfig->rules([AddOverrideAttributeToOverriddenMethodsRector::class]);
+    $rectorConfig->rules([
+        \Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector::class,
+        \Rector\Php83\Rector\ClassConst\AddTypeToConstRector::class,
+    ]);
 };

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/AddTypeToConstRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class AddTypeToConstRectorTest 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/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/apply_type_to_class_const_when_class_final.php.inc

@@ -0,0 +1,41 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+final class ApplyTypesWhenClassFinal
+{
+    public const STRING = 'some_type';
+
+    public const INT = 1;
+
+    public const FLOAT = 1.0;
+
+    public const BOOL = true;
+
+    public const NULL = null;
+
+    public const ARRAY = [];
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+final class ApplyTypesWhenClassFinal
+{
+    public const string STRING = 'some_type';
+
+    public const int INT = 1;
+
+    public const float FLOAT = 1.0;
+
+    public const bool BOOL = true;
+
+    public const null NULL = null;
+
+    public const array ARRAY = [];
+}
+
+?>

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/apply_type_to_class_const_when_const_protected.php.inc

@@ -0,0 +1,41 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+class ApplyTypesToPrivateConsts
+{
+    private const STRING = 'some_type';
+
+    private const INT = 1;
+
+    private const FLOAT = 1.0;
+
+    private const BOOL = true;
+
+    private const NULL = null;
+
+    private const ARRAY = [];
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+class ApplyTypesToPrivateConsts
+{
+    private const string STRING = 'some_type';
+
+    private const int INT = 1;
+
+    private const float FLOAT = 1.0;
+
+    private const bool BOOL = true;
+
+    private const null NULL = null;
+
+    private const array ARRAY = [];
+}
+
+?>

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_abstract_class.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+abstract class SkipAbstractClass
+{
+    public const STRING = 'some_type';
+}
+
+?>
+

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_implementable_not_autoloaded.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+final class SkipExtendsNotAutoloadedInterfaceClass implements NotAutoloadedInterface
+{
+    public const STRING = 'some_type';
+}
+
+?>
+

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_interface_defines_const.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+use Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source\SomeInterface;
+
+final class SkipOnInterfaceImplements implements SomeInterface
+{
+    public const STRING = 'some_type';
+}
+
+?>
+

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_operations_used.php.inc

@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+final class SomeClass
+{
+    public const string A = 'A';
+
+    public const B = self::A . 'b';
+
+    public const int INT = 1;
+
+    public const INT2 = 1 + self::INT;
+}
+
+?>

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_parent_class_const_defines_type.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+use Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source\ParentClass;
+
+final class SomeClass extends ParentClass
+{
+    public const STRING_OR_INT = 'some_type';
+}
+
+?>
+

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_parent_not_autoloaded.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+final class SkipExtendsNotAutoloadedClass extends NotAutoloadedClass
+{
+    public const STRING = 'some_type';
+}
+
+?>
+

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_referencing_another_const.php.inc

@@ -0,0 +1,12 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+use Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source\ParentClass;
+
+final class SomeClass
+{
+    public const STRING = ParentClass::STRING_OR_INT;
+}
+
+?>

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_trait_defines_const.php.inc

@@ -0,0 +1,15 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+use Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source\SomeTrait;
+
+final class SkipWhenTraitDefinesInterface
+{
+    use SomeTrait;
+
+    public const STRING = 'something';
+}
+
+?>
+

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_trait_not_autoloaded.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+final class SkipExtendsNotAutoloadedClass
+{
+    use NotAutoloadedTrait;
+
+    public const STRING = 'some_type';
+}
+
+?>
+

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Fixture/skip_when_type_already_set.php.inc

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Fixture;
+
+final class SomeClass
+{
+    public const string|int string = 'A';
+}
+
+?>

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Source/ParentClass.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source;
+
+class ParentClass
+{
+    public const STRING_OR_INT = 'string';
+}

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Source/SomeInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source;
+
+interface SomeInterface
+{
+    public const STRING = 'something';
+}

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Source/SomeOtherInterface.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source;
+
+interface SomeOtherInterface
+{
+    public const STRING_ANOTHER = 'something';
+}

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/Source/SomeTrait.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassConst\AddTypeToConstRector\Source;
+
+trait SomeTrait
+{
+    public const STRING = 'something';
+}

rules-tests/Php83/Rector/ClassConst/AddTypeToConstRector/config/configured_rule.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Core\ValueObject\PhpVersion;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rule(\Rector\Php83\Rector\ClassConst\AddTypeToConstRector::class);
+
+    $rectorConfig->phpVersion(PhpVersion::PHP_83);
+};