IlluminateDispatcherPlugin::onPostModifyResource() - Code Metrics - Inspection of "updated documentation, added more tests, added yam..." - pjordaan/laravel-apie - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 47e930...93ce54 )

by Pieter
created 2020-06-13 15:33 UTC
IlluminateDispatcherPlugin::onPostModifyResource() A

↳ Parent: IlluminateDispatcherPlugin
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	1
b	0
f	0
<?php


namespace W2w\Laravel\Apie\Plugins\IlluminateDispatcher;

use Illuminate\Auth\AuthManager;
use Illuminate\Contracts\Auth\Access\Gate;
use Illuminate\Contracts\Events\Dispatcher;
use Illuminate\Support\Str;
use Illuminate\Validation\Factory;
use ReflectionClass;
use W2w\Laravel\Apie\Contracts\HasApieRulesContract;
use W2w\Lib\Apie\Events\DecodeEvent;
use W2w\Lib\Apie\Events\DeleteResourceEvent;
use W2w\Lib\Apie\Events\ModifySingleResourceEvent;
use W2w\Lib\Apie\Events\NormalizeEvent;
use W2w\Lib\Apie\Events\ResponseEvent;
use W2w\Lib\Apie\Events\RetrievePaginatedResourcesEvent;
use W2w\Lib\Apie\Events\RetrieveSingleResourceEvent;
use W2w\Lib\Apie\Events\StoreExistingResourceEvent;
use W2w\Lib\Apie\Events\StoreNewResourceEvent;
use W2w\Lib\Apie\PluginInterfaces\ResourceLifeCycleInterface;

/**
 * Link the Apie resource life cycle methods Laravel:
 * - event dispatcher
 * - validation rules with adding 'rules' in context.
 * - if the api resource is linked to a policy, check the policy.
 */
class IlluminateDispatcherPlugin implements ResourceLifeCycleInterface
{
    /**
     * @var Dispatcher
     */
    private $dispatcher;

    /**
     * @var Factory
     */
    private $validator;

    /**
     * @var AuthManager
     */
    private $gate;

    /**
     * @param Dispatcher $dispatcher
     * @param Factory $validator
     * @param Gate $gate
     */
    public function __construct(Dispatcher $dispatcher, Factory $validator, Gate $gate)
    {
        $this->dispatcher = $dispatcher;
        $this->validator = $validator;
        $this->gate = $gate;

    }

    /**
     * @param string $methodName
     * @param object $event
     */
    private function dispatch(string $methodName, object $event)
    {
        $eventName = 'apie.' . Str::snake(substr($methodName, 2));
        $this->dispatcher->dispatch($eventName, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPreDeleteResource(DeleteResourceEvent $event)
    {
        if ($this->gate->getPolicyFor($event->getResourceClass())) {
            $this->gate->authorize('remove', [$event->getResourceClass(), $event->getId()]);
        }
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPostDeleteResource(DeleteResourceEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPreRetrieveResource(RetrieveSingleResourceEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPostRetrieveResource(RetrieveSingleResourceEvent $event)
    {
        if ($this->gate->getPolicyFor($event->getResource())) {
            $this->gate->authorize('view', $event->getResource());
        }

        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPreRetrieveAllResources(RetrievePaginatedResourcesEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPostRetrieveAllResources(RetrievePaginatedResourcesEvent $event)
    {
        $resources = $event->getResources();

        $event->setResources($this->iterateList($resources));
        $event->setResources($this->iterateList(/** @scrutinizer ignore-type */ $resources));
        $this->dispatch(__FUNCTION__, $event);
    }

    private function iterateList(iterable $resourceList)
    {
        foreach ($resourceList as $resource) {
            // do policy check for every individual item because of polymorphic item list.
            if (!$this->gate->getPolicyFor($resource) || $this->gate->allows('view', $resource)) {
                yield $resource;
            }
        }
    }

    /**
     * {@inheritDoc}
     */
    public function onPrePersistExistingResource(StoreExistingResourceEvent $event)
    {
        if ($this->gate->getPolicyFor($event->getResource())) {
            $this->gate->authorize('update', $event->getResource());
        }
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPostPersistExistingResource(StoreExistingResourceEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPreModifyResource(ModifySingleResourceEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPostModifyResource(ModifySingleResourceEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPreCreateResource(StoreNewResourceEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPostCreateResource(StoreNewResourceEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPrePersistNewResource(StoreExistingResourceEvent $event)
    {
        if ($this->gate->getPolicyFor($event->getResource())) {
            $this->gate->authorize('create', $event->getResource());
        }
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPostPersistNewResource(StoreExistingResourceEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPreCreateResponse(ResponseEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPostCreateResponse(ResponseEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPreCreateNormalizedData(NormalizeEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPostCreateNormalizedData(NormalizeEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPreDecodeRequestBody(DecodeEvent $event)
    {
        $this->dispatch(__FUNCTION__, $event);
    }

    /**
     * {@inheritDoc}
     */
    public function onPostDecodeRequestBody(DecodeEvent $event)
    {
        $refl = new ReflectionClass($event->getResourceClass());
        if ($refl->implementsInterface(HasApieRulesContract::class)) {
            // maybe move this to a listener?
            $rules = $refl->getMethod('getApieRules')->invoke(null);
            $decodedData = json_decode(json_encode($event->getDecodedData()), true);
            $validation = $this->validator->make($decodedData, $rules);
            $validation->validate();
        }
        $this->dispatch(__FUNCTION__, $event);
    }
}

pjordaan / laravel-apie

Push — master ( 47e930...93ce54 )

IlluminateDispatcherPlugin::onPostModifyResource() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
