[PHP8.3] add new rectors for get_class()/get_parent_class() without arguments #6405

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.

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

TomasVotruba merged 3 commits into rectorphp:main from cabbey:add-get-class-rectors

Nov 4, 2024

config/set/php83.php

-Original file line number
+Diff line change
@@ Expand Up / @@ -6,11 +6,13 @@ @@
     use Rector\Php83\Rector\ClassConst\AddTypeToConstRector;
     use Rector\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector;
     use Rector\Php83\Rector\FuncCall\CombineHostPortLdapUriRector;
+    use Rector\Php83\Rector\FuncCall\RemoveGetClassGetParentClassNoArgsRector;
     return static function (RectorConfig $rectorConfig): void {
         $rectorConfig->rules([
             AddOverrideAttributeToOverriddenMethodsRector::class,
             AddTypeToConstRector::class,
             CombineHostPortLdapUriRector::class,
+            RemoveGetClassGetParentClassNoArgsRector::class,
         ]);
     };

...ector/FuncCall/RemoveGetClassGetParentClassNoArgsRector/Fixture/fixture_get_class.php.inc

-Original file line number
+Diff line change
@@ -0,0 +1,27 @@
+    <?php
+    namespace Rector\Tests\Php83\Rector\FuncCall\RemoveGetClassGetParentClassNoArgsRector\Fixture;
+    class Fixture
+    {
+        public function test()
+        {
+            echo get_class();
+        }
+    }
+    ?>
+    -----
+    <?php
+    namespace Rector\Tests\Php83\Rector\FuncCall\RemoveGetClassGetParentClassNoArgsRector\Fixture;
+    class Fixture
+    {
+        public function test()
+        {
+            echo self::class;
+        }
+    }
+    ?>

...uncCall/RemoveGetClassGetParentClassNoArgsRector/Fixture/fixture_get_parent_class.php.inc

-Original file line number
+Diff line change
@@ -0,0 +1,27 @@
+    <?php
+    namespace Rector\Tests\Php83\Rector\FuncCall\RemoveGetClassGetParentClassNoArgsRector\Fixture;
+    class Fixture
+    {
+        public function test()
+        {
+            echo get_parent_class();
+        }
+    }
+    ?>
+    -----
+    <?php
+    namespace Rector\Tests\Php83\Rector\FuncCall\RemoveGetClassGetParentClassNoArgsRector\Fixture;
+    class Fixture
+    {
+        public function test()
+        {
+            echo parent::class;
+        }
+    }
+    ?>

...uncCall/RemoveGetClassGetParentClassNoArgsRector/Fixture/skip_different_func_call.php.inc

-Original file line number
+Diff line change
@@ -0,0 +1,11 @@
+    <?php
+    namespace Rector\Tests\Php83\Rector\FuncCall\RemoveGetClassGetParentClassNoArgsRector\Fixture;
+    class SkipDifferentFuncCall
+    {
+        public function run($a, $b)
+        {
+            return str_contains($a, $b);
+        }
+    }

...3/Rector/FuncCall/RemoveGetClassGetParentClassNoArgsRector/Fixture/skip_with_args.php.inc

-Original file line number
+Diff line change
@@ -0,0 +1,15 @@
+    <?php
+    namespace Rector\Tests\Php83\Rector\FuncCall\RemoveGetClassGetParentClassNoArgsRector\Fixture;
+    use Rector\Php83\Rector\FuncCall\RemoveGetClassGetParentClassNoArgsRector;
+    class SkipWithArgs
+    {
+        public function test()
+        {
+            $obj = new RemoveGetClassGetParentClassNoArgsRector();
+            echo get_class($obj);
+            echo get_parent_class($obj);
+        }
+    }

...RemoveGetClassGetParentClassNoArgsRector/RemoveGetClassGetParentClassNoArgsRectorTest.php

-Original file line number
+Diff line change
@@ -0,0 +1,28 @@
+    <?php
+    declare(strict_types=1);
+    namespace Rector\Tests\Php83\Rector\FuncCall\RemoveGetClassGetParentClassNoArgsRector;
+    use Iterator;
+    use PHPUnit\Framework\Attributes\DataProvider;
+    use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+    final class RemoveGetClassGetParentClassNoArgsRectorTest 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';
+        }
+    }

...Php83/Rector/FuncCall/RemoveGetClassGetParentClassNoArgsRector/config/configured_rule.php

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    <?php
+    declare(strict_types=1);
+    use Rector\Config\RectorConfig;
+    use Rector\Php83\Rector\FuncCall\RemoveGetClassGetParentClassNoArgsRector;
+    use Rector\ValueObject\PhpVersion;
+    return static function (RectorConfig $rectorConfig): void {
+        $rectorConfig->rule(RemoveGetClassGetParentClassNoArgsRector::class);
+        $rectorConfig->phpVersion(PhpVersion::PHP_83);
+    };

rules/Php83/Rector/FuncCall/RemoveGetClassGetParentClassNoArgsRector.php

-Original file line number
+Diff line change
@@ -0,0 +1,88 @@
+    <?php
+    declare(strict_types=1);
+    namespace Rector\Php83\Rector\FuncCall;
+    use PhpParser\Node;
+    use Rector\Rector\AbstractRector;
+    use Rector\ValueObject\PhpVersionFeature;
+    use Rector\VersionBonding\Contract\MinPhpVersionInterface;
+    use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+    use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+    /**
+     * @see \Rector\Tests\Php83\Rector\FuncCall\RemoveGetClassGetParentClassNoArgsRector\RemoveGetClassGetParentClassNoArgsRectorTest
+     */
+    final class RemoveGetClassGetParentClassNoArgsRector extends AbstractRector implements MinPhpVersionInterface
+    {
+        public function getRuleDefinition(): RuleDefinition
+        {
+            $r = new RuleDefinition(
+                'Replace calls to get_class() and get_parent_class() without arguments with self::class and parent::class.',
+                [
+                    new CodeSample(
+                        <<<'OLD_CODE_SAMPLE'
+                        class Example extends StdClass {
+                            public function whoAreYou() {
+                                return get_class() . ' daughter of ' . get_parent_class();
+                            }
+                        }
+                        OLD_CODE_SAMPLE
+                        ,
+                        <<<'NEW_CODE_SAMPLE'
+                        class Example extends StdClass {
+                            public function whoAreYou() {
+                                return self::class . ' daughter of ' . parent::class;
+                            }
+                        }
+                        NEW_CODE_SAMPLE
+                    ),
+                ]
+            );
+            return $r;
+        }
+        /**
+         * @return array<class-string<Node>>
+         */
+        public function getNodeTypes(): array
+        {
+            return [Node\Expr\FuncCall::class];
+        }
+        /**
+         * @param Node\Expr\FuncCall $node
+         */
+        public function refactor(Node $node): ?Node
+        {
+            if ($node->isFirstClassCallable()) {
+                return null;
+            }
+            if (count($node->getArgs()) !== 0) {
+                return null;
+            }
+            $target = null;
+            if ($this->isName($node, 'get_class')) {
+                $target = 'self';
+            }
+            if ($this->isName($node, 'get_parent_class')) {
+                $target = 'parent';
+            }
+            if ($target !== null) {
+                return new Node\Expr\ClassConstFetch(new Node\Name([$target]), new Node\VarLikeIdentifier('class'));
+            }
+            return null;
+        }
+        public function provideMinPhpVersion(): int
+        {
+            return PhpVersionFeature::DEPRECATE_GET_CLASS_WITHOUT_ARGS;
+        }
+    }

src/ValueObject/PhpVersionFeature.php

-Original file line number
+Diff line change
@@ Expand Up / @@ -689,4 +689,11 @@ final class PhpVersionFeature @@
          * @var int
          */
         public const DEPRECATE_HOST_PORT_SEPARATE_ARGS = PhpVersion::PHP_83;
+        /**
+         * @see https://www.php.net/manual/en/migration83.deprecated.php#migration83.deprecated.core.get-class
+         * @see https://php.watch/versions/8.3/get_class-get_parent_class-parameterless-deprecated
+         * @var int
+         */
+        public const DEPRECATE_GET_CLASS_WITHOUT_ARGS = PhpVersion::PHP_83;
     }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[PHP8.3] add new rectors for get_class()/get_parent_class() without arguments #6405

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!