etsy/phan

src/Phan/Debug.php

Summary

Maintainability

D

2 days

Test Coverage

Method `getFlagInfo` has 148 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    private static function getFlagInfo(): array
    {
        // TODO: Use AST's built in flag info if available.
        static $exclusive, $combinable;
        // Write this in a way that lets Phan infer the value of $combinable at the end.

Found in src/Phan/Debug.php - About 5 hrs to fix

File `Debug.php` has 340 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

declare(strict_types=1);

namespace Phan;

Found in src/Phan/Debug.php - About 4 hrs to fix

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

class Debug
{
    // option for self::astDump
    public const AST_DUMP_LINENOS = 1;

Found in src/Phan/Debug.php by phpmd

Exclude checks
- Disable engine
- Disable check

The class Debug has 11 public methods. Consider refactoring Debug to keep number of public methods under 10.
Open

class Debug
{
    // option for self::astDump
    public const AST_DUMP_LINENOS = 1;

Found in src/Phan/Debug.php by phpmd

Read up
Read up
Exclude checks
- Disable engine
- Disable check

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

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

    public static function astDump($ast, int $options = 0): string
    {
        if ($ast instanceof Node) {
            $result = Parser::getKindName($ast->kind);

Found in src/Phan/Debug.php - About 2 hrs to fix

Read up
Read up

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 `nodeToString` has 37 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function nodeToString(
        $node,
        $name = null,
        int $indent = 0
    ): string {

Found in src/Phan/Debug.php - About 1 hr to fix

Function `nodeToString` has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

    public static function nodeToString(
        $node,
        $name = null,
        int $indent = 0
    ): string {

Found in src/Phan/Debug.php - About 1 hr to fix

Read up
Read up

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 `formatFlags` has a Cognitive Complexity of 11 (exceeds 5 allowed). Consider refactoring.
Open

    public static function formatFlags(int $kind, int $flags): string
    {
        [$exclusive, $combinable] = self::getFlagInfo();
        if (isset($exclusive[$kind])) {
            $flag_info = $exclusive[$kind];

Found in src/Phan/Debug.php - About 1 hr to fix

Read up
Read up

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 `astDump` has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public static function astDump($ast, int $options = 0): string
    {
        if ($ast instanceof Node) {
            $result = Parser::getKindName($ast->kind);

Found in src/Phan/Debug.php - About 1 hr to fix

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

    public static function astFlagDescription(int $flags, int $kind): string
    {
        [$exclusive, $combinable] = self::getFlagInfo();
        $flag_names = [];
        if (isset($exclusive[$kind])) {

Found in src/Phan/Debug.php - About 55 mins to fix

Read up
Read up

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 "UNKNOWN_KIND($kind)";

Found in src/Phan/Debug.php - About 30 mins to fix

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

    public static function backtrace(int $levels = 0): void
    {
        $bt = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, $levels + 1);
        foreach ($bt as $level => $context) {
            if (!$level) {

Found in src/Phan/Debug.php - About 25 mins to fix

Read up
Read up

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 getFlagInfo() has 156 lines of code. Current threshold is set to 100. Avoid really long methods.
Open

    private static function getFlagInfo(): array
    {
        // TODO: Use AST's built in flag info if available.
        static $exclusive, $combinable;
        // Write this in a way that lets Phan infer the value of $combinable at the end.

Found in src/Phan/Debug.php by phpmd

Exclude checks
- Disable engine
- Disable check

The method nodeToString() has an NPath complexity of 768. The configured NPath complexity threshold is 200.
Open

    public static function nodeToString(
        $node,
        $name = null,
        int $indent = 0
    ): string {

Found in src/Phan/Debug.php by phpmd

Read up
Read up
Exclude checks
- Disable engine
- Disable check

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

    public static function nodeToString(
        $node,
        $name = null,
        int $indent = 0
    ): string {

Found in src/Phan/Debug.php by phpmd

Read up
Read up
Exclude checks
- Disable engine
- Disable check

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

            $shared_binary_ops = [
                flags\BINARY_BITWISE_OR => 'BINARY_BITWISE_OR',
                flags\BINARY_BITWISE_AND => 'BINARY_BITWISE_AND',
                flags\BINARY_BITWISE_XOR => 'BINARY_BITWISE_XOR',
                flags\BINARY_CONCAT => 'BINARY_CONCAT',

Found in src/Phan/Debug.php and 1 other location - About 1 hr to fix

Read up
Read up

.phan/plugins/DuplicateExpressionPlugin.php on lines 195..209

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

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

Don't Repeat Yourself on the C2 Wiki
Duplicated Code on SourceMaking
Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

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

                ast\AST_BINARY_OP => $shared_binary_ops + [
                    flags\BINARY_BOOL_AND => 'BINARY_BOOL_AND',
                    flags\BINARY_BOOL_OR => 'BINARY_BOOL_OR',
                    flags\BINARY_BOOL_XOR => 'BINARY_BOOL_XOR',
                    flags\BINARY_IS_IDENTICAL => 'BINARY_IS_IDENTICAL',

Found in src/Phan/Debug.php and 2 other locations - About 55 mins to fix

Read up
Read up

src/Phan/Analysis/PostOrderAnalysisVisitor.php on lines 1038..1052

src/Phan/Debug.php on lines 332..345

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

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

Don't Repeat Yourself on the C2 Wiki
Duplicated Code on SourceMaking
Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

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

            $types = [
                flags\TYPE_NULL => 'TYPE_NULL',
                flags\TYPE_FALSE => 'TYPE_FALSE',
                flags\TYPE_BOOL => 'TYPE_BOOL',
                flags\TYPE_LONG => 'TYPE_LONG',

Found in src/Phan/Debug.php and 2 other locations - About 55 mins to fix

Read up
Read up

src/Phan/Analysis/PostOrderAnalysisVisitor.php on lines 1038..1052

src/Phan/Debug.php on lines 389..402

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

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

Don't Repeat Yourself on the C2 Wiki
Duplicated Code on SourceMaking
Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

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

        $bt = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, $levels + 1);

Found in src/Phan/Debug.php by phpmd

Read up
Read up
Exclude checks
- Disable engine
- Disable check

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.