Sign upLogin

AJenbo/php-tracer-weaver

View on GitHub
Star

Showing 30 of 30 total issues

The method getArrayType has a boolean flag argument $xdebug3, which is a certain sign of a Single Responsibility Principle violation.
Open

    public function getArrayType(string $arrayType, bool $xdebug3 = false): string
Severity: Minor
Found in src/PHPWeaver/Xtrace/TraceSignatureLogger.php by phpmd

BooleanArgumentFlag

Since: 1.4.0

A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

Example

class Foo {
    public function bar($flag = true) {
    }
}

Source https://phpmd.org/rules/cleancode.html#booleanargumentflag

Avoid too many return statements within this method.
Open

                return 'int';
Severity: Major
Found in src/PHPWeaver/Xtrace/TraceSignatureLogger.php - About 30 mins to fix

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

        public function processLine(string $line): void
    {
        /** @var array<int, string> */
        $entry = str_getcsv($line, "\t");
    Severity: Minor
    Found in src/PHPWeaver/Xtrace/TraceReader.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

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

        private function parseTrace(string $tracefile): Signatures
    {
        $sigs = new Signatures();
        if (is_file($tracefile)) {
            $traceFile = new SplFileObject($tracefile);
    Severity: Minor
    Found in src/PHPWeaver/Command/WeaveCommand.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

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

        public function accept(Token $token): void
    {
        if ($token->isA(T_INTERFACE) || $token->isA(T_CLASS)) {
            $this->state = 1;
    Severity: Minor
    Found in src/PHPWeaver/Scanner/ClassScanner.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

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

        public function accept(Token $token): void
    {
        if ($token->isA(T_FUNCTION)) {
            $this->currentClassScope = $token->getDepth();
            $this->state = 1;
    Severity: Minor
    Found in src/PHPWeaver/Scanner/FunctionBodyScanner.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

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

        private function transformFiles(array $filesToWeave, Signatures $sigs): void
    {
        $this->progressBarStart(count($filesToWeave), '<info>Updating source files …</info>');

        foreach ($filesToWeave as $fileToWeave) {
    Severity: Minor
    Found in src/PHPWeaver/Command/WeaveCommand.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 getArrayElements uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            } else {
            preg_match('/^array \((.*?)(?:, )?\.{0,3}\)$/s', $type, $match);
        }
    Severity: Minor
    Found in src/PHPWeaver/Xtrace/TraceSignatureLogger.php by phpmd

    ElseExpression

    Since: 1.4.0

    An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

    Example

    class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

    Source https://phpmd.org/rules/cleancode.html#elseexpression

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

        public function generateDoc(string $func, string $class = '', array $params = [], string $namespace = ''): ?string
    {
        if ((!$params && ('__construct' === $func || '__destruct' === $func))
            || !$this->signatures->has($func, $class, $namespace)
        ) {
    Severity: Minor
    Found in src/PHPWeaver/Transform/TracerDocBlockEditor.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 accept() has a Cyclomatic Complexity of 11. The configured cyclomatic complexity threshold is 10.
    Open

        public function accept(Token $token): void
    {
        if ($token->isA(T_DOC_COMMENT)) {
            $this->state = 1;
            $this->raiseBuffer();
    Severity: Minor
    Found in src/PHPWeaver/Transform/DocCommentEditorTransformer.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

    Severity
    Category
    Status
    Source
    Language