Sign upLogin

etsy/phan

View on GitHub
Star
src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.php

Summary

Maintainability
D
1 day
Test Coverage

Function findNodeAtOffsetRecursive has a Cognitive Complexity of 34 (exceeds 5 allowed). Consider refactoring.
Open

    private static function findNodeAtOffsetRecursive(\Microsoft\PhpParser\Node $parser_node, int $offset)
    {
        foreach ($parser_node->getChildNodesAndTokens() as $key => $node_or_token) {
            if ($node_or_token instanceof Token) {
                // fprintf(
Severity: Minor
Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.php - About 5 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 TolerantASTConverterWithNodeMapping has an overall complexity of 55 which is very high. The configured complexity threshold is 50.
Open

class TolerantASTConverterWithNodeMapping extends TolerantASTConverter
{
    /**
     * @var PhpParser\Node|Token|null
     * This is the closest node or token from tolerant-php-parser
Severity: Minor
Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.php by phpmd

Method findNodeAtOffsetRecursive has 35 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private static function findNodeAtOffsetRecursive(\Microsoft\PhpParser\Node $parser_node, int $offset)
    {
        foreach ($parser_node->getChildNodesAndTokens() as $key => $node_or_token) {
            if ($node_or_token instanceof Token) {
                // fprintf(
Severity: Minor
Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.php - About 1 hr to fix

    Function markNodeAsSelected has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
    Open

        private static function markNodeAsSelected($n, $ast_node): void
    {
        // fwrite(STDERR, "Marking corresponding node as flagged: " . json_encode($n) . "\n" . \Phan\Debug::nodeToString($ast_node) . "\n");
        // fflush(STDERR);
        if ($ast_node instanceof ast\Node) {
    Severity: Minor
    Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.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

    Avoid too many return statements within this method.
    Open

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

      Avoid too many return statements within this method.
      Open

                          return true;
      Severity: Major
      Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.php - About 30 mins to fix

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

            protected static function phpParserNodeToAstNode($n)
    {
        static $callback_map;
        static $fallback_closure;
        if (\is_null($callback_map)) {
        Severity: Minor
        Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.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 method findNodeAtOffsetRecursive() has a Cyclomatic Complexity of 13. The configured cyclomatic complexity threshold is 10.
        Open

            private static function findNodeAtOffsetRecursive(\Microsoft\PhpParser\Node $parser_node, int $offset)
    {
        foreach ($parser_node->getChildNodesAndTokens() as $key => $node_or_token) {
            if ($node_or_token instanceof Token) {
                // fprintf(
        Severity: Minor
        Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.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

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

                if (\is_null($callback_map)) {
            // XXX: If initHandleMap is called on TolerantASTConverter in the parent implementation before TolerantASTConverterWithNodeMapping,
            // then static:: in the callbacks would point to TolerantASTConverter, not this subclass.
            //
            // This is worked around by copying and pasting the parent implementation
        Severity: Major
        Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.php and 1 other location - About 2 hrs to fix
        src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.php on lines 389..406

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

        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

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

                if (\is_null($callback_map)) {
            // XXX: If initHandleMap is called on TolerantASTConverter in the parent implementation before TolerantASTConverterWithNodeMapping,
            // then static:: in the callbacks would point to TolerantASTConverter, not this subclass.
            //
            // This is worked around by copying and pasting the parent implementation
        Severity: Major
        Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.php and 1 other location - About 2 hrs to fix
        src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.php on lines 349..367

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

        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 $n. Configured minimum length is 3.
        Open

            protected static function phpParserNonValueNodeToAstNode($n)
        Severity: Minor
        Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.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 $n. Configured minimum length is 3.
        Open

            private static function markNodeAsSelected($n, $ast_node): void
        Severity: Minor
        Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.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 $n. Configured minimum length is 3.
        Open

            protected static function phpParserNodeToAstNode($n)
        Severity: Minor
        Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.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 $n. Configured minimum length is 3.
        Open

            protected static function phpParserNodeToAstNodeOrPlaceholderExpr($n)
        Severity: Minor
        Found in src/Phan/AST/TolerantASTConverter/TolerantASTConverterWithNodeMapping.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