ControllerMethodName::apply() - Code Metrics - Inspection of "Improve tests for further implementations" - mi-schi/phpmd-extension - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 10351e...ea3c3c )

by Michael

created 2016-08-17 17:14 UTC

ControllerMethodName::apply() B

↳ Parent: ControllerMethodName

Complexity

Conditions	5
Paths	5

Size

Total Lines	19
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	12
CRAP Score	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	19
ccs	12
cts	12
cp	1
rs	8.8571
cc	5
eloc	9
nc	5
nop	1
crap	5

<?php

namespace MS\PHPMD\Rule\Naming;

use PDepend\Source\AST\ASTClass;
use PHPMD\AbstractNode;
use PHPMD\AbstractRule;
use PHPMD\Node\ClassNode;
use PHPMD\Node\MethodNode;
use PHPMD\Rule\ClassAware;

/**
 * When the class is concrete and ends with Controller, the method names have to end with Action.
 */
class ControllerMethodName extends AbstractRule implements ClassAware
{
    /**
     * @param AbstractNode|ClassNode $node
     */
    public function apply(AbstractNode $node)
    {
        if (false === $this->isController($node)) {

            return;
        }

        $allowedMethodNames = explode($this->getStringProperty('delimiter'), $this->getStringProperty('allowedMethodNames'));

        /** @var MethodNode $method */
        foreach ($node->getMethods() as $method) {
            if (true === in_array($method->getImage(), $allowedMethodNames)) {
              continue;
            }

            if ('Action' !== substr($method->getImage(), -6, 6)) {
                $this->addViolation($method);
            }
        }
    }

    /**
     * @param ClassNode|ASTClass $node
     *
     * @return bool
     */
    private function isController(ClassNode $node)
    {
        if (true === $node->isAbstract()) {
            return false;
        }

        if ('Controller' === substr($node->getImage(), -10, 10)) {
            return true;
        }

        return false;
    }
}


1		<?php
2
3		namespace MS\PHPMD\Rule\Naming;
4
5		use PDepend\Source\AST\ASTClass;
6		use PHPMD\AbstractNode;
7		use PHPMD\AbstractRule;
8		use PHPMD\Node\ClassNode;
9		use PHPMD\Node\MethodNode;
10		use PHPMD\Rule\ClassAware;
11
12		/**
13		* When the class is concrete and ends with Controller, the method names have to end with Action.
14		*/
15		class ControllerMethodName extends AbstractRule implements ClassAware
16		{
17		/**
18		* @param AbstractNode\|ClassNode $node
19		*/
20	6	public function apply(AbstractNode $node)
21		{
22	6	if (false === $this->isController($node)) {
		0 ignored issues – show Compatibility introduced 2016-07-29 16:04 UTC by Report Bug Copy Issue Report `$node` of type `object<PHPMD\AbstractNode>` is not a sub-type of `object<PHPMD\Node\ClassNode>`. It seems like you assume a child class of the class `PHPMD\AbstractNode` 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...
23	4	return;
24		}
25
26	2	$allowedMethodNames = explode($this->getStringProperty('delimiter'), $this->getStringProperty('allowedMethodNames'));
27
28		/** @var MethodNode $method */
29	2	foreach ($node->getMethods() as $method) {
30	2	if (true === in_array($method->getImage(), $allowedMethodNames)) {
31	2	continue;
32		}
33
34	2	if ('Action' !== substr($method->getImage(), -6, 6)) {
35	2	$this->addViolation($method);
36	2	}
37	2	}
38	2	}
39
40		/**
41		* @param ClassNode\|ASTClass $node
42		*
43		* @return bool
44		*/
45	6	private function isController(ClassNode $node)
46		{
47	6	if (true === $node->isAbstract()) {
48	1	return false;
49		}
50
51	5	if ('Controller' === substr($node->getImage(), -10, 10)) {
52	2	return true;
53		}
54
55	3	return false;
56		}
57		}
58

mi-schi / phpmd-extension

GitHub Access Token became invalid

Push — master ( 10351e...ea3c3c )

ControllerMethodName::apply() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like