Skip to content

Commit 32eb3ee

Browse files
sirbrilligsirbrillig
authored
Merge pull request #9 from sirbrillig/update/multiple-files
Separate symbol records by file
2 parents 20bc0f4 + a0ffb0c commit 32eb3ee

File tree

7 files changed

+137
-31
lines changed

7 files changed

+137
-31
lines changed

‎ImportDetection/FileSymbolRecord.php‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
namespace ImportDetection;
4+
5+
class FileSymbolRecord {
6+
public $importedFunctions = [];
7+
public $importedConsts = [];
8+
public $importedClasses = [];
9+
public $importedSymbolRecords = [];
10+
public $seenSymbols = [];
11+
12+
public function addImportedFunctions($names) {
13+
$this->importedFunctions = array_merge($this->importedFunctions, $names);
14+
}
15+
16+
public function addImportedClasses($names) {
17+
$this->importedClasses = array_merge($this->importedClasses, $names);
18+
}
19+
20+
public function addImportedConsts($names) {
21+
$this->importedConsts = array_merge($this->importedConsts, $names);
22+
}
23+
}

‎ImportDetection/Sniffs/Imports/RequireImportsSniff.php‎

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,14 @@
55
use ImportDetection\Symbol;
66
use ImportDetection\ImportedSymbol;
77
use ImportDetection\SniffHelpers;
8+
use ImportDetection\FileSymbolRecord;
89
use PHP_CodeSniffer\Sniffs\Sniff;
910
use PHP_CodeSniffer\Files\File;
1011

1112
class RequireImportsSniff implements Sniff {
1213
public $ignoreUnimportedSymbols = null;
1314

14-
private $importedFunctions = [];
15-
private $importedConsts = [];
16-
private $importedClasses = [];
17-
private $importedSymbolRecords = [];
18-
private $seenSymbols = [];
15+
private $symbolRecordsByFile = [];
1916

2017
public function register() {
2118
return [T_USE, T_STRING, T_RETURN_TYPE, T_WHITESPACE];
@@ -25,6 +22,7 @@ public function process(File $phpcsFile, $stackPtr) {
2522
$helper = new SniffHelpers();
2623
$tokens = $phpcsFile->getTokens();
2724
$token = $tokens[$stackPtr];
25+
$this->symbolRecordsByFile[$phpcsFile->path] = $this->symbolRecordsByFile[$phpcsFile->path] ?? new FileSymbolRecord;
2826
if ($token['type'] === 'T_WHITESPACE') {
2927
$this->debug('found whitespace');
3028
return $this->processEndOfFile($phpcsFile, $stackPtr);
@@ -35,15 +33,15 @@ public function process(File $phpcsFile, $stackPtr) {
3533
}
3634
$symbol = $helper->getFullSymbol($phpcsFile, $stackPtr);
3735
// If the symbol has been seen before (if this is a duplicate), ignore it
38-
if (in_array($symbol, $this->seenSymbols)) {
36+
if (in_array($symbol, $this->symbolRecordsByFile[$phpcsFile->path]->seenSymbols)) {
3937
$this->debug('found duplicate symbol ' . $symbol->getName());
4038
return;
4139
}
42-
$this->seenSymbols[] = $symbol;
40+
$this->symbolRecordsByFile[$phpcsFile->path]->seenSymbols[] = $symbol;
4341
// If the symbol is in the ignore list, ignore it
4442
if ($this->isSymbolIgnored($symbol)) {
4543
$this->debug('found ignored symbol ' . $symbol->getName());
46-
$this->markSymbolUsed($symbol);
44+
$this->markSymbolUsed($phpcsFile, $symbol);
4745
return;
4846
}
4947
// If the symbol is a fully-qualified namespace, ignore it
@@ -85,7 +83,7 @@ public function process(File $phpcsFile, $stackPtr) {
8583
// If the symbol has no namespace and is itself is imported or defined, ignore it
8684
if ($this->isSymbolDefined($phpcsFile, $symbol)) {
8785
$this->debug('found defined symbol ' . $symbol->getName());
88-
$this->markSymbolUsed($symbol);
86+
$this->markSymbolUsed($phpcsFile, $symbol);
8987
return;
9088
}
9189
$error = "Found unimported symbol '{$symbol->getName()}'.";
@@ -130,11 +128,11 @@ private function isSymbolDefined(File $phpcsFile, Symbol $symbol): bool {
130128

131129
private function isNamespaceImportedOrDefined(File $phpcsFile, string $namespace): bool {
132130
return (
133-
$this->isClassImported($namespace)
131+
$this->isClassImported($phpcsFile, $namespace)
134132
|| $this->isClassDefined($phpcsFile, $namespace)
135-
|| $this->isFunctionImported($namespace)
133+
|| $this->isFunctionImported($phpcsFile, $namespace)
136134
|| $this->isFunctionDefined($phpcsFile, $namespace)
137-
|| $this->isConstImported($namespace)
135+
|| $this->isConstImported($phpcsFile, $namespace)
138136
|| $this->isConstDefined($phpcsFile, $namespace)
139137
);
140138
}
@@ -152,43 +150,43 @@ private function processUse(File $phpcsFile, $stackPtr) {
152150
}
153151
}
154152

155-
private function recordImportedSymbols(int $stackPtr, array $importNames) {
153+
private function recordImportedSymbols(File $phpcsFile, int $stackPtr, array $importNames) {
156154
foreach ($importNames as $symbol) {
157-
$this->importedSymbolRecords[] = new ImportedSymbol($stackPtr, $symbol);
155+
$this->symbolRecordsByFile[$phpcsFile->path]->importedSymbolRecords[] = new ImportedSymbol($stackPtr, $symbol);
158156
}
159157
}
160158

161159
private function saveFunctionImport(File $phpcsFile, $stackPtr) {
162160
$helper = new SniffHelpers();
163161
$importNames = $helper->getImportNames($phpcsFile, $stackPtr);
164-
$this->recordImportedSymbols($stackPtr, $importNames);
165-
$this->importedFunctions = array_merge($this->importedFunctions, $importNames);
162+
$this->recordImportedSymbols($phpcsFile, $stackPtr, $importNames);
163+
$this->symbolRecordsByFile[$phpcsFile->path]->addImportedFunctions($importNames);
166164
}
167165

168166
private function saveConstImport(File $phpcsFile, $stackPtr) {
169167
$helper = new SniffHelpers();
170168
$importNames = $helper->getImportNames($phpcsFile, $stackPtr);
171-
$this->recordImportedSymbols($stackPtr, $importNames);
172-
$this->importedConsts = array_merge($this->importedConsts, $importNames);
169+
$this->recordImportedSymbols($phpcsFile, $stackPtr, $importNames);
170+
$this->symbolRecordsByFile[$phpcsFile->path]->addImportedConsts($importNames);
173171
}
174172

175173
private function saveClassImport(File $phpcsFile, $stackPtr) {
176174
$helper = new SniffHelpers();
177175
$importNames = $helper->getImportNames($phpcsFile, $stackPtr);
178-
$this->recordImportedSymbols($stackPtr, $importNames);
179-
$this->importedClasses = array_merge($this->importedClasses, $importNames);
176+
$this->recordImportedSymbols($phpcsFile, $stackPtr, $importNames);
177+
$this->symbolRecordsByFile[$phpcsFile->path]->addImportedClasses($importNames);
180178
}
181179

182-
private function isFunctionImported(string $functionName): bool {
183-
return in_array($functionName, $this->importedFunctions);
180+
private function isFunctionImported(File $phpcsFile, string $functionName): bool {
181+
return in_array($functionName, $this->symbolRecordsByFile[$phpcsFile->path]->importedFunctions);
184182
}
185183

186-
private function isConstImported(string $constName): bool {
187-
return in_array($constName, $this->importedConsts);
184+
private function isConstImported(File $phpcsFile, string $constName): bool {
185+
return in_array($constName, $this->symbolRecordsByFile[$phpcsFile->path]->importedConsts);
188186
}
189187

190-
private function isClassImported(string $name): bool {
191-
return in_array($name, $this->importedClasses);
188+
private function isClassImported(File $phpcsFile, string $name): bool {
189+
return in_array($name, $this->symbolRecordsByFile[$phpcsFile->path]->importedClasses);
192190
}
193191

194192
private function isClassDefined(File $phpcsFile, string $className): bool {
@@ -229,16 +227,16 @@ private function isConstDefined(File $phpcsFile, string $functionName): bool {
229227
return false;
230228
}
231229

232-
private function markSymbolUsed(Symbol $symbol) {
233-
$record = $this->getSymbolRecord($symbol);
230+
private function markSymbolUsed(File $phpcsFile, Symbol $symbol) {
231+
$record = $this->getSymbolRecord($phpcsFile, $symbol);
234232
if (! $record) {
235233
return;
236234
}
237235
$record->markUsed();
238236
}
239237

240-
private function getSymbolRecord(Symbol $symbol) {
241-
foreach ($this->importedSymbolRecords as $record) {
238+
private function getSymbolRecord(File $phpcsFile, Symbol $symbol) {
239+
foreach ($this->symbolRecordsByFile[$phpcsFile->path]->importedSymbolRecords as $record) {
242240
if ($record->getName() === $symbol->getTopLevelNamespace()) {
243241
return $record;
244242
}
@@ -253,7 +251,7 @@ private function processEndOfFile(File $phpcsFile, int $stackPtr) {
253251
return;
254252
}
255253
// For each import, if the Symbol was not used, mark a warning
256-
foreach ($this->importedSymbolRecords as $record) {
254+
foreach ($this->symbolRecordsByFile[$phpcsFile->path]->importedSymbolRecords as $record) {
257255
if (! $record->isUsed()) {
258256
$error = "Found unused symbol '{$record->getName()}'.";
259257
$phpcsFile->addWarning($error, $record->getPtr(), 'Import');

‎phpcs.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,7 @@
4141
<rule ref="VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable">
4242
<type>error</type>
4343
</rule>
44+
<rule ref="Generic.Files.LineLength.TooLong">
45+
<severity>0</severity>
46+
</rule>
4447
</ruleset>

‎tests/SniffTestHelper.php‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
namespace ImportDetectionTest;
55

66
use PHP_CodeSniffer\Files\LocalFile;
7+
use PHP_CodeSniffer\Files\FileList;
78
use PHP_CodeSniffer\Ruleset;
89
use PHP_CodeSniffer\Config;
910

@@ -22,12 +23,53 @@ public function prepareLocalFileForSniffs($sniffFiles, string $fixtureFile): Loc
2223
return new LocalFile($fixtureFile, $ruleset, $config);
2324
}
2425

26+
public function prepareLocalFilesForSniffs($sniffFiles, $fixtureFiles): FileList {
27+
$config = new Config();
28+
if (! is_array($fixtureFiles)) {
29+
$fixtureFiles = [$fixtureFiles];
30+
}
31+
$config->files = $fixtureFiles;
32+
$ruleset = new Ruleset($config);
33+
if (! is_array($sniffFiles)) {
34+
$sniffFiles = [$sniffFiles];
35+
}
36+
$ruleset->registerSniffs($sniffFiles, [], []);
37+
$ruleset->populateTokenListeners();
38+
return new FileList($config, $ruleset);
39+
}
40+
41+
public function processFiles($sniffFiles) {
42+
foreach ($sniffFiles as $phpcsFile) {
43+
if (! file_exists($phpcsFile->path)) {
44+
throw new \Exception('Fixture file does not exist! ' . $phpcsFile->path);
45+
}
46+
$phpcsFile->process();
47+
}
48+
}
49+
2550
public function getLineNumbersFromMessages(array $messages): array {
2651
$lines = array_keys($messages);
2752
sort($lines);
2853
return $lines;
2954
}
3055

56+
public function getNoticesFromFiles($phpcsFiles, string $noticeType): array {
57+
$noticesByFile = [];
58+
foreach ($phpcsFiles as $phpcsFile) {
59+
switch ($noticeType) {
60+
case 'warning':
61+
$noticesByFile[$phpcsFile->path] = $this->getLineNumbersFromMessages($phpcsFile->getWarnings());
62+
break;
63+
case 'error':
64+
$noticesByFile[$phpcsFile->path] = $this->getLineNumbersFromMessages($phpcsFile->getErrors());
65+
break;
66+
default:
67+
throw new \Exception("Invalid notice type '{$noticeType}'");
68+
}
69+
}
70+
return $noticesByFile;
71+
}
72+
3173
public function getWarningLineNumbersFromFile(LocalFile $phpcsFile): array {
3274
return $this->getLineNumbersFromMessages($phpcsFile->getWarnings());
3375
}

‎tests/Sniffs/Imports/MultipleFilesFixtures/MultipleFilesFixtures1.php‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?php
2+
3+
namespace MyNamespace;
4+
5+
use MyNamespace\Sub\Bar;
6+
7+
class Foo {
8+
}
9+
10+
function doAThing() {
11+
}

‎tests/Sniffs/Imports/MultipleFilesFixtures/MultipleFilesFixtures2.php‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?php
2+
3+
namespace MyNamespace;
4+
5+
class Foo {
6+
}
7+
8+
function doAThing() {
9+
executeCommand();
10+
}

‎tests/Sniffs/Imports/RequireImportsSniffTest.php‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,23 @@ public function testRequireImportsSniffCountsTraitUseAsUsage() {
9999
$expectedLines = [10];
100100
$this->assertEquals($expectedLines, $lines);
101101
}
102+
103+
public function testRequireImportsDoesNotBleedToMultipleFiles() {
104+
$fixtureFile = __DIR__ . '/MultipleFilesFixtures';
105+
$sniffFile = __DIR__ . '/../../../ImportDetection/Sniffs/Imports/RequireImportsSniff.php';
106+
$helper = new SniffTestHelper();
107+
$phpcsFiles = $helper->prepareLocalFilesForSniffs($sniffFile, $fixtureFile);
108+
// Unclear why this works, but if I run this twice the first fixture file
109+
// gets all its warnings cleared (and the other fixture file has the same
110+
// warning twice).
111+
$helper->processFiles($phpcsFiles);
112+
$helper->processFiles($phpcsFiles);
113+
$linesByFile = $helper->getNoticesFromFiles($phpcsFiles, 'warning');
114+
$expectedLines = [
115+
// The runner runs 'MultipleFilesFixtures2' first.
116+
__DIR__ . '/MultipleFilesFixtures/MultipleFilesFixtures2.php' => [],
117+
__DIR__ . '/MultipleFilesFixtures/MultipleFilesFixtures1.php' => [5],
118+
];
119+
$this->assertEquals($expectedLines, $linesByFile);
120+
}
102121
}

0 commit comments

Comments
 (0)