HasRelationships::allRelationsAllowed() - Code Metrics - Inspection of "Cleaned up unit tests and small tweaks" - flugger/laravel-responder - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v2 ( e7bb8d...182303 )

by Alexander

created 2017-07-29 15:03 UTC

HasRelationships::allRelationsAllowed() A

↳ Parent: HasRelationships

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace Flugg\Responder\Transformers\Concerns;

use Closure;

/**
 * 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 the transformer has whitelisted all relations.
     *
     * @return bool
     */
    public function allRelationsAllowed(): 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 collect($this->load)->keys()->mapWithKeys(function ($relation) {
            if (method_exists($this, $method = 'load' . ucfirst($relation))) {
                return [$relation => $this->makeEagerLoadCallback($method)];
            }

            return $relation;
        });
    }

    /**
     * Extract a deep list of default relations, recursively.
     *
     * @return string[]
     */
    public function extractDefaultRelations(): array
    {
        return collect($this->getDefaultRelations())->merge($this->load->map(function ($transformer, $relation) {
            return collect($this->resolveTransformer($transformer)->extractDefaultRelations())
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                ->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();
    }

    /**
     * Extract a deep list of default relations, recursively.
     *
     * @param  string $method
     * @return \Closure
     */
    public function makeEagerLoadCallback(string $method): Closure
    {
        return function ($query) use ($method) {
            return $this->$method($query);
        };
    }
}

1		<?php
2
3		namespace Flugg\Responder\Transformers\Concerns;
4
5		use Closure;
6
7		/**
8		* A trait to be used by a transformer to handle relations
9		*
10		* @package flugger/laravel-responder
11		* @author Alexander Tømmerås <[email protected]>
12		* @license The MIT License
13		*/
14		trait HasRelationships
15		{
16		/**
17		* List of available relations.
18		*
19		* @var string[]
20		*/
21		protected $relations = ['*'];
22
23		/**
24		* A list of autoloaded default relations.
25		*
26		* @var array
27		*/
28		protected $load = [];
29
30		/**
31		* Indicates if the transformer has whitelisted all relations.
32		*
33		* @return bool
34		*/
35	3	public function allRelationsAllowed(): bool
36		{
37	3	return $this->relations == ['*'];
38		}
39
40		/**
41		* Get a list of whitelisted relations.
42		*
43		* @return string[]
44		*/
45		public function getRelations(): array
46		{
47		return array_filter($this->relations, function ($relation) {
48		return $relation !== '*';
49		});
50		}
51
52		/**
53		* Get a list of default relations.
54		*
55		* @return string[]
56		*/
57		public function getDefaultRelations(): array
58		{
59		return collect($this->load)->keys()->mapWithKeys(function ($relation) {
60		if (method_exists($this, $method = 'load' . ucfirst($relation))) {
61		return [$relation => $this->makeEagerLoadCallback($method)];
62		}
63
64		return $relation;
65		});
66		}
67
68		/**
69		* Extract a deep list of default relations, recursively.
70		*
71		* @return string[]
72		*/
73		public function extractDefaultRelations(): array
74		{
75		return collect($this->getDefaultRelations())->merge($this->load->map(function ($transformer, $relation) {
76		return collect($this->resolveTransformer($transformer)->extractDefaultRelations())
		0 ignored issues – show Bug introduced 2017-07-23 23:31 UTC by Report Bug Copy Issue Report It seems like `resolveTransformer()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
77		->keys()
78		->map(function ($nestedRelation) use ($relation) {
79		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...
80		});
81		}))->all();
82		}
83
84		/**
85		* Extract a deep list of default relations, recursively.
86		*
87		* @param string $method
88		* @return \Closure
89		*/
90		public function makeEagerLoadCallback(string $method): Closure
91		{
92		return function ($query) use ($method) {
93		return $this->$method($query);
94		};
95		}
96		}

flugger / laravel-responder

Push — v2 ( e7bb8d...182303 )

HasRelationships::allRelationsAllowed() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like