Passed
Pull Request — master (#69)
by Dave
02:19
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\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 ExakatJsonResultsParser implements ResultsParser
34
{
35
    const LINE_FROM = 'line';
36
    const TYPE = 'type';
37
    const FILE = 'file';
38
39
    /**
40
     * {@inheritdoc}
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
    /**
54
     * {@inheritdoc}
55
     */
56
    public function getIdentifier(): Identifier
57
    {
58
        return new ExakatJsonIdentifier();
59
    }
60
61
    /**
62
     * {@inheritdoc}
63
     */
64
    public function showTypeGuessingWarning(): bool
65
    {
66
        return false;
67
    }
68
69
    /**
70
     * Converts from an array.
71
     *
72
     * @param array<mixed> $analysisResultsAsArray
73
     *
74
     * @throws ParseAtLocationException
75
     */
76
    private function convertFromArray(array $analysisResultsAsArray, ProjectRoot $projectRoot): AnalysisResults
77
    {
78
        $analysisResultsBuilder = new AnalysisResultsBuilder();
79
80
        $resultsCount = 0;
81
82
        /** @psalm-suppress MixedAssignment */
83
        foreach ($analysisResultsAsArray as $analysisResultAsArray) {
84
            ++$resultsCount;
85
            try {
86
                ArrayUtils::assertArray($analysisResultAsArray);
87
                $analysisResult = $this->convertAnalysisResultFromArray($analysisResultAsArray, $projectRoot);
88
                $analysisResultsBuilder->addAnalysisResult($analysisResult);
89
            } catch (ArrayParseException | JsonParseException | InvalidPathException $e) {
90
                throw ParseAtLocationException::issueAtPosition($e, $resultsCount);
91
            }
92
        }
93
94
        return $analysisResultsBuilder->build();
95
    }
96
97
    /**
98
     * @param array<mixed> $analysisResultAsArray
99
     *
100
     * @throws ArrayParseException
101
     * @throws JsonParseException
102
     * @throws InvalidPathException
103
     */
104
    private function convertAnalysisResultFromArray(
105
        array $analysisResultAsArray,
106
        ProjectRoot $projectRoot
107
    ): AnalysisResult {
108
        $absoluteFileNameAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::FILE);
109
        $lineAsInt = ArrayUtils::getIntValue($analysisResultAsArray, self::LINE_FROM);
110
        $typeAsString = ArrayUtils::getStringValue($analysisResultAsArray, self::TYPE);
111
        $relativeFileNameAsString = $projectRoot->getPathRelativeToRootDirectory($absoluteFileNameAsString);
112
113
        $location = new Location(
114
            new FileName($relativeFileNameAsString),
115
            new LineNumber($lineAsInt)
116
        );
117
118
        return new AnalysisResult(
119
            $location,
120
            new Type($typeAsString),
121
            '',
122
            JsonUtils::toString($analysisResultAsArray)
123
        );
124
    }
125
}
126