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

ExakatJsonResultsParser   A

Complexity

Total Complexity 8

Size/Duplication

Total Lines 90
Duplicated Lines 0 %

Importance

Changes 0
Metric Value
eloc 34
dl 0
loc 90
rs 10
c 0
b 0
f 0
wmc 8

5 Methods

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