Context::addSymbol() - Code Metrics - Inspection of "Make compiler notices configurable" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#277)

by Enrico

created 2016-11-24 17:34 UTC

Context::addSymbol() A

↳ Parent: Context

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	1
dl	0
loc	7
ccs	0
cts	4
cp	0
crap	2
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * @author Patsura Dmitry https://github.com/ovr <[email protected]>
 */

namespace PHPSA;

use PHPSA\Compiler\Expression;
use PHPSA\Compiler\GlobalVariable;
use PHPSA\Definition\AbstractDefinition;
use PHPSA\Definition\ParentDefinition;
use Symfony\Component\Console\Output\OutputInterface;
use Webiny\Component\EventManager\EventManager;

class Context
{
    /**
     * For FunctionDefinition it's null, use scopePointer
     *
     * @var ParentDefinition|null
     */
    public $scope;

    /**
     * @var AliasManager
     */
    public $aliasManager;

    /**
     * @var Application
     */
    public $application;

    /**
     * @var string|integer
     */
    public $currentBranch;

    /**
     * @var OutputInterface
     */
    public $output;

    /**
     * @var Variable[]
     */
    protected $symbols = [];

    /**
     * @var ScopePointer|null
     */
    public $scopePointer;

    /**
     * @var string
     */
    protected $filepath;

    /**
     * @var EventManager
     */
    protected $eventManager;

    /**
     * Construct our Context with all needed information
     *
     * @param OutputInterface $output
     * @param Application $application
     * @param EventManager $eventManager
     */
    public function __construct(OutputInterface $output, Application $application, EventManager $eventManager)
    {
        $this->output = $output;
        $this->application = $application;

        $this->initGlobals();
        $this->eventManager = $eventManager;
    }

    /**
     * @return Expression
     */
    public function getExpressionCompiler()
    {
        return new Expression($this, $this->eventManager);
    }

    /**
     * Adds all global variables to the context.
     */
    public function initGlobals()
    {
        /**
         * http://php.net/manual/language.variables.superglobals.php
         */
        $this->addVariable(new GlobalVariable('GLOBALS', [], CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_SERVER', [], CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_GET', [], CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_POST', [], CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_FILES', [], CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_COOKIE', [], CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_SESSION', [], CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_REQUEST', [], CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_ENV', [], CompiledExpression::ARR));
    }

    /**
     * Creates a variable from a symbol and adds it to the context.
     *
     * @param string $name
     * @return Variable
     */
    public function addSymbol($name)
    {
        $variable = new Variable($name);
        $this->symbols[$name] = $variable;

        return $variable;
    }

    /**
     * Adds a variable to the context.
     *
     * @param Variable $variable
     * @return bool
     */
    public function addVariable(Variable $variable)
    {
        $this->symbols[$variable->getName()] = $variable;

        return true;
    }

    /**
     * Resets context to beginning stage.
     */
    public function clear()
    {
        $this->symbols = [];
        $this->scope = null;
        $this->scopePointer = null;
        $this->currentBranch = null;
        $this->aliasManager = null;

        $this->initGlobals();
    }

    /**
     * Clears only all symbols.
     */
    public function clearSymbols()
    {
        unset($this->symbols);
        $this->symbols = [];
    }

    /**
     * Returns a variable if it exists.
     *
     * @param $name
     * @return Variable|null
     */
    public function getSymbol($name)
    {
        return isset($this->symbols[$name]) ? $this->symbols[$name] : null;
    }

    /**
     * Creates a warning message.
     *
     * @param string $type
     * @param string $message
     * @return bool
     */
    public function warning($type, $message)
    {
        $this->output
            ->writeln('<comment>Warning:  ' . $message . ' in ' . $this->filepath . '  [' . $type . ']</comment>');

        $this->output->writeln('');

        return true;
    }

    /**
     * Creates a notice message.
     *
     * @param string $type
     * @param string $message
     * @param \PhpParser\NodeAbstract $expr
     * @param int $status
     * @return bool
     */
    public function notice($type, $message, \PhpParser\NodeAbstract $expr, $status = Check::CHECK_SAFE)

    {
        $analyzerConfig = $this->application->getConfiguration()->getValue('analyzers');

        if ($type == "language_error" && !$analyzerConfig['language_error']['enabled']) {
            return true;
        }

        $filepath = $this->filepath;
        $code = file($filepath);

        $this->output->writeln('<comment>Notice:  ' . $message . " in {$filepath} on {$expr->getLine()} [{$type}]</comment>");
        $this->output->writeln('');

        if ($this->application->getConfiguration()->valueIsTrue('blame')) {
            exec("git blame --show-email -L {$expr->getLine()},{$expr->getLine()} " . $filepath, $result);
            if ($result && isset($result[0])) {
                $result[0] = trim($result[0]);

                $this->output->writeln("<comment>\t {$result[0]}</comment>");
            }
        } else {
            $code = trim($code[$expr->getLine() - 1]);
            $this->output->writeln("<comment>\t {$code} </comment>");
        }

        $this->output->writeln('');

        $issueCollector = $this->application->getIssuesCollector();
        $issueCollector->addIssue(
            new Issue(
                $type,
                $message,
                new IssueLocation(
                    $this->filepath,
                    $expr->getLine() - 1
                )
            )
        );

        return true;
    }

    /**
     * Creates a syntax error message.
     *
     * @param \PhpParser\Error $exception
     * @param string $filepath
     * @return bool
     */
    public function syntaxError(\PhpParser\Error $exception, $filepath)
    {
        $code = file($filepath);

        $this->output->writeln('<error>Syntax error:  ' . $exception->getMessage() . " in {$filepath} </error>");
        $this->output->writeln('');

        $issueCollector = $this->application->getIssuesCollector();
        $issueCollector->addIssue(
            new Issue(
                'syntax-error',
                'syntax-error',
                new IssueLocation(
                    $filepath,
                    $exception->getStartLine() - 2
                )
            )
        );

        $code = trim($code[$exception->getStartLine()-2]);
        $this->output->writeln("<comment>\t {$code} </comment>");

        return true;
    }

    /**
     * Returns an array of all variables.
     *
     * @return Variable[]
     */
    public function getSymbols()
    {
        return $this->symbols;
    }

    /**
     * @param AbstractDefinition $scope
     */
    public function setScope(AbstractDefinition $scope = null)
    {
        $this->scope = $scope;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    /**
     * Creates a debug message.
     */
    public function debug($message, \PhpParser\Node $expr = null)
    {
        if ($this->output->isDebug()) {
            $this->output->writeln('[DEBUG] ' . $message);
            $this->output->write($this->filepath);

            if ($expr) {
                $this->output->write(':' . $expr->getLine());
            }

            $this->output->writeln('');
        }
    }

    /**
     * @return string
     */
    public function getFilepath()
    {
        return $this->filepath;
    }

    /**
     * @param string $filepath
     */
    public function setFilepath($filepath)
    {
        $this->filepath = $filepath;
    }

    /**
     * @return integer
     */
    public function getCurrentBranch()
    {
        return $this->currentBranch;
    }

    /**
     * @param int|string $currentBranch
     */
    public function setCurrentBranch($currentBranch)
    {
        $this->currentBranch = $currentBranch;
    }

    /**
     * Updates all references on the given variable.
     *
     * @param Variable $variable
     * @param $type
     * @param $value
     */
    public function modifyReferencedVariables(Variable $variable, $type, $value)
    {
        foreach ($this->symbols as $symbol) {
            $referencedTo = $symbol->getReferencedTo();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            if ($referencedTo) {
                if ($referencedTo === $variable) {
                    $symbol->modify($type, $value);
                }
            }
        }
    }

    /**
     * @return EventManager
     */
    public function getEventManager()
    {
        return $this->eventManager;
    }
}


1		<?php
2		/**
3		* @author Patsura Dmitry https://github.com/ovr <[email protected]>
4		*/
5
6		namespace PHPSA;
7
8		use PHPSA\Compiler\Expression;
9		use PHPSA\Compiler\GlobalVariable;
10		use PHPSA\Definition\AbstractDefinition;
11		use PHPSA\Definition\ParentDefinition;
12		use Symfony\Component\Console\Output\OutputInterface;
13		use Webiny\Component\EventManager\EventManager;
14
15		class Context
16		{
17		/**
18		* For FunctionDefinition it's null, use scopePointer
19		*
20		* @var ParentDefinition\|null
21		*/
22		public $scope;
23
24		/**
25		* @var AliasManager
26		*/
27		public $aliasManager;
28
29		/**
30		* @var Application
31		*/
32		public $application;
33
34		/**
35		* @var string\|integer
36		*/
37		public $currentBranch;
38
39		/**
40		* @var OutputInterface
41		*/
42		public $output;
43
44		/**
45		* @var Variable[]
46		*/
47		protected $symbols = [];
48
49		/**
50		* @var ScopePointer\|null
51		*/
52		public $scopePointer;
53
54		/**
55		* @var string
56		*/
57		protected $filepath;
58
59		/**
60		* @var EventManager
61		*/
62		protected $eventManager;
63
64		/**
65		* Construct our Context with all needed information
66		*
67		* @param OutputInterface $output
68		* @param Application $application
69		* @param EventManager $eventManager
70		*/
71	882	public function __construct(OutputInterface $output, Application $application, EventManager $eventManager)
72		{
73	882	$this->output = $output;
74	882	$this->application = $application;
75
76	882	$this->initGlobals();
77	882	$this->eventManager = $eventManager;
78	882	}
79
80		/**
81		* @return Expression
82		*/
83	881	public function getExpressionCompiler()
84		{
85	881	return new Expression($this, $this->eventManager);
86		}
87
88		/**
89		* Adds all global variables to the context.
90		*/
91	882	public function initGlobals()
92		{
93		/**
94		* http://php.net/manual/language.variables.superglobals.php
95		*/
96	882	$this->addVariable(new GlobalVariable('GLOBALS', [], CompiledExpression::ARR));
97	882	$this->addVariable(new GlobalVariable('_SERVER', [], CompiledExpression::ARR));
98	882	$this->addVariable(new GlobalVariable('_GET', [], CompiledExpression::ARR));
99	882	$this->addVariable(new GlobalVariable('_POST', [], CompiledExpression::ARR));
100	882	$this->addVariable(new GlobalVariable('_FILES', [], CompiledExpression::ARR));
101	882	$this->addVariable(new GlobalVariable('_COOKIE', [], CompiledExpression::ARR));
102	882	$this->addVariable(new GlobalVariable('_SESSION', [], CompiledExpression::ARR));
103	882	$this->addVariable(new GlobalVariable('_REQUEST', [], CompiledExpression::ARR));
104	882	$this->addVariable(new GlobalVariable('_ENV', [], CompiledExpression::ARR));
105	882	}
106
107		/**
108		* Creates a variable from a symbol and adds it to the context.
109		*
110		* @param string $name
111		* @return Variable
112		*/
113		public function addSymbol($name)
114		{
115		$variable = new Variable($name);
116		$this->symbols[$name] = $variable;
117
118		return $variable;
119		}
120
121		/**
122		* Adds a variable to the context.
123		*
124		* @param Variable $variable
125		* @return bool
126		*/
127	882	public function addVariable(Variable $variable)
128		{
129	882	$this->symbols[$variable->getName()] = $variable;
130
131	882	return true;
132		}
133
134		/**
135		* Resets context to beginning stage.
136		*/
137	48	public function clear()
138		{
139	48	$this->symbols = [];
140	48	$this->scope = null;
141	48	$this->scopePointer = null;
142	48	$this->currentBranch = null;
143	48	$this->aliasManager = null;
144
145	48	$this->initGlobals();
146	48	}
147
148		/**
149		* Clears only all symbols.
150		*/
151	45	public function clearSymbols()
152		{
153	45	unset($this->symbols);
154	45	$this->symbols = [];
155	45	}
156
157		/**
158		* Returns a variable if it exists.
159		*
160		* @param $name
161		* @return Variable\|null
162		*/
163	88	public function getSymbol($name)
164		{
165	88	return isset($this->symbols[$name]) ? $this->symbols[$name] : null;
166		}
167
168		/**
169		* Creates a warning message.
170		*
171		* @param string $type
172		* @param string $message
173		* @return bool
174		*/
175	13	public function warning($type, $message)
176		{
177	13	$this->output
178	13	->writeln('<comment>Warning: ' . $message . ' in ' . $this->filepath . ' [' . $type . ']</comment>');
179
180	13	$this->output->writeln('');
181
182	13	return true;
183		}
184
185		/**
186		* Creates a notice message.
187		*
188		* @param string $type
189		* @param string $message
190		* @param \PhpParser\NodeAbstract $expr
191		* @param int $status
192		* @return bool
193		*/
194	48	public function notice($type, $message, \PhpParser\NodeAbstract $expr, $status = Check::CHECK_SAFE)
		0 ignored issues – show Unused Code introduced 2016-01-16 20:22 UTC by Report Bug Copy Issue Report The parameter `$status` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
195		{
196	48	$analyzerConfig = $this->application->getConfiguration()->getValue('analyzers');
197
198	48	if ($type == "language_error" && !$analyzerConfig['language_error']['enabled']) {
199		return true;
200		}
201
202	48	$filepath = $this->filepath;
203	48	$code = file($filepath);
204
205	48	$this->output->writeln('<comment>Notice: ' . $message . " in {$filepath} on {$expr->getLine()} [{$type}]</comment>");
206	48	$this->output->writeln('');
207
208	48	if ($this->application->getConfiguration()->valueIsTrue('blame')) {
209		exec("git blame --show-email -L {$expr->getLine()},{$expr->getLine()} " . $filepath, $result);
210		if ($result && isset($result[0])) {
211		$result[0] = trim($result[0]);
212
213		$this->output->writeln("<comment>\t {$result[0]}</comment>");
214		}
215		} else {
216	48	$code = trim($code[$expr->getLine() - 1]);
217	48	$this->output->writeln("<comment>\t {$code} </comment>");
218		}
219
220	48	$this->output->writeln('');
221
222	48	$issueCollector = $this->application->getIssuesCollector();
223	48	$issueCollector->addIssue(
224	48	new Issue(
225	48	$type,
226	48	$message,
227	48	new IssueLocation(
228	48	$this->filepath,
229	48	$expr->getLine() - 1
230	48	)
231	48	)
232	48	);
233
234	48	return true;
235		}
236
237		/**
238		* Creates a syntax error message.
239		*
240		* @param \PhpParser\Error $exception
241		* @param string $filepath
242		* @return bool
243		*/
244		public function syntaxError(\PhpParser\Error $exception, $filepath)
245		{
246		$code = file($filepath);
247
248		$this->output->writeln('<error>Syntax error: ' . $exception->getMessage() . " in {$filepath} </error>");
249		$this->output->writeln('');
250
251		$issueCollector = $this->application->getIssuesCollector();
252		$issueCollector->addIssue(
253		new Issue(
254		'syntax-error',
255		'syntax-error',
256		new IssueLocation(
257		$filepath,
258		$exception->getStartLine() - 2
259		)
260		)
261		);
262
263		$code = trim($code[$exception->getStartLine()-2]);
264		$this->output->writeln("<comment>\t {$code} </comment>");
265
266		return true;
267		}
268
269		/**
270		* Returns an array of all variables.
271		*
272		* @return Variable[]
273		*/
274	45	public function getSymbols()
275		{
276	45	return $this->symbols;
277		}
278
279		/**
280		* @param AbstractDefinition $scope
281		*/
282	882	public function setScope(AbstractDefinition $scope = null)
283		{
284	882	$this->scope = $scope;
		0 ignored issues – show Documentation Bug introduced 2015-11-22 15:25 UTC by Report Bug Copy Issue Report It seems like `$scope` can also be of type `object<PHPSA\Definition\AbstractDefinition>`. However, the property `$scope` is declared as type `object<PHPSA\Definition\ParentDefinition>\|null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
285	882	}
286
287		/**
288		* Creates a debug message.
289		*/
290	50	public function debug($message, \PhpParser\Node $expr = null)
291		{
292	50	if ($this->output->isDebug()) {
293		$this->output->writeln('[DEBUG] ' . $message);
294		$this->output->write($this->filepath);
295
296		if ($expr) {
297		$this->output->write(':' . $expr->getLine());
298		}
299
300		$this->output->writeln('');
301		}
302	50	}
303
304		/**
305		* @return string
306		*/
307		public function getFilepath()
308		{
309		return $this->filepath;
310		}
311
312		/**
313		* @param string $filepath
314		*/
315	48	public function setFilepath($filepath)
316		{
317	48	$this->filepath = $filepath;
318	48	}
319
320		/**
321		* @return integer
322		*/
323	41	public function getCurrentBranch()
324		{
325	41	return $this->currentBranch;
326		}
327
328		/**
329		* @param int\|string $currentBranch
330		*/
331	10	public function setCurrentBranch($currentBranch)
332		{
333	10	$this->currentBranch = $currentBranch;
334	10	}
335
336		/**
337		* Updates all references on the given variable.
338		*
339		* @param Variable $variable
340		* @param $type
341		* @param $value
342		*/
343	6	public function modifyReferencedVariables(Variable $variable, $type, $value)
344		{
345	6	foreach ($this->symbols as $symbol) {
346	6	$referencedTo = $symbol->getReferencedTo();
		0 ignored issues – show Bug introduced 2016-05-17 11:01 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$referencedTo` is correct as `$symbol->getReferencedTo()` (which targets `PHPSA\Variable::getReferencedTo()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
347	6	if ($referencedTo) {
348	2	if ($referencedTo === $variable) {
349	2	$symbol->modify($type, $value);
350	2	}
351	2	}
352	6	}
353	6	}
354
355		/**
356		* @return EventManager
357		*/
358	61	public function getEventManager()
359		{
360	61	return $this->eventManager;
361		}
362		}
363

ovr / phpsa

Pull Request — master (#277)

Context::addSymbol() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like