Merge pull request #6 from sirbrillig/update/fix-trait-use

Do not ignore trait usage

Author: sirbrillig

ImportDetection/SniffHelpers.php

@@ -62,6 +62,9 @@ public function isPredefinedClass(File $phpcsFile, $stackPtr) {
 
 	public function getImportType(File $phpcsFile, $stackPtr): string {
 		$tokens = $phpcsFile->getTokens();
+		if (! empty($tokens[$stackPtr]['conditions'])) {
+			return 'trait-application';
+		}
 		$nextStringPtr = $phpcsFile->findNext([T_STRING], $stackPtr + 1);
 		if (! $nextStringPtr) {
 			return 'unknown';
@@ -154,7 +157,11 @@ public function isWithinNamespaceStatement(File $phpcsFile, $stackPtr): bool {
 		return !! $phpcsFile->findPrevious([T_NAMESPACE], $stackPtr - 1, $previousStatementPtr);
 	}
 
-	public function isWithinUseStatement(File $phpcsFile, $stackPtr): bool {
+	public function isWithinImportStatement(File $phpcsFile, $stackPtr): bool {
+		$tokens = $phpcsFile->getTokens();
+		if (! empty($tokens[$stackPtr]['conditions'])) {
+			return false;
+		}
 		$isClosureImport = $phpcsFile->findNext([T_OPEN_PARENTHESIS], $stackPtr + 1, $stackPtr + 5);
 		if ($isClosureImport) {
 			return false;
@@ -192,7 +199,7 @@ public function isFunctionAMethod(File $phpcsFile, $stackPtr): bool {
 
 	public function isSymbolADefinition(File $phpcsFile, Symbol $symbol): bool {
 		// if the previous non-whitespace token is const, function, class, or trait, it is a definition
-		// Note: this does not handle use statements, for that use isWithinUseStatement
+		// Note: this does not handle use statements, for that use isWithinImportStatement
 		$stackPtr = $symbol->getSymbolPosition();
 		$prevToken = $this->getPreviousNonWhitespaceToken($phpcsFile, $stackPtr) ?? [];
 		return $this->isTokenADefinition($prevToken) || $this->isWithinDefineCall($phpcsFile, $stackPtr) || $this->isWithinDeclareCall($phpcsFile, $stackPtr);

ImportDetection/Sniffs/Imports/RequireImportsSniff.php

@@ -26,60 +26,81 @@ public function process(File $phpcsFile, $stackPtr) {
 		$tokens = $phpcsFile->getTokens();
 		$token = $tokens[$stackPtr];
 		if ($token['type'] === 'T_WHITESPACE') {
+			$this->debug('found whitespace');
 			return $this->processEndOfFile($phpcsFile, $stackPtr);
 		}
 		if ($token['type'] === 'T_USE') {
+			$this->debug('found import');
 			return $this->processUse($phpcsFile, $stackPtr);
 		}
 		$symbol = $helper->getFullSymbol($phpcsFile, $stackPtr);
 		// If the symbol has been seen before (if this is a duplicate), ignore it
 		if (in_array($symbol, $this->seenSymbols)) {
+			$this->debug('found duplicate symbol ' . $symbol->getName());
 			return;
 		}
 		$this->seenSymbols[] = $symbol;
 		// If the symbol is in the ignore list, ignore it
 		if ($this->isSymbolIgnored($symbol)) {
+			$this->debug('found ignored symbol ' . $symbol->getName());
 			$this->markSymbolUsed($symbol);
 			return;
 		}
 		// If the symbol is a fully-qualified namespace, ignore it
 		if ($symbol->isAbsoluteNamespace()) {
+			$this->debug('found absolute namespaced symbol ' . $symbol->getName());
 			return;
 		}
 		// If this symbol is a definition, ignore it
 		if ($helper->isSymbolADefinition($phpcsFile, $symbol)) {
+			$this->debug('found definition symbol ' . $symbol->getName());
 			return;
 		}
 		// If this symbol is a static reference or an object reference, ignore it
 		if ($helper->isStaticReference($phpcsFile, $stackPtr) || $helper->isObjectReference($phpcsFile, $stackPtr)) {
+			$this->debug('found static symbol ' . $symbol->getName());
 			return;
 		}
 		// If this symbol is a namespace definition, ignore it
 		if ($helper->isWithinNamespaceStatement($phpcsFile, $symbol->getSymbolPosition())) {
+			$this->debug('found namespace definition symbol ' . $symbol->getName());
 			return;
 		}
 		// If this symbol is an import, ignore it
-		if ($helper->isWithinUseStatement($phpcsFile, $symbol->getSymbolPosition())) {
+		if ($helper->isWithinImportStatement($phpcsFile, $symbol->getSymbolPosition())) {
+			$this->debug('found symbol inside an import ' . $symbol->getName());
 			return;
 		}
 		// If the symbol is predefined, ignore it
 		if ($helper->isPredefinedConstant($phpcsFile, $stackPtr) || $helper->isBuiltInFunction($phpcsFile, $stackPtr)) {
+			$this->debug('found predefined symbol ' . $symbol->getName());
 			return;
 		}
 		// If this symbol is a predefined typehint, ignore it
 		if ($helper->isPredefinedTypehint($phpcsFile, $stackPtr)) {
+			$this->debug('found typehint symbol ' . $symbol->getName());
 			return;
 		}
 		// If the symbol's namespace is imported or defined, ignore it
 		// If the symbol has no namespace and is itself is imported or defined, ignore it
 		if ($this->isSymbolDefined($phpcsFile, $symbol)) {
+			$this->debug('found defined symbol ' . $symbol->getName());
 			$this->markSymbolUsed($symbol);
 			return;
 		}
 		$error = "Found unimported symbol '{$symbol->getName()}'.";
 		$phpcsFile->addWarning($error, $stackPtr, 'Symbol');
 	}
 
+	private function debug(string $message) {
+		if (! defined('PHP_CODESNIFFER_VERBOSITY')) {
+			return;
+		}
+		if (PHP_CODESNIFFER_VERBOSITY > 3) {
+			echo PHP_EOL . "RequireImportsSniff: DEBUG: $message" . PHP_EOL;
+		}
+	}
+
 	private function isSymbolIgnored(Symbol $symbol): bool {
 		$symbolName = $symbol->getName();
 		$pattern = $this->getIgnoredSymbolPattern();

phpcs.xml

@@ -33,6 +33,11 @@
 
     <!-- variables: https://github.com/sirbrillig/VariableAnalysis/ -->
     <rule ref="VariableAnalysis"/>
+    <rule ref="VariableAnalysis.CodeAnalysis.VariableAnalysis">
+        <properties>
+            <property name="allowUnusedCaughtExceptions" value="true"/>
+        </properties>
+    </rule>
     <rule ref="VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable">
         <type>error</type>
     </rule>

tests/Sniffs/Imports/RequireImportsSniffTest.php

@@ -88,4 +88,15 @@ public function testRequireImportsSniffDoesNotCountMethodNames() {
 		$expectedLines = [ 11 ];
 		$this->assertEquals($expectedLines, $lines);
 	}
+
+	public function testRequireImportsSniffCountsTraitUseAsUsage() {
+		$fixtureFile = __DIR__ . '/UsedTraitFixture.php';
+		$sniffFile = __DIR__ . '/../../../ImportDetection/Sniffs/Imports/RequireImportsSniff.php';
+		$helper = new SniffTestHelper();
+		$phpcsFile = $helper->prepareLocalFileForSniffs($sniffFile, $fixtureFile);
+		$phpcsFile->process();
+		$lines = $helper->getWarningLineNumbersFromFile($phpcsFile);
+		$expectedLines = [10];
+		$this->assertEquals($expectedLines, $lines);
+	}
 }

tests/Sniffs/Imports/UsedTraitFixture.php

@@ -0,0 +1,14 @@
+<?php
+declare(strict_types=1);
+
+namespace Services\Kitchen;
+
+use Services\Appliance;
+
+class Toaster {
+	use Appliance;
+	use UnimportedSymbol; // this should be a warning
+	public function makeToast() {
+		$this->energize();
+	}
+}