StringableInterfaceFixer - fix for imported from global namespace (#783)

Author: kubawerlos

README.md

@@ -3,7 +3,7 @@
 [![Latest stable version](https://img.shields.io/packagist/v/kubawerlos/php-cs-fixer-custom-fixers.svg?label=current%20version)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 [![PHP version](https://img.shields.io/packagist/php-v/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://php.net)
 [![License](https://img.shields.io/github/license/kubawerlos/php-cs-fixer-custom-fixers.svg)](LICENSE)
-![Tests](https://img.shields.io/badge/tests-3413-brightgreen.svg)
+![Tests](https://img.shields.io/badge/tests-3417-brightgreen.svg)
 [![Downloads](https://img.shields.io/packagist/dt/kubawerlos/php-cs-fixer-custom-fixers.svg)](https://packagist.org/packages/kubawerlos/php-cs-fixer-custom-fixers)
 
 [![CI Status](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/workflows/CI/badge.svg?branch=main)](https://github.com/kubawerlos/php-cs-fixer-custom-fixers/actions)

src/Fixer/StringableInterfaceFixer.php

@@ -55,11 +55,11 @@ public function isRisky(): bool
 
     public function fix(\SplFileInfo $file, Tokens $tokens): void
     {
-        $isNamespaced = false;
+        $namespaceStartIndex = null;
 
         for ($index = 1; $index < $tokens->count(); $index++) {
             if ($tokens[$index]->isGivenKind(\T_NAMESPACE)) {
-                $isNamespaced = true;
+                $namespaceStartIndex = $index;
                 continue;
             }
 
@@ -76,7 +76,7 @@ public function fix(\SplFileInfo $file, Tokens $tokens): void
                 continue;
             }
 
-            $this->addStringableInterface($tokens, $index, $isNamespaced);
+            $this->addStringableInterface($tokens, $index, $namespaceStartIndex);
         }
     }
 
@@ -101,7 +101,7 @@ private function doesHaveToStringMethod(Tokens $tokens, int $classStartIndex, in
         return false;
     }
 
-    private function addStringableInterface(Tokens $tokens, int $classIndex, bool $isNamespaced): void
+    private function addStringableInterface(Tokens $tokens, int $classIndex, ?int $namespaceStartIndex): void
     {
         $implementsIndex = $tokens->getNextTokenOfKind($classIndex, ['{', [\T_IMPLEMENTS]]);
         \assert(\is_int($implementsIndex));
@@ -126,7 +126,7 @@ private function addStringableInterface(Tokens $tokens, int $classIndex, bool $i
 
         $implementsEndIndex = $tokens->getNextTokenOfKind($implementsIndex, ['{']);
         \assert(\is_int($implementsEndIndex));
-        if ($this->isStringableAlreadyUsed($tokens, $implementsIndex + 1, $implementsEndIndex - 1, $isNamespaced)) {
+        if ($this->isStringableAlreadyUsed($tokens, $implementsIndex + 1, $implementsEndIndex - 1, $namespaceStartIndex)) {
             return;
         }
 
@@ -144,7 +144,7 @@ private function addStringableInterface(Tokens $tokens, int $classIndex, bool $i
         );
     }
 
-    private function isStringableAlreadyUsed(Tokens $tokens, int $implementsStartIndex, int $implementsEndIndex, bool $isNamespaced): bool
+    private function isStringableAlreadyUsed(Tokens $tokens, int $implementsStartIndex, int $implementsEndIndex, ?int $namespaceStartIndex): bool
     {
         for ($index = $implementsStartIndex; $index < $implementsEndIndex; $index++) {
             if (!$tokens[$index]->equals([\T_STRING, 'Stringable'], false)) {
@@ -162,9 +162,35 @@ private function isStringableAlreadyUsed(Tokens $tokens, int $implementsStartInd
                     return true;
                 }
             } else {
-                if (!$isNamespaced) {
+                if ($namespaceStartIndex === null) {
                     return true;
                 }
+                if ($this->isStringableImported($tokens, $namespaceStartIndex, $index)) {
+                    return true;
+                }
+            }
+        }
+
+        return false;
+    }
+
+    private function isStringableImported(Tokens $tokens, int $startIndex, int $endIndex): bool
+    {
+        for ($index = $startIndex; $index < $endIndex; $index++) {
+            if (!$tokens[$index]->equals([\T_STRING, 'Stringable'], false)) {
+                continue;
+            }
+
+            $useIndex = $tokens->getPrevMeaningfulToken($index);
+            \assert(\is_int($useIndex));
+
+            if ($tokens[$useIndex]->isGivenKind(\T_NS_SEPARATOR)) {
+                $useIndex = $tokens->getPrevMeaningfulToken($useIndex);
+                \assert(\is_int($useIndex));
+            }
+
+            if ($tokens[$useIndex]->isGivenKind(\T_USE)) {
+                return true;
             }
         }
 

tests/Fixer/StringableInterfaceFixerTest.php

@@ -44,6 +44,32 @@ public static function provideFixCases(): iterable
         yield ['<?php class Foo implements Stringable  { public function __toString() { return "Foo"; } }'];
         yield ['<?php class Foo implements \Stringable { public function __toString() { return "Foo"; } }'];
 
+        yield ['<?php
+            namespace Foo;
+            use Stringable;
+            class Bar implements Stringable {
+                public function __toString() { return ""; }
+            }
+        '];
+
+        yield ['<?php
+            namespace Foo;
+            use \Stringable;
+            class Bar implements Stringable {
+                public function __toString() { return ""; }
+            }
+        '];
+
+        yield ['<?php
+            namespace Foo;
+            use Bar;
+            use STRINGABLE;
+            use Baz;
+            class Qux implements Stringable {
+                public function __toString() { return ""; }
+            }
+        '];
+
         yield ['<?php class Foo {
                     public function toString() {
                     function () { return 0; };
@@ -155,6 +181,23 @@ public function __TOSTRING() { return "Foo"; }
             ',
         ];
 
+        yield [
+            '<?php
+                namespace Foo;
+                use Bar;
+                class Baz implements Stringable, \Stringable {
+                    public function __toString() { return ""; }
+                }
+            ',
+            '<?php
+                namespace Foo;
+                use Bar;
+                class Baz implements Stringable {
+                    public function __toString() { return ""; }
+                }
+            ',
+        ];
+
         yield [
             '<?php new class implements \Stringable {
                 public function __construct() {}