HasRelationships::getDefaultRelations() - Code Metrics - Inspection of "Small tweaks" - flugger/laravel-responder - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v2 ( b247ab...8c624d )

by Alexander

created 2017-08-07 00:14 UTC

HasRelationships::getDefaultRelations() A

↳ Parent: HasRelationships

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace Flugg\Responder\Transformers\Concerns;

use Closure;
use Illuminate\Contracts\Container\Container;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;

/**
 * A trait to be used by a transformer to handle relations
 *
 * @package flugger/laravel-responder
 * @author  Alexander Tømmerås <[email protected]>
 * @license The MIT License
 */
trait HasRelationships
{
    /**
     * List of available relations.
     *
     * @var string[]
     */
    protected $relations = ['*'];

    /**
     * A list of autoloaded default relations.
     *
     * @var array
     */
    protected $load = [];

    /**
     * Indicates if all relations are allowed.
     *
     * @return bool
     */
    public function allowsAllRelations(): bool
    {
        return $this->relations == ['*'];
    }

    /**
     * Get a list of whitelisted relations.
     *
     * @return string[]
     */
    public function getRelations(): array
    {
        return array_filter($this->relations, function ($relation) {
            return $relation != '*';
        });
    }

    /**
     * Get a list of default relations.
     *
     * @return string[]
     */
    public function getDefaultRelations(): array
    {
        return array_keys($this->load);
    }

    /**
     * Extract a deep list of default relations, recursively.
     *
     * @return string[]
     */
    public function extractDefaultRelations(): array
    {
        return collect($this->getDefaultRelationsWithEagerLoads())
            ->merge(collect($this->load)->map(function ($transformer, $relation) {
                return collect($this->resolveContainer()->make($transformer)->extractDefaultRelations())
                    ->keys()
                    ->map(function ($nestedRelation) use ($relation) {
                        return "$relation.$nestedRelation";
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
                    });
            }))
            ->all();
    }

    /**
     *
     *
     * @return string[]
     */
    protected function getDefaultRelationsWithEagerLoads(): array
    {
        return collect($this->load)->keys()->mapWithKeys(function ($relation) {
            if (method_exists($this, $method = 'load' . ucfirst($relation))) {
                return [$relation => $this->makeEagerLoadCallback($method)];
            }

            return [$relation => function () { }];
        })->all();
    }

    /**
     *
     *
     * @param  string $method
     * @return \Closure
     */
    protected function makeEagerLoadCallback(string $method): Closure
    {
        return function ($query) use ($method) {
            return $this->$method($query);
        };
    }

    /**
     *
     *
     * @param \Illuminate\Database\Eloquent\Model $model
     * @param  string                             $identifier
     * @return mixed
     */
    protected function resolveRelation(Model $model, string $identifier)
    {
        if (method_exists($this, $method = 'filter' . ucfirst($identifier))) {
            return $this->$method($model->$identifier);
        }

        return $model->$identifier;
    }

    /**
     * Resolve a container using the resolver callback.
     *
     * @return \Illuminate\Contracts\Container\Container
     */
    protected abstract function resolveContainer(): Container;
}

1			<?php
2
3			namespace Flugg\Responder\Transformers\Concerns;
4
5			use Closure;
6			use Illuminate\Contracts\Container\Container;
7			use Illuminate\Database\Eloquent\Model;
8			use Illuminate\Support\Collection;
9
10			/**
11			* A trait to be used by a transformer to handle relations
12			*
13			* @package flugger/laravel-responder
14			* @author Alexander Tømmerås <[email protected]>
15			* @license The MIT License
16			*/
17			trait HasRelationships
18			{
19			/**
20			* List of available relations.
21			*
22			* @var string[]
23			*/
24			protected $relations = ['*'];
25
26			/**
27			* A list of autoloaded default relations.
28			*
29			* @var array
30			*/
31			protected $load = [];
32
33			/**
34			* Indicates if all relations are allowed.
35			*
36			* @return bool
37			*/
38			public function allowsAllRelations(): bool
39			{
40			return $this->relations == ['*'];
41			}
42
43			/**
44			* Get a list of whitelisted relations.
45			*
46			* @return string[]
47			*/
48			public function getRelations(): array
49			{
50			return array_filter($this->relations, function ($relation) {
51			return $relation != '*';
52			});
53			}
54
55			/**
56			* Get a list of default relations.
57			*
58			* @return string[]
59			*/
60			public function getDefaultRelations(): array
61			{
62			return array_keys($this->load);
63			}
64
65			/**
66			* Extract a deep list of default relations, recursively.
67			*
68			* @return string[]
69			*/
70			public function extractDefaultRelations(): array
71			{
72			return collect($this->getDefaultRelationsWithEagerLoads())
73			->merge(collect($this->load)->map(function ($transformer, $relation) {
74			return collect($this->resolveContainer()->make($transformer)->extractDefaultRelations())
75			->keys()
76			->map(function ($nestedRelation) use ($relation) {
77			return "$relation.$nestedRelation";
			0 ignored issues – show Coding Style Best Practice introduced 2017-07-23 23:31 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$relation` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history... Coding Style Best Practice introduced 2017-07-23 23:31 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$nestedRelation` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
78			});
79			}))
80			->all();
81			}
82
83			/**
84			*
85			*
86			* @return string[]
87			*/
88			protected function getDefaultRelationsWithEagerLoads(): array
89			{
90			return collect($this->load)->keys()->mapWithKeys(function ($relation) {
91			if (method_exists($this, $method = 'load' . ucfirst($relation))) {
92			return [$relation => $this->makeEagerLoadCallback($method)];
93			}
94
95			return [$relation => function () { }];
96			})->all();
97			}
98
99			/**
100			*
101			*
102			* @param string $method
103			* @return \Closure
104			*/
105			protected function makeEagerLoadCallback(string $method): Closure
106			{
107			return function ($query) use ($method) {
108			return $this->$method($query);
109			};
110			}
111
112			/**
113			*
114			*
115			* @param \Illuminate\Database\Eloquent\Model $model
116			* @param string $identifier
117			* @return mixed
118			*/
119			protected function resolveRelation(Model $model, string $identifier)
120			{
121			if (method_exists($this, $method = 'filter' . ucfirst($identifier))) {
122			return $this->$method($model->$identifier);
123			}
124
125			return $model->$identifier;
126			}
127
128			/**
129			* Resolve a container using the resolver callback.
130			*
131			* @return \Illuminate\Contracts\Container\Container
132			*/
133			protected abstract function resolveContainer(): Container;
134			}

flugger / laravel-responder

Push — v2 ( b247ab...8c624d )

HasRelationships::getDefaultRelations() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like