TestAnnotation::pass() - Code Metrics - Inspection of "Fix dependencies constraints" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#156)

by Kévin

created 2016-10-02 08:42 UTC

TestAnnotation::pass() B

↳ Parent: TestAnnotation

Complexity

Conditions	5
Paths	5

Size

Total Lines	25
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	15
CRAP Score	5.0061

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	15
c	1
b	0
f	0
nc	5
nop	2
dl	0
loc	25
ccs	15
cts	16
cp	0.9375
crap	5.0061
rs	8.439

<?php

namespace PHPSA\Analyzer\Pass\Statement;

use phpDocumentor\Reflection\DocBlockFactory;
use PhpParser\Node\Stmt\ClassMethod;
use PHPSA\Analyzer\Pass\AnalyzerPassInterface;
use PHPSA\Analyzer\Pass\ConfigurablePassInterface;
use PHPSA\Context;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;

class TestAnnotation implements ConfigurablePassInterface, AnalyzerPassInterface
{

    /** @var DocBlockFactory */
    protected $docBlockFactory;

    public function __construct()
    {
        $this->docBlockFactory = DocBlockFactory::createInstance();
    }

    /**
     * @param ClassMethod $methodStmt
     * @param Context $context
     * @return bool
     */
    public function pass(ClassMethod $methodStmt, Context $context)
    {
        $functionName = $methodStmt->name;
        if (!$functionName) {
            return false;
        }

        if (substr($functionName, 0, 4) !== 'test') {
            return false;
        }

        if ($methodStmt->getDocComment()) {
            $phpdoc = $this->docBlockFactory->create($methodStmt->getDocComment()->getText());

            if ($phpdoc->hasTag('test')) {
                $context->notice(
                    'test.annotation',
                    'Annotation @test is not needed when the method is prefixed with test.',
                    $methodStmt
                );
                return true;
            }
        }
        return false;
    }

    /**
     * @return TreeBuilder
     */
    public function getConfiguration()
    {
        $treeBuilder = new TreeBuilder();
        $treeBuilder->root('test_annotation')
            ->canBeDisabled()
        ;

        return $treeBuilder;
    }

    /**
     * @return array
     */
    public function getRegister()
    {
        return [
            ClassMethod::class
        ];
    }
}


1		<?php
2
3		namespace PHPSA\Analyzer\Pass\Statement;
4
5		use phpDocumentor\Reflection\DocBlockFactory;
6		use PhpParser\Node\Stmt\ClassMethod;
7		use PHPSA\Analyzer\Pass\AnalyzerPassInterface;
8		use PHPSA\Analyzer\Pass\ConfigurablePassInterface;
9		use PHPSA\Context;
10		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
11
12		class TestAnnotation implements ConfigurablePassInterface, AnalyzerPassInterface
13		{
14
15		/** @var DocBlockFactory */
16		protected $docBlockFactory;
17
18	1	public function __construct()
19		{
20	1	$this->docBlockFactory = DocBlockFactory::createInstance();
21	1	}
22
23		/**
24		* @param ClassMethod $methodStmt
25		* @param Context $context
26		* @return bool
27		*/
28	24	public function pass(ClassMethod $methodStmt, Context $context)
29		{
30	24	$functionName = $methodStmt->name;
31	24	if (!$functionName) {
32		return false;
33		}
34
35	24	if (substr($functionName, 0, 4) !== 'test') {
36	11	return false;
37		}
38
39	15	if ($methodStmt->getDocComment()) {
40	11	$phpdoc = $this->docBlockFactory->create($methodStmt->getDocComment()->getText());
41
42	11	if ($phpdoc->hasTag('test')) {
43	1	$context->notice(
44	1	'test.annotation',
45	1	'Annotation @test is not needed when the method is prefixed with test.',
46		$methodStmt
47	1	);
48	1	return true;
49		}
50	11	}
51	15	return false;
52		}
53
54		/**
55		* @return TreeBuilder
56		*/
57		public function getConfiguration()
58		{
59		$treeBuilder = new TreeBuilder();
60		$treeBuilder->root('test_annotation')
61		->canBeDisabled()
62		;
63
64		return $treeBuilder;
65		}
66
67		/**
68		* @return array
69		*/
70	1	public function getRegister()
71		{
72		return [
73		ClassMethod::class
74	1	];
75		}
76		}
77

ovr / phpsa

Pull Request — master (#156)

TestAnnotation::pass() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like