FileParser::getFunctionLimits() - Code Metrics - Inspection of "First pass at using related errors in phpcs" - exussum12/coverageChecker - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Pull Request — master (#30)

by Scott

created 2018-02-09 22:25 UTC

FileParser::getFunctionLimits() A

↳ Parent: FileParser

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?php
namespace exussum12\CoverageChecker;

use PhpParser\Node;
use PhpParser\Parser;
use PhpParser\ParserFactory;

class FileParser
{
    protected $sourceCode = '';
    protected $classes = [];
    protected $functions = [];

    public function __construct($sourceCode)
    {
        $this->sourceCode = $sourceCode;
        $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
        $this->parse($parser);
    }

    /**
     * @return CodeLimits[]
     */
    public function getClassLimits()
    {
        return $this->classes;
    }

    /**
     * @return CodeLimits[]
     */
    public function getFunctionLimits()
    {
        return $this->functions;
    }

    protected function parse(Parser $parser)
    {
        $ast = $parser->parse($this->sourceCode);
        foreach ($ast as $node) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $this->handleNode($node);
        }
    }

    protected function getCodeLimits(Node $node)
    {
        $startLine = $node->getAttribute('startLine');
        $endLine = $node->getAttribute('endLine');
        if ($node->getDocComment()) {
            $startLine = $node->getDocComment()->getLine();
        }

        return new CodeLimits($startLine, $endLine);
    }

    protected function addClass($classLimits)
    {
        $this->classes[] = $classLimits;
    }

    protected function addFunction($classLimits)
    {
        $this->functions[] = $classLimits;
    }

    protected function handleClass(Node $node)
    {
        $this->addClass($this->getCodeLimits($node));

        foreach ($node->getMethods() as $function) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
            $this->handleNode($function);
        }
    }

    protected function handleFunction(Node $node)
    {
        $this->addFunction($this->getCodeLimits($node));
    }

    private function handleNamespace(Node $node)
    {
        foreach ($node->stmts as $part) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            $this->handleNode($part);
        }
    }

    /**
     * @param $node
     */
    protected function handleNode($node)
    {
        $type = $node->getType();
        if ($type == 'Stmt_Namespace') {
            $this->handleNamespace($node);
        }

        if ($type == 'Stmt_Class') {
            $this->handleClass($node);
        }

        if ($type == "Stmt_Function" || $type == "Stmt_ClassMethod") {
            $this->handleFunction($node);
        }
    }
}


1			<?php
2			namespace exussum12\CoverageChecker;
3
4			use PhpParser\Node;
5			use PhpParser\Parser;
6			use PhpParser\ParserFactory;
7
8			class FileParser
9			{
10			protected $sourceCode = '';
11			protected $classes = [];
12			protected $functions = [];
13
14			public function __construct($sourceCode)
15			{
16			$this->sourceCode = $sourceCode;
17			$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
18			$this->parse($parser);
19			}
20
21			/**
22			* @return CodeLimits[]
23			*/
24			public function getClassLimits()
25			{
26			return $this->classes;
27			}
28
29			/**
30			* @return CodeLimits[]
31			*/
32			public function getFunctionLimits()
33			{
34			return $this->functions;
35			}
36
37			protected function parse(Parser $parser)
38			{
39			$ast = $parser->parse($this->sourceCode);
40			foreach ($ast as $node) {
			0 ignored issues – show Bug introduced 2018-02-09 22:28 UTC by Report Bug Copy Issue Report The expression `$ast` of type `array<integer,object<PhpParser\Node>>\|null` 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...
41			$this->handleNode($node);
42			}
43			}
44
45			protected function getCodeLimits(Node $node)
46			{
47			$startLine = $node->getAttribute('startLine');
48			$endLine = $node->getAttribute('endLine');
49			if ($node->getDocComment()) {
50			$startLine = $node->getDocComment()->getLine();
51			}
52
53			return new CodeLimits($startLine, $endLine);
54			}
55
56			protected function addClass($classLimits)
57			{
58			$this->classes[] = $classLimits;
59			}
60
61			protected function addFunction($classLimits)
62			{
63			$this->functions[] = $classLimits;
64			}
65
66			protected function handleClass(Node $node)
67			{
68			$this->addClass($this->getCodeLimits($node));
69
70			foreach ($node->getMethods() as $function) {
			0 ignored issues – show Bug introduced 2018-02-09 22:28 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `PhpParser\Node` as the method `getMethods()` does only exist in the following implementations of said interface: `PhpParser\Node\Stmt\ClassLike`, `PhpParser\Node\Stmt\Class_`, `PhpParser\Node\Stmt\Interface_`, `PhpParser\Node\Stmt\Trait_`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
71			$this->handleNode($function);
72			}
73			}
74
75			protected function handleFunction(Node $node)
76			{
77			$this->addFunction($this->getCodeLimits($node));
78			}
79
80			private function handleNamespace(Node $node)
81			{
82			foreach ($node->stmts as $part) {
			0 ignored issues – show Bug introduced 2018-02-09 22:28 UTC by Report Bug Copy Issue Report Accessing `stmts` on the interface `PhpParser\Node` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
83			$this->handleNode($part);
84			}
85			}
86
87			/**
88			* @param $node
89			*/
90			protected function handleNode($node)
91			{
92			$type = $node->getType();
93			if ($type == 'Stmt_Namespace') {
94			$this->handleNamespace($node);
95			}
96
97			if ($type == 'Stmt_Class') {
98			$this->handleClass($node);
99			}
100
101			if ($type == "Stmt_Function" \|\| $type == "Stmt_ClassMethod") {
102			$this->handleFunction($node);
103			}
104			}
105			}
106

exussum12 / coverageChecker

Pull Request — master (#30)

FileParser::getFunctionLimits() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like