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

PsalmJsonResultsParser   A

Complexity

Total Complexity 7

Size/Duplication

Total Lines 70
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
eloc 35
dl 0
loc 70
rs 10
c 0
b 0
f 0
wmc 7

4 Methods

Rating   Name   Duplication   Size   Complexity  
A convertFromString() 0 23 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\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 PsalmJsonResultsParser implements ResultsParser
32
{
33
    const LINE_FROM = 'line_from';
34
    const TYPE = 'type';
35
    const FILE = 'file_path';
36
    const SEVERITY = 'severity';
37
    const ERROR_SEVERITY_LEVEL = 'error';
38
    const MESSAGE = 'message';
39
40
    public function convertFromString(string $resultsAsString, ProjectRoot $projectRoot): AnalysisResults
41
    {
42
        $analysisResultsAsArray = JsonUtils::toArray($resultsAsString);
43
        $analysisResultsBuilder = new AnalysisResultsBuilder();
44
45
        $resultsCount = 0;
46
47
        /** @psalm-suppress MixedAssignment */
48
        foreach ($analysisResultsAsArray as $analysisResultAsArray) {
49
            ++$resultsCount;
50
            try {
51
                ArrayUtils::assertArray($analysisResultAsArray);
52
                $severity = ArrayUtils::getStringValue($analysisResultAsArray, self::SEVERITY);
53
                if (self::ERROR_SEVERITY_LEVEL === $severity) {
54
                    $analysisResult = $this->convertAnalysisResultFromArray($analysisResultAsArray, $projectRoot);
55
                    $analysisResultsBuilder->addAnalysisResult($analysisResult);
56
                }
57
            } catch (ArrayParseException | InvalidPathException $e) {
58
                throw ParseAtLocationException::issueAtPosition($e, $resultsCount);
59
            }
60
        }
61
62
        return $analysisResultsBuilder->build();
63
    }
64
65
    /**
66
     * @psalm-param array<mixed> $analysisResultAsArray
67
     *
68
     * @throws ArrayParseException
69
     * @throws InvalidPathException
70
     */
71
    private function convertAnalysisResultFromArray(
72
        array $analysisResultAsArray,
73
        ProjectRoot $projectRoot
74
    ): AnalysisResult {
75
        $absoluteFileNameAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::FILE);
76
        $lineAsInt = ArrayUtils::getIntValue($analysisResultAsArray, self::LINE_FROM);
77
        $typeAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::TYPE);
78
79
        $location = Location::fromAbsoluteFileName(
80
            new AbsoluteFileName($absoluteFileNameAsString),
81
            $projectRoot,
82
            new LineNumber($lineAsInt)
83
        );
84
85
        return new AnalysisResult(
86
            $location,
87
            new Type($typeAsString),
88
            ArrayUtils::getStringValue($analysisResultAsArray, self::MESSAGE),
89
            JsonUtils::toString($analysisResultAsArray)
90
        );
91
    }
92
93
    public function getIdentifier(): Identifier
94
    {
95
        return new PsalmJsonIdentifier();
96
    }
97
98
    public function showTypeGuessingWarning(): bool
99
    {
100
        return false;
101
    }
102
}
103