TestAnnotation::getRegister() - Code Metrics - Inspection of "Merge pull request #138 from ddmler/test-annotatio..." - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1f691f...f49b53 )

by Enrico

created 2016-09-26 17:20 UTC

TestAnnotation::getRegister() A

↳ Parent: TestAnnotation

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	6
ccs	2
cts	2
cp	1
crap	1
rs	9.4285

<?php

namespace PHPSA\Analyzer\Pass\Statement;

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;
use phpDocumentor\Reflection\DocBlock;

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

ovr / phpsa

Push — master ( 1f691f...f49b53 )

TestAnnotation::getRegister() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like