etsy/phan

src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php

Summary

F
5 days

File VariableTrackerVisitor.php has 761 lines of code (exceeds 250 allowed). Consider refactoring. Open

<?php

declare(strict_types=1);

namespace Phan\Plugin\Internal\VariableTracker;
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 1 day to fix

VariableTrackerVisitor has 56 functions (exceeds 20 allowed). Consider refactoring. Open

final class VariableTrackerVisitor extends AnalysisVisitor
{
/**
* This shared graph instance maps definitions of variables (in a function-like context)
* to the uses of that variable.
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 1 day to fix

The class VariableTrackerVisitor has an overall complexity of 190 which is very high. The configured complexity threshold is 50. Open

final class VariableTrackerVisitor extends AnalysisVisitor
{
/**
* This shared graph instance maps definitions of variables (in a function-like context)
* to the uses of that variable.

The class VariableTrackerVisitor has 39 public methods. Consider refactoring VariableTrackerVisitor to keep number of public methods under 10. Open

final class VariableTrackerVisitor extends AnalysisVisitor
{
/**
* This shared graph instance maps definitions of variables (in a function-like context)
* to the uses of that variable.

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

The class VariableTrackerVisitor has 51 non-getter- and setter-methods. Consider refactoring VariableTrackerVisitor to keep number of methods under 25. Open

final class VariableTrackerVisitor extends AnalysisVisitor
{
/**
* This shared graph instance maps definitions of variables (in a function-like context)
* to the uses of that variable.

TooManyMethods

Since: 0.1

A class with too many methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

The default was changed from 10 to 25 in PHPMD 2.3.

Example

Source https://phpmd.org/rules/codesize.html#toomanymethods

Function visitSwitchList has a Cognitive Complexity of 20 (exceeds 5 allowed). Consider refactoring. Open

    public function visitSwitchList(Node $node): VariableTrackingScope {$outer_scope = $this->scope;$inner_scope_list = [];
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

Function analyzeDimAssignmentTarget has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring. Open

    private function analyzeDimAssignmentTarget(Node $node): VariableTrackingScope { // Treat$y in $x[$y] = $z; as a usage of$y
$this->scope =$this->analyzeWhenValidNode($this->scope,$node->children['dim']);
$expr =$node->children['expr'];
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

Method visitSwitchList has 40 lines of code (exceeds 25 allowed). Consider refactoring. Open

    public function visitSwitchList(Node $node): VariableTrackingScope {$outer_scope = $this->scope;$inner_scope_list = [];
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 1 hr to fix

Function visitIf has a Cognitive Complexity of 13 (exceeds 5 allowed). Consider refactoring. Open

    public function visitIf(Node $node): VariableTrackingScope {$outer_scope = $this->scope;$inner_scope_list = [];
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 1 hr to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

    public function visitFor(Node $node): VariableTrackingScope {$this->checkIsSideEffectFreeLoopNode($node);$top_level_statement = $this->top_level_statement; Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 1 hr to fix Method visitIf has 30 lines of code (exceeds 25 allowed). Consider refactoring. Open  public function visitIf(Node$node): VariableTrackingScope
{
$outer_scope =$this->scope;

$inner_scope_list = []; Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 1 hr to fix Function visitClosure has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring. Open  public function visitClosure(Node$node): VariableTrackingScope
{
foreach ($node->children['uses']->children ?? [] as$closure_use) {
if (!($closure_use instanceof Node)) { continue; Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 1 hr to fix Cognitive Complexity Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend. A method's cognitive complexity is based on a few simple rules: • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one • Code is considered more complex for each "break in the linear flow of the code" • Code is considered more complex when "flow breaking structures are nested" Further reading Method analyzeAssignmentTarget has 27 lines of code (exceeds 25 allowed). Consider refactoring. Open  private function analyzeAssignmentTarget($node, bool $is_ref,$const_expr): VariableTrackingScope
{
// TODO: Push onto the node list?
if (!($node instanceof Node)) { return$this->scope;
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 1 hr to fix

Method visitAssignOp has 26 lines of code (exceeds 25 allowed). Consider refactoring. Open

    public function visitAssignOp(Node $node): VariableTrackingScope {$expr = $node->children['expr']; if ($expr instanceof Node) {
$this->scope =$this->analyze($this->scope,$expr);
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 1 hr to fix

    public function visitFor(Node $node): VariableTrackingScope {$this->checkIsSideEffectFreeLoopNode($node);$top_level_statement = $this->top_level_statement; Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 55 mins to fix Cognitive Complexity Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend. A method's cognitive complexity is based on a few simple rules: • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one • Code is considered more complex for each "break in the linear flow of the code" • Code is considered more complex when "flow breaking structures are nested" Further reading Function visitVar has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring. Open  public function visitVar(Node$node): VariableTrackingScope
{
$name =$node->children['name'];
if (\is_string($name)) { self::$variable_graph->recordVariableUsage($name,$node, $this->scope); Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 45 mins to fix Cognitive Complexity Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend. A method's cognitive complexity is based on a few simple rules: • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one • Code is considered more complex for each "break in the linear flow of the code" • Code is considered more complex when "flow breaking structures are nested" Further reading Function analyzeArrayAssignmentTarget has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open  private function analyzeArrayAssignmentTarget(Node$node, $const_expr): VariableTrackingScope { foreach ($node->children as $elem_node) { if (!($elem_node instanceof Node)) {
continue;
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 35 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

Function analyzePropAssignmentTarget has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open

    private function analyzePropAssignmentTarget(Node $node): VariableTrackingScope { // Treat$y in $x->$y = $z; as a usage of$y
$this->scope =$this->analyzeWhenValidNode($this->scope,$node->children['prop']);
$expr =$node->children['expr'];
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 35 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

Function hasUnknownTypeLoopNodeKinds has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring. Open

    private static function hasUnknownTypeLoopNodeKinds(Node $node): bool { switch ($node->kind) {
case ast\AST_CLOSURE:
case ast\AST_ARROW_FUNC:
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 35 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

    private function analyzeIncDec(Node $node): VariableTrackingScope {$var_node = $node->children['var']; if ($var_node instanceof Node && $var_node->kind === ast\AST_VAR) {$name = $var_node->children['name']; Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 35 mins to fix Cognitive Complexity Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend. A method's cognitive complexity is based on a few simple rules: • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one • Code is considered more complex for each "break in the linear flow of the code" • Code is considered more complex when "flow breaking structures are nested" Further reading Avoid too many return statements within this method. Open  return$this->scope;
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 30 mins to fix

                return $this->analyze($this->scope, $var_node); Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 30 mins to fix Avoid too many return statements within this method. Open  return$this->scope;
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 30 mins to fix

Avoid too many return statements within this method. Open

                return $this->analyzeDimAssignmentTarget($node);
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 30 mins to fix

Avoid too many return statements within this method. Open

                return $this->analyzePropAssignmentTarget($node);
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 30 mins to fix

                return $this->analyze($this->scope, $node); Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 30 mins to fix Function visitCall has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open  public function visitCall(Node$node): VariableTrackingScope
{
if (isset($node->dynamic_var_uses)) {$this->handleDynamicVarUses($node,$node->dynamic_var_uses);
}
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 25 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

Function checkIsSideEffectFreeLoopNode has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open

    private function checkIsSideEffectFreeLoopNode(Node $node): void { // @phan-suppress-next-line PhanUndeclaredProperty if (isset($node->has_loop_body_without_side_effects)) {
$this->side_effect_free_loop_nodes[] =$node;
Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 25 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

• Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
• Code is considered more complex for each "break in the linear flow of the code"
• Code is considered more complex when "flow breaking structures are nested"

Function markVariablesAsReference has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring. Open

    private static function markVariablesAsReference(Node $expr): void { while (\in_array($expr->kind, [ast\AST_DIM, ast\AST_PROP], true)) {
$expr =$expr->children['expr'];
if (!$expr instanceof Node) { Found in src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php - About 25 mins to fix Cognitive Complexity Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend. A method's cognitive complexity is based on a few simple rules: • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one • Code is considered more complex for each "break in the linear flow of the code" • Code is considered more complex when "flow breaking structures are nested" Further reading The class VariableTrackerVisitor has 1150 lines of code. Current threshold is 1000. Avoid really long classes. Open final class VariableTrackerVisitor extends AnalysisVisitor { /** * This shared graph instance maps definitions of variables (in a function-like context) * to the uses of that variable. The method hasUnknownTypeLoopNodeKinds() has a Cyclomatic Complexity of 15. The configured cyclomatic complexity threshold is 10. Open  private static function hasUnknownTypeLoopNodeKinds(Node$node): bool
{
switch ($node->kind) { case ast\AST_CLOSURE: case ast\AST_ARROW_FUNC: CyclomaticComplexity Since: 0.1 Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity. Example // Cyclomatic Complexity = 11 class Foo { 1 public function example() { 2 if ($a == $b) { 3 if ($a1 == $b1) { fiddle(); 4 } elseif ($a2 == $b2) { fiddle(); } else { fiddle(); } 5 } elseif ($c == $d) { 6 while ($c == $d) { fiddle(); } 7 } elseif ($e == $f) { 8 for ($n = 0; $n <$h; $n++) { fiddle(); } } else { switch ($z) {
9               case 1:
fiddle();
break;
10              case 2:
fiddle();
break;
11              case 3:
fiddle();
break;
default:
fiddle();
break;
}
}
}
}

Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity

The method visitSwitchList() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10. Open

    public function visitSwitchList(Node $node): VariableTrackingScope {$outer_scope = $this->scope;$inner_scope_list = [];

CyclomaticComplexity

Since: 0.1

Complexity is determined by the number of decision points in a method plus one for the method entry. The decision points are 'if', 'while', 'for', and 'case labels'. Generally, 1-4 is low complexity, 5-7 indicates moderate complexity, 8-10 is high complexity, and 11+ is very high complexity.

Example

// Cyclomatic Complexity = 11
class Foo {
1   public function example() {
2       if ($a ==$b) {
3           if ($a1 ==$b1) {
fiddle();
4           } elseif ($a2 ==$b2) {
fiddle();
} else {
fiddle();
}
5       } elseif ($c ==$d) {
6           while ($c ==$d) {
fiddle();
}
7        } elseif ($e ==$f) {
8           for ($n = 0;$n < $h;$n++) {
fiddle();
}
} else {
switch ($z) { 9 case 1: fiddle(); break; 10 case 2: fiddle(); break; 11 case 3: fiddle(); break; default: fiddle(); break; } } } } Source https://phpmd.org/rules/codesize.html#cyclomaticcomplexity The class VariableTrackerVisitor has a coupling between objects value of 15. Consider to reduce the number of dependencies under 13. Open final class VariableTrackerVisitor extends AnalysisVisitor { /** * This shared graph instance maps definitions of variables (in a function-like context) * to the uses of that variable. CouplingBetweenObjects Since: 1.1.0 A class with too many dependencies has negative impacts on several quality aspects of a class. This includes quality criteria like stability, maintainability and understandability Example class Foo { /** * @var \foo\bar\X */ private$x = null;

/**
* @var \foo\bar\Y
*/
private $y = null; /** * @var \foo\bar\Z */ private$z = null;

public function setFoo(\Foo $foo) {} public function setBar(\Bar$bar) {}
public function setBaz(\Baz $baz) {} /** * @return \SplObjectStorage * @throws \OutOfRangeException * @throws \InvalidArgumentException * @throws \ErrorException */ public function process(\Iterator$it) {}

// ...
}

Source https://phpmd.org/rules/design.html#couplingbetweenobjects

Similar blocks of code found in 2 locations. Consider refactoring. Open

    public function visitStmtList(Node $node): VariableTrackingScope {$top_level_statement = $this->top_level_statement; foreach ($node->children as $child_node) { if (!($child_node instanceof Node)) {
src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php on lines 231..245

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 97.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Similar blocks of code found in 2 locations. Consider refactoring. Open

    public function visitExprList(Node $node): VariableTrackingScope {$top_level_statement = $this->top_level_statement; foreach ($node->children as $child_node) { if (!($child_node instanceof Node)) {
src/Phan/Plugin/Internal/VariableTracker/VariableTrackerVisitor.php on lines 211..225

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 97.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.