QueryBuilderRequest::getFilterValue() - Code Metrics - Inspection of "Split comma separated filter values on unspaced co..." - spatie/laravel-query-builder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#346)

unknown

created 2019-09-27 10:10 UTC

QueryBuilderRequest::getFilterValue() A

↳ Parent: QueryBuilderRequest

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	22
rs	9.2568
c	0
b	0
f	0
cc	5
nc	5
nop	1

<?php

namespace Spatie\QueryBuilder;

use Illuminate\Support\Str;
use Illuminate\Http\Request;
use Illuminate\Support\Collection;

class QueryBuilderRequest extends Request
{
    public static function fromRequest(Request $request): self
    {
        return static::createFrom($request, new self());
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function includes(): Collection
    {
        $includeParameterName = config('query-builder.parameters.include');

        $includeParts = $this->query($includeParameterName);

        if (! is_array($includeParts)) {
            $includeParts = explode(',', strtolower($this->query($includeParameterName)));
        }

        return collect($includeParts)
            ->filter()
            ->map([Str::class, 'camel']);
    }

    public function appends(): Collection

    {
        $appendParameterName = config('query-builder.parameters.append');

        $appendParts = $this->query($appendParameterName);

        if (! is_array($appendParts)) {
            $appendParts = explode(',', strtolower($appendParts));
        }

        return collect($appendParts)->filter();
    }

    public function filters(): Collection

    {
        $filterParameterName = config('query-builder.parameters.filter');

        $filterParts = $this->query($filterParameterName, []);

        if (is_string($filterParts)) {
            return collect();
        }

        $filters = collect($filterParts);

        return $filters->map(function ($value) {
            return $this->getFilterValue($value);
        });
    }

    public function fields(): Collection

    {
        $fieldsParameterName = config('query-builder.parameters.fields');

        $fieldsPerTable = collect($this->query($fieldsParameterName));

        if ($fieldsPerTable->isEmpty()) {
            return collect();
        }

        return $fieldsPerTable->map(function ($fields) {
            return explode(',', $fields);
        });
    }

    public function sorts(): Collection

    {
        $sortParameterName = config('query-builder.parameters.sort');

        $sortParts = $this->query($sortParameterName);

        if (is_string($sortParts)) {
            $sortParts = explode(',', $sortParts);
        }

        return collect($sortParts)->filter();
    }

    /**
     * @param $value
     *
     * @return array|bool
     */
    protected function getFilterValue($value)
    {
        if (is_array($value)) {
            return collect($value)->map(function ($valueValue) {
                return $this->getFilterValue($valueValue);
            })->all();
        }

        if (Str::contains($value, ',')) {
            return $this->explodeIgnoringWhitespace(',', $value);
        }

        if ($value === 'true') {
            return true;
        }

        if ($value === 'false') {
            return false;
        }

        return $value;
    }

    /**
     * @param string $delimiter The boundary string.
     * @param string $string The input string
     *
     * @return array The values between the delimiters in the given string, ignoring any spaced delimiters inside values
     */
    private function explodeIgnoringWhitespace(string $delimiter, string $string): array
    {
        return preg_split(
            '/'.preg_quote($delimiter).'(?=\S)/',
            trim($string, $delimiter),
            null,
            PREG_SPLIT_NO_EMPTY
        );
    }
}


1		<?php
2
3		namespace Spatie\QueryBuilder;
4
5		use Illuminate\Support\Str;
6		use Illuminate\Http\Request;
7		use Illuminate\Support\Collection;
8
9		class QueryBuilderRequest extends Request
10		{
11		public static function fromRequest(Request $request): self
12		{
13		return static::createFrom($request, new self());
		0 ignored issues – show Documentation introduced 2019-03-11 09:17 UTC by Report Bug Copy Issue Report `$request` is of type `object<Illuminate\Http\Request>`, but the function expects a `object<self>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
14		}
15
16		public function includes(): Collection
17		{
18		$includeParameterName = config('query-builder.parameters.include');
19
20		$includeParts = $this->query($includeParameterName);
21
22		if (! is_array($includeParts)) {
23		$includeParts = explode(',', strtolower($this->query($includeParameterName)));
24		}
25
26		return collect($includeParts)
27		->filter()
28		->map([Str::class, 'camel']);
29		}
30
31	View Code Duplication	public function appends(): Collection
		0 ignored issues – show Duplication introduced 2019-08-05 15:01 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
32		{
33		$appendParameterName = config('query-builder.parameters.append');
34
35		$appendParts = $this->query($appendParameterName);
36
37		if (! is_array($appendParts)) {
38		$appendParts = explode(',', strtolower($appendParts));
39		}
40
41		return collect($appendParts)->filter();
42		}
43
44	View Code Duplication	public function filters(): Collection
		0 ignored issues – show Duplication introduced 2019-08-05 15:01 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
45		{
46		$filterParameterName = config('query-builder.parameters.filter');
47
48		$filterParts = $this->query($filterParameterName, []);
49
50		if (is_string($filterParts)) {
51		return collect();
52		}
53
54		$filters = collect($filterParts);
55
56		return $filters->map(function ($value) {
57		return $this->getFilterValue($value);
58		});
59		}
60
61	View Code Duplication	public function fields(): Collection
		0 ignored issues – show Duplication introduced 2019-03-11 09:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
62		{
63		$fieldsParameterName = config('query-builder.parameters.fields');
64
65		$fieldsPerTable = collect($this->query($fieldsParameterName));
66
67		if ($fieldsPerTable->isEmpty()) {
68		return collect();
69		}
70
71		return $fieldsPerTable->map(function ($fields) {
72		return explode(',', $fields);
73		});
74		}
75
76	View Code Duplication	public function sorts(): Collection
		0 ignored issues – show Duplication introduced 2019-04-11 02:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
77		{
78		$sortParameterName = config('query-builder.parameters.sort');
79
80		$sortParts = $this->query($sortParameterName);
81
82		if (is_string($sortParts)) {
83		$sortParts = explode(',', $sortParts);
84		}
85
86		return collect($sortParts)->filter();
87		}
88
89		/**
90		* @param $value
91		*
92		* @return array\|bool
93		*/
94		protected function getFilterValue($value)
95		{
96		if (is_array($value)) {
97		return collect($value)->map(function ($valueValue) {
98		return $this->getFilterValue($valueValue);
99		})->all();
100		}
101
102		if (Str::contains($value, ',')) {
103		return $this->explodeIgnoringWhitespace(',', $value);
104		}
105
106		if ($value === 'true') {
107		return true;
108		}
109
110		if ($value === 'false') {
111		return false;
112		}
113
114		return $value;
115		}
116
117		/**
118		* @param string $delimiter The boundary string.
119		* @param string $string The input string
120		*
121		* @return array The values between the delimiters in the given string, ignoring any spaced delimiters inside values
122		*/
123		private function explodeIgnoringWhitespace(string $delimiter, string $string): array
124		{
125		return preg_split(
126		'/'.preg_quote($delimiter).'(?=\S)/',
127		trim($string, $delimiter),
128		null,
129		PREG_SPLIT_NO_EMPTY
130		);
131		}
132		}
133

spatie / laravel-query-builder

Pull Request — master (#346)

QueryBuilderRequest::getFilterValue() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like