src/Phan/AST/ASTSimplifier.php

Summary

Maintainability
F
4 days
Test Coverage

File ASTSimplifier.php has 583 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace Phan\AST;
Severity: Major
Found in src/Phan/AST/ASTSimplifier.php - About 1 day to fix

    Function normalizeIfStatement has a Cognitive Complexity of 29 (exceeds 5 allowed). Consider refactoring.
    Open

        private static function normalizeIfStatement(Node $original_node): array
        {
            $nodes = [$original_node];
            // Repeatedly apply these rules
            do {
    Severity: Minor
    Found in src/Phan/AST/ASTSimplifier.php - About 4 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"

    Further reading

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

    class ASTSimplifier
    {
        public function __construct()
        {
        }
    Severity: Minor
    Found in src/Phan/AST/ASTSimplifier.php by phpmd

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

    class ASTSimplifier
    {
        public function __construct()
        {
        }
    Severity: Minor
    Found in src/Phan/AST/ASTSimplifier.php by phpmd

    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

    ASTSimplifier has 27 functions (exceeds 20 allowed). Consider refactoring.
    Open

    class ASTSimplifier
    {
        public function __construct()
        {
        }
    Severity: Minor
    Found in src/Phan/AST/ASTSimplifier.php - About 3 hrs to fix

      Method normalizeIfStatement has 62 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          private static function normalizeIfStatement(Node $original_node): array
          {
              $nodes = [$original_node];
              // Repeatedly apply these rules
              do {
      Severity: Major
      Found in src/Phan/AST/ASTSimplifier.php - About 2 hrs to fix

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

            private static function normalizeWhileStatement(Node $original_node): array
            {
                $node = $original_node;
                // Repeatedly apply these rules
                while (true) {
        Severity: Minor
        Found in src/Phan/AST/ASTSimplifier.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"

        Further reading

        Function normalizeForStatement has a Cognitive Complexity of 15 (exceeds 5 allowed). Consider refactoring.
        Open

            private static function normalizeForStatement(Node $node): array
            {
                // Repeatedly apply these rules
                while (true) {
                    $for_cond_list = $node->children['cond'];
        Severity: Minor
        Found in src/Phan/AST/ASTSimplifier.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 applyIfNegatedToIfElseReduction has 32 lines of code (exceeds 25 allowed). Consider refactoring.
        Open

            private static function applyIfNegatedToIfElseReduction(Node $node): Node
            {
                if (count($node->children) !== 1) {
                    throw new AssertionError("Expected one child node");
                }
        Severity: Minor
        Found in src/Phan/AST/ASTSimplifier.php - About 1 hr to fix

          Function applyToStatementList has a Cognitive Complexity of 10 (exceeds 5 allowed). Consider refactoring.
          Open

              private static function applyToStatementList(Node $statement_list): Node
              {
                  if ($statement_list->kind !== ast\AST_STMT_LIST) {
                      $statement_list = self::buildStatementList($statement_list->lineno, $statement_list);
                  }
          Severity: Minor
          Found in src/Phan/AST/ASTSimplifier.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

          Function normalizeStatementList has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
          Open

              private static function normalizeStatementList(array $statements): array
              {
                  $modified = false;
                  $new_statements = [];
                  foreach ($statements as $stmt) {
          Severity: Minor
          Found in src/Phan/AST/ASTSimplifier.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

          Avoid too many return statements within this method.
          Open

                          return false;
          Severity: Major
          Found in src/Phan/AST/ASTSimplifier.php - About 30 mins to fix

            Avoid too many return statements within this method.
            Open

                            return [self::applyToStatementList($node)];
            Severity: Major
            Found in src/Phan/AST/ASTSimplifier.php - About 30 mins to fix

              Avoid too many return statements within this method.
              Open

                              return [self::normalizeTryStatement($node)];
              Severity: Major
              Found in src/Phan/AST/ASTSimplifier.php - About 30 mins to fix

                Avoid too many return statements within this method.
                Open

                                return self::normalizeIfStatement($node);
                Severity: Major
                Found in src/Phan/AST/ASTSimplifier.php - About 30 mins to fix

                  Avoid too many return statements within this method.
                  Open

                                  return self::isExpressionWithoutSideEffects($node->children['class']);
                  Severity: Major
                  Found in src/Phan/AST/ASTSimplifier.php - About 30 mins to fix

                    The method normalizeIfStatement() has an NPath complexity of 9721. The configured NPath complexity threshold is 200.
                    Open

                        private static function normalizeIfStatement(Node $original_node): array
                        {
                            $nodes = [$original_node];
                            // Repeatedly apply these rules
                            do {
                    Severity: Minor
                    Found in src/Phan/AST/ASTSimplifier.php by phpmd

                    NPathComplexity

                    Since: 0.1

                    The NPath complexity of a method is the number of acyclic execution paths through that method. A threshold of 200 is generally considered the point where measures should be taken to reduce complexity.

                    Example

                    class Foo {
                        function bar() {
                            // lots of complicated code
                        }
                    }

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

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

                        public static function isExpressionWithoutSideEffects($node): bool
                        {
                            if (!($node instanceof Node)) {
                                return true;
                            }
                    Severity: Minor
                    Found in src/Phan/AST/ASTSimplifier.php by phpmd

                    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 normalizeWhileStatement() has a Cyclomatic Complexity of 10. The configured cyclomatic complexity threshold is 10.
                    Open

                        private static function normalizeWhileStatement(Node $original_node): array
                        {
                            $node = $original_node;
                            // Repeatedly apply these rules
                            while (true) {
                    Severity: Minor
                    Found in src/Phan/AST/ASTSimplifier.php by phpmd

                    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 normalizeIfStatement() has a Cyclomatic Complexity of 27. The configured cyclomatic complexity threshold is 10.
                    Open

                        private static function normalizeIfStatement(Node $original_node): array
                        {
                            $nodes = [$original_node];
                            // Repeatedly apply these rules
                            do {
                    Severity: Minor
                    Found in src/Phan/AST/ASTSimplifier.php by phpmd

                    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 apply() has a Cyclomatic Complexity of 12. The configured cyclomatic complexity threshold is 10.
                    Open

                        private static function apply(Node $node): array
                        {
                            switch ($node->kind) {
                                case ast\AST_FUNC_DECL:
                                case ast\AST_METHOD:
                    Severity: Minor
                    Found in src/Phan/AST/ASTSimplifier.php by phpmd

                    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

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

                                    if (in_array($if_cond_children['left']->kind ?? 0, [ast\AST_ASSIGN, ast\AST_ASSIGN_REF], true) &&
                                            ($if_cond_children['left']->children['var']->kind ?? 0) === ast\AST_VAR &&
                                            self::isExpressionWithoutSideEffects($if_cond_children['right'])) {
                                        self::replaceLastNodeWithNodeList($nodes, ...self::applyAssignInLeftSideOfBinaryOpReduction($node));
                                        continue;
                    Severity: Major
                    Found in src/Phan/AST/ASTSimplifier.php and 1 other location - About 1 hr to fix
                    src/Phan/AST/ASTSimplifier.php on lines 256..261

                    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 107.

                    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

                    Further Reading

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

                                    if (in_array($if_cond_children['right']->kind ?? 0, [ast\AST_ASSIGN, ast\AST_ASSIGN_REF], true) &&
                                            ($if_cond_children['right']->children['var']->kind ?? 0) === ast\AST_VAR &&
                                            self::isExpressionWithoutSideEffects($if_cond_children['left'])) {
                                        self::replaceLastNodeWithNodeList($nodes, ...self::applyAssignInRightSideOfBinaryOpReduction($node));
                                        continue;
                    Severity: Major
                    Found in src/Phan/AST/ASTSimplifier.php and 1 other location - About 1 hr to fix
                    src/Phan/AST/ASTSimplifier.php on lines 250..255

                    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 107.

                    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

                    Further Reading

                    Avoid variables with short names like $l. Configured minimum length is 3.
                    Open

                        private static function buildIfNode(Node $l, Node $r): Node
                    Severity: Minor
                    Found in src/Phan/AST/ASTSimplifier.php by phpmd

                    ShortVariable

                    Since: 0.2

                    Detects when a field, local, or parameter has a very short name.

                    Example

                    class Something {
                        private $q = 15; // VIOLATION - Field
                        public static function main( array $as ) { // VIOLATION - Formal
                            $r = 20 + $this->q; // VIOLATION - Local
                            for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                                $r += $this->q;
                            }
                        }
                    }

                    Source https://phpmd.org/rules/naming.html#shortvariable

                    Avoid variables with short names like $r. Configured minimum length is 3.
                    Open

                        private static function buildIfNode(Node $l, Node $r): Node
                    Severity: Minor
                    Found in src/Phan/AST/ASTSimplifier.php by phpmd

                    ShortVariable

                    Since: 0.2

                    Detects when a field, local, or parameter has a very short name.

                    Example

                    class Something {
                        private $q = 15; // VIOLATION - Field
                        public static function main( array $as ) { // VIOLATION - Formal
                            $r = 20 + $this->q; // VIOLATION - Local
                            for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                                $r += $this->q;
                            }
                        }
                    }

                    Source https://phpmd.org/rules/naming.html#shortvariable

                    Avoid variables with short names like $l. Configured minimum length is 3.
                    Open

                                $l = array_pop($children);
                    Severity: Minor
                    Found in src/Phan/AST/ASTSimplifier.php by phpmd

                    ShortVariable

                    Since: 0.2

                    Detects when a field, local, or parameter has a very short name.

                    Example

                    class Something {
                        private $q = 15; // VIOLATION - Field
                        public static function main( array $as ) { // VIOLATION - Formal
                            $r = 20 + $this->q; // VIOLATION - Local
                            for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                                $r += $this->q;
                            }
                        }
                    }

                    Source https://phpmd.org/rules/naming.html#shortvariable

                    Avoid variables with short names like $r. Configured minimum length is 3.
                    Open

                                $r = array_pop($children);
                    Severity: Minor
                    Found in src/Phan/AST/ASTSimplifier.php by phpmd

                    ShortVariable

                    Since: 0.2

                    Detects when a field, local, or parameter has a very short name.

                    Example

                    class Something {
                        private $q = 15; // VIOLATION - Field
                        public static function main( array $as ) { // VIOLATION - Formal
                            $r = 20 + $this->q; // VIOLATION - Local
                            for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                                $r += $this->q;
                            }
                        }
                    }

                    Source https://phpmd.org/rules/naming.html#shortvariable

                    There are no issues that match your filters.

                    Category
                    Status