ContextResolver::__construct() - Code Metrics - mkusher/padawan.php - Measure and Improve Code Quality continuously with Scrutinizer

ContextResolver::__construct() A
last analyzed 2016-12-29 09:07 UTC

↳ Parent: ContextResolver

Complexity

Conditions	1
Paths	1

Size

Total Lines	11
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	9
nc	1
nop	4

<?php

namespace Padawan\Framework\Complete\Resolver;

use Padawan\Domain\Completion\Token;
use Padawan\Domain\Completion\Context;
use Padawan\Domain\Scope;
use Padawan\Domain\Scope\FileScope;
use Padawan\Domain\Project\FQN;
use Padawan\Domain\Project\Index;
use Padawan\Domain\Project\FQCN;
use Padawan\Parser\ErrorFreePhpParser;
use Padawan\Parser\UseParser;
use Psr\Log\LoggerInterface;
use PhpParser\Node\Expr\Variable;
use PhpParser\Node\Name;

class ContextResolver
{
    public function __construct(
        ErrorFreePhpParser $parser,
        NodeTypeResolver $typeResolver,
        LoggerInterface $logger,
        UseParser $useParser
    ) {
        $this->parser = $parser;
        $this->typeResolver = $typeResolver;
        $this->logger = $logger;
        $this->useParser = $useParser;
    }
    public function getContext($badLine, Index $index, Scope $scope = null)
    {
        if (empty($scope)) {
            $scope = new FileScope(new FQN);
        }

        $token = $this->getLastToken($badLine);
        $this->logger->debug(sprintf(
            'Found token \'%s\' with type %s',
            $token->getSymbol(),
            $token->getType()
        ));
        return $this->createContext($scope, $token, $badLine, $index);
    }

    /**
     * @return Token
     */
    protected function getLastToken($badLine)
    {
        try {
            $symbols = @token_get_all($this->prepareLine($badLine, false));
        } catch (\Exception $e) {
            $symbols = [0, 0];
        }
        $token = null;
        array_shift($symbols);
        do {
            $token = $this->addSymbolForToken(array_pop($symbols), $token);
        } while (!$token->isReady() && count($symbols));
        return $token;
    }

    protected function createContext(Scope $scope, Token $token, $badLine, Index $index)
    {
        $context = new Context($scope, $token);
        $nodes = $this->parser->parse($this->prepareLine($badLine));

        if ($token->isObjectOperator() || $token->isStaticOperator() || $token->isMethodCall()) {
            if (is_array($nodes)) {
                $workingNode = array_pop($nodes);
            } else {
                $workingNode = $nodes;
            }
            $isThis = false;
            if ($workingNode instanceof Variable && $workingNode->name === 'this') {
                $isThis = true;
            }
            if ($workingNode instanceof Name) {
                $nodeFQCN = $this->useParser->getFQCN($workingNode);
                if ($scope->getFQCN() instanceof FQCN
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                    && $nodeFQCN->toString() === $scope->getFQCN()->toString()
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
                ) {
                    $isThis = true;
                }
            }
            $types = $this->typeResolver->getChainType($workingNode, $index, $scope);
            $context->setData([
                array_pop($types),
                $isThis,
                $types,
                $workingNode
            ]);
        }
        if ($token->isUseOperator()
            || $token->isNamespaceOperator()
            || $token->isNewOperator()
        ) {
            $context->setData(trim($token->getSymbol()));
        }

        return $context;
    }

    protected function addSymbolForToken($symbol, Token $token = null)
    {
        if (is_array($symbol)) {
            $code = $symbol[0];
            $symbol = $symbol[1];
        } else {
            $code = $symbol;
        }
        if (empty($token)) {
            $token = new Token($code, $symbol);
        } else {
            $token->add($code, $symbol);
        }
        return $token;
    }

    protected function prepareLine($badLine, $wrapFunctionCall = true)
    {
        if (strpos($badLine, '<?php') === false
            || strpos($badLine, '<?') === false
        ) {
            $badLine = '<?php ' . $badLine;
        }
        $badLine = str_replace(['elseif', 'else', 'catch'], '', $badLine);
        if ($wrapFunctionCall && $badLine[strlen($badLine) - 1] === '(') {
            $badLine .= ')';
        }
        return $badLine;
    }

    private $logger;
    private $parser;
    private $typeResolver;
    private $useParser;
}


1			<?php
2
3			namespace Padawan\Framework\Complete\Resolver;
4
5			use Padawan\Domain\Completion\Token;
6			use Padawan\Domain\Completion\Context;
7			use Padawan\Domain\Scope;
8			use Padawan\Domain\Scope\FileScope;
9			use Padawan\Domain\Project\FQN;
10			use Padawan\Domain\Project\Index;
11			use Padawan\Domain\Project\FQCN;
12			use Padawan\Parser\ErrorFreePhpParser;
13			use Padawan\Parser\UseParser;
14			use Psr\Log\LoggerInterface;
15			use PhpParser\Node\Expr\Variable;
16			use PhpParser\Node\Name;
17
18			class ContextResolver
19			{
20			public function __construct(
21			ErrorFreePhpParser $parser,
22			NodeTypeResolver $typeResolver,
23			LoggerInterface $logger,
24			UseParser $useParser
25			) {
26			$this->parser = $parser;
27			$this->typeResolver = $typeResolver;
28			$this->logger = $logger;
29			$this->useParser = $useParser;
30			}
31			public function getContext($badLine, Index $index, Scope $scope = null)
32			{
33			if (empty($scope)) {
34			$scope = new FileScope(new FQN);
35			}
36
37			$token = $this->getLastToken($badLine);
38			$this->logger->debug(sprintf(
39			'Found token \'%s\' with type %s',
40			$token->getSymbol(),
41			$token->getType()
42			));
43			return $this->createContext($scope, $token, $badLine, $index);
44			}
45
46			/**
47			* @return Token
48			*/
49			protected function getLastToken($badLine)
50			{
51			try {
52			$symbols = @token_get_all($this->prepareLine($badLine, false));
53			} catch (\Exception $e) {
54			$symbols = [0, 0];
55			}
56			$token = null;
57			array_shift($symbols);
58			do {
59			$token = $this->addSymbolForToken(array_pop($symbols), $token);
60			} while (!$token->isReady() && count($symbols));
61			return $token;
62			}
63
64			protected function createContext(Scope $scope, Token $token, $badLine, Index $index)
65			{
66			$context = new Context($scope, $token);
67			$nodes = $this->parser->parse($this->prepareLine($badLine));
68
69			if ($token->isObjectOperator() \|\| $token->isStaticOperator() \|\| $token->isMethodCall()) {
70			if (is_array($nodes)) {
71			$workingNode = array_pop($nodes);
72			} else {
73			$workingNode = $nodes;
74			}
75			$isThis = false;
76			if ($workingNode instanceof Variable && $workingNode->name === 'this') {
77			$isThis = true;
78			}
79			if ($workingNode instanceof Name) {
80			$nodeFQCN = $this->useParser->getFQCN($workingNode);
81			if ($scope->getFQCN() instanceof FQCN
			0 ignored issues – show Bug introduced 2016-05-08 10:22 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Padawan\Domain\Scope` as the method `getFQCN()` does only exist in the following implementations of said interface: `Padawan\Domain\Scope\ClassScope`, `Padawan\Domain\Scope\MethodScope`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
82			&& $nodeFQCN->toString() === $scope->getFQCN()->toString()
			0 ignored issues – show Bug introduced 2016-05-08 10:22 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Padawan\Domain\Scope` as the method `getFQCN()` does only exist in the following implementations of said interface: `Padawan\Domain\Scope\ClassScope`, `Padawan\Domain\Scope\MethodScope`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
83			) {
84			$isThis = true;
85			}
86			}
87			$types = $this->typeResolver->getChainType($workingNode, $index, $scope);
88			$context->setData([
89			array_pop($types),
90			$isThis,
91			$types,
92			$workingNode
93			]);
94			}
95			if ($token->isUseOperator()
96			\|\| $token->isNamespaceOperator()
97			\|\| $token->isNewOperator()
98			) {
99			$context->setData(trim($token->getSymbol()));
100			}
101
102			return $context;
103			}
104
105			protected function addSymbolForToken($symbol, Token $token = null)
106			{
107			if (is_array($symbol)) {
108			$code = $symbol[0];
109			$symbol = $symbol[1];
110			} else {
111			$code = $symbol;
112			}
113			if (empty($token)) {
114			$token = new Token($code, $symbol);
115			} else {
116			$token->add($code, $symbol);
117			}
118			return $token;
119			}
120
121			protected function prepareLine($badLine, $wrapFunctionCall = true)
122			{
123			if (strpos($badLine, '<?php') === false
124			\|\| strpos($badLine, '<?') === false
125			) {
126			$badLine = '<?php ' . $badLine;
127			}
128			$badLine = str_replace(['elseif', 'else', 'catch'], '', $badLine);
129			if ($wrapFunctionCall && $badLine[strlen($badLine) - 1] === '(') {
130			$badLine .= ')';
131			}
132			return $badLine;
133			}
134
135			private $logger;
136			private $parser;
137			private $typeResolver;
138			private $useParser;
139			}
140

mkusher / padawan.php

ContextResolver::__construct() A last analyzed 2016-12-29 09:07 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like

ContextResolver::__construct() A
last analyzed 2016-12-29 09:07 UTC