PhpstanJsonResultsParser::convertFromString() - Code Metrics - DaveLiddament/sarb - Measure and Improve Code Quality continuously with Scrutinizer

PhpstanJsonResultsParser::convertFromString() B
last analyzed 2025-05-26 00:37 UTC

↳ Parent: PhpstanJsonResultsParser

Complexity

Conditions	9
Paths	16

Size

Total Lines	52
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	9
eloc	31
nc	16
nop	2
dl	0
loc	52
rs	8.0555
c	0
b	0
f	0

How to fix Long Method

<?php

/**
 * Static Analysis Results Baseliner (sarb).
 *
 * (c) Dave Liddament
 *
 * For the full copyright and licence information please view the LICENSE file distributed with this source code.
 */

declare(strict_types=1);

namespace DaveLiddament\StaticAnalysisResultsBaseliner\Plugins\ResultsParsers\PhpstanJsonResultsParser;

use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\AbsoluteFileName;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\InvalidPathException;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\LineNumber;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Location;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\ProjectRoot;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Severity;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Type;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResult;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResults;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\AnalysisResultsBuilder;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ErrorReportedByStaticAnalysisTool;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\Identifier;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ResultsParser;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayParseException;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayUtils;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\FqcnRemover;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\JsonUtils;
use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ParseAtLocationException;

/**
 * Handles PHPStan's JSON output.
 *
 * NOTE: SARB only deals with errors that are attached to a particular line in a file.
 * PHPStan can report general errors (not specific to file). These are ignored by SARB.
 */
final class PhpstanJsonResultsParser implements ResultsParser
{
    private const LINE = 'line';
    private const TYPE = 'message';
    private const FILES = 'files';
    private const MESSAGES = 'messages';
    private const ERRORS = 'errors';

    public function __construct(
        private FqcnRemover $fqcnRemover,
    ) {
    }

    public function convertFromString(string $resultsAsString, ProjectRoot $projectRoot): AnalysisResults
    {
        $analysisResultsAsArray = JsonUtils::toArray($resultsAsString);

        $analysisResultsBuilder = new AnalysisResultsBuilder();

        try {
            $errors = ArrayUtils::getArrayValue($analysisResultsAsArray, self::ERRORS);
        } catch (ArrayParseException $e) {
            throw ParseAtLocationException::issueParsing($e, 'Root node');
        }

        if (count($errors) > 0) {
            try {
                ArrayUtils::assertArrayOfStrings($errors);
            } catch (ArrayParseException $e) {
                throw ParseAtLocationException::issueParsing($e, self::ERRORS);
            }
            $errorMessage = 'PHPStan failed with errors:'.\PHP_EOL.implode("\n", $errors);
            throw new ErrorReportedByStaticAnalysisTool($errorMessage);
        }

        try {
            $filesErrors = ArrayUtils::getArrayValue($analysisResultsAsArray, self::FILES);
        } catch (ArrayParseException $e) {
            throw ParseAtLocationException::issueParsing($e, 'Root node');
        }

        /** @psalm-suppress MixedAssignment */
        foreach ($filesErrors as $absoluteFileNameAsString => $fileErrors) {
            try {
                if (!is_string($absoluteFileNameAsString)) {
                    throw new ArrayParseException('Expected filename to be of type string');
                }

                ArrayUtils::assertArray($fileErrors);

                $absoluteFileName = new AbsoluteFileName($absoluteFileNameAsString);

                $messages = ArrayUtils::getArrayValue($fileErrors, self::MESSAGES);

                foreach ($messages as $message) {
                    ArrayUtils::assertArray($message);
                    $analysisResult = $this->convertAnalysisResultFromArray($message, $absoluteFileName, $projectRoot);
                    $analysisResultsBuilder->addAnalysisResult($analysisResult);
                }
            } catch (ArrayParseException|InvalidPathException $e) {
                throw ParseAtLocationException::issueParsing($e, "Result [$absoluteFileNameAsString]");
            }
        }

        return $analysisResultsBuilder->build();
    }

    /**
     * @psalm-param array<mixed> $analysisResultAsArray
     *
     * @throws ArrayParseException
     * @throws InvalidPathException
     */
    private function convertAnalysisResultFromArray(
        array $analysisResultAsArray,
        AbsoluteFileName $absoluteFileName,
        ProjectRoot $projectRoot,
    ): AnalysisResult {
        $lineAsInt = ArrayUtils::getIntOrNullValue($analysisResultAsArray, self::LINE);

        // PHPStan sometimes reports errors not assigned to any line number. In this case give the line number as 0
        if (null === $lineAsInt) {
            $lineAsInt = 0;
        }

        $rawType = ArrayUtils::getStringValue($analysisResultAsArray, self::TYPE);
        $type = $this->fqcnRemover->removeRqcn($rawType);

        $location = Location::fromAbsoluteFileName(
            $absoluteFileName,
            $projectRoot,
            new LineNumber($lineAsInt),
        );

        return new AnalysisResult(
            $location,
            new Type($type),
            $rawType,
            $analysisResultAsArray,
            Severity::error(),
        );
    }

    public function getIdentifier(): Identifier
    {
        return new PhpstanJsonIdentifier();
    }

    public function showTypeGuessingWarning(): bool
    {
        return true;
    }
}


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\PhpstanJsonResultsParser;
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\Severity;
21			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Common\Type;
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\ErrorReportedByStaticAnalysisTool;
26			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\Identifier;
27			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\ResultsParser\ResultsParser;
28			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayParseException;
29			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ArrayUtils;
30			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\FqcnRemover;
31			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\JsonUtils;
32			use DaveLiddament\StaticAnalysisResultsBaseliner\Domain\Utils\ParseAtLocationException;
33
34			/**
35			* Handles PHPStan's JSON output.
36			*
37			* NOTE: SARB only deals with errors that are attached to a particular line in a file.
38			* PHPStan can report general errors (not specific to file). These are ignored by SARB.
39			*/
40			final class PhpstanJsonResultsParser implements ResultsParser
41			{
42			private const LINE = 'line';
43			private const TYPE = 'message';
44			private const FILES = 'files';
45			private const MESSAGES = 'messages';
46			private const ERRORS = 'errors';
47
48			public function __construct(
49			private FqcnRemover $fqcnRemover,
50			) {
51			}
52
53			public function convertFromString(string $resultsAsString, ProjectRoot $projectRoot): AnalysisResults
54			{
55			$analysisResultsAsArray = JsonUtils::toArray($resultsAsString);
56
57			$analysisResultsBuilder = new AnalysisResultsBuilder();
58
59			try {
60			$errors = ArrayUtils::getArrayValue($analysisResultsAsArray, self::ERRORS);
61			} catch (ArrayParseException $e) {
62			throw ParseAtLocationException::issueParsing($e, 'Root node');
63			}
64
65			if (count($errors) > 0) {
66			try {
67			ArrayUtils::assertArrayOfStrings($errors);
68			} catch (ArrayParseException $e) {
69			throw ParseAtLocationException::issueParsing($e, self::ERRORS);
70			}
71			$errorMessage = 'PHPStan failed with errors:'.\PHP_EOL.implode("\n", $errors);
72			throw new ErrorReportedByStaticAnalysisTool($errorMessage);
73			}
74
75			try {
76			$filesErrors = ArrayUtils::getArrayValue($analysisResultsAsArray, self::FILES);
77			} catch (ArrayParseException $e) {
78			throw ParseAtLocationException::issueParsing($e, 'Root node');
79			}
80
81			/** @psalm-suppress MixedAssignment */
82			foreach ($filesErrors as $absoluteFileNameAsString => $fileErrors) {
83			try {
84			if (!is_string($absoluteFileNameAsString)) {
85			throw new ArrayParseException('Expected filename to be of type string');
86			}
87
88			ArrayUtils::assertArray($fileErrors);
89
90			$absoluteFileName = new AbsoluteFileName($absoluteFileNameAsString);
91
92			$messages = ArrayUtils::getArrayValue($fileErrors, self::MESSAGES);
93
94			foreach ($messages as $message) {
95			ArrayUtils::assertArray($message);
96			$analysisResult = $this->convertAnalysisResultFromArray($message, $absoluteFileName, $projectRoot);
97			$analysisResultsBuilder->addAnalysisResult($analysisResult);
98			}
99			} catch (ArrayParseException\|InvalidPathException $e) {
100			throw ParseAtLocationException::issueParsing($e, "Result [$absoluteFileNameAsString]");
101			}
102			}
103
104			return $analysisResultsBuilder->build();
105			}
106
107			/**
108			* @psalm-param array<mixed> $analysisResultAsArray
109			*
110			* @throws ArrayParseException
111			* @throws InvalidPathException
112			*/
113			private function convertAnalysisResultFromArray(
114			array $analysisResultAsArray,
115			AbsoluteFileName $absoluteFileName,
116			ProjectRoot $projectRoot,
117			): AnalysisResult {
118			$lineAsInt = ArrayUtils::getIntOrNullValue($analysisResultAsArray, self::LINE);
119
120			// PHPStan sometimes reports errors not assigned to any line number. In this case give the line number as 0
121			if (null === $lineAsInt) {
122			$lineAsInt = 0;
123			}
124
125			$rawType = ArrayUtils::getStringValue($analysisResultAsArray, self::TYPE);
126			$type = $this->fqcnRemover->removeRqcn($rawType);
127
128			$location = Location::fromAbsoluteFileName(
129			$absoluteFileName,
130			$projectRoot,
131			new LineNumber($lineAsInt),
132			);
133
134			return new AnalysisResult(
135			$location,
136			new Type($type),
137			$rawType,
138			$analysisResultAsArray,
139			Severity::error(),
140			);
141			}
142
143			public function getIdentifier(): Identifier
144			{
145			return new PhpstanJsonIdentifier();
146			}
147
148			public function showTypeGuessingWarning(): bool
149			{
150			return true;
151			}
152			}
153

DaveLiddament / sarb

PhpstanJsonResultsParser::convertFromString() B last analyzed 2025-05-26 00:37 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

PhpstanJsonResultsParser::convertFromString() B
last analyzed 2025-05-26 00:37 UTC