PlainRenderer::renderTrace() - Code Metrics - Inspection of "Separate new Interceptors" - spiral/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#1122)

by Aleksei

created 2024-08-21 14:59 UTC

PlainRenderer::renderTrace() B

↳ Parent: PlainRenderer

Complexity

Conditions	10
Paths	20

Size

Total Lines	53
Code Lines	34

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	33
CRAP Score	10.0186

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	34
c	1
b	0
f	0
dl	0
loc	53
ccs	33
cts	35
cp	0.9429
rs	7.6666
cc	10
nc	20
nop	2
crap	10.0186

How to fix Long Method Complexity

<?php

declare(strict_types=1);

namespace Spiral\Exceptions\Renderer;

use Spiral\Exceptions\Style\PlainStyle;
use Spiral\Exceptions\Verbosity;

final class PlainRenderer extends AbstractRenderer
{
    protected const FORMATS = ['text/plain', 'text', 'plain', 'cli', 'console'];
    // Lines to show around targeted line.
    private const SHOW_LINES = 2;

    private array $lines = [];

    public function render(
        \Throwable $exception,
        ?Verbosity $verbosity = null,
        string $format = null
    ): string {
        $verbosity ??= $this->defaultVerbosity;
        $exceptions = [$exception];
        while ($exception = $exception->getPrevious()) {
            $exceptions[] = $exception;
        }

        $exceptions = \array_reverse($exceptions);

        $result = [];
        $rootDir = \getcwd();

        foreach ($exceptions as $exception) {
            $file = \str_starts_with($exception->getFile(), $rootDir)
                ? \substr($exception->getFile(), \strlen($rootDir) + 1)
                : $exception->getFile();

            $row = \sprintf(
                "[%s]\n%s in %s:%s\n",
                $exception::class,
                $exception->getMessage(),
                $file,
                $exception->getLine(),
            );

            if ($verbosity->value >= Verbosity::DEBUG->value) {
                $row .= $this->renderTrace($exception, new Highlighter(new PlainStyle()));
            } elseif ($verbosity->value >= Verbosity::VERBOSE->value) {
                $row .= $this->renderTrace($exception);
            }

            $result[] = $row;
        }

        $this->lines = [];

        return \implode('', \array_reverse($result));
    }

    /**
     * Render exception call stack.
     */
    private function renderTrace(\Throwable $e, Highlighter $h = null): string
    {
        $stacktrace = $this->getStacktrace($e);
        if ($stacktrace === []) {
            return '';
        }

        $result = "\n";
        $rootDir = \getcwd();

        $pad = \strlen((string)\count($stacktrace));

        foreach ($stacktrace as $i => $trace) {
            if (isset($trace['type'], $trace['class'])) {
                $line = \sprintf(
                    '%s. %s%s%s()',
                    \str_pad((string)((int) $i + 1), $pad, ' ', \STR_PAD_LEFT),
                    $trace['class'],
                    $trace['type'],
                    $trace['function']
                );
            } else {
                $line = $trace['function'];
            }

            if (isset($trace['file'])) {
                $file = \str_starts_with($trace['file'], $rootDir)
                    ? \substr($trace['file'], \strlen($rootDir) + 1)
                    : $trace['file'];

                $line .= \sprintf(' at %s:%s', $file, $trace['line']);
            }

            if (\in_array($line, $this->lines, true)) {
                continue;
            }

            $this->lines[] = $line;

            $result .= $line . "\n";

            if ($h !== null && !empty($trace['file']) && \is_file($trace['file'])) {
                $str = @\file_get_contents($trace['file']);
                $result .= $h->highlightLines(
                    $str,
                    /** @scrutinizer ignore-type */ $str,
                    $trace['line'],
                    self::SHOW_LINES
                ) . "\n";
                unset($str);
            }
        }

        return $result . "\n";
    }
}


spiral / framework

Pull Request — master (#1122)

PlainRenderer::renderTrace() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like