WhileAnalyzer::getAndExpressions() - Code Metrics - vimeo/psalm - Measure and Improve Code Quality continuously with Scrutinizer

WhileAnalyzer::getAndExpressions() A
last analyzed 2020-07-20 09:18 UTC

↳ Parent: WhileAnalyzer

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0

<?php
namespace Psalm\Internal\Analyzer\Statements\Block;

use PhpParser;
use Psalm\Internal\Analyzer\ScopeAnalyzer;
use Psalm\Internal\Analyzer\StatementsAnalyzer;
use Psalm\Internal\Analyzer\Statements\ExpressionAnalyzer;
use Psalm\Context;
use Psalm\Internal\Scope\LoopScope;
use Psalm\Type;
use function in_array;
use function array_merge;

/**
 * @internal
 */
class WhileAnalyzer
{
    /**
     * @param   StatementsAnalyzer           $statements_analyzer
     * @param   PhpParser\Node\Stmt\While_  $stmt
     * @param   Context                     $context
     *
     * @return  false|null
     */
    public static function analyze(
        StatementsAnalyzer $statements_analyzer,
        PhpParser\Node\Stmt\While_ $stmt,
        Context $context
    ) {
        $while_true = ($stmt->cond instanceof PhpParser\Node\Expr\ConstFetch && $stmt->cond->name->parts === ['true'])
            || ($stmt->cond instanceof PhpParser\Node\Scalar\LNumber && $stmt->cond->value > 0);

        $pre_context = null;

        if ($while_true) {
            $pre_context = clone $context;
        }

        $while_context = clone $context;

        $while_context->inside_loop = true;
        $while_context->break_types[] = 'loop';

        $codebase = $statements_analyzer->getCodebase();

        if ($codebase->alter_code) {
            $while_context->branch_point = $while_context->branch_point ?: (int) $stmt->getAttribute('startFilePos');
        }

        $loop_scope = new LoopScope($while_context, $context);
        $loop_scope->protected_var_ids = $context->protected_var_ids;

        if (LoopAnalyzer::analyze(
            $statements_analyzer,
            $stmt->stmts,
            self::getAndExpressions($stmt->cond),
            [],
            $loop_scope,
            $inner_loop_context
        ) === false) {
            return false;
        }

        if (!$inner_loop_context) {
            throw new \UnexpectedValueException('Should always enter loop');
        }

        $always_enters_loop = false;

        if ($stmt_cond_type = $statements_analyzer->node_data->getType($stmt->cond)) {
            $always_enters_loop = true;

            foreach ($stmt_cond_type->getAtomicTypes() as $iterator_type) {
                if ($iterator_type instanceof Type\Atomic\TArray
                    || $iterator_type instanceof Type\Atomic\ObjectLike
                ) {
                    if ($iterator_type instanceof Type\Atomic\ObjectLike) {
                        if (!$iterator_type->sealed) {
                            $always_enters_loop = false;
                        }
                    } elseif (!$iterator_type instanceof Type\Atomic\TNonEmptyArray) {
                        $always_enters_loop = false;
                    }

                    continue;
                }

                if ($iterator_type instanceof Type\Atomic\TTrue) {
                    continue;
                }

                if ($iterator_type instanceof Type\Atomic\TLiteralString
                    && $iterator_type->value
                ) {
                    continue;
                }

                if ($iterator_type instanceof Type\Atomic\TLiteralInt
                    && $iterator_type->value
                ) {
                    continue;
                }

                $always_enters_loop = false;
                break;
            }
        }

        $can_leave_loop = !$while_true
            || in_array(ScopeAnalyzer::ACTION_BREAK, $loop_scope->final_actions, true);

        if ($always_enters_loop && $can_leave_loop) {

            foreach ($inner_loop_context->vars_in_scope as $var_id => $type) {
                // if there are break statements in the loop it's not certain
                // that the loop has finished executing, so the assertions at the end
                // the loop in the while conditional may not hold
                if (in_array(ScopeAnalyzer::ACTION_BREAK, $loop_scope->final_actions, true)
                    || in_array(ScopeAnalyzer::ACTION_CONTINUE, $loop_scope->final_actions, true)
                ) {
                    if (isset($loop_scope->possibly_defined_loop_parent_vars[$var_id])) {
                        $context->vars_in_scope[$var_id] = Type::combineUnionTypes(
                            $type,
                            $loop_scope->possibly_defined_loop_parent_vars[$var_id]
                        );
                    }
                } else {
                    $context->vars_in_scope[$var_id] = $type;
                }
            }
        }

        $while_context->loop_scope = null;

        if ($can_leave_loop) {

            $context->vars_possibly_in_scope = array_merge(
                $context->vars_possibly_in_scope,
                $while_context->vars_possibly_in_scope
            );
        } elseif ($pre_context) {
            $context->vars_possibly_in_scope = $pre_context->vars_possibly_in_scope;
        }

        $context->referenced_var_ids = array_merge(
            $context->referenced_var_ids,
            $while_context->referenced_var_ids
        );

        if ($codebase->find_unused_variables) {
            $suppressed_issues = $statements_analyzer->getSuppressedIssues();

            if (!in_array('RedundantCondition', $suppressed_issues, true)) {
                $statements_analyzer->addSuppressedIssues(['RedundantCondition']);
            }
            if (!in_array('RedundantConditionGivenDocblockType', $suppressed_issues, true)) {
                $statements_analyzer->addSuppressedIssues(['RedundantConditionGivenDocblockType']);
            }
            if (!in_array('TypeDoesNotContainType', $suppressed_issues, true)) {
                $statements_analyzer->addSuppressedIssues(['TypeDoesNotContainType']);
            }

            $while_context->inside_conditional = true;
            ExpressionAnalyzer::analyze($statements_analyzer, $stmt->cond, $while_context);
            $while_context->inside_conditional = false;

            if (!in_array('RedundantCondition', $suppressed_issues, true)) {
                $statements_analyzer->removeSuppressedIssues(['RedundantCondition']);
            }
            if (!in_array('RedundantConditionGivenDocblockType', $suppressed_issues, true)) {
                $statements_analyzer->removeSuppressedIssues(['RedundantConditionGivenDocblockType']);
            }
            if (!in_array('TypeDoesNotContainType', $suppressed_issues, true)) {
                $statements_analyzer->removeSuppressedIssues(['TypeDoesNotContainType']);
            }

            $context->unreferenced_vars = $while_context->unreferenced_vars;
        }

        return null;
    }

    /**
     * @return list<PhpParser\Node\Expr>

     */
    private static function getAndExpressions(
        PhpParser\Node\Expr $expr
    ) : array {
        if ($expr instanceof PhpParser\Node\Expr\BinaryOp\BooleanAnd) {
            return array_merge(
                self::getAndExpressions($expr->left),
                self::getAndExpressions($expr->right)
            );
        }

        return [$expr];
    }
}


1		<?php
2		namespace Psalm\Internal\Analyzer\Statements\Block;
3
4		use PhpParser;
5		use Psalm\Internal\Analyzer\ScopeAnalyzer;
6		use Psalm\Internal\Analyzer\StatementsAnalyzer;
7		use Psalm\Internal\Analyzer\Statements\ExpressionAnalyzer;
8		use Psalm\Context;
9		use Psalm\Internal\Scope\LoopScope;
10		use Psalm\Type;
11		use function in_array;
12		use function array_merge;
13
14		/**
15		* @internal
16		*/
17		class WhileAnalyzer
18		{
19		/**
20		* @param StatementsAnalyzer $statements_analyzer
21		* @param PhpParser\Node\Stmt\While_ $stmt
22		* @param Context $context
23		*
24		* @return false\|null
25		*/
26		public static function analyze(
27		StatementsAnalyzer $statements_analyzer,
28		PhpParser\Node\Stmt\While_ $stmt,
29		Context $context
30		) {
31		$while_true = ($stmt->cond instanceof PhpParser\Node\Expr\ConstFetch && $stmt->cond->name->parts === ['true'])
32		\|\| ($stmt->cond instanceof PhpParser\Node\Scalar\LNumber && $stmt->cond->value > 0);
33
34		$pre_context = null;
35
36		if ($while_true) {
37		$pre_context = clone $context;
38		}
39
40		$while_context = clone $context;
41
42		$while_context->inside_loop = true;
43		$while_context->break_types[] = 'loop';
44
45		$codebase = $statements_analyzer->getCodebase();
46
47		if ($codebase->alter_code) {
48		$while_context->branch_point = $while_context->branch_point ?: (int) $stmt->getAttribute('startFilePos');
49		}
50
51		$loop_scope = new LoopScope($while_context, $context);
52		$loop_scope->protected_var_ids = $context->protected_var_ids;
53
54		if (LoopAnalyzer::analyze(
55		$statements_analyzer,
56		$stmt->stmts,
57		self::getAndExpressions($stmt->cond),
58		[],
59		$loop_scope,
60		$inner_loop_context
61		) === false) {
62		return false;
63		}
64
65		if (!$inner_loop_context) {
66		throw new \UnexpectedValueException('Should always enter loop');
67		}
68
69		$always_enters_loop = false;
70
71		if ($stmt_cond_type = $statements_analyzer->node_data->getType($stmt->cond)) {
72		$always_enters_loop = true;
73
74		foreach ($stmt_cond_type->getAtomicTypes() as $iterator_type) {
75		if ($iterator_type instanceof Type\Atomic\TArray
76		\|\| $iterator_type instanceof Type\Atomic\ObjectLike
77		) {
78		if ($iterator_type instanceof Type\Atomic\ObjectLike) {
79		if (!$iterator_type->sealed) {
80		$always_enters_loop = false;
81		}
82		} elseif (!$iterator_type instanceof Type\Atomic\TNonEmptyArray) {
83		$always_enters_loop = false;
84		}
85
86		continue;
87		}
88
89		if ($iterator_type instanceof Type\Atomic\TTrue) {
90		continue;
91		}
92
93		if ($iterator_type instanceof Type\Atomic\TLiteralString
94		&& $iterator_type->value
95		) {
96		continue;
97		}
98
99		if ($iterator_type instanceof Type\Atomic\TLiteralInt
100		&& $iterator_type->value
101		) {
102		continue;
103		}
104
105		$always_enters_loop = false;
106		break;
107		}
108		}
109
110		$can_leave_loop = !$while_true
111		\|\| in_array(ScopeAnalyzer::ACTION_BREAK, $loop_scope->final_actions, true);
112
113	View Code Duplication	if ($always_enters_loop && $can_leave_loop) {
		0 ignored issues – show Duplication introduced 2020-05-19 22:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
114		foreach ($inner_loop_context->vars_in_scope as $var_id => $type) {
115		// if there are break statements in the loop it's not certain
116		// that the loop has finished executing, so the assertions at the end
117		// the loop in the while conditional may not hold
118		if (in_array(ScopeAnalyzer::ACTION_BREAK, $loop_scope->final_actions, true)
119		\|\| in_array(ScopeAnalyzer::ACTION_CONTINUE, $loop_scope->final_actions, true)
120		) {
121		if (isset($loop_scope->possibly_defined_loop_parent_vars[$var_id])) {
122		$context->vars_in_scope[$var_id] = Type::combineUnionTypes(
123		$type,
124		$loop_scope->possibly_defined_loop_parent_vars[$var_id]
125		);
126		}
127		} else {
128		$context->vars_in_scope[$var_id] = $type;
129		}
130		}
131		}
132
133		$while_context->loop_scope = null;
134
135	View Code Duplication	if ($can_leave_loop) {
		0 ignored issues – show Duplication introduced 2020-05-19 22:01 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
136		$context->vars_possibly_in_scope = array_merge(
137		$context->vars_possibly_in_scope,
138		$while_context->vars_possibly_in_scope
139		);
140		} elseif ($pre_context) {
141		$context->vars_possibly_in_scope = $pre_context->vars_possibly_in_scope;
142		}
143
144		$context->referenced_var_ids = array_merge(
145		$context->referenced_var_ids,
146		$while_context->referenced_var_ids
147		);
148
149		if ($codebase->find_unused_variables) {
150		$suppressed_issues = $statements_analyzer->getSuppressedIssues();
151
152		if (!in_array('RedundantCondition', $suppressed_issues, true)) {
153		$statements_analyzer->addSuppressedIssues(['RedundantCondition']);
154		}
155		if (!in_array('RedundantConditionGivenDocblockType', $suppressed_issues, true)) {
156		$statements_analyzer->addSuppressedIssues(['RedundantConditionGivenDocblockType']);
157		}
158		if (!in_array('TypeDoesNotContainType', $suppressed_issues, true)) {
159		$statements_analyzer->addSuppressedIssues(['TypeDoesNotContainType']);
160		}
161
162		$while_context->inside_conditional = true;
163		ExpressionAnalyzer::analyze($statements_analyzer, $stmt->cond, $while_context);
164		$while_context->inside_conditional = false;
165
166		if (!in_array('RedundantCondition', $suppressed_issues, true)) {
167		$statements_analyzer->removeSuppressedIssues(['RedundantCondition']);
168		}
169		if (!in_array('RedundantConditionGivenDocblockType', $suppressed_issues, true)) {
170		$statements_analyzer->removeSuppressedIssues(['RedundantConditionGivenDocblockType']);
171		}
172		if (!in_array('TypeDoesNotContainType', $suppressed_issues, true)) {
173		$statements_analyzer->removeSuppressedIssues(['TypeDoesNotContainType']);
174		}
175
176		$context->unreferenced_vars = $while_context->unreferenced_vars;
177		}
178
179		return null;
180		}
181
182		/**
183		* @return list<PhpParser\Node\Expr>
		0 ignored issues – show Documentation introduced 2020-05-19 22:00 UTC by Report Bug Copy Issue Report The doc-type `list<PhpParser\Node\Expr>` could not be parsed: Expected "\|" or "end of type", but got "<" at position 4. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
184		*/
185		private static function getAndExpressions(
186		PhpParser\Node\Expr $expr
187		) : array {
188		if ($expr instanceof PhpParser\Node\Expr\BinaryOp\BooleanAnd) {
189		return array_merge(
190		self::getAndExpressions($expr->left),
191		self::getAndExpressions($expr->right)
192		);
193		}
194
195		return [$expr];
196		}
197		}
198

vimeo / psalm

WhileAnalyzer::getAndExpressions() A last analyzed 2020-07-20 09:18 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WhileAnalyzer::getAndExpressions() A
last analyzed 2020-07-20 09:18 UTC