NotInRule - Code Metrics - Inspection of "Unit test NotInRule Fixes #86" - jclaveau/php-logical-filter - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d2e239...75a482 )

by Jean

created 2019-03-16 17:45 UTC

NotInRule A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	162
Duplicated Lines	9.26 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

78.79%

Importance

Changes

Metric	Value
dl	15
loc	162
ccs	52
cts	66
cp	0.7879
rs	10
c	0
b	0
f	0
wmc	23
lcom	1
cbo	3

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	isNormalizationAllowed()	0	9	2
A	getPossibilities()	0	9	2
A	getField()	0	12	2
A	setField()	0	12	2
A	setPossibilities()	0	26	5
A	getValues()	0	4	1
A	hasSolution()	0	4	1
A	toArray()	0	22	5
A	toString()	15	15	2

How to fix Duplicated Code

<?php
namespace JClaveau\LogicalFilter\Rule;

/**
 * a ! in x
 */
class NotInRule extends NotRule
{
    /** @var string operator */
    const operator = '!in';

    /**
     * @param string $field The field to apply the rule on.
     * @param array  $value The value the field can equal to.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function __construct( $field, $possibilities )
    {
        $this->addOperand(new InRule($field, $possibilities));
    }

    /**
     */
    public function isNormalizationAllowed(array $contextual_options=[])

    {
        $operand = $this->getOperandAt(0);
        if (! $operand->getPossibilities()) {
            return false;
        }

        return $operand->isNormalizationAllowed($contextual_options);
    }

    /**
     */
    public function getField()

    {
        if (! $this->getOperandAt(0)) {
            // TODO a NotRule with no operand should be simplified as
            //      a TrueRule
            throw new \LogicException(
                "Trying to get the field of an InRule negation missing its operand"
            );
        }

        return $this->getOperandAt(0)->getField();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
    }

    /**
     */
    public function setField($field)

    {
        if (! $this->getOperandAt(0)) {
            // TODO a NotRule with no operand should be simplified as
            //      a TrueRule
            throw new \LogicException(
                "Trying to set the field of an InRule negation missing its operand"
            );
        }

        return $this->getOperandAt(0)->setField($field);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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 array
     */
    public function getPossibilities()
    {
        if ($this->getOperandAt(0) instanceof EqualRule) {
            // In can be simplified in =
            return [$this->getOperandAt(0)->getValue()];
        }

        return $this->getOperandAt(0)->getPossibilities();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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

     */
    public function setPossibilities($possibilities)
    {
        if (    is_object($possibilities)
            && method_exists($possibilities, 'toArray')
        ) {
            $possibilities = $possibilities->toArray();

        }

        if ($this->getOperandAt(0) instanceof EqualRule) {
            // TODO this case should occure anymore while a NotInRule
            // may not have the same class once simplified
            $possibilities[] = $this->getOperandAt(0)->getValue();

            $operands = [
                new InRule(
                    $this->getOperandAt(0)->getField(),
                    array_unique($possibilities)
                ),
            ];

            $this->setOperands($operands);
        }
        elseif ($this->getOperandAt(0) instanceof InRule) {
            return $this->getOperandAt(0)->setPossibilities($possibilities);
        }
    }

    /**
     */
    public function getValues()
    {
        return $this->getPossibilities();
    }

    /**
     */
    public function hasSolution(array $contextual_options=[])
    {
        return true;
    }

    /**
     * @param array $options   + show_instance=false Display the operator of the rule or its instance id
     *
     * @return array
     */
    public function toArray(array $options=[])
    {
        $default_options = [
            'show_instance' => false,
        ];
        foreach ($default_options as $default_option => &$default_value) {
            if ( ! isset($options[ $default_option ])) {
                $options[ $default_option ] = $default_value;
            }
        }

        try {
            return [
                $this->getField(),
                $options['show_instance'] ? $this->getInstanceId() : self::operator,
                $this->getPossibilities(),
            ];
        }
        catch (\LogicException $e) {
            return parent::toArray();
        }
    }

    /**
     * @todo cache support
     */
    public function toString(array $options=[])

    {
        try {
            $operator = self::operator;

            $stringified_possibilities = '[' . implode(', ', array_map(function($possibility) {
                return var_export($possibility, true);
            }, $this->getPossibilities()) ) .']';

            return "['{$this->getField()}', '$operator', $stringified_possibilities]";
        }
        catch (\LogicException $e) {
            return parent::toString();
        }
    }

    /**/
}


1			<?php
2			namespace JClaveau\LogicalFilter\Rule;
3
4			/**
5			* a ! in x
6			*/
7			class NotInRule extends NotRule
8			{
9			/** @var string operator */
10			const operator = '!in';
11
12			/**
13			* @param string $field The field to apply the rule on.
14			* @param array $value The value the field can equal to.
			0 ignored issues – show Bug introduced 2018-12-30 16:52 UTC by Report Bug Copy Issue Report There is no parameter named `$value`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
15			*/
16	26		public function __construct( $field, $possibilities )
17			{
18	26		$this->addOperand(new InRule($field, $possibilities));
19	26		}
20
21			/**
22			*/
23	14		public function isNormalizationAllowed(array $contextual_options=[])
			0 ignored issues – show Documentation introduced 2018-12-31 16:08 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
24			{
25	14		$operand = $this->getOperandAt(0);
26	14		if (! $operand->getPossibilities()) {
27	1		return false;
28			}
29
30	13		return $operand->isNormalizationAllowed($contextual_options);
31			}
32
33			/**
34			*/
35	25		public function getField()
			0 ignored issues – show Documentation introduced 2018-12-31 16:08 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
36			{
37	25		if (! $this->getOperandAt(0)) {
38			// TODO a NotRule with no operand should be simplified as
39			// a TrueRule
40	1		throw new \LogicException(
41			"Trying to get the field of an InRule negation missing its operand"
42	1		);
43			}
44
45	24		return $this->getOperandAt(0)->getField();
			0 ignored issues – show Bug introduced 2018-12-30 16:52 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `JClaveau\LogicalFilter\Rule\AbstractRule` as the method `getField()` does only exist in the following sub-classes of `JClaveau\LogicalFilter\Rule\AbstractRule`: `JClaveau\LogicalFilter\Rule\AboveOrEqualRule`, `JClaveau\LogicalFilter\Rule\AboveRule`, `JClaveau\LogicalFilter\Rule\AbstractAtomicRule`, `JClaveau\LogicalFilter\Rule\BelowOrEqualRule`, `JClaveau\LogicalFilter\Rule\BelowRule`, `JClaveau\LogicalFilter\Rule\BetweenOrEqualBothRule`, `JClaveau\LogicalFilter\R...BetweenOrEqualLowerRule`, `JClaveau\LogicalFilter\R...BetweenOrEqualUpperRule`, `JClaveau\LogicalFilter\Rule\BetweenRule`, `JClaveau\LogicalFilter\Rule\EqualRule`, `JClaveau\LogicalFilter\Rule\InRule`, `JClaveau\LogicalFilter\Rule\NotEqualRule`, `JClaveau\LogicalFilter\Rule\NotInRule`, `JClaveau\LogicalFilter\Rule\RegexpRule`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
46			}
47
48			/**
49			*/
50	2		public function setField($field)
			0 ignored issues – show Documentation introduced 2018-12-31 16:08 UTC by Report Bug Copy Issue Report The return type could not be reliably inferred; please add a `@return` annotation. Our type inference engine in quite powerful, but sometimes the code does not provide enough clues to go by. In these cases we request you to add a `@return` annotation as described here. Loading history...
51			{
52	2		if (! $this->getOperandAt(0)) {
53			// TODO a NotRule with no operand should be simplified as
54			// a TrueRule
55	1		throw new \LogicException(
56			"Trying to set the field of an InRule negation missing its operand"
57	1		);
58			}
59
60	1		return $this->getOperandAt(0)->setField($field);
			0 ignored issues – show Bug introduced 2019-03-16 17:49 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `JClaveau\LogicalFilter\Rule\AbstractRule` as the method `setField()` does only exist in the following sub-classes of `JClaveau\LogicalFilter\Rule\AbstractRule`: `JClaveau\LogicalFilter\Rule\AboveOrEqualRule`, `JClaveau\LogicalFilter\Rule\AboveRule`, `JClaveau\LogicalFilter\Rule\AbstractAtomicRule`, `JClaveau\LogicalFilter\Rule\BelowOrEqualRule`, `JClaveau\LogicalFilter\Rule\BelowRule`, `JClaveau\LogicalFilter\Rule\EqualRule`, `JClaveau\LogicalFilter\Rule\InRule`, `JClaveau\LogicalFilter\Rule\NotEqualRule`, `JClaveau\LogicalFilter\Rule\NotInRule`, `JClaveau\LogicalFilter\Rule\RegexpRule`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
61			}
62
63			/**
64			* @return array
65			*/
66	23		public function getPossibilities()
67			{
68	23		if ($this->getOperandAt(0) instanceof EqualRule) {
69			// In can be simplified in =
70			return [$this->getOperandAt(0)->getValue()];
71			}
72
73	23		return $this->getOperandAt(0)->getPossibilities();
			0 ignored issues – show Bug introduced 2018-12-30 16:52 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `JClaveau\LogicalFilter\Rule\AbstractRule` as the method `getPossibilities()` does only exist in the following sub-classes of `JClaveau\LogicalFilter\Rule\AbstractRule`: `JClaveau\LogicalFilter\Rule\InRule`, `JClaveau\LogicalFilter\Rule\NotInRule`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
74			}
75
76			/**
77			* @return $this
			0 ignored issues – show Documentation introduced 2018-12-31 16:08 UTC by Report Bug Copy Issue Report Should the return type not be `null\|InRule`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
78			*/
79	7		public function setPossibilities($possibilities)
80			{
81	7		if ( is_object($possibilities)
82	7		&& method_exists($possibilities, 'toArray')
83	7		) {
84	1		$possibilities = $possibilities->toArray();
			0 ignored issues – show Coding Style introduced 2018-12-31 16:08 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$possibilities`. This often makes code more readable. Loading history...
85	1		}
86
87	7		if ($this->getOperandAt(0) instanceof EqualRule) {
88			// TODO this case should occure anymore while a NotInRule
89			// may not have the same class once simplified
90			$possibilities[] = $this->getOperandAt(0)->getValue();
91
92			$operands = [
93			new InRule(
94			$this->getOperandAt(0)->getField(),
95			array_unique($possibilities)
96			),
97			];
98
99			$this->setOperands($operands);
100			}
101	7		elseif ($this->getOperandAt(0) instanceof InRule) {
102	7		return $this->getOperandAt(0)->setPossibilities($possibilities);
103			}
104			}
105
106			/**
107			*/
108	3		public function getValues()
109			{
110	3		return $this->getPossibilities();
111			}
112
113			/**
114			*/
115	3		public function hasSolution(array $contextual_options=[])
116			{
117	3		return true;
118			}
119
120			/**
121			* @param array $options + show_instance=false Display the operator of the rule or its instance id
122			*
123			* @return array
124			*/
125	23		public function toArray(array $options=[])
126			{
127			$default_options = [
128	23		'show_instance' => false,
129	23		];
130	23		foreach ($default_options as $default_option => &$default_value) {
131	23		if ( ! isset($options[ $default_option ])) {
132	23		$options[ $default_option ] = $default_value;
133	23		}
134	23		}
135
136			try {
137			return [
138	23		$this->getField(),
139	23		$options['show_instance'] ? $this->getInstanceId() : self::operator,
140	23		$this->getPossibilities(),
141	23		];
142			}
143			catch (\LogicException $e) {
144			return parent::toArray();
145			}
146			}
147
148			/**
149			* @todo cache support
150			*/
151	1	View Code Duplication	public function toString(array $options=[])
			0 ignored issues – show Duplication introduced 2018-12-30 16:52 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...
152			{
153			try {
154	1		$operator = self::operator;
155
156	1		$stringified_possibilities = '[' . implode(', ', array_map(function($possibility) {
157	1		return var_export($possibility, true);
158	1		}, $this->getPossibilities()) ) .']';
159
160	1		return "['{$this->getField()}', '$operator', $stringified_possibilities]";
161			}
162			catch (\LogicException $e) {
163			return parent::toString();
164			}
165			}
166
167			/**/
168			}
169

jclaveau / php-logical-filter

Push — master ( d2e239...75a482 )

NotInRule A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

10 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like