Context::addSymbol() - Code Metrics - Inspection of "Start to work on generic issue reporters" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#235)

by Kévin

created 2016-10-12 06:49 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	4
CRAP Score	1

Importance

Changes

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

<?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 notice message.
     *
     * @param string $type
     * @param string $message
     * @param \PhpParser\NodeAbstract $expr
     * @param int $status
     * @param array $categories
     * @return bool
     */
    public function notice($type, $message, \PhpParser\NodeAbstract $expr, $status = Check::CHECK_SAFE, array $categories = [Issue::CATEGORY_BUG_RISK])

    {
        $issue = new Issue($type, $message, new IssueLocation($this->filepath, $expr->getLine()), $categories);

        return $this->addIssue($issue);
    }

    /**
     * Creates a syntax error message.
     *
     * @param \PhpParser\Error $exception
     * @param string $filepath
     * @return bool
     */
    public function syntaxError(\PhpParser\Error $exception, $filepath)
    {
        $issue = new Issue(
            'syntax-error',
            $exception->getMessage(),
            new IssueLocation($filepath, $exception->getStartLine()),
            [Issue::CATEGORY_BUG_RISK]
        );

        return $this->addIssue($issue);
    }

    /**
     * @param Issue $issue
     * @return bool
     */
    protected function addIssue(Issue $issue)
    {
        if ($this->application->getConfiguration()->getValue('blame')) {
            $line = $issue->getLocation()->getLineStart();

            exec("git blame --show-email -L {$line},{$line} " . $issue->getLocation()->getFilePath(), $result);
            if ($result && isset($result[0])) {
                $issue->setBlame(trim($result[0]));
            }
        }

        $issueCollector = $this->application->getIssuesCollector();
        $issueCollector->addIssue($issue);

        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	868	public function __construct(OutputInterface $output, Application $application, EventManager $eventManager)
72		{
73	868	$this->output = $output;
74	868	$this->application = $application;
75
76	868	$this->initGlobals();
77	868	$this->eventManager = $eventManager;
78	868	}
79
80		/**
81		* @return Expression
82		*/
83	859	public function getExpressionCompiler()
84		{
85	859	return new Expression($this, $this->eventManager);
86		}
87
88		/**
89		* Adds all global variables to the context.
90		*/
91	868	public function initGlobals()
92		{
93		/**
94		* http://php.net/manual/language.variables.superglobals.php
95		*/
96	868	$this->addVariable(new GlobalVariable('GLOBALS', [], CompiledExpression::ARR));
97	868	$this->addVariable(new GlobalVariable('_SERVER', [], CompiledExpression::ARR));
98	868	$this->addVariable(new GlobalVariable('_GET', [], CompiledExpression::ARR));
99	868	$this->addVariable(new GlobalVariable('_POST', [], CompiledExpression::ARR));
100	868	$this->addVariable(new GlobalVariable('_FILES', [], CompiledExpression::ARR));
101	868	$this->addVariable(new GlobalVariable('_COOKIE', [], CompiledExpression::ARR));
102	868	$this->addVariable(new GlobalVariable('_SESSION', [], CompiledExpression::ARR));
103	868	$this->addVariable(new GlobalVariable('_REQUEST', [], CompiledExpression::ARR));
104	868	$this->addVariable(new GlobalVariable('_ENV', [], CompiledExpression::ARR));
105	868	}
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	3	public function addSymbol($name)
114		{
115	3	$variable = new Variable($name);
116	3	$this->symbols[$name] = $variable;
117
118	3	return $variable;
119		}
120
121		/**
122		* Adds a variable to the context.
123		*
124		* @param Variable $variable
125		* @return bool
126		*/
127	868	public function addVariable(Variable $variable)
128		{
129	868	$this->symbols[$variable->getName()] = $variable;
130
131	868	return true;
132		}
133
134		/**
135		* Resets context to beginning stage.
136		*/
137	41	public function clear()
138		{
139	41	$this->symbols = [];
140	41	$this->scope = null;
141	41	$this->scopePointer = null;
142	41	$this->currentBranch = null;
143	41	$this->aliasManager = null;
144
145	41	$this->initGlobals();
146	41	}
147
148		/**
149		* Clears only all symbols.
150		*/
151	39	public function clearSymbols()
152		{
153	39	unset($this->symbols);
154	39	$this->symbols = [];
155	39	}
156
157		/**
158		* Returns a variable if it exists.
159		*
160		* @param $name
161		* @return Variable\|null
162		*/
163	79	public function getSymbol($name)
164		{
165	79	return isset($this->symbols[$name]) ? $this->symbols[$name] : null;
166		}
167
168		/**
169		* Creates a notice message.
170		*
171		* @param string $type
172		* @param string $message
173		* @param \PhpParser\NodeAbstract $expr
174		* @param int $status
175		* @param array $categories
176		* @return bool
177		*/
178	41	public function notice($type, $message, \PhpParser\NodeAbstract $expr, $status = Check::CHECK_SAFE, array $categories = [Issue::CATEGORY_BUG_RISK])
		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...
179		{
180	41	$issue = new Issue($type, $message, new IssueLocation($this->filepath, $expr->getLine()), $categories);
181
182	41	return $this->addIssue($issue);
183		}
184
185		/**
186		* Creates a syntax error message.
187		*
188		* @param \PhpParser\Error $exception
189		* @param string $filepath
190		* @return bool
191		*/
192		public function syntaxError(\PhpParser\Error $exception, $filepath)
193		{
194		$issue = new Issue(
195		'syntax-error',
196		$exception->getMessage(),
197		new IssueLocation($filepath, $exception->getStartLine()),
198		[Issue::CATEGORY_BUG_RISK]
199		);
200
201		return $this->addIssue($issue);
202		}
203
204		/**
205		* @param Issue $issue
206		* @return bool
207		*/
208	41	protected function addIssue(Issue $issue)
209		{
210	41	if ($this->application->getConfiguration()->getValue('blame')) {
211		$line = $issue->getLocation()->getLineStart();
212
213		exec("git blame --show-email -L {$line},{$line} " . $issue->getLocation()->getFilePath(), $result);
214		if ($result && isset($result[0])) {
215		$issue->setBlame(trim($result[0]));
216		}
217		}
218
219	41	$issueCollector = $this->application->getIssuesCollector();
220	41	$issueCollector->addIssue($issue);
221
222	41	return true;
223		}
224
225		/**
226		* Returns an array of all variables.
227		*
228		* @return Variable[]
229		*/
230	39	public function getSymbols()
231		{
232	39	return $this->symbols;
233		}
234
235		/**
236		* @param AbstractDefinition $scope
237		*/
238	868	public function setScope(AbstractDefinition $scope = null)
239		{
240	868	$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...
241	868	}
242
243		/**
244		* Creates a debug message.
245		*/
246	41	public function debug($message, \PhpParser\Node $expr = null)
247		{
248	41	if ($this->output->isDebug()) {
249		$this->output->writeln('[DEBUG] ' . $message);
250		$this->output->write($this->filepath);
251
252		if ($expr) {
253		$this->output->write(':' . $expr->getLine());
254		}
255
256		$this->output->writeln('');
257		}
258	41	}
259
260		/**
261		* @return string
262		*/
263		public function getFilepath()
264		{
265		return $this->filepath;
266		}
267
268		/**
269		* @param string $filepath
270		*/
271	41	public function setFilepath($filepath)
272		{
273	41	$this->filepath = $filepath;
274	41	}
275
276		/**
277		* @return integer
278		*/
279	36	public function getCurrentBranch()
280		{
281	36	return $this->currentBranch;
282		}
283
284		/**
285		* @param int\|string $currentBranch
286		*/
287	9	public function setCurrentBranch($currentBranch)
288		{
289	9	$this->currentBranch = $currentBranch;
290	9	}
291
292		/**
293		* Updates all references on the given variable.
294		*
295		* @param Variable $variable
296		* @param $type
297		* @param $value
298		*/
299	5	public function modifyReferencedVariables(Variable $variable, $type, $value)
300		{
301	5	foreach ($this->symbols as $symbol) {
302	5	$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...
303	5	if ($referencedTo) {
304	2	if ($referencedTo === $variable) {
305	2	$symbol->modify($type, $value);
306	2	}
307	2	}
308	5	}
309	5	}
310
311		/**
312		* @return EventManager
313		*/
314	54	public function getEventManager()
315		{
316	54	return $this->eventManager;
317		}
318		}
319

ovr / phpsa

Pull Request — master (#235)

Context::addSymbol() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like