UnusedUseStatement sniff - better recognise classes in doc-block anno…

…tations
webimpress · May 11, 2019 · aa8d6af · aa8d6af
1 parent 740631f
commit aa8d6af
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 0 deletions.
diff --git a/src/WebimpressCodingStandard/Sniffs/Namespaces/UnusedUseStatementSniff.php b/src/WebimpressCodingStandard/Sniffs/Namespaces/UnusedUseStatementSniff.php
@@ -125,6 +125,8 @@ public function process(File $phpcsFile, $stackPtr)
         while ($classUsed !== false) {
             $isStringToken = $tokens[$classUsed]['code'] === T_STRING;
 
+            $match = null;
+
             if (($isStringToken && strtolower($tokens[$classUsed]['content']) === $lowerClassName)
                 || ($tokens[$classUsed]['code'] === T_DOC_COMMENT_STRING
                     && preg_match(
@@ -136,6 +138,16 @@ public function process(File $phpcsFile, $stackPtr)
                         '/@' . preg_quote($lowerClassName, '/') . '(\(|\\\\|$)/i',
                         $tokens[$classUsed]['content']
                     ))
+                || (! $isStringToken
+                    && ! preg_match(
+                        '/"[^"]*' . preg_quote($lowerClassName, '/') . '\b[^"]*"/i',
+                        $tokens[$classUsed]['content']
+                    )
+                    && preg_match(
+                        '/(?<!")@' . preg_quote($lowerClassName, '/') . '\b/i',
+                        $tokens[$classUsed]['content'],
+                        $match
+                    ))
             ) {
                 $beforeUsage = $phpcsFile->findPrevious(
                     $isStringToken ? Tokens::$emptyTokens : $emptyTokens,
@@ -167,6 +179,10 @@ public function process(File $phpcsFile, $stackPtr)
                     ) {
                         return;
                     }
+
+                    if ($match) {
+                        return;
+                    }
                 } else {
                     return;
                 }

diff --git a/test/Sniffs/Namespaces/UnusedUseStatementUnitTest.inc b/test/Sniffs/Namespaces/UnusedUseStatementUnitTest.inc
@@ -39,6 +39,12 @@ use BarBaz\Unused14;
 use Unused15;
 use Used19;
 use Used20;
+use Used21;
+use Used22;
+use FooBar;
+use FooB;
+use Unused16;
+use Unused17;
 
 /**
  * @Used10
@@ -123,4 +129,11 @@ class Foo
         new /** hey */ Used18 \ World();
         MyClass::Unused14;
     }
+
+    /**
+     * @Used21(param=@Used22, value=@Used23, key=@FooBar, foo="@Unused16", bar="something @Unused17 bar")
+     */
+    protected function testAnnotations()
+    {
+    }
 }
diff --git a/test/Sniffs/Namespaces/UnusedUseStatementUnitTest.inc.fixed b/test/Sniffs/Namespaces/UnusedUseStatementUnitTest.inc.fixed
@@ -25,6 +25,9 @@ use FooBar\Used17;
 use FooBar\Used18;
 use Used19;
 use Used20;
+use Used21;
+use Used22;
+use FooBar;
 
 /**
  * @Used10
@@ -109,4 +112,11 @@ class Foo
         new /** hey */ Used18 \ World();
         MyClass::Unused14;
     }
+
+    /**
+     * @Used21(param=@Used22, value=@Used23, key=@FooBar, foo="@Unused16", bar="something @Unused17 bar")
+     */
+    protected function testAnnotations()
+    {
+    }
 }
diff --git a/test/Sniffs/Namespaces/UnusedUseStatementUnitTest.php b/test/Sniffs/Namespaces/UnusedUseStatementUnitTest.php
@@ -43,6 +43,9 @@ protected function getErrorList(string $testFile = '') : array
             37 => 1,
             38 => 1,
             39 => 1,
+            45 => 1,
+            46 => 1,
+            47 => 1,
         ];
     }