CommonContextTrait - Code Metrics - Inspection of "Fixes for #452" - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#453)

by ANTHONIUS

created 2018-01-21 07:58 UTC

CommonContextTrait A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
wmc	6
lcom	1
cbo	1
dl	0
loc	81
rs	10
c	1
b	1
f	0

6 Methods

Rating	Name	Size	Complexity
A	gatherContexts()	7	1
A	generateUrl()	13	1
A	visit()	4	1
A	getService()	4	1
A	getRepository()	4	1
A	getUserContext()	4	1

<?php
/**
 * YAWIK
 *
 * @filesource
 * @license MIT
 * @copyright  2013 - 2017 Cross Solution <http://cross-solution.de>
 */

namespace Yawik\Behat;


use Auth\Entity\User;
use Behat\Behat\Hook\Scope\BeforeScenarioScope;
use Behat\MinkExtension\Context\MinkContext;
use Core\Repository\RepositoryInterface;
use Zend\View\Helper\Url;

trait CommonContextTrait
{
	/**
	 * @var MinkContext
	 */
	protected $minkContext;
	
	/**
	 * @var CoreContext
	 */
	protected $coreContext;
	
	/**
	 * @var UserContext
	 */
	protected $userContext;
	
	/**
	 * @var SummaryFormContext
	 */
	protected $summaryFormContext;
	
	/**
	 * @BeforeScenario
	 *
	 * @param BeforeScenarioScope $scope
	 */
	public function gatherContexts(BeforeScenarioScope $scope)
	{
		$this->minkContext = $scope->getEnvironment()->getContext(MinkContext::class);
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.
    }
}
		$this->coreContext = $scope->getEnvironment()->getContext(CoreContext::class);
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.
    }
}
		$this->userContext = $scope->getEnvironment()->getContext(UserContext::class);
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.
    }
}
		$this->summaryFormContext = $scope->getEnvironment()->getContext(SummaryFormContext::class);
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.
    }
}
	}
	
	public function generateUrl($name,array $params=array(),array $options=array())
	{
	    $defaults = ['lang'=>'en'];
	    $params = array_merge($defaults,$params);
        /* @var Url $urlHelper */
        $urlHelper = $this
            ->getService('ViewHelperManager')
            ->get('url')
        ;
        $url = $urlHelper($name,$params,$options);

        return $this->coreContext->generateUrl($url);
	}
	
	public function visit($url)
	{
		$this->coreContext->iVisit($url);
	}
	
	/**
	 * @param $id
	 * @return mixed|object
	 */
	public function getService($id)
	{
		return $this->coreContext->getServiceManager()->get($id);
	}
	
	/**
	 * @param $id
	 *
	 * @return RepositoryInterface
	 */
	public function getRepository($id)
	{
		return $this->coreContext->getRepositories()->get($id);
	}

    /**
     * @return UserContext
     */
	public function getUserContext()
    {
        return $this->userContext;
    }
}


1			<?php
2			/**
3			* YAWIK
4			*
5			* @filesource
6			* @license MIT
7			* @copyright 2013 - 2017 Cross Solution <http://cross-solution.de>
8			*/
9
10			namespace Yawik\Behat;
11
12
13			use Auth\Entity\User;
14			use Behat\Behat\Hook\Scope\BeforeScenarioScope;
15			use Behat\MinkExtension\Context\MinkContext;
16			use Core\Repository\RepositoryInterface;
17			use Zend\View\Helper\Url;
18
19			trait CommonContextTrait
20			{
21			/**
22			* @var MinkContext
23			*/
24			protected $minkContext;
25
26			/**
27			* @var CoreContext
28			*/
29			protected $coreContext;
30
31			/**
32			* @var UserContext
33			*/
34			protected $userContext;
35
36			/**
37			* @var SummaryFormContext
38			*/
39			protected $summaryFormContext;
40
41			/**
42			* @BeforeScenario
43			*
44			* @param BeforeScenarioScope $scope
45			*/
46			public function gatherContexts(BeforeScenarioScope $scope)
47			{
48			$this->minkContext = $scope->getEnvironment()->getContext(MinkContext::class);
			0 ignored issues – show Bug introduced 2017-09-27 14:55 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Testwork\Environment\Environment` as the method `getContext()` does only exist in the following implementations of said interface: `Behat\Behat\Context\Envi...lizedContextEnvironment`, `FriendsOfBehat\ContextSe...ntextServiceEnvironment`. 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...
49			$this->coreContext = $scope->getEnvironment()->getContext(CoreContext::class);
			0 ignored issues – show Bug introduced 2017-09-27 14:55 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Testwork\Environment\Environment` as the method `getContext()` does only exist in the following implementations of said interface: `Behat\Behat\Context\Envi...lizedContextEnvironment`, `FriendsOfBehat\ContextSe...ntextServiceEnvironment`. 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...
50			$this->userContext = $scope->getEnvironment()->getContext(UserContext::class);
			0 ignored issues – show Bug introduced 2017-09-27 14:55 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Testwork\Environment\Environment` as the method `getContext()` does only exist in the following implementations of said interface: `Behat\Behat\Context\Envi...lizedContextEnvironment`, `FriendsOfBehat\ContextSe...ntextServiceEnvironment`. 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...
51			$this->summaryFormContext = $scope->getEnvironment()->getContext(SummaryFormContext::class);
			0 ignored issues – show Bug introduced 2017-09-27 14:55 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Testwork\Environment\Environment` as the method `getContext()` does only exist in the following implementations of said interface: `Behat\Behat\Context\Envi...lizedContextEnvironment`, `FriendsOfBehat\ContextSe...ntextServiceEnvironment`. 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...
52			}
53
54			public function generateUrl($name,array $params=array(),array $options=array())
55			{
56			$defaults = ['lang'=>'en'];
57			$params = array_merge($defaults,$params);
58			/* @var Url $urlHelper */
59			$urlHelper = $this
60			->getService('ViewHelperManager')
61			->get('url')
62			;
63			$url = $urlHelper($name,$params,$options);
64
65			return $this->coreContext->generateUrl($url);
66			}
67
68			public function visit($url)
69			{
70			$this->coreContext->iVisit($url);
71			}
72
73			/**
74			* @param $id
75			* @return mixed\|object
76			*/
77			public function getService($id)
78			{
79			return $this->coreContext->getServiceManager()->get($id);
80			}
81
82			/**
83			* @param $id
84			*
85			* @return RepositoryInterface
86			*/
87			public function getRepository($id)
88			{
89			return $this->coreContext->getRepositories()->get($id);
90			}
91
92			/**
93			* @return UserContext
94			*/
95			public function getUserContext()
96			{
97			return $this->userContext;
98			}
99			}
100

cross-solution / YAWIK

Pull Request — develop (#453)

CommonContextTrait A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

6 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like