AbstractTableController - Code Metrics - Inspection of "Update pragmarx/google2fa requirement from ^6.1 to..." - Cherry-Pie/Jarboe - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#14)

unknown

created 2020-04-26 10:04 UTC

AbstractTableController A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	215
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	35

Test Coverage

Coverage

85.88%

Importance

Changes

Metric	Value
wmc	33
lcom	2
cbo	35
dl	0
loc	215
ccs	73
cts	85
cp	0.8588
rs	9.76
c	0
b	0
f	0

7 Methods

Rating	Name	Size	Complexity
A	__construct()	14	1
A	can()	17	5
A	crud()	4	1
D	__call()	56	18
A	bound()	18	4
A	createUnauthorizedResponse()	10	2
A	model()	8	2

<?php

namespace Yaro\Jarboe\Http\Controllers;

use Illuminate\Foundation\Validation\ValidatesRequests;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Request as RequestFacade;
use Illuminate\Validation\ValidationException;
use Spatie\Permission\Exceptions\UnauthorizedException;
use Yaro\Jarboe\Http\Controllers\Traits\AliasesTrait;
use Yaro\Jarboe\Http\Controllers\Traits\BreadcrumbsTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\CreateHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\DeleteHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\EditHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\ForceDeleteHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\InlineHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\ListHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\OrderByHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\PerPageHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\RenderRepeaterItemHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\RestoreHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\SearchHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\SearchRelationHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\SortableHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\StoreHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\ToolbarHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\Handlers\UpdateHandlerTrait;
use Yaro\Jarboe\Http\Controllers\Traits\NotifyTrait;
use Yaro\Jarboe\Table\Actions\CreateAction;
use Yaro\Jarboe\Table\Actions\DeleteAction;
use Yaro\Jarboe\Table\Actions\EditAction;
use Yaro\Jarboe\Table\Actions\ForceDeleteAction;
use Yaro\Jarboe\Table\Actions\RestoreAction;
use Yaro\Jarboe\Table\CRUD;
use Yaro\Jarboe\Table\Fields\AbstractField;
use Yaro\Jarboe\Table\Toolbar\TranslationLocalesSelectorTool;
use Yaro\Jarboe\ViewComponents\Breadcrumbs\BreadcrumbsInterface;

/**
 * @method mixed list(Request $request)
 * @method mixed search(Request $request)
 * @method mixed create(Request $request)
 * @method mixed store(Request $request)
 * @method mixed edit(Request $request, $id)
 * @method mixed update(Request $request, $id)
 * @method mixed delete(Request $request, $id)
 * @method mixed restore(Request $request, $id)
 * @method mixed forceDelete(Request $request, $id)
 * @method mixed inline(Request $request)
 */
abstract class AbstractTableController
{
    use ValidatesRequests;
    use NotifyTrait;
    use AliasesTrait;
    use DeleteHandlerTrait;
    use ToolbarHandlerTrait;
    use InlineHandlerTrait;
    use ForceDeleteHandlerTrait;
    use RestoreHandlerTrait;
    use UpdateHandlerTrait;
    use StoreHandlerTrait;
    use ListHandlerTrait;
    use EditHandlerTrait;
    use CreateHandlerTrait;
    use OrderByHandlerTrait;
    use PerPageHandlerTrait;
    use SortableHandlerTrait;
    use SearchRelationHandlerTrait;
    use SearchHandlerTrait;
    use BreadcrumbsTrait;
    use RenderRepeaterItemHandlerTrait;

    /**
     * Permission group name.
     *
     * @var string|array
     * array(
     *     'list'        => 'permission:list',
     *     'search'      => 'permission:search',
     *     'create'      => 'permission:create',
     *     'store'       => 'permission:store',
     *     'edit'        => 'permission:edit',
     *     'update'      => 'permission:update',
     *     'inline'      => 'permission:inline',
     *     'delete'      => 'permission:delete',
     *     'restore'     => 'permission:restore',
     *     'forceDelete' => 'permission:force-delete',
     * )
     */
    protected $permissions = '';

    /**
     * @var CRUD
     */
    protected $crud;

    /**
     * ID of manipulated model.
     *
     * @var mixed
     */
    protected $idEntity;

    public function __construct()
    {
        $this->crud = app(CRUD::class);
        $this->crud()->tableIdentifier(crc32(static::class));
        $this->crud()->formClass(config('jarboe.crud.form_class'));
        $this->crud()->actions()->set([
            CreateAction::make(),
            EditAction::make(),
            RestoreAction::make(),
            DeleteAction::make(),
            ForceDeleteAction::make(),
        ]);
        $this->breadcrumbs = app(BreadcrumbsInterface::class);
    }

    protected function crud(): CRUD
    {
        return $this->crud;
    }

    /**
     * Check if user has permission for the action.
     *
     * @param $action
     * @return bool
     */
    protected function can($action): bool
    {
        if (!$this->permissions) {
            return true;
        }
        if (is_array($this->permissions) && !array_key_exists($action, $this->permissions)) {
            return true;
        }

        if (is_array($this->permissions)) {
            $permission = $this->permissions[$action];
        } else {
            $permission = sprintf('%s:%s', $this->permissions, $action);
        }

        return $this->admin()->can($permission);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function __call($name, $arguments)

    {
        /** @var Request $request */
        $request = RequestFacade::instance();

        $id = null;
        if (isset($arguments[0])) {
            $id = $arguments[1] ?? $arguments[0];
        }

        try {
            switch ($name) {
                case 'list':
                    return $this->handleList($request);
                case 'search':
                    return $this->handleSearch($request);
                case 'create':
                    return $this->handleCreate($request);
                case 'store':
                    return $this->handleStore($request);
                case 'edit':
                    return $this->handleEdit($request, $id);
                case 'update':
                    return $this->handleUpdate($request, $id);
                case 'delete':
                    return $this->handleDelete($request, $id);
                case 'restore':
                    return $this->handleRestore($request, $id);
                case 'forceDelete':
                    return $this->handleForceDelete($request, $id);
                case 'inline':
                    return $this->handleInline($request);
                case 'renderRepeaterItem':
                    $fieldName = $id;
                    return $this->handleRenderRepeaterItem($request, $fieldName);

                default:
                    throw new \RuntimeException('Invalid method ' . $name);
            }
        } catch (ValidationException $e) {
            throw $e;
        } catch (UnauthorizedException $e) {
            return $this->createUnauthorizedResponse($request, $e);
        } catch (\Throwable $e) {
            // TODO: response objects
            if ($request->isXmlHttpRequest() || $request->wantsJson()) {
                return response()->json([
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                    'title' => get_class($e),
                    'description' => $e->getMessage(),
                ], 406);
            }

            $this->notifyBigDanger(get_class($e), $e->getMessage(), 0);
            return redirect()->back()->withInput($request->input());
        }
    }

    /**
     * Bound fields/tools/etc with global data.
     */
    protected function bound()
    {
        /** @var AbstractField $field */
        foreach ($this->crud()->getAllFieldObjects() as $field) {
            $field->prepare($this->crud);
        }

        /** @var AbstractField $field */
        foreach ($this->crud()->getFieldsWithoutMarkup() as $field) {
            if ($field->isTranslatable()) {
                $this->addTool(new TranslationLocalesSelectorTool());
                break;
            }
        }

        $this->crud()->actions()->setCrud($this->crud());
        $this->initBreadcrumbs();
    }

    /**
     * Create response for unauthorized request.
     *
     * @param Request $request
     * @param UnauthorizedException $exception
     * @return \Illuminate\Contracts\View\Factory|\Illuminate\Http\JsonResponse|\Illuminate\View\View
     */
    protected function createUnauthorizedResponse(Request $request, UnauthorizedException $exception)
    {
        if ($request->wantsJson()) {
            return response()->json([
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
                'message' => $exception->getMessage()
            ], 401);
        }

        return view('jarboe::errors.401');
    }

    /**
     * Get model for current request.
     *
     * @return string
     * @throws \RuntimeException
     */
    protected function model()
    {
        if (!$this->idEntity) {
            throw new \RuntimeException('Trying to access to non-existed entity');
        }

        return $this->crud()->repo()->find($this->idEntity);
    }

    /**
     * @return void
     */
    abstract protected function init();
}


Pull Request — master (#14)

AbstractTableController A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

7 Methods

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		namespace Yaro\Jarboe\Http\Controllers;
4
5		use Illuminate\Foundation\Validation\ValidatesRequests;
6		use Illuminate\Http\Request;
7		use Illuminate\Support\Facades\Request as RequestFacade;
8		use Illuminate\Validation\ValidationException;
9		use Spatie\Permission\Exceptions\UnauthorizedException;
10		use Yaro\Jarboe\Http\Controllers\Traits\AliasesTrait;
11		use Yaro\Jarboe\Http\Controllers\Traits\BreadcrumbsTrait;
12		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\CreateHandlerTrait;
13		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\DeleteHandlerTrait;
14		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\EditHandlerTrait;
15		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\ForceDeleteHandlerTrait;
16		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\InlineHandlerTrait;
17		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\ListHandlerTrait;
18		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\OrderByHandlerTrait;
19		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\PerPageHandlerTrait;
20		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\RenderRepeaterItemHandlerTrait;
21		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\RestoreHandlerTrait;
22		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\SearchHandlerTrait;
23		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\SearchRelationHandlerTrait;
24		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\SortableHandlerTrait;
25		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\StoreHandlerTrait;
26		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\ToolbarHandlerTrait;
27		use Yaro\Jarboe\Http\Controllers\Traits\Handlers\UpdateHandlerTrait;
28		use Yaro\Jarboe\Http\Controllers\Traits\NotifyTrait;
29		use Yaro\Jarboe\Table\Actions\CreateAction;
30		use Yaro\Jarboe\Table\Actions\DeleteAction;
31		use Yaro\Jarboe\Table\Actions\EditAction;
32		use Yaro\Jarboe\Table\Actions\ForceDeleteAction;
33		use Yaro\Jarboe\Table\Actions\RestoreAction;
34		use Yaro\Jarboe\Table\CRUD;
35		use Yaro\Jarboe\Table\Fields\AbstractField;
36		use Yaro\Jarboe\Table\Toolbar\TranslationLocalesSelectorTool;
37		use Yaro\Jarboe\ViewComponents\Breadcrumbs\BreadcrumbsInterface;
38
39		/**
40		* @method mixed list(Request $request)
41		* @method mixed search(Request $request)
42		* @method mixed create(Request $request)
43		* @method mixed store(Request $request)
44		* @method mixed edit(Request $request, $id)
45		* @method mixed update(Request $request, $id)
46		* @method mixed delete(Request $request, $id)
47		* @method mixed restore(Request $request, $id)
48		* @method mixed forceDelete(Request $request, $id)
49		* @method mixed inline(Request $request)
50		*/
51		abstract class AbstractTableController
52		{
53		use ValidatesRequests;
54		use NotifyTrait;
55		use AliasesTrait;
56		use DeleteHandlerTrait;
57		use ToolbarHandlerTrait;
58		use InlineHandlerTrait;
59		use ForceDeleteHandlerTrait;
60		use RestoreHandlerTrait;
61		use UpdateHandlerTrait;
62		use StoreHandlerTrait;
63		use ListHandlerTrait;
64		use EditHandlerTrait;
65		use CreateHandlerTrait;
66		use OrderByHandlerTrait;
67		use PerPageHandlerTrait;
68		use SortableHandlerTrait;
69		use SearchRelationHandlerTrait;
70		use SearchHandlerTrait;
71		use BreadcrumbsTrait;
72		use RenderRepeaterItemHandlerTrait;
73
74		/**
75		* Permission group name.
76		*
77		* @var string\|array
78		* array(
79		* 'list' => 'permission:list',
80		* 'search' => 'permission:search',
81		* 'create' => 'permission:create',
82		* 'store' => 'permission:store',
83		* 'edit' => 'permission:edit',
84		* 'update' => 'permission:update',
85		* 'inline' => 'permission:inline',
86		* 'delete' => 'permission:delete',
87		* 'restore' => 'permission:restore',
88		* 'forceDelete' => 'permission:force-delete',
89		* )
90		*/
91		protected $permissions = '';
92
93		/**
94		* @var CRUD
95		*/
96		protected $crud;
97
98		/**
99		* ID of manipulated model.
100		*
101		* @var mixed
102		*/
103		protected $idEntity;
104
105	70	public function __construct()
106		{
107	70	$this->crud = app(CRUD::class);
108	70	$this->crud()->tableIdentifier(crc32(static::class));
109	70	$this->crud()->formClass(config('jarboe.crud.form_class'));
110	70	$this->crud()->actions()->set([
111	70	CreateAction::make(),
112	70	EditAction::make(),
113	70	RestoreAction::make(),
114	70	DeleteAction::make(),
115	70	ForceDeleteAction::make(),
116		]);
117	70	$this->breadcrumbs = app(BreadcrumbsInterface::class);
118	70	}
119
120	70	protected function crud(): CRUD
121		{
122	70	return $this->crud;
123		}
124
125		/**
126		* Check if user has permission for the action.
127		*
128		* @param $action
129		* @return bool
130		*/
131	35	protected function can($action): bool
132		{
133	35	if (!$this->permissions) {
134	15	return true;
135		}
136	21	if (is_array($this->permissions) && !array_key_exists($action, $this->permissions)) {
137	1	return true;
138		}
139
140	21	if (is_array($this->permissions)) {
141	1	$permission = $this->permissions[$action];
142		} else {
143	21	$permission = sprintf('%s:%s', $this->permissions, $action);
144		}
145
146	21	return $this->admin()->can($permission);
		0 ignored issues – show Bug introduced 2019-10-24 14:58 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Illuminate\Contracts\Auth\Authenticatable` as the method `can()` does only exist in the following implementations of said interface: `Illuminate\Foundation\Auth\User`, `Yaro\Jarboe\Models\Admin`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
147		}
148
149	23	public function __call($name, $arguments)
		0 ignored issues – show Documentation introduced 2019-08-31 12:57 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
150		{
151		/** @var Request $request */
152	23	$request = RequestFacade::instance();
153
154	23	$id = null;
155	23	if (isset($arguments[0])) {
156	22	$id = $arguments[1] ?? $arguments[0];
157		}
158
159		try {
160	23	switch ($name) {
161	23	case 'list':
162	3	return $this->handleList($request);
163	20	case 'search':
164	2	return $this->handleSearch($request);
165	18	case 'create':
166	2	return $this->handleCreate($request);
167	16	case 'store':
168	2	return $this->handleStore($request);
169	14	case 'edit':
170	2	return $this->handleEdit($request, $id);
171	12	case 'update':
172	2	return $this->handleUpdate($request, $id);
173	10	case 'delete':
174	2	return $this->handleDelete($request, $id);
175	8	case 'restore':
176	3	return $this->handleRestore($request, $id);
177	5	case 'forceDelete':
178	2	return $this->handleForceDelete($request, $id);
179	3	case 'inline':
180	2	return $this->handleInline($request);
181	1	case 'renderRepeaterItem':
182		$fieldName = $id;
183		return $this->handleRenderRepeaterItem($request, $fieldName);
184
185		default:
186	1	throw new \RuntimeException('Invalid method ' . $name);
187		}
188	12	} catch (ValidationException $e) {
189	1	throw $e;
190	11	} catch (UnauthorizedException $e) {
191	10	return $this->createUnauthorizedResponse($request, $e);
192	1	} catch (\Throwable $e) {
193		// TODO: response objects
194	1	if ($request->isXmlHttpRequest() \|\| $request->wantsJson()) {
195		return response()->json([
		0 ignored issues – show Bug introduced 2020-01-10 20:13 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Illuminate\Contracts\Routing\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
196		'title' => get_class($e),
197		'description' => $e->getMessage(),
198		], 406);
199		}
200
201	1	$this->notifyBigDanger(get_class($e), $e->getMessage(), 0);
202	1	return redirect()->back()->withInput($request->input());
203		}
204		}
205
206		/**
207		* Bound fields/tools/etc with global data.
208		*/
209	50	protected function bound()
210		{
211		/** @var AbstractField $field */
212	50	foreach ($this->crud()->getAllFieldObjects() as $field) {
213	49	$field->prepare($this->crud);
214		}
215
216		/** @var AbstractField $field */
217	50	foreach ($this->crud()->getFieldsWithoutMarkup() as $field) {
218	49	if ($field->isTranslatable()) {
219		$this->addTool(new TranslationLocalesSelectorTool());
220		break;
221		}
222		}
223
224	50	$this->crud()->actions()->setCrud($this->crud());
225	50	$this->initBreadcrumbs();
226	50	}
227
228		/**
229		* Create response for unauthorized request.
230		*
231		* @param Request $request
232		* @param UnauthorizedException $exception
233		* @return \Illuminate\Contracts\View\Factory\|\Illuminate\Http\JsonResponse\|\Illuminate\View\View
234		*/
235	11	protected function createUnauthorizedResponse(Request $request, UnauthorizedException $exception)
236		{
237	11	if ($request->wantsJson()) {
238	1	return response()->json([
		0 ignored issues – show Bug introduced 2019-09-03 10:29 UTC by Report Bug Copy Issue Report The method `json` does only exist in `Illuminate\Contracts\Routing\ResponseFactory`, but not in `Illuminate\Http\Response`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
239	1	'message' => $exception->getMessage()
240	1	], 401);
241		}
242
243	11	return view('jarboe::errors.401');
244		}
245
246		/**
247		* Get model for current request.
248		*
249		* @return string
250		* @throws \RuntimeException
251		*/
252		protected function model()
253		{
254		if (!$this->idEntity) {
255		throw new \RuntimeException('Trying to access to non-existed entity');
256		}
257
258		return $this->crud()->repo()->find($this->idEntity);
259		}
260
261		/**
262		* @return void
263		*/
264		abstract protected function init();
265		}
266

Cherry-Pie / Jarboe

Pull Request — master (#14)

AbstractTableController A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

7 Methods

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like