WidgetRenderer::printError() - Code Metrics - Inspection of "refactor" - imanghafoori1/laravel-widgetize - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d51216...708e0d )

by Iman

created 2019-07-09 17:33 UTC

WidgetRenderer::printError() A

↳ Parent: WidgetRenderer

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	3
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	6
ccs	0
cts	4
cp	0
crap	6
rs	10

<?php

namespace Imanghafoori\Widgets\Utils;

use Illuminate\Contracts\Debug\ExceptionHandler;
use Illuminate\Support\Str;

class WidgetRenderer
{
    public $html;

    private $_viewData;

    private $_policies;

    /**
     * BaseWidget constructor.
     */
    public function __construct()
    {
        $this->_policies = app(Policies::class);
    }

    /**
     * @param $widget object|string
     * @param array $args
     * @return string
     */
    public function renderWidget($widget, ...$args)
    {
        if (is_string($widget)) {
            $widget = $this->makeWidgetObj($widget);
        }
        event('widgetize.rendering_widget', [$widget]);

        app(Normalizer::class)->normalizeWidgetConfig($widget);

        if (app()->offsetExists('debugbar')) {
            app('widgetize.debugger')->addMessage(['widget class:' => $widget, 'args:' => $args]);
        }

        try {
            $html = $this->generateHtml($widget, ...$args);
        } catch (\Exception $e) {

            return app()->make(ExceptionHandler::class)->render(app('request'), $e)->send();
        }

        return $html;
    }

    /**
     * @param $widget object
     * @return \Illuminate\Foundation\Application|mixed
     */
    private function makeWidgetObj($widget)
    {
        if (starts_with($widget, ['\\'])) {
            return app($widget);
        }

        $widget = app()->getNamespace().'Widgets\\'.$widget;
        $widget = app()->/** @scrutinizer ignore-call */ getNamespace().'Widgets\\'.$widget;

        return app($widget);
    }

    /**
     * It tries to get the html from cache if possible, otherwise generates it.
     *
     * @param $widget object
     * @param array ...$args
     *
     * @return string
     */
    private function generateHtml($widget, ...$args)
    {
        // Everything inside this function is executed only when the cache is not available.
        $expensivePhpCode = function () use ($widget, $args) {
            $this->makeDataForView($widget, $args);

            return $this->renderTemplate($widget);
        };

        if (! $widget->cacheView) {
            return $expensivePhpCode();
        }

        // We first try to get the output from the cache before trying to run the expensive $expensivePhpCode...
        return app(Cache::class)->cacheResult($args, $expensivePhpCode, $widget);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }

    /**
     * @param $widget object
     * @param $args array
     *
     * @return null
     */
    private function makeDataForView($widget, array $args)
    {
        $expensiveCode = function () use ($widget, $args) {

            // Here we call the data method on the widget class.
            $viewData = \App::call($widget->controller, ...$args);
            $viewData = \App::call($widget->controller, /** @scrutinizer ignore-type */ ...$args);

            if (($widget->presenter)) {
                // We make an object and call the `present` method on it.
                // Piping the data through the presenter before sending it to view.
                $viewData = \App::call($widget->presenter, [$viewData]);
            }

            return $viewData;
        };

        if ($widget->cacheView) {
            $this->_viewData = $expensiveCode();
        } else {
            $this->_viewData = app(Cache::class)->cacheResult($args, $expensiveCode, $widget, 'dataProvider');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        }
    }

    /**
     * @param $widget object
     * @return string HTML output
     * @throws \Throwable
     */
    private function renderTemplate($widget)
    {
        // Here we render the view file to raw html.
        try {
            $this->html = view($widget->template, [$widget->contextAs => $this->_viewData])->render();
        } catch (\Exception $e) {
            $this->printError($widget, $e);
        }

        // We try to minify the html before storing it in cache to save space.
        if ($this->_policies->widgetShouldBeMinified($widget)) {
            $this->html = app(HtmlMinifier::class)->minify($this->html);
        }

        // We add some HTML comments before and after the widget output
        // So then, we will be able to easily identify the widget in browser's developer tool.
        if ($this->_policies->widgetShouldHaveDebugInfo()) {
            $this->html = app(DebugInfo::class)->addIdentifierToHtml($widget, $this->html);
        }

        return $this->html;
    }

    /**
     * @param            $widget
     * @param \Exception $e
     */
    private function printError($widget, \Exception $e): void
    {
        if (Str::contains($e->getMessage(), 'Undefined variable:')) {
            dump('You should use the "$'.$widget->contextAs.'" variable in your widget view to access controller data');
        }
        dd($e);
    }
}


imanghafoori1 / laravel-widgetize

Push — master ( d51216...708e0d )

WidgetRenderer::printError() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like