Context::warning() - Code Metrics - Inspection of "[Compiler] Initial support for Throw statement" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 124462...3bbcdb )

by Дмитрий

created 2016-07-17 13:00 UTC

Context::warning() A

↳ Parent: Context

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	9
ccs	0
cts	5
cp	0
rs	9.6666
cc	1
eloc	5
nc	1
nop	2
crap	2

<?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 = array();

    /**
     * @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);
    }

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

    /**
     * @param string $name
     * @return Variable
     */
    public function addSymbol($name)
    {
        $variable = new Variable($name);
        $this->symbols[$name] = $variable;

        return $variable;
    }

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

        return true;
    }

    /**
     * Clear prevent context
     */
    public function clear()
    {
        $this->symbols = array();
        $this->scope = null;
        $this->scopePointer = null;
        $this->currentBranch = null;
        $this->aliasManager = null;

        $this->initGlobals();
    }

    public function clearSymbols()
    {
        unset($this->symbols);
        $this->symbols = array();
    }

    /**
     * @param $name
     * @return Variable|null
     */
    public function getSymbol($name)
    {
        return isset($this->symbols[$name]) ? $this->symbols[$name] : null;
    }

    /**
     * @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;
    }

    /**
     * @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)

    {
        $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('');

        $this->application->getIssuesCollector()
            ->addIssue($type, $message, basename($this->filepath), $expr->getLine() - 1);

        return true;
    }

    /**
     * @param \PhpParser\Error $exception
     * @param string $filepath
     * @return bool
     */
    public function sytaxError(\PhpParser\Error $exception, $filepath)
    {
        $code = file($filepath);

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

        $this->application->getIssuesCollector()
            ->addIssue('syntax-error', 'syntax-error', $filepath, $exception->getStartLine() - 2);

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

        return true;
    }

    /**
     * @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;
}
    }

    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;
    }

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

ovr / phpsa

Push — master ( 124462...3bbcdb )

Context::warning() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like