Completed
Pull Request — master (#124)
by Enrico
04:04
created

FileParser   B

Complexity

Total Complexity 24

Size/Duplication

Total Lines 139
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 17

Test Coverage

Coverage 75%

Importance

Changes 0
Metric Value
dl 0
loc 139
ccs 57
cts 76
cp 0.75
rs 7.8571
c 0
b 0
f 0
wmc 24
lcom 1
cbo 17

3 Methods

Rating   Name   Duplication   Size   Complexity  
A __construct() 0 8 1
C parserFile() 0 51 9
C parseTopDefinitions() 0 46 14
1
<?php
2
/**
3
 * @author Patsura Dmitry https://github.com/ovr <[email protected]>
4
 */
5
6
namespace PHPSA\Definition;
7
8
use Exception;
9
use PHPSA\AliasManager;
10
use PHPSA\Compiler;
11
use PHPSA\Context;
12
use PhpParser\Node;
13
use RuntimeException;
14
15
class FileParser
16
{
17
    /**
18
     * @var \PhpParser\Parser
19
     */
20
    protected $parser;
21
22
    /**
23
     * @var \PhpParser\NodeTraverser
24
     */
25
    protected $nodeTraverser;
26
27
    /**
28
     * @var Compiler
29
     */
30
    protected $compiler;
31
32
    /**
33
     * @param \PhpParser\Parser $parser
34
     * @param Compiler $compiler
35
     */
36 24
    public function __construct(\PhpParser\Parser $parser, Compiler $compiler)
37
    {
38 24
        $this->nodeTraverser = new \PhpParser\NodeTraverser();
39 24
        $this->nodeTraverser->addVisitor(new \PhpParser\NodeVisitor\NameResolver);
40
41 24
        $this->parser = $parser;
42 24
        $this->compiler = $compiler;
43 24
    }
44
45
    /**
46
     * @param string $filepath
47
     * @param Context $context
48
     * @throws RuntimeException when filepath is not readable
49
     */
50 24
    public function parserFile($filepath, Context $context)
51
    {
52 24
        $context->setFilepath($filepath);
53
54
        try {
55 24
            if (!is_readable($filepath)) {
56
                throw new RuntimeException('File ' . $filepath . ' is not readable');
57
            }
58
59 24
            $context->debug('<comment>Precompile: ' . $filepath . '.</comment>');
60
61 24
            $code = file_get_contents($filepath);
62 24
            $astTree = $this->parser->parse($code);
63
64 24
            $this->nodeTraverser->traverse($astTree);
0 ignored issues
show
Bug introduced by
It seems like $astTree defined by $this->parser->parse($code) on line 62 can also be of type null; however, PhpParser\NodeTraverser::traverse() does only seem to accept array<integer,object<PhpParser\Node>>, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
65
66 24
            $context->aliasManager = new AliasManager();
67 24
            $namespace = null;
68
69
            /**
70
             * Step 1 Precompile
71
             */
72 24
            foreach ($astTree as $topStatement) {
0 ignored issues
show
Bug introduced by
The expression $astTree 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.

  1. 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) { /** ... */ }
    
  2. 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) { /** .. */ }
    
  3. 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...
73 24
                if ($topStatement instanceof Node\Stmt\Namespace_) {
74
                    /**
75
                     * Namespace block can be created without NS name
76
                     */
77 24
                    if ($topStatement->name) {
78 24
                        $namespace = $topStatement->name->toString();
79 24
                        $context->aliasManager->setNamespace($namespace);
80 24
                    }
81
82 24
                    if ($topStatement->stmts) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $topStatement->stmts of type PhpParser\Node[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
83 24
                        $this->parseTopDefinitions($topStatement->stmts, $context->aliasManager, $filepath);
0 ignored issues
show
Documentation introduced by
$topStatement->stmts is of type array<integer,object<PhpParser\Node>>, but the function expects a object<PhpParser\Node\St...t<PhpParser\Node\Stmt>>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
84 24
                    }
85 24
                } else {
86
                    if (is_array($topStatement)) {
87
                        $this->parseTopDefinitions($topStatement, $context->aliasManager, $filepath);
88
                    } else {
89
                        $this->parseTopDefinitions($astTree, $context->aliasManager, $filepath);
0 ignored issues
show
Documentation introduced by
$astTree is of type array<integer,object<PhpParser\Node>>|null, but the function expects a object<PhpParser\Node\St...t<PhpParser\Node\Stmt>>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
90
                    }
91
                }
92 24
            }
93
94 24
            $context->clear();
95 24
        } catch (\PhpParser\Error $e) {
96
            $context->syntaxError($e, $filepath);
97
        } catch (Exception $e) {
98
            $context->output->writeln("<error>{$e->getMessage()}</error>");
99
        }
100 24
    }
101
102
    /**
103
     * @param Node\Stmt|Node\Stmt[] $topStatement
104
     * @param AliasManager $aliasManager
105
     * @param string $filepath
106
     */
107 24
    protected function parseTopDefinitions($topStatement, AliasManager $aliasManager, $filepath)
108
    {
109 24
        foreach ($topStatement as $statement) {
0 ignored issues
show
Bug introduced by
The expression $topStatement of type object<PhpParser\Node\St...t<PhpParser\Node\Stmt>> is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. 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) { /** ... */ }
    
  2. 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) { /** .. */ }
    
  3. 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...
110 24
            if ($statement instanceof Node\Stmt\Use_) {
111
                if (count($statement->uses) > 0) {
112
                    foreach ($statement->uses as $use) {
113
                        $aliasManager->add($use->name->parts);
114
                    }
115
                }
116 24
            } elseif ($statement instanceof Node\Stmt\Class_) {
117 24
                $definition = new ClassDefinition($statement->name, $statement, $statement->type);
118 24
                $definition->setFilepath($filepath);
119 24
                $definition->setNamespace($aliasManager->getNamespace());
120
121 24
                if ($statement->extends) {
122
                    $definition->setExtendsClass($statement->extends->toString());
123
                }
124
125 24
                if ($statement->implements) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $statement->implements of type PhpParser\Node\Name[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
126
                    foreach ($statement->implements as $interface) {
127
                        $definition->addInterface($interface->toString());
128
                    }
129
                }
130
131 24
                foreach ($statement->stmts as $stmt) {
132 24
                    if ($stmt instanceof Node\Stmt\ClassMethod) {
133 23
                        $method = new ClassMethod($stmt->name, $stmt, $stmt->type);
134
135 23
                        $definition->addMethod($method);
136 24
                    } elseif ($stmt instanceof Node\Stmt\Property) {
137 2
                        $definition->addProperty($stmt);
138 3
                    } elseif ($stmt instanceof Node\Stmt\ClassConst) {
139 1
                        $definition->addConst($stmt);
140 1
                    }
141 24
                }
142
143 24
                $this->compiler->addClass($definition);
144 24
            } elseif ($statement instanceof Node\Stmt\Function_) {
145 1
                $definition = new FunctionDefinition($statement->name, $statement);
146 1
                $definition->setFilepath($filepath);
147 1
                $definition->setNamespace($aliasManager->getNamespace());
148
149 1
                $this->compiler->addFunction($definition);
150 1
            }
151 24
        }
152 24
    }
153
}
154