Passed
Pull Request — master (#69)
by Dave
02:21
created

PsalmJsonResultsParser   A

Complexity

Total Complexity 9

Size/Duplication

Total Lines 87
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
wmc 9
eloc 39
dl 0
loc 87
rs 10
c 0
b 0
f 0

5 Methods

Rating   Name   Duplication   Size   Complexity  
A convertFromString() 0 9 2
A convertFromArray() 0 22 4
A convertAnalysisResultFromArray() 0 19 1
A showTypeGuessingWarning() 0 3 1
A getIdentifier() 0 3 1
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\PsalmJsonResultsParser;
14
15
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\AbsoluteFileName;
16
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\InvalidPathException;
17
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\LineNumber;
18
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Location;
19
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\ProjectRoot;
20
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Type;
21
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\File\InvalidFileFormatException;
22
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResult;
23
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResults;
24
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResultsBuilder;
25
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\Identifier;
26
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ResultsParser;
27
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayParseException;
28
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayUtils;
29
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\JsonParseException;
30
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\JsonUtils;
31
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ParseAtLocationException;
32
33
class PsalmJsonResultsParser implements ResultsParser
34
{
35
    const LINE_FROM = 'line_from';
36
    const TYPE = 'type';
37
    const FILE = 'file_path';
38
    const SEVERITY = 'severity';
39
    const ERROR_SEVERITY_LEVEL = 'error';
40
    const MESSAGE = 'message';
41
42
    public function convertFromString(string $resultsAsString, ProjectRoot $projectRoot): AnalysisResults
43
    {
44
        try {
45
            $asArray = JsonUtils::toArray($resultsAsString);
46
        } catch (JsonParseException $e) {
47
            throw new InvalidFileFormatException('Not a valid JSON format');
48
        }
49
50
        return $this->convertFromArray($asArray, $projectRoot);
51
    }
52
53
    public function getIdentifier(): Identifier
54
    {
55
        return new PsalmJsonIdentifier();
56
    }
57
58
    public function showTypeGuessingWarning(): bool
59
    {
60
        return false;
61
    }
62
63
    /**
64
     * Converts from an array.
65
     *
66
     * @psalm-param array<mixed> $analysisResultsAsArray
67
     *
68
     * @throws ParseAtLocationException
69
     */
70
    private function convertFromArray(array $analysisResultsAsArray, ProjectRoot $projectRoot): AnalysisResults
71
    {
72
        $analysisResultsBuilder = new AnalysisResultsBuilder();
73
74
        $resultsCount = 0;
75
76
        /** @psalm-suppress MixedAssignment */
77
        foreach ($analysisResultsAsArray as $analysisResultAsArray) {
78
            ++$resultsCount;
79
            try {
80
                ArrayUtils::assertArray($analysisResultAsArray);
81
                $severity = ArrayUtils::getStringValue($analysisResultAsArray, self::SEVERITY);
82
                if (self::ERROR_SEVERITY_LEVEL === $severity) {
83
                    $analysisResult = $this->convertAnalysisResultFromArray($analysisResultAsArray, $projectRoot);
84
                    $analysisResultsBuilder->addAnalysisResult($analysisResult);
85
                }
86
            } catch (ArrayParseException | JsonParseException | InvalidPathException $e) {
87
                throw ParseAtLocationException::issueAtPosition($e, $resultsCount);
88
            }
89
        }
90
91
        return $analysisResultsBuilder->build();
92
    }
93
94
    /**
95
     * @psalm-param array<mixed> $analysisResultAsArray
96
     *
97
     * @throws ArrayParseException
98
     * @throws JsonParseException
99
     * @throws InvalidPathException
100
     */
101
    private function convertAnalysisResultFromArray(
102
        array $analysisResultAsArray,
103
        ProjectRoot $projectRoot
104
    ): AnalysisResult {
105
        $absoluteFileNameAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::FILE);
106
        $lineAsInt = ArrayUtils::getIntValue($analysisResultAsArray, self::LINE_FROM);
107
        $typeAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::TYPE);
108
109
        $location = Location::fromAbsoluteFileName(
110
            new AbsoluteFileName($absoluteFileNameAsString),
111
            $projectRoot,
112
            new LineNumber($lineAsInt)
113
        );
114
115
        return new AnalysisResult(
116
            $location,
117
            new Type($typeAsString),
118
            ArrayUtils::getStringValue($analysisResultAsArray, self::MESSAGE),
119
            JsonUtils::toString($analysisResultAsArray)
120
        );
121
    }
122
}
123