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

PsalmJsonResultsParser   A

Complexity

Total Complexity 9

Size/Duplication

Total Lines 96
Duplicated Lines 0 %

Importance

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

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\FileName;
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
    /**
43
     * {@inheritdoc}
44
     */
45
    public function convertFromString(string $resultsAsString, ProjectRoot $projectRoot): AnalysisResults
46
    {
47
        try {
48
            $asArray = JsonUtils::toArray($resultsAsString);
49
        } catch (JsonParseException $e) {
50
            throw new InvalidFileFormatException('Not a valid JSON format');
51
        }
52
53
        return $this->convertFromArray($asArray, $projectRoot);
54
    }
55
56
    /**
57
     * {@inheritdoc}
58
     */
59
    public function getIdentifier(): Identifier
60
    {
61
        return new PsalmJsonIdentifier();
62
    }
63
64
    /**
65
     * {@inheritdoc}
66
     */
67
    public function showTypeGuessingWarning(): bool
68
    {
69
        return false;
70
    }
71
72
    /**
73
     * Converts from an array.
74
     *
75
     * @phpstan-param array<mixed> $analysisResultsAsArray
76
     *
77
     * @throws ParseAtLocationException
78
     */
79
    private function convertFromArray(array $analysisResultsAsArray, ProjectRoot $projectRoot): AnalysisResults
80
    {
81
        $analysisResultsBuilder = new AnalysisResultsBuilder();
82
83
        $resultsCount = 0;
84
85
        /** @psalm-suppress MixedAssignment */
86
        foreach ($analysisResultsAsArray as $analysisResultAsArray) {
87
            ++$resultsCount;
88
            try {
89
                ArrayUtils::assertArray($analysisResultAsArray);
90
                $severity = ArrayUtils::getStringValue($analysisResultAsArray, self::SEVERITY);
91
                if (self::ERROR_SEVERITY_LEVEL === $severity) {
92
                    $analysisResult = $this->convertAnalysisResultFromArray($analysisResultAsArray, $projectRoot);
93
                    $analysisResultsBuilder->addAnalysisResult($analysisResult);
94
                }
95
            } catch (ArrayParseException | JsonParseException | InvalidPathException $e) {
96
                throw ParseAtLocationException::issueAtPosition($e, $resultsCount);
97
            }
98
        }
99
100
        return $analysisResultsBuilder->build();
101
    }
102
103
    /**
104
     * @phpstan-param array<mixed> $analysisResultAsArray
105
     *
106
     * @throws ArrayParseException
107
     * @throws JsonParseException
108
     * @throws InvalidPathException
109
     */
110
    private function convertAnalysisResultFromArray(
111
        array $analysisResultAsArray,
112
        ProjectRoot $projectRoot
113
    ): AnalysisResult {
114
        $absoluteFileNameAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::FILE);
115
        $lineAsInt = ArrayUtils::getIntValue($analysisResultAsArray, self::LINE_FROM);
116
        $typeAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::TYPE);
117
        $relativeFileNameAsString = $projectRoot->getPathRelativeToRootDirectory($absoluteFileNameAsString);
118
119
        $location = new Location(
120
            new FileName($relativeFileNameAsString),
121
            new LineNumber($lineAsInt)
122
        );
123
124
        return new AnalysisResult(
125
            $location,
126
            new Type($typeAsString),
127
            ArrayUtils::getStringValue($analysisResultAsArray, self::MESSAGE),
128
            JsonUtils::toString($analysisResultAsArray)
129
        );
130
    }
131
}
132