convertFromString()   A
last analyzed

Complexity

Conditions 3
Paths 5

Size

Total Lines 21
Code Lines 12

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 3
eloc 12
c 1
b 0
f 0
nc 5
nop 2
dl 0
loc 21
rs 9.8666
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
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\SeverityReader;
31
32
final class SarbRelativeFileJsonResultsParser implements ResultsParser
33
{
34
    private const LINE = 'line';
35
    private const TYPE = 'type';
36
    private const FILE = 'relative_path';
37
    private const MESSAGE = 'message';
38
    private const SEVERITY = 'severity';
39
40
    public function getIdentifier(): Identifier
41
    {
42
        return new SarbRelativeFileJsonIdentifier();
43
    }
44
45
    public function showTypeGuessingWarning(): bool
46
    {
47
        return false;
48
    }
49
50
    public function convertFromString(string $resultsAsString, ProjectRoot $projectRoot): AnalysisResults
51
    {
52
        $analysisResultsAsArray = JsonUtils::toArray($resultsAsString);
53
54
        $analysisResultsBuilder = new AnalysisResultsBuilder();
55
56
        $resultsCount = 0;
57
58
        /** @psalm-suppress MixedAssignment */
59
        foreach ($analysisResultsAsArray as $analysisResultAsArray) {
60
            ++$resultsCount;
61
            try {
62
                ArrayUtils::assertArray($analysisResultAsArray);
63
                $analysisResult = $this->convertAnalysisResultFromArray($analysisResultAsArray, $projectRoot);
64
                $analysisResultsBuilder->addAnalysisResult($analysisResult);
65
            } catch (ArrayParseException|InvalidPathException $e) {
66
                throw ParseAtLocationException::issueAtPosition($e, $resultsCount);
67
            }
68
        }
69
70
        return $analysisResultsBuilder->build();
71
    }
72
73
    /**
74
     * @param array<mixed> $analysisResultAsArray
75
     *
76
     * @throws InvalidPathException
77
     * @throws ArrayParseException
78
     */
79
    private function convertAnalysisResultFromArray(
80
        array $analysisResultAsArray,
81
        ProjectRoot $projectRoot,
82
    ): AnalysisResult {
83
        $relativeFileNameAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::FILE);
84
        $lineAsInt = ArrayUtils::getIntValue($analysisResultAsArray, self::LINE);
85
        $typeAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::TYPE);
86
87
        $location = Location::fromRelativeFileName(
88
            new RelativeFileName($relativeFileNameAsString),
89
            $projectRoot,
90
            new LineNumber($lineAsInt),
91
        );
92
93
        return new AnalysisResult(
94
            $location,
95
            new Type($typeAsString),
96
            ArrayUtils::getStringValue($analysisResultAsArray, self::MESSAGE),
97
            $analysisResultAsArray,
98
            SeverityReader::getOptionalSeverity($analysisResultAsArray, self::SEVERITY),
99
        );
100
    }
101
}
102