railt / console

src/ExceptionRenderer.php

<?php
/**
 * This file is part of Railt package.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
declare(strict_types=1);

namespace Railt\Console;

use Railt\Io\Exception\NotReadableException;
use Railt\Io\File;

/**
 * Class ExceptionRenderer
 */
class ExceptionRenderer
{
    /**
     * @var Highlighter
     */
    private $highlighter;

    /**
     * ExceptionRenderer constructor.
     * @param Highlighter $highlighter
     */
    public function __construct(Highlighter $highlighter)
    {
        $this->highlighter = $highlighter;
    }

    /**
     * @param \Throwable $e
     * @return string
     */
    public function render(\Throwable $e): string
    {
        return
            $this->renderHeader($e) .
            $this->renderFileHeader($e) .
            $this->renderCode($e) .
            $this->renderTrace($e);
    }

    /**
     * @param \Throwable $e
     * @return string
     */
    private function renderCode(\Throwable $e): string
    {
        try {
            $file = File::fromPathname($e->getFile());
        } catch (NotReadableException $error) {
            $file = File::fromSources('', $e->getFile());
        }

        return $this->highlighter->highlight($file, $e->getLine()) .

It seems like $file defined by \Railt\Io\File::fromPathname($e->getFile()) on line 54 can also be of type object<Railt\Io\File>; however, Railt\Console\Highlighter::highlight() does only seem to accept object<Railt\Io\Readable>, maybe add an additional type check?

            \PHP_EOL;
    }

    /**
     * @param \Throwable $e
     * @return string
     */
    private function renderHeader(\Throwable $e): string
    {
        [$name, $msg] = [$this->classname($e), $e->getMessage()];

The variable $name does not exist. Did you forget to declare it?

The variable $msg does not exist. Did you forget to declare it?

        return \sprintf('<error> %s </error> <comment>%s</comment>', $name, $msg) .
            \PHP_EOL . \PHP_EOL;
    }

    /**
     * @param string|object $class
     * @return string
     */
    private function classname($class): string
    {
        $class = \is_object($class) ? \get_class($class) : $class;

        return \basename(\str_replace('\\', '/', $class));
    }

    /**
     * @param \Throwable $e
     * @return string
     */
    private function renderFileHeader(\Throwable $e): string
    {
        $message = 'in <fg=cyan;options=underscore>%s</> at line <fg=cyan>%d</>';

        return \sprintf($message, $e->getFile(), $e->getLine()) .
            \PHP_EOL . \PHP_EOL;
    }

    /**
     * @param \Throwable $e
     * @return string
     */
    private function renderTrace(\Throwable $e): string
    {
        $result = ['<comment>Stack Trace:</comment>'];

        foreach ($e->getTrace() as $i => $trace) {
            $line = $this->traceInvocation($trace);
            $args = $this->traceArguments($trace);

            $result[] = \sprintf('<fg=blue>%3s</> <comment>%s(%s)</comment>', '#' . $i, $line, $args);
            $result[] = \sprintf('    <fg=cyan>%s</>:<fg=cyan>%d</>', $trace['file'], $trace['line']);
        }

        return \implode(\PHP_EOL, $result) .
            \PHP_EOL;
    }

    /**
     * @param array $trace
     * @return string
     */
    private function traceArguments(array $trace): string
    {
        $result = [];

        foreach (($trace['args'] ?? []) as $arg) {
            $result[] = \is_object($arg) ? 'Object(' . $this->classname($arg) . ')' : \gettype($arg);
        }

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

    /**
     * @param array $trace
     * @return string
     */
    private function traceInvocation(array $trace): string
    {
        return isset($trace['class'])
            ? $trace['class'] . $trace['type'] . $trace['function']
            : $trace['function'];
    }
}