Add support for adding the #[Override] attribute to methods implementing interfaces (#7934)

Author: hockdudu

rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/AddToInterfaceMethodsTest.php

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

rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/Fixture/skip_countable.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Fixture;
+
+use Countable;
+
+final class SkipCountable implements Countable
+{
+    public function count(): int
+    {
+        return 0;
+    }
+}

rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/Fixture/skip_interface.php.inc

@@ -0,0 +1,13 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Fixture;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\ExampleFromInterface;
+
+final class SkipInterface implements ExampleFromInterface
+{
+    public function foo()
+    {
+        return 'implements only';
+    }
+}

rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/Fixture/skip_interface_mixed_usage.php.inc

@@ -0,0 +1,44 @@
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Fixture;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\ExampleFromAnotherInterface;
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\ExampleParentClass;
+
+final class SkipInterfaceMixedUsage extends ExampleParentClass implements ExampleFromAnotherInterface
+{
+    public function foo()
+    {
+        return 'overrides method';
+    }
+
+    public function baz()
+    {
+        return 'implements only';
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Fixture;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\ExampleFromAnotherInterface;
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\ExampleParentClass;
+
+final class SkipInterfaceMixedUsage extends ExampleParentClass implements ExampleFromAnotherInterface
+{
+    #[\Override]
+    public function foo()
+    {
+        return 'overrides method';
+    }
+
+    public function baz()
+    {
+        return 'implements only';
+    }
+}
+
+?>

…Rector/Fixture/skip_on_interface.php.inc …ure/skip_on_stringable_interface.php.incrules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/Fixture/skip_on_interface.php.inc renamed to rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/Fixture/skip_on_stringable_interface.php.inc rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/Fixture/skip_on_interface.php.inc renamed to rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/Fixture/skip_on_stringable_interface.php.inc

@@ -2,7 +2,7 @@
 
 namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Fixture;
 
-final class SkipOnInterface implements \Stringable
+final class SkipOnStringableInterface implements \Stringable
 {
     public function __toString(): string
     {

rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/FixtureAddToInterfaceMethods/extends_abstract_parent.php.inc

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\FixtureAddToInterfaceMethods;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\AbstractParentWithInterface;
+
+final class ExtendsAbstractParent extends AbstractParentWithInterface
+{
+    public function foo()
+    {
+        return true;
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\FixtureAddToInterfaceMethods;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\AbstractParentWithInterface;
+
+final class ExtendsAbstractParent extends AbstractParentWithInterface
+{
+    #[\Override]
+    public function foo()
+    {
+        return true;
+    }
+}
+
+?>

rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/FixtureAddToInterfaceMethods/implement_built_in.php.inc

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\FixtureAddToInterfaceMethods;
+
+use Countable;
+
+final class ImplementBuiltIn implements Countable
+{
+    public function count(): int
+    {
+        return 0;
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\FixtureAddToInterfaceMethods;
+
+use Countable;
+
+final class ImplementBuiltIn implements Countable
+{
+    #[\Override]
+    public function count(): int
+    {
+        return 0;
+    }
+}
+
+?>

rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/FixtureAddToInterfaceMethods/indirect_totring_override.php.inc

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\FixtureAddToInterfaceMethods;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\SomeClassImplementsToString;
+
+final class IndirectToStringOverride extends SomeClassImplementsToString
+{
+    public function __toString(): string
+    {
+        return 'hello';
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\FixtureAddToInterfaceMethods;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\SomeClassImplementsToString;
+
+final class IndirectToStringOverride extends SomeClassImplementsToString
+{
+    #[\Override]
+    public function __toString(): string
+    {
+        return 'hello';
+    }
+}
+
+?>

rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/FixtureAddToInterfaceMethods/interface_implement.php.inc

@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\FixtureAddToInterfaceMethods;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\ExampleFromInterface;
+
+final class InterfaceImplement implements ExampleFromInterface
+{
+    public function foo()
+    {
+        return true;
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\FixtureAddToInterfaceMethods;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\ExampleFromInterface;
+
+final class InterfaceImplement implements ExampleFromInterface
+{
+    #[\Override]
+    public function foo()
+    {
+        return true;
+    }
+}
+
+?>

rules-tests/Php83/Rector/ClassMethod/AddOverrideAttributeToOverriddenMethodsRector/FixtureAddToInterfaceMethods/interface_implement_multiple.php.inc

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\FixtureAddToInterfaceMethods;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\ExampleFromAnotherInterface;
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\ExampleFromInterface;
+
+final class InterfaceImplementMultiple implements ExampleFromInterface, ExampleFromAnotherInterface
+{
+    public function foo()
+    {
+        return true;
+    }
+
+    public function baz()
+    {
+        return true;
+    }
+}
+
+?>
+-----
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\FixtureAddToInterfaceMethods;
+
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\ExampleFromAnotherInterface;
+use Rector\Tests\Php83\Rector\ClassMethod\AddOverrideAttributeToOverriddenMethodsRector\Source\ExampleFromInterface;
+
+final class InterfaceImplementMultiple implements ExampleFromInterface, ExampleFromAnotherInterface
+{
+    #[\Override]
+    public function foo()
+    {
+        return true;
+    }
+
+    #[\Override]
+    public function baz()
+    {
+        return true;
+    }
+}
+
+?>