WhereFilter::compare() - Code Metrics - Inspection of "Use a switch statement to improve readability" - stakx-io/stakx - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 31dcb1...8b9d02 )

by Vladimir

created 2016-09-08 06:13 UTC

WhereFilter::compare() C

↳ Parent: WhereFilter

Complexity

Conditions	12
Paths	22

Size

Total Lines	29
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	12.486

Importance

Changes	6
Bugs	0	Features	2

Metric	Value
cc	12
eloc	17
c	6
b	0
f	2
nc	22
nop	4
dl	0
loc	29
ccs	17
cts	20
cp	0.85
crap	12.486
rs	5.1612

How to fix Complexity

<?php

namespace allejo\stakx\Twig;

use allejo\stakx\Object\ContentItem;
use Twig_Error_Syntax;

class WhereFilter
{
    public function __invoke ($array, $key, $comparison, $value)
    {
        $results = array();
        $this->search_r($array, $key, $comparison, $value, $results);

        return $results;
    }

    public static function get ()
    {
        return new \Twig_SimpleFilter('where', new self());
    }

    private function search_r ($array, $key, $comparison, $value, &$results)

    {
        if (!is_array($array) && !($array instanceof ContentItem))
        {
            return;
        }

        if ($this->compare($array, $key, $comparison, $value))
        {
            $results[] = $array;
        }

        foreach ($array as $subarray)
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
        {
            $this->search_r($subarray, $key, $comparison, $value, $results);
        }
    }

    private function compare ($array, $key, $comparison, $value)
    {
        $fm = false;

        if ($array instanceof ContentItem)
        {
            $array = $array->getFrontMatter();
            $fm = true;
        }

        if (!isset($array[$key]))
        {
            return ($fm && $comparison === "==" && $value === null);
        }

        switch ($comparison)
        {
            case "==": return ($array[$key] === $value);
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case "!=": return ($array[$key] !== $value);
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case ">" : return ($array[$key] > $value);
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
            case ">=": return ($array[$key] >= $value);
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case "<" : return ($array[$key] < $value);
switch ($selector) {
    case "A": //right
        doSomething();
        break;
    case "B" : //wrong
        doSomethingElse();
        break;
}
            case "<=": return ($array[$key] <= $value);
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case "~=": return ($this->contains($array[$key], $value));
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;

            default:
                throw new Twig_Error_Syntax("Invalid where comparison ({$comparison})");
        }
    }

    private function contains ($haystack, $needle)
    {
        return ((is_array($haystack) && in_array($needle, $haystack)) ||
                (is_string($haystack) && strpos($haystack, $needle) !== false));
    }
}

1		<?php
2
3		namespace allejo\stakx\Twig;
4
5		use allejo\stakx\Object\ContentItem;
6		use Twig_Error_Syntax;
7
8		class WhereFilter
9		{
10	20	public function __invoke ($array, $key, $comparison, $value)
11		{
12	20	$results = array();
13	20	$this->search_r($array, $key, $comparison, $value, $results);
14
15	19	return $results;
16		}
17
18	1	public static function get ()
19		{
20	1	return new \Twig_SimpleFilter('where', new self());
21		}
22
23	20	private function search_r ($array, $key, $comparison, $value, &$results)
		0 ignored issues – show Coding Style introduced 2016-08-21 19:38 UTC by Report Bug Copy Issue Report This method is not in camel caps format. This check looks for method names that are not written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection seeker becomes `databaseConnectionSeeker`. Loading history...
24		{
25	20	if (!is_array($array) && !($array instanceof ContentItem))
26	20	{
27	19	return;
28		}
29
30	20	if ($this->compare($array, $key, $comparison, $value))
31	20	{
32	14	$results[] = $array;
33	14	}
34
35	20	foreach ($array as $subarray)
		0 ignored issues – show Bug introduced 2016-08-28 08:57 UTC by Report Bug Copy Issue Report The expression `$array` of type `array\|object<allejo\stakx\Object\ContentItem>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
36		{
37	20	$this->search_r($subarray, $key, $comparison, $value, $results);
38	19	}
39	19	}
40
41	20	private function compare ($array, $key, $comparison, $value)
42		{
43	20	$fm = false;
44
45	20	if ($array instanceof ContentItem)
46	20	{
47		$array = $array->getFrontMatter();
48		$fm = true;
49		}
50
51	20	if (!isset($array[$key]))
52	20	{
53	20	return ($fm && $comparison === "==" && $value === null);
54		}
55
56		switch ($comparison)
57		{
58	19	case "==": return ($array[$key] === $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
59	14	case "!=": return ($array[$key] !== $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
60	11	case ">" : return ($array[$key] > $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
61	9	case ">=": return ($array[$key] >= $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
62	7	case "<" : return ($array[$key] < $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report There must be no space before the colon in a CASE statement As per the PSR-2 coding standard, there must not be a space in front of the colon in case statements. switch ($selector) { case "A": //right doSomething(); break; case "B" : //wrong doSomethingElse(); break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
63	5	case "<=": return ($array[$key] <= $value);
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
64	3	case "~=": return ($this->contains($array[$key], $value));
		0 ignored issues – show Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-09-08 06:16 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history...
65
66	1	default:
67	1	throw new Twig_Error_Syntax("Invalid where comparison ({$comparison})");
68	1	}
69		}
70
71	2	private function contains ($haystack, $needle)
72		{
73	2	return ((is_array($haystack) && in_array($needle, $haystack)) \|\|
74	2	(is_string($haystack) && strpos($haystack, $needle) !== false));
75		}
76		}

stakx-io / stakx

Push — master ( 31dcb1...8b9d02 )

WhereFilter::compare() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like