Skip to content

Commit e048c90

Browse files
jrfnljrfnl
authored
PHPCS: enforce tab indentation (sirbrillig#254)
The PHPCS ruleset as it was, didn't enforce space nor tab indentation. After discussion with sirbrillig, it became clear that tab indentation is preferred. This commit adjusts the ruleset to enforce tab indentation and updates all files to use tabs instead of spaces for indentation. Co-authored-by: jrfnl <jrfnl@users.noreply.github.com>
1 parent 156490d commit e048c90

19 files changed

+4780
-4786
lines changed

‎Tests/BaseTestCase.php

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -7,41 +7,41 @@
77
use PHP_CodeSniffer\Config;
88

99
class BaseTestCase extends TestCase {
10-
const STANDARD_NAME = 'VariableAnalysis';
11-
12-
public function prepareLocalFileForSniffs($fixtureFile) {
13-
$sniffFile = __DIR__ . '/../VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php';
14-
15-
$config = new Config();
16-
$config->cache = false;
17-
$config->standards = [self::STANDARD_NAME];
18-
$config->ignored = [];
19-
20-
$sniffFiles = [realpath($sniffFile)];
21-
$ruleset = new Ruleset($config);
22-
$ruleset->registerSniffs($sniffFiles, [], []);
23-
$ruleset->populateTokenListeners();
24-
if (! file_exists($fixtureFile)) {
25-
throw new \Exception('Fixture file does not exist: ' . $fixtureFile);
26-
}
27-
return new LocalFile($fixtureFile, $ruleset, $config);
28-
}
29-
30-
public function getLineNumbersFromMessages(array $messages) {
31-
$lines = array_keys($messages);
32-
sort($lines);
33-
return $lines;
34-
}
35-
36-
public function getWarningLineNumbersFromFile(LocalFile $phpcsFile) {
37-
return $this->getLineNumbersFromMessages($phpcsFile->getWarnings());
38-
}
39-
40-
public function getErrorLineNumbersFromFile(LocalFile $phpcsFile) {
41-
return $this->getLineNumbersFromMessages($phpcsFile->getErrors());
42-
}
43-
44-
public function getFixture($fixtureFilename) {
45-
return realpath(__DIR__ . '/VariableAnalysisSniff/fixtures/' . $fixtureFilename);
46-
}
10+
const STANDARD_NAME = 'VariableAnalysis';
11+
12+
public function prepareLocalFileForSniffs($fixtureFile) {
13+
$sniffFile = __DIR__ . '/../VariableAnalysis/Sniffs/CodeAnalysis/VariableAnalysisSniff.php';
14+
15+
$config = new Config();
16+
$config->cache = false;
17+
$config->standards = [self::STANDARD_NAME];
18+
$config->ignored = [];
19+
20+
$sniffFiles = [realpath($sniffFile)];
21+
$ruleset = new Ruleset($config);
22+
$ruleset->registerSniffs($sniffFiles, [], []);
23+
$ruleset->populateTokenListeners();
24+
if (! file_exists($fixtureFile)) {
25+
throw new \Exception('Fixture file does not exist: ' . $fixtureFile);
26+
}
27+
return new LocalFile($fixtureFile, $ruleset, $config);
28+
}
29+
30+
public function getLineNumbersFromMessages(array $messages) {
31+
$lines = array_keys($messages);
32+
sort($lines);
33+
return $lines;
34+
}
35+
36+
public function getWarningLineNumbersFromFile(LocalFile $phpcsFile) {
37+
return $this->getLineNumbersFromMessages($phpcsFile->getWarnings());
38+
}
39+
40+
public function getErrorLineNumbersFromFile(LocalFile $phpcsFile) {
41+
return $this->getLineNumbersFromMessages($phpcsFile->getErrors());
42+
}
43+
44+
public function getFixture($fixtureFilename) {
45+
return realpath(__DIR__ . '/VariableAnalysisSniff/fixtures/' . $fixtureFilename);
46+
}
4747
}

‎Tests/VariableAnalysisSniff/ArrayAssignmentShortcutTest.php

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@
44
use VariableAnalysis\Tests\BaseTestCase;
55

66
class ArrayAssignmentShortcutTest extends BaseTestCase {
7-
public function testArrayAssignmentReportsCorrectLines() {
8-
$fixtureFile = $this->getFixture('ArrayAssignmentShortcutFixture.php');
9-
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
10-
$phpcsFile->process();
7+
public function testArrayAssignmentReportsCorrectLines() {
8+
$fixtureFile = $this->getFixture('ArrayAssignmentShortcutFixture.php');
9+
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
10+
$phpcsFile->process();
1111

12-
$lines = $this->getWarningLineNumbersFromFile($phpcsFile);
13-
$expectedWarnings = [
14-
21,
15-
27,
16-
28,
17-
29,
18-
];
19-
$this->assertSame($expectedWarnings, $lines);
20-
}
12+
$lines = $this->getWarningLineNumbersFromFile($phpcsFile);
13+
$expectedWarnings = [
14+
21,
15+
27,
16+
28,
17+
29,
18+
];
19+
$this->assertSame($expectedWarnings, $lines);
20+
}
2121

22-
public function testArrayAssignmentHasCorrectSniffCodes() {
23-
$fixtureFile = $this->getFixture('ArrayAssignmentShortcutFixture.php');
24-
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
25-
$phpcsFile->process();
22+
public function testArrayAssignmentHasCorrectSniffCodes() {
23+
$fixtureFile = $this->getFixture('ArrayAssignmentShortcutFixture.php');
24+
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
25+
$phpcsFile->process();
2626

27-
$warnings = $phpcsFile->getWarnings();
28-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[21][5][0]['source']);
29-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[27][5][0]['source']);
30-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[28][5][0]['source']);
31-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[29][10][0]['source']);
32-
}
27+
$warnings = $phpcsFile->getWarnings();
28+
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[21][5][0]['source']);
29+
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[27][5][0]['source']);
30+
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[28][5][0]['source']);
31+
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[29][10][0]['source']);
32+
}
3333
}

‎Tests/VariableAnalysisSniff/ArrowFunctionTest.php

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -4,57 +4,57 @@
44
use VariableAnalysis\Tests\BaseTestCase;
55

66
class ArrowFunctionTest extends BaseTestCase {
7-
public function testArrowFunctions() {
8-
$fixtureFile = $this->getFixture('ArrowFunctionFixture.php');
9-
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
10-
$phpcsFile->ruleset->setSniffProperty(
11-
'VariableAnalysis\Sniffs\CodeAnalysis\VariableAnalysisSniff',
12-
'allowUnusedParametersBeforeUsed',
13-
'true'
14-
);
15-
$phpcsFile->process();
16-
$lines = $this->getWarningLineNumbersFromFile($phpcsFile);
17-
$expectedWarnings = [
18-
9,
19-
14,
20-
19,
21-
24,
22-
30,
23-
34,
24-
51,
25-
57,
26-
61,
27-
67,
28-
71,
29-
];
30-
$this->assertSame($expectedWarnings, $lines);
31-
}
7+
public function testArrowFunctions() {
8+
$fixtureFile = $this->getFixture('ArrowFunctionFixture.php');
9+
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
10+
$phpcsFile->ruleset->setSniffProperty(
11+
'VariableAnalysis\Sniffs\CodeAnalysis\VariableAnalysisSniff',
12+
'allowUnusedParametersBeforeUsed',
13+
'true'
14+
);
15+
$phpcsFile->process();
16+
$lines = $this->getWarningLineNumbersFromFile($phpcsFile);
17+
$expectedWarnings = [
18+
9,
19+
14,
20+
19,
21+
24,
22+
30,
23+
34,
24+
51,
25+
57,
26+
61,
27+
67,
28+
71,
29+
];
30+
$this->assertSame($expectedWarnings, $lines);
31+
}
3232

33-
public function testArrowFunctionsWithoutUnusedBeforeUsed() {
34-
$fixtureFile = $this->getFixture('ArrowFunctionFixture.php');
35-
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
36-
$phpcsFile->ruleset->setSniffProperty(
37-
'VariableAnalysis\Sniffs\CodeAnalysis\VariableAnalysisSniff',
38-
'allowUnusedParametersBeforeUsed',
39-
'false'
40-
);
41-
$phpcsFile->process();
42-
$lines = $this->getWarningLineNumbersFromFile($phpcsFile);
43-
$expectedWarnings = [
44-
9,
45-
14,
46-
19,
47-
24,
48-
30,
49-
34,
50-
39,
51-
51,
52-
57,
53-
61,
54-
63,
55-
67,
56-
71,
57-
];
58-
$this->assertSame($expectedWarnings, $lines);
59-
}
33+
public function testArrowFunctionsWithoutUnusedBeforeUsed() {
34+
$fixtureFile = $this->getFixture('ArrowFunctionFixture.php');
35+
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
36+
$phpcsFile->ruleset->setSniffProperty(
37+
'VariableAnalysis\Sniffs\CodeAnalysis\VariableAnalysisSniff',
38+
'allowUnusedParametersBeforeUsed',
39+
'false'
40+
);
41+
$phpcsFile->process();
42+
$lines = $this->getWarningLineNumbersFromFile($phpcsFile);
43+
$expectedWarnings = [
44+
9,
45+
14,
46+
19,
47+
24,
48+
30,
49+
34,
50+
39,
51+
51,
52+
57,
53+
61,
54+
63,
55+
67,
56+
71,
57+
];
58+
$this->assertSame($expectedWarnings, $lines);
59+
}
6060
}

‎Tests/VariableAnalysisSniff/ClosingPhpTagsTest.php

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,28 @@
44
use VariableAnalysis\Tests\BaseTestCase;
55

66
class ClosingPhpTagsTest extends BaseTestCase {
7-
public function testVariableWarningsWhenClosingTagsAreUsed() {
8-
$fixtureFile = $this->getFixture('ClosingPhpTagsFixture.php');
9-
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
10-
$phpcsFile->process();
11-
$lines = $this->getWarningLineNumbersFromFile($phpcsFile);
12-
$expectedWarnings = [
13-
6,
14-
8,
15-
13,
16-
16,
17-
];
18-
$this->assertSame($expectedWarnings, $lines);
19-
}
7+
public function testVariableWarningsWhenClosingTagsAreUsed() {
8+
$fixtureFile = $this->getFixture('ClosingPhpTagsFixture.php');
9+
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
10+
$phpcsFile->process();
11+
$lines = $this->getWarningLineNumbersFromFile($phpcsFile);
12+
$expectedWarnings = [
13+
6,
14+
8,
15+
13,
16+
16,
17+
];
18+
$this->assertSame($expectedWarnings, $lines);
19+
}
2020

21-
public function testVariableWarningsHaveCorrectSniffCodesWhenClosingTagsAreUsed() {
22-
$fixtureFile = $this->getFixture('ClosingPhpTagsFixture.php');
23-
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
24-
$phpcsFile->process();
25-
$warnings = $phpcsFile->getWarnings();
26-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[6][1][0]['source']);
27-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[8][6][0]['source']);
28-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[13][1][0]['source']);
29-
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[16][6][0]['source']);
30-
}
21+
public function testVariableWarningsHaveCorrectSniffCodesWhenClosingTagsAreUsed() {
22+
$fixtureFile = $this->getFixture('ClosingPhpTagsFixture.php');
23+
$phpcsFile = $this->prepareLocalFileForSniffs($fixtureFile);
24+
$phpcsFile->process();
25+
$warnings = $phpcsFile->getWarnings();
26+
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[6][1][0]['source']);
27+
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[8][6][0]['source']);
28+
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable', $warnings[13][1][0]['source']);
29+
$this->assertSame('VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable', $warnings[16][6][0]['source']);
30+
}
3131
}

0 commit comments

Comments
 (0)