1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* Static Analysis Results Baseliner (sarb). |
5
|
|
|
* |
6
|
|
|
* (c) Dave Liddament |
7
|
|
|
* |
8
|
|
|
* For the full copyright and licence information please view the LICENSE file distributed with this source code. |
9
|
|
|
*/ |
10
|
|
|
|
11
|
|
|
declare(strict_types=1); |
12
|
|
|
|
13
|
|
|
namespace DaveLiddament\StaticAnalysisResultsBaseliner\Plugins\ResultsParsers\SarbJsonResultsParser; |
14
|
|
|
|
15
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\InvalidPathException; |
16
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\LineNumber; |
17
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Location; |
18
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\ProjectRoot; |
19
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\RelativeFileName; |
20
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Type; |
21
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResult; |
22
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResults; |
23
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResultsBuilder; |
24
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\Identifier; |
25
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ResultsParser; |
26
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayParseException; |
27
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayUtils; |
28
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\JsonUtils; |
29
|
|
|
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ParseAtLocationException; |
30
|
|
|
|
31
|
|
|
class SarbRelativeFileJsonResultsParser implements ResultsParser |
32
|
|
|
{ |
33
|
|
|
private const LINE = 'line'; |
34
|
|
|
private const TYPE = 'type'; |
35
|
|
|
private const FILE = 'relative_path'; |
36
|
|
|
private const MESSAGE = 'message'; |
37
|
|
|
|
38
|
|
|
public function getIdentifier(): Identifier |
39
|
|
|
{ |
40
|
|
|
return new SarbRelativeFileJsonIdentifier(); |
41
|
|
|
} |
42
|
|
|
|
43
|
|
|
public function showTypeGuessingWarning(): bool |
44
|
|
|
{ |
45
|
|
|
return false; |
46
|
|
|
} |
47
|
|
|
|
48
|
|
|
public function convertFromString(string $resultsAsString, ProjectRoot $projectRoot): AnalysisResults |
49
|
|
|
{ |
50
|
|
|
$analysisResultsAsArray = JsonUtils::toArray($resultsAsString); |
51
|
|
|
|
52
|
|
|
$analysisResultsBuilder = new AnalysisResultsBuilder(); |
53
|
|
|
|
54
|
|
|
$resultsCount = 0; |
55
|
|
|
|
56
|
|
|
/** @psalm-suppress MixedAssignment */ |
57
|
|
|
foreach ($analysisResultsAsArray as $analysisResultAsArray) { |
58
|
|
|
++$resultsCount; |
59
|
|
|
try { |
60
|
|
|
ArrayUtils::assertArray($analysisResultAsArray); |
61
|
|
|
$analysisResult = $this->convertAnalysisResultFromArray($analysisResultAsArray, $projectRoot); |
62
|
|
|
$analysisResultsBuilder->addAnalysisResult($analysisResult); |
63
|
|
|
} catch (ArrayParseException | InvalidPathException $e) { |
64
|
|
|
throw ParseAtLocationException::issueAtPosition($e, $resultsCount); |
65
|
|
|
} |
66
|
|
|
} |
67
|
|
|
|
68
|
|
|
return $analysisResultsBuilder->build(); |
69
|
|
|
} |
70
|
|
|
|
71
|
|
|
/** |
72
|
|
|
* @psalm-param array<mixed> $analysisResultAsArray |
73
|
|
|
* |
74
|
|
|
* @throws InvalidPathException |
75
|
|
|
* @throws ArrayParseException |
76
|
|
|
*/ |
77
|
|
|
private function convertAnalysisResultFromArray( |
78
|
|
|
array $analysisResultAsArray, |
79
|
|
|
ProjectRoot $projectRoot |
80
|
|
|
): AnalysisResult { |
81
|
|
|
$relativeFileNameAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::FILE); |
82
|
|
|
$lineAsInt = ArrayUtils::getIntValue($analysisResultAsArray, self::LINE); |
83
|
|
|
$typeAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::TYPE); |
84
|
|
|
|
85
|
|
|
$location = Location::fromRelativeFileName( |
86
|
|
|
new RelativeFileName($relativeFileNameAsString), |
87
|
|
|
$projectRoot, |
88
|
|
|
new LineNumber($lineAsInt) |
89
|
|
|
); |
90
|
|
|
|
91
|
|
|
return new AnalysisResult( |
92
|
|
|
$location, |
93
|
|
|
new Type($typeAsString), |
94
|
|
|
ArrayUtils::getStringValue($analysisResultAsArray, self::MESSAGE), |
95
|
|
|
$analysisResultAsArray |
96
|
|
|
); |
97
|
|
|
} |
98
|
|
|
} |
99
|
|
|
|