TransformBuilder::without() - Code Metrics - Inspection of "Refactor function in transform builder" - flugger/laravel-responder - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v2 ( 8c624d...f3844b )

by Alexander

created 2017-08-07 00:24 UTC

TransformBuilder::without() A

↳ Parent: TransformBuilder

Complexity

Conditions	2
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

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

<?php

namespace Flugg\Responder;

use Flugg\Responder\Contracts\Pagination\PaginatorFactory;
use Flugg\Responder\Contracts\Resources\ResourceFactory;
use Flugg\Responder\Contracts\TransformFactory;
use Flugg\Responder\Exceptions\InvalidSerializerException;
use Flugg\Responder\Pagination\CursorPaginator;
use Flugg\Responder\Transformers\Transformer;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use League\Fractal\Pagination\Cursor;
use League\Fractal\Pagination\IlluminatePaginatorAdapter;
use League\Fractal\Resource\NullResource;
use League\Fractal\Serializer\SerializerAbstract;

/**
 * A builder class responsible for building transformed arrays.
 *
 * @package flugger/laravel-responder
 * @author  Alexander Tømmerås <[email protected]>
 * @license The MIT License
 */
class TransformBuilder
{
    /**
     * A factory class for making Fractal resources.
     *
     * @var \Flugg\Responder\Contracts\Resources\ResourceFactory
     */
    protected $resourceFactory;

    /**
     * A factory for making transformed arrays.
     *
     * @var \Flugg\Responder\Contracts\TransformFactory
     */
    private $transformFactory;

    /**
     * A factory used to build Fractal paginator adapters.
     *
     * @var \Flugg\Responder\Contracts\Pagination\PaginatorFactory
     */
    protected $paginatorFactory;

    /**
     * The resource that's being built.
     *
     * @var \League\Fractal\Resource\ResourceInterface
     */
    protected $resource;

    /**
     * A serializer for formatting data after transforming.
     *
     * @var \League\Fractal\Serializer\SerializerAbstract
     */
    protected $serializer;

    /**
     * A list of included relations.
     *
     * @var array
     */
    protected $with = [];

    /**
     * A list of excluded relations.
     *
     * @var array
     */
    protected $without = [];

    /**
     * A list of sparse fieldsets.
     *
     * @var array
     */
    protected $only = [];

    /**
     * Construct the builder class.
     *
     * @param \Flugg\Responder\Contracts\Resources\ResourceFactory   $resourceFactory
     * @param \Flugg\Responder\Contracts\TransformFactory            $transformFactory
     * @param \Flugg\Responder\Contracts\Pagination\PaginatorFactory $paginatorFactory
     */
    public function __construct(ResourceFactory $resourceFactory, TransformFactory $transformFactory, PaginatorFactory $paginatorFactory)
    {
        $this->resourceFactory = $resourceFactory;
        $this->transformFactory = $transformFactory;
        $this->paginatorFactory = $paginatorFactory;
    }

    /**
     * Make a resource from the given data and transformer and set the resource key.
     *
     * @param  mixed                                                          $data
     * @param  \Flugg\Responder\Transformers\Transformer|callable|string|null $transformer
     * @param  string|null                                                    $resourceKey
     * @return $this
     */
    public function resource($data = null, $transformer = null, string $resourceKey = null)
    {
        $this->resource = $this->resourceFactory->make($data, $transformer, $resourceKey);

        if ($data instanceof CursorPaginator) {
            $this->cursor($this->paginatorFactory->makeCursor($data));
        } elseif ($data instanceof LengthAwarePaginator) {
            $this->paginator($this->paginatorFactory->make($data));

        }

        return $this;
    }

    /**
     * Manually set the cursor on the resource.
     *
     * @param  \League\Fractal\Pagination\Cursor $cursor
     * @return $this
     */
    public function cursor(Cursor $cursor)
    {
        $this->resource->setCursor($cursor);
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.
    }
}

        return $this;
    }

    /**
     * Manually set the paginator on the resource.
     *
     * @param  \League\Fractal\Pagination\IlluminatePaginatorAdapter $paginator
     * @return $this
     */
    public function paginator(IlluminatePaginatorAdapter $paginator)
    {
        $this->resource->setPaginator($paginator);
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.
    }
}

        return $this;
    }

    /**
     * Add meta data appended to the response data.
     *
     * @param  array $data
     * @return $this
     */
    public function meta(array $data)
    {
        $this->resource->setMeta($data);

        return $this;
    }

    /**
     * Include relations to the transform.
     *
     * @param  string[]|string $relations
     * @return $this
     */
    public function with($relations)
    {
        $this->with = array_merge($this->with, is_array($relations) ? $relations : func_get_args());

        return $this;
    }

    /**
     * Exclude relations from the transform.
     *
     * @param  string[]|string $relations
     * @return $this
     */
    public function without($relations)
    {
        $this->without = array_merge($this->without, is_array($relations) ? $relations : func_get_args());

        return $this;
    }

    /**
     * Filter fields to output using sparse fieldsets.
     *
     * @param  string[]|string $fields
     * @return $this
     */
    public function only($fields)
    {
        $this->only = array_merge($this->only, is_array($fields) ? $fields : func_get_args());

        return $this;
    }

    /**
     * Set the serializer.
     *
     * @param  \League\Fractal\Serializer\SerializerAbstract|string $serializer
     * @return $this
     * @throws \Flugg\Responder\Exceptions\InvalidSerializerException
     */
    public function serializer($serializer)
    {
        if (is_string($serializer)) {
            $serializer = new $serializer;
        }

        if (! $serializer instanceof SerializerAbstract) {
            throw new InvalidSerializerException;
        }

        $this->serializer = $serializer;

        return $this;
    }

    /**
     * Transform and serialize the data and return the transformed array.
     *
     * @return array
     */
    public function transform(): array
    {
        $this->prepareRelations($this->resource->getData(), $this->resource->getTransformer());

        return $this->transformFactory->make($this->resource ?: new NullResource, $this->serializer, [
            'includes' => $this->with,
            'excludes' => $this->without,
            'fieldsets' => $this->only,
        ]);
    }

    /**
     * Prepare requested relations for the transformation.
     *
     * @param  mixed                                                          $data
     * @param  \Flugg\Responder\Transformers\Transformer|callable|string|null $transformer
     * @return void
     */
    protected function prepareRelations($data, $transformer)
    {
        if ($transformer instanceof Transformer) {
            $this->with($transformer->extractDefaultRelations());
        }

        if ($data instanceof Model || $data instanceof Collection) {
            $data->load($this->with);
        }

        $this->with = $this->stripEagerLoadConstraints($this->with);
    }

    /**
     * Remove eager load constraint functions from the given relations.
     *
     * @param  array $relations
     * @return array
     */
    protected function stripEagerLoadConstraints(array $relations): array
    {
        return collect($relations)->map(function ($value, $key) {
            return is_numeric($key) ? $value : $key;
        })->values()->all();
    }
}

Push — v2 ( 8c624d...f3844b )

TransformBuilder::without() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1		<?php
2
3		namespace Flugg\Responder;
4
5		use Flugg\Responder\Contracts\Pagination\PaginatorFactory;
6		use Flugg\Responder\Contracts\Resources\ResourceFactory;
7		use Flugg\Responder\Contracts\TransformFactory;
8		use Flugg\Responder\Exceptions\InvalidSerializerException;
9		use Flugg\Responder\Pagination\CursorPaginator;
10		use Flugg\Responder\Transformers\Transformer;
		0 ignored issues – show Bug introduced 2017-08-06 21:02 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `Flugg\Responder\Transformer`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
11		use Illuminate\Contracts\Pagination\LengthAwarePaginator;
12		use Illuminate\Database\Eloquent\Collection;
13		use Illuminate\Database\Eloquent\Model;
14		use League\Fractal\Pagination\Cursor;
15		use League\Fractal\Pagination\IlluminatePaginatorAdapter;
16		use League\Fractal\Resource\NullResource;
17		use League\Fractal\Serializer\SerializerAbstract;
18
19		/**
20		* A builder class responsible for building transformed arrays.
21		*
22		* @package flugger/laravel-responder
23		* @author Alexander Tømmerås <[email protected]>
24		* @license The MIT License
25		*/
26		class TransformBuilder
27		{
28		/**
29		* A factory class for making Fractal resources.
30		*
31		* @var \Flugg\Responder\Contracts\Resources\ResourceFactory
32		*/
33		protected $resourceFactory;
34
35		/**
36		* A factory for making transformed arrays.
37		*
38		* @var \Flugg\Responder\Contracts\TransformFactory
39		*/
40		private $transformFactory;
41
42		/**
43		* A factory used to build Fractal paginator adapters.
44		*
45		* @var \Flugg\Responder\Contracts\Pagination\PaginatorFactory
46		*/
47		protected $paginatorFactory;
48
49		/**
50		* The resource that's being built.
51		*
52		* @var \League\Fractal\Resource\ResourceInterface
53		*/
54		protected $resource;
55
56		/**
57		* A serializer for formatting data after transforming.
58		*
59		* @var \League\Fractal\Serializer\SerializerAbstract
60		*/
61		protected $serializer;
62
63		/**
64		* A list of included relations.
65		*
66		* @var array
67		*/
68		protected $with = [];
69
70		/**
71		* A list of excluded relations.
72		*
73		* @var array
74		*/
75		protected $without = [];
76
77		/**
78		* A list of sparse fieldsets.
79		*
80		* @var array
81		*/
82		protected $only = [];
83
84		/**
85		* Construct the builder class.
86		*
87		* @param \Flugg\Responder\Contracts\Resources\ResourceFactory $resourceFactory
88		* @param \Flugg\Responder\Contracts\TransformFactory $transformFactory
89		* @param \Flugg\Responder\Contracts\Pagination\PaginatorFactory $paginatorFactory
90		*/
91	17	public function __construct(ResourceFactory $resourceFactory, TransformFactory $transformFactory, PaginatorFactory $paginatorFactory)
92		{
93	17	$this->resourceFactory = $resourceFactory;
94	17	$this->transformFactory = $transformFactory;
95	17	$this->paginatorFactory = $paginatorFactory;
96	17	}
97
98		/**
99		* Make a resource from the given data and transformer and set the resource key.
100		*
101		* @param mixed $data
102		* @param \Flugg\Responder\Transformers\Transformer\|callable\|string\|null $transformer
103		* @param string\|null $resourceKey
104		* @return $this
105		*/
106	16	public function resource($data = null, $transformer = null, string $resourceKey = null)
107		{
108	16	$this->resource = $this->resourceFactory->make($data, $transformer, $resourceKey);
109
110	16	if ($data instanceof CursorPaginator) {
111	1	$this->cursor($this->paginatorFactory->makeCursor($data));
112		} elseif ($data instanceof LengthAwarePaginator) {
113	1	$this->paginator($this->paginatorFactory->make($data));
		0 ignored issues – show Compatibility introduced 2017-07-23 23:31 UTC by Report Bug Copy Issue Report `$this->paginatorFactory->make($data)` of type `object<League\Fractal\Pa...ion\PaginatorInterface>` is not a sub-type of `object<League\Fractal\Pa...minatePaginatorAdapter>`. It seems like you assume a concrete implementation of the interface `League\Fractal\Pagination\PaginatorInterface` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
114		}
115
116	16	return $this;
117		}
118
119		/**
120		* Manually set the cursor on the resource.
121		*
122		* @param \League\Fractal\Pagination\Cursor $cursor
123		* @return $this
124		*/
125	2	public function cursor(Cursor $cursor)
126		{
127	2	$this->resource->setCursor($cursor);
		0 ignored issues – show Bug introduced 2017-07-23 23:31 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `League\Fractal\Resource\ResourceInterface` as the method `setCursor()` does only exist in the following implementations of said interface: `League\Fractal\Resource\Collection`. 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...
128
129	2	return $this;
130		}
131
132		/**
133		* Manually set the paginator on the resource.
134		*
135		* @param \League\Fractal\Pagination\IlluminatePaginatorAdapter $paginator
136		* @return $this
137		*/
138	2	public function paginator(IlluminatePaginatorAdapter $paginator)
139		{
140	2	$this->resource->setPaginator($paginator);
		0 ignored issues – show Bug introduced 2017-07-23 23:31 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `League\Fractal\Resource\ResourceInterface` as the method `setPaginator()` does only exist in the following implementations of said interface: `League\Fractal\Resource\Collection`. 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...
141
142	2	return $this;
143		}
144
145		/**
146		* Add meta data appended to the response data.
147		*
148		* @param array $data
149		* @return $this
150		*/
151	1	public function meta(array $data)
152		{
153	1	$this->resource->setMeta($data);
154
155	1	return $this;
156		}
157
158		/**
159		* Include relations to the transform.
160		*
161		* @param string[]\|string $relations
162		* @return $this
163		*/
164	3	public function with($relations)
165		{
166	3	$this->with = array_merge($this->with, is_array($relations) ? $relations : func_get_args());
167
168	3	return $this;
169		}
170
171		/**
172		* Exclude relations from the transform.
173		*
174		* @param string[]\|string $relations
175		* @return $this
176		*/
177	2	public function without($relations)
178		{
179	2	$this->without = array_merge($this->without, is_array($relations) ? $relations : func_get_args());
180
181	2	return $this;
182		}
183
184		/**
185		* Filter fields to output using sparse fieldsets.
186		*
187		* @param string[]\|string $fields
188		* @return $this
189		*/
190	2	public function only($fields)
191		{
192	2	$this->only = array_merge($this->only, is_array($fields) ? $fields : func_get_args());
193
194	2	return $this;
195		}
196
197		/**
198		* Set the serializer.
199		*
200		* @param \League\Fractal\Serializer\SerializerAbstract\|string $serializer
201		* @return $this
202		* @throws \Flugg\Responder\Exceptions\InvalidSerializerException
203		*/
204	17	public function serializer($serializer)
205		{
206	17	if (is_string($serializer)) {
207	2	$serializer = new $serializer;
208		}
209
210	17	if (! $serializer instanceof SerializerAbstract) {
211	1	throw new InvalidSerializerException;
212		}
213
214	17	$this->serializer = $serializer;
215
216	17	return $this;
217		}
218
219		/**
220		* Transform and serialize the data and return the transformed array.
221		*
222		* @return array
223		*/
224	10	public function transform(): array
225		{
226	10	$this->prepareRelations($this->resource->getData(), $this->resource->getTransformer());
227
228	10	return $this->transformFactory->make($this->resource ?: new NullResource, $this->serializer, [
229	10	'includes' => $this->with,
230	10	'excludes' => $this->without,
231	10	'fieldsets' => $this->only,
232		]);
233		}
234
235		/**
236		* Prepare requested relations for the transformation.
237		*
238		* @param mixed $data
239		* @param \Flugg\Responder\Transformers\Transformer\|callable\|string\|null $transformer
240		* @return void
241		*/
242	10	protected function prepareRelations($data, $transformer)
243		{
244	10	if ($transformer instanceof Transformer) {
245	1	$this->with($transformer->extractDefaultRelations());
246		}
247
248	10	if ($data instanceof Model \|\| $data instanceof Collection) {
249	1	$data->load($this->with);
250		}
251
252	10	$this->with = $this->stripEagerLoadConstraints($this->with);
253	10	}
254
255		/**
256		* Remove eager load constraint functions from the given relations.
257		*
258		* @param array $relations
259		* @return array
260		*/
261		protected function stripEagerLoadConstraints(array $relations): array
262		{
263	10	return collect($relations)->map(function ($value, $key) {
264	3	return is_numeric($key) ? $value : $key;
265	10	})->values()->all();
266		}
267		}

flugger / laravel-responder

Push — v2 ( 8c624d...f3844b )

TransformBuilder::without() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like