ThrowMustBundlePreviousExceptionRule::processNode()

Complexity

Conditions	2
Paths	2

Size

Total Lines	59
Code Lines	25

Duplication

Lines	0
Ratio	0 %

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	ThrowMustBundlePreviousExceptionRule.php$0 ➔ __construct()	0	5	1
A	ThrowMustBundlePreviousExceptionRule.php$0 ➔ getUnusedThrows()	0	4	1
C	ThrowMustBundlePreviousExceptionRule.php$0 ➔ leaveNode()	0	18	8

<?php


namespace TheCodingMachine\PHPStan\Rules\Exceptions;


use PhpParser\Node;
use PhpParser\Node\Stmt\Catch_;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitorAbstract;
use PHPStan\Analyser\Scope;
use PHPStan\Broker\Broker;
use PHPStan\Rules\Rule;

/**
 * When throwing into a catch block, checks that the previous exception is passed to the new "throw" clause
 * (the initial stack trace must not be lost).
 */
class ThrowMustBundlePreviousExceptionRule implements Rule
{
    public function getNodeType(): string
    {
        return Catch_::class;
    }

    /**
     * @param Catch_ $node
     * @param \PHPStan\Analyser\Scope $scope
     * @return string[]
     */
    public function processNode(Node $node, Scope $scope): array
    {
        $visitor = new class($node->var) extends NodeVisitorAbstract {
            /**
             * @var string
             */
            private $catchedVariableName;
            private $exceptionUsedCount = 0;
            private $unusedThrows = [];

            public function __construct(string $catchedVariableName)
            {

                $this->catchedVariableName = $catchedVariableName;
            }

            public function leaveNode(Node $node) {
                if ($node instanceof Node\Expr\Variable) {

The class PhpParser\Node\Expr\Variable does not exist. Did you forget a USE statement, or did you not list all dependencies?

                    if ($node->name === $this->catchedVariableName) {
                        $this->exceptionUsedCount++;
                    }
                }

                // If the variable is used in the context of a method call (like $e->getMessage()), the exception is not passed as a "previous exception".
                if ($node instanceof Node\Expr\MethodCall) {

The class PhpParser\Node\Expr\MethodCall does not exist. Did you forget a USE statement, or did you not list all dependencies?

                    if ($node->var instanceof Node\Expr\Variable && $node->var->name === $this->catchedVariableName) {

The class PhpParser\Node\Expr\Variable does not exist. Did you forget a USE statement, or did you not list all dependencies?

                        $this->exceptionUsedCount--;
                    }
                }

                if ($node instanceof Node\Stmt\Throw_ && $this->exceptionUsedCount === 0) {

The class PhpParser\Node\Stmt\Throw_ does not exist. Did you forget a USE statement, or did you not list all dependencies?

                    $this->unusedThrows[] = $node;
                }
            }

            /**
             * @return array
             */
            public function getUnusedThrows(): array
            {
                return $this->unusedThrows;
            }

        };

        $traverser = new NodeTraverser();

        $traverser->addVisitor($visitor);

        $traverser->traverse($node->stmts);

        $errors = [];

        foreach ($visitor->getUnusedThrows() as $throw) {
            $errors[] = sprintf('Thrown exceptions in a catch block must bundle the previous exception (see throw statement line %d)', $throw->getLine());
        }

        return $errors;
    }
}