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

SarbJsonResultsParser   A

Complexity

Total Complexity 8

Size/Duplication

Total Lines 91
Duplicated Lines 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 35
c 1
b 0
f 0
dl 0
loc 91
rs 10
wmc 8

5 Methods

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