Shoot\Shoot\Middleware\InspectorMiddleware

Complexity

Total Complexity

27

Size/Duplication

Total Lines	187
Duplicated Lines	0 %

Test Coverage

Coverage

77.46%

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	scriptEnd()	0	3	1
A	value()	0	8	4
A	object()	0	8	3
A	view()	0	5	1
A	process()	0	7	1
A	iterable()	0	17	4
A	presentationModel()	0	15	3
A	group()	0	8	2
A	script()	0	3	1
A	scalar()	0	14	5
A	escape()	0	3	1
A	groupEnd()	0	3	1

<?php
declare(strict_types=1);

namespace Shoot\Shoot\Middleware;

use Psr\Http\Message\ServerRequestInterface;
use Shoot\Shoot\HasPresenterInterface;
use Shoot\Shoot\MiddlewareInterface;
use Shoot\Shoot\PresentationModel;
use Shoot\Shoot\View;

/**
 * The inspector shows you what templates, presentation models, presenters and variables were used to render a page by
 * logging this information to your browser console.
 */
final class InspectorMiddleware implements MiddlewareInterface
{
    /**
     * Process the view within the context of the current HTTP request, either before or after calling the next
     * middleware. Returns the processed view.
     *
     * @param View                   $view
     * @param ServerRequestInterface $request
     * @param callable               $next
     *
     * @return View
     */
    public function process(View $view, ServerRequestInterface $request, callable $next): View
    {
        $this->script();
        $this->view($view);
        $this->scriptEnd();

        return $next($view);
    }

    /**
     * @param mixed  $value
     * @param string $label
     *
     * @return void
     */
    private function value($value, string $label = ''): void
    {
        if (is_scalar($value)) {
            $this->scalar($value, $label);
        } elseif (is_array($value)) {
            $this->iterable($value, $label);
        } elseif (is_object($value)) {
            $this->object($value, $label);
        }
    }

    /**
     * @param bool|float|int|string $scalar
     * @param string                $label
     *
     * @return void
     */
    private function scalar($scalar, string $label = ''): void
    {
        if (is_bool($scalar)) {
            $scalar = $scalar ? 'true' : 'false';
        } elseif (is_string($scalar)) {
            $scalar = "'{$this->escape($scalar)}'";
        }

        if ($label !== '') {
            $label = $this->escape($label);

            echo "console.log('%c{$label}','font-weight:bold',{$scalar});";
        } else {
            echo "console.log({$scalar});";
        }
    }

    /**
     * @param mixed[] $iterable
     * @param string  $label
     *
     * @return void
     */
    private function iterable(array $iterable, string $label = ''): void
    {
        if ($label === '') {
            $label = '...';
        }

        $this->group($label);

        foreach ($iterable as $key => $item) {
            if (!is_string($key)) {
                $key = '';
            }

            $this->value($item, $key);
        }

        $this->groupEnd();
    }

    /**
     * @param object $object
     * @param string $label
     *
     * @return void
     */
    private function object($object, string $label = ''): void
    {
        if ($object instanceof PresentationModel) {
            $this->presentationModel($object, $label);
        } elseif ($object instanceof View) {
            $this->view($object);
        } else {
            $this->iterable(get_object_vars($object), $label);
        }
    }

    /**
     * @param View $view
     *
     * @return void
     */
    private function view(View $view): void
    {
        $this->group($view->getName(), false);
        $this->presentationModel($view->getPresentationModel(), 'presentationModel');
        $this->groupEnd();
    }

    /**
     * @param PresentationModel $presentationModel
     * @param string            $label
     *
     * @return void
     */
    private function presentationModel(PresentationModel $presentationModel, string $label = ''): void
    {
        if ($label === '') {
            $label = $presentationModel->getName();
        }

        $this->group($label, false);
        $this->value($presentationModel->getName(), 'name');

        if ($presentationModel instanceof HasPresenterInterface) {
            $this->value($presentationModel->getPresenterName(), 'presenter');
        }

        $this->iterable($presentationModel->getVariables(), 'variables');
        $this->groupEnd();
    }

    /**
     * @param string $string
     *
     * @return string
     */
    private function escape(string $string): string
    {
        return addslashes($string);
    }

    /**
     * @param string $label
     * @param bool   $collapsed
     *
     * @return void
     */
    private function group(string $label, bool $collapsed = true): void
    {
        $label = $this->escape($label);

        if ($collapsed) {
            echo "console.groupCollapsed('{$label}');";
        } else {
            echo "console.group('{$label}');";
        }
    }

    /**
     * @return void
     */
    private function groupEnd(): void
    {
        echo 'console.groupEnd();';
    }

    /**
     * @return void
     */
    private function script(): void
    {
        echo '<script>';
    }

    /**
     * @return void
     */
    private function scriptEnd(): void
    {
        echo '</script>';
    }
}