|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/* |
|
4
|
|
|
* This file is part of Symplify |
|
5
|
|
|
* Copyright (c) 2016 Tomas Votruba (http://tomasvotruba.cz). |
|
6
|
|
|
*/ |
|
7
|
|
|
|
|
8
|
|
|
namespace Symplify\PHP7_CodeSniffer\Sniff\Naming; |
|
9
|
|
|
|
|
10
|
|
|
use Nette\Utils\Strings; |
|
11
|
|
|
use Symplify\PHP7_CodeSniffer\Exception\Sniff\Naming\InvalidSniffClassException; |
|
12
|
|
|
use Symplify\PHP7_CodeSniffer\Exception\Sniff\Naming\InvalidSniffCodeException; |
|
13
|
|
|
use Symplify\PHP7_CodeSniffer\Exception\Sniff\Naming\SniffClassCouldNotBeFoundException; |
|
14
|
|
|
|
|
15
|
|
|
final class SniffNaming |
|
16
|
|
|
{ |
|
17
|
5 |
|
public static function guessClassByCode(string $sniffCode) : string |
|
18
|
|
|
{ |
|
19
|
5 |
|
self::ensureSniffCodeIsValid($sniffCode); |
|
20
|
|
|
|
|
21
|
4 |
|
$parts = explode('.', $sniffCode); |
|
22
|
|
|
|
|
23
|
|
|
$possibleClasses = [ |
|
24
|
4 |
|
$parts[0].'CodingStandard\\Sniffs\\'.$parts[1].'\\'.$parts[2].'Sniff', |
|
25
|
4 |
|
$parts[0].'\\CodingStandard\\Sniffs\\'.$parts[1].'\\'.$parts[2].'Sniff', |
|
26
|
4 |
|
'PHP_CodeSniffer\\Standards\\'.$parts[0].'\\Sniffs\\'.$parts[1].'\\'.$parts[2].'Sniff', |
|
27
|
|
|
]; |
|
28
|
|
|
|
|
29
|
4 |
|
foreach ($possibleClasses as $possibleClass) { |
|
30
|
4 |
|
if (class_exists($possibleClass)) { |
|
31
|
4 |
|
return $possibleClass; |
|
32
|
|
|
} |
|
33
|
|
|
} |
|
34
|
|
|
|
|
35
|
1 |
|
self::reportClassCouldNotBeFound($sniffCode, $possibleClasses); |
|
36
|
|
|
} |
|
37
|
|
|
|
|
38
|
12 |
|
public static function guessCodeByClass(string $sniffClass) : string |
|
39
|
|
|
{ |
|
40
|
12 |
|
self::ensureClassNameIsValid($sniffClass); |
|
41
|
|
|
|
|
42
|
11 |
|
$parts = explode('\\', $sniffClass); |
|
43
|
|
|
|
|
44
|
11 |
|
$standardName = $parts[count($parts)-4]; |
|
45
|
11 |
|
if (Strings::endsWith($standardName, 'CodingStandard')) { |
|
46
|
8 |
|
$standardName = substr($standardName, 0, -strlen('CodingStandard')); |
|
47
|
|
|
} |
|
48
|
|
|
|
|
49
|
11 |
|
$categoryName = $parts[count($parts)-2]; |
|
50
|
|
|
|
|
51
|
11 |
|
$sniffName = $parts[count($parts)-1]; |
|
52
|
11 |
|
$sniffName = substr($sniffName, 0, -strlen('Sniff')); |
|
53
|
|
|
|
|
54
|
11 |
|
return $standardName.'.'.$categoryName.'.'.$sniffName; |
|
55
|
|
|
} |
|
56
|
|
|
|
|
57
|
5 |
|
private static function ensureSniffCodeIsValid(string $sniffCode) |
|
58
|
|
|
{ |
|
59
|
5 |
|
$parts = explode('.', $sniffCode); |
|
60
|
|
|
|
|
61
|
5 |
|
if (count($parts) !== 3) { |
|
62
|
1 |
|
throw new InvalidSniffCodeException( |
|
63
|
|
|
sprintf( |
|
64
|
1 |
|
'"%s" is not valid sniff code. Code in form "%s" is expected.', |
|
65
|
|
|
$sniffCode, |
|
66
|
1 |
|
'Standard.Category.Specific' |
|
67
|
|
|
) |
|
68
|
|
|
); |
|
69
|
|
|
} |
|
70
|
4 |
|
} |
|
71
|
|
|
|
|
72
|
12 |
|
private static function ensureClassNameIsValid(string $sniffClass) |
|
73
|
|
|
{ |
|
74
|
12 |
|
$parts = explode('\\', $sniffClass); |
|
75
|
|
|
|
|
76
|
12 |
|
if (count($parts) < 4) { |
|
77
|
1 |
|
throw new InvalidSniffClassException(sprintf( |
|
78
|
1 |
|
'"%s" is not valid sniff class name. Name in form "%s" or "%s" is expected.', |
|
79
|
|
|
$sniffClass, |
|
80
|
1 |
|
'<Name>CodingStandard\Sniffs\<Category>\<Name>Sniff', |
|
81
|
1 |
|
'<Name>\CodingStandard\Sniffs\<Category>\<Name>Sniff' |
|
82
|
|
|
)); |
|
83
|
|
|
} |
|
84
|
11 |
|
} |
|
85
|
|
|
|
|
86
|
1 |
|
private static function reportClassCouldNotBeFound(string $sniffCode, array $guessedClasses) |
|
87
|
|
|
{ |
|
88
|
1 |
|
throw new SniffClassCouldNotBeFoundException(sprintf( |
|
89
|
1 |
|
'Sniff class for code "%s" could not be found. We tried:'.PHP_EOL.PHP_EOL.' - %s ', |
|
90
|
|
|
$sniffCode, |
|
91
|
1 |
|
implode(PHP_EOL . ' - ', $guessedClasses) |
|
92
|
|
|
)); |
|
93
|
|
|
} |
|
94
|
|
|
} |
|
95
|
|
|
|
Symplify /
PHP7_CodeSniffer
