UserContext - Code Metrics - Inspection of "created organizations profile page ref #458" - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#462)

by ANTHONIUS

created 2018-02-14 02:01 UTC

UserContext D

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	421
Duplicated Lines	1.19 %

Coupling/Cohesion

Components	1
Dependencies	21

Importance

Changes	3
Bugs	2	Features	0

Metric	Value
wmc	47
lcom	1
cbo	21
dl	5
loc	421
rs	4.3696
c	3
b	2
f	0

26 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	15	2
A	tearDown()	0	22	2
A	beforeScenario()	0	7	1
A	iSignInWithSocialUser()	0	8	2
A	iAmLoggedInAsARecruiter()	0	13	2
A	iDonTHaveUser()	0	8	2
A	iHaveUserWithTheFollowing()	0	23	2
A	iAmLoggedInAsAnAdmin()	0	5	1
A	startLogin()	0	11	3
A	getUserRepository()	0	4	1
A	thereIsAUserIdentifiedBy()	0	14	3
B	createUser()	0	34	2
A	iHaveMainOrganization()	5	21	3
A	getMainOrganization()	0	4	1
A	iWantToLogIn()	0	6	1
A	iSpecifyTheUsernameAs()	0	4	1
A	iSpecifyThePasswordAs()	0	4	1
A	iAmLoggedInAsIdentifiedBy()	0	14	2
A	iLogIn()	0	4	1
A	iPressLogoutLink()	0	5	1
A	iLogInWith()	0	10	1
A	iGoToProfilePage()	0	5	1
B	thereIsAUserWithTheFollowing()	0	15	6
A	addCreatedUser()	0	6	2
A	iWantToChangeMyPassword()	0	5	1
A	getCurrentUser()	0	7	2

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like UserContext often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use UserContext, and based on these observations, apply Extract Interface, too.

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

namespace Yawik\Behat;

use Auth\Entity\User as User;
use Auth\Entity\UserInterface;
use Auth\Repository\User as UserRepository;
use Auth\Service\Register;
use Behat\Behat\Context\Context;
use Behat\Behat\Hook\Scope\BeforeScenarioScope;
use Behat\Gherkin\Node\TableNode;
use Behat\MinkExtension\Context\MinkContext;
use Core\Entity\Permissions;
use Doctrine\Common\Util\Inflector;
use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Event\LifecycleEventArgs;
use Doctrine\ODM\MongoDB\Events;
use Organizations\Entity\Organization;
use Organizations\Entity\OrganizationName;
use Organizations\Repository\Organization as OrganizationRepository;
use Yawik\Behat\Exception\FailedExpectationException;

class UserContext implements Context
{
    use CommonContextTrait;
	
	/**
	 * @var User[]
	 */
	static private $users = [];
	
	/**
	 * @var UserRepository
	 */
	static private $userRepo;
	
	private $socialLoginInfo = [];

    /**
     * @var DocumentManager
     */
	static private $dm;
	
	/**
	 * @var UserInterface
	 */
	private $loggedInUser;

    /**
     * @var Organization
     */
	private $mainOrganization;

    /**
     * @var User
     */
    protected $currentUser;
	
	public function __construct($parameters=[])
	{
		$defaultLoginInfo = [
			'facebook' => [
				'email' => getenv('FACEBOOK_USER_EMAIL'),
				'pass' => getenv('FACEBOOK_USER_PASSWORD')
			],
			'linkedin' => [
				'session_key-login' => getenv('LINKEDIN_USER_EMAIL'),
				'session_password-login' => getenv('LINKEDIN_USER_PASSWORD')
			],
		];
		$socialLoginConfig = isset($parameters['social_login_info']) ? $parameters['social_login_info']:[];
		$this->socialLoginInfo = array_merge($defaultLoginInfo,$socialLoginConfig);
	}

    /**
     * Empty all data every each tests
     *
     * @AfterSuite
     */
	static public function tearDown()

    {
        $dm = static::$dm;
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}

        $documents = [
            'Applications\Entity\Application',
            'Cv\Entity\Cv',
            'Jobs\Entity\Job',
            'Organizations\Entity\Organization',
            'Auth\Entity\User',
            'Jobs\Entity\Category',
            'Auth\Entity\UserImage',
            'Organizations\Entity\OrganizationName',
        ];
        foreach($documents as $document){
            $dm->createQueryBuilder($document)
                ->remove()
                ->getQuery()
                ->execute()
            ;
        }
    }

	/**
	 * @BeforeScenario
	 * @param BeforeScenarioScope $scope
	 */
	public function beforeScenario(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.
    }
}
		static::$userRepo = $this->getUserRepository();
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
		static::$dm = $this->getUserRepository()->getDocumentManager();
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
	}
	
	/**
	 * @When I fill in login form with :provider user
	 */
	public function iSignInWithSocialUser($provider)
	{
		$provider = strtolower($provider);
		$mink = $this->minkContext;
		foreach($this->socialLoginInfo[$provider] as $field=>$value){
			$mink->fillField($field,$value);
		}
	}
	
	/**
	 * @Given I am logged in as a recruiter
	 * @Given I am logged in as a recruiter with :organization as organization
	 */
	public function iAmLoggedInAsARecruiter($organization=null)
	{
		$user = $this->thereIsAUserIdentifiedBy(
			'[email protected]',
			'test',User::ROLE_RECRUITER,
			'Test Recruiter',
			$organization
		);
		$this->startLogin($user,'test');
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		if(!is_null($organization)){
            $this->iHaveMainOrganization($user,$organization);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        }
	}
	
	/**
	 * @Given I don't have :login user
	 * @param string $login
	 */
	public function iDonTHaveUser($login)
	{
		$repo = $this->getUserRepository();
		$user=$repo->findByLogin($login);
		if($user instanceof UserInterface){
			$repo->remove($user,true);
		}
	}
	
	/**
	 * @Given I have a :role with the following:
	 * @param $role
	 * @param TableNode $fields
	 */
	public function iHaveUserWithTheFollowing($role,TableNode $fields)
	{
		$normalizedFields = [
			'login' => '[email protected]',
			'fullname' => 'Test Login',
			'role' => User::ROLE_USER,
			'password' => 'test',
			'organization' => 'Cross Solution'
		];
		foreach($fields->getRowsHash() as $field=>$value){
			$field = Inflector::camelize($field);
			$normalizedFields[$field] = $value;
		}
		
		$this->thereIsAUserIdentifiedBy(
			$normalizedFields['login'],
			$normalizedFields['password'],
			$role,
			$normalizedFields['fullname'],
			$normalizedFields['organization']
		);
		
	}
	
	/**
	 * @Given I am logged in as an administrator
	 */
	public function iAmLoggedInAsAnAdmin()
	{
		$user = $this->thereIsAUserIdentifiedBy('[email protected]','test',User::ROLE_ADMIN);
		$this->startLogin($user,'test');
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
	}
	
	private function startLogin(UserInterface $user, $password)
	{
		$currentUser = $this->currentUser;
		if(!is_object($currentUser) || $user->getId()!=$currentUser->getId()){
			$this->iWantToLogIn();
			$this->iSpecifyTheUsernameAs($user->getLogin());
			$this->iSpecifyThePasswordAs($password);
			$this->iLogIn();
			$this->currentUser = $user;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
		}
	}
	
	/**
	 * @return UserRepository
	 */
	public function getUserRepository()
	{
		return $this->coreContext->getRepositories()->get('Auth\Entity\User');
	}
	
	/**
	 * @Given there is a user :email identified by :password
	 */
	public function thereIsAUserIdentifiedBy($email, $password,$role=User::ROLE_RECRUITER,$fullname="Test Recruiter",$organization=null)
	{
		$repo = $this->getUserRepository();
		if(!is_object($user=$repo->findByEmail($email))){
			$user = $this->createUser($email,$password,$role,$fullname,$organization);

		}
		
		if(!is_null($organization)){
			$this->iHaveMainOrganization($user,$organization);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		}
		$this->addCreatedUser($user);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		$repo->getDocumentManager()->refresh($user);
		return $user;
	}
	
	/**
	 * @param $email
	 * @param $password
	 * @param $username
	 * @param string $fullname
	 * @param string $role
	 *
	 * @return \Auth\Entity\UserInterface

	 */
	public function createUser($email,$password,$role=User::ROLE_RECRUITER,$fullname="Test Recruiter")
	{
		/* @var Register $service */
		/* @var User $user */
		$repo = $this->getUserRepository();
		$user = $repo->create([]);
		$user->setLogin($email);
		$user->setPassword($password);
		$user->setRole($role);
		$settings = $user->getSettings('Applications');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
		
		$expFullName = explode(' ',$fullname);
		$info = $user->getInfo();
		$info->setFirstName(array_shift($expFullName));
		$info->setLastName(count($expFullName)>0 ? implode(' ',$expFullName):'');
		$info->setEmail($email);
		$info->setEmailVerified(true);
		$repo->store($user);
		$repo->getDocumentManager()->refresh($user);
		
		$eventArgs = new LifecycleEventArgs($user, $repo->getDocumentManager());
		$repo->getDocumentManager()->getEventManager()->dispatchEvent(
			Events::postLoad,
			$eventArgs
		);
		/* @var \Core\EventManager\EventManager $events */
		/* @var \Auth\Listener\Events\AuthEvent $event */
		//@TODO: [Behat] event not working in travis
		//$events = $this->coreContext->getEventManager();

		//$event  = $events->getEvent(AuthEvent::EVENT_USER_REGISTERED, $this);

		//$event->setUser($user);

		//$events->triggerEvent($event);

		return $user;
	}
	
	/**
	 * @When I have :organization as my main organization
	 * @param $orgName
	 */
	public function iHaveMainOrganization(UserInterface $user,$orgName)
	{
		/* @var $repoOrganization OrganizationRepository */
		$repoOrganization = $this->coreContext->getRepositories()->get('Organizations/Organization');
		$result = $repoOrganization->findByName($orgName);
		$organization = count($result) > 0 ? $result[0]:null;
		if(!$organization instanceof Organization){

			$organization = new Organization();
			$organizationName = new OrganizationName($orgName);
			$organization->setOrganizationName($organizationName);
		}
        $organization->setProfileSetting(Organization::PROFILE_ALWAYS_ENABLE);
        $permissions = $organization->getPermissions();
        $permissions->grant($user,Permissions::PERMISSION_ALL);

        $organization->setUser($user);
        $repoOrganization->store($organization);
        $repoOrganization->getDocumentManager()->refresh($organization);

        $this->mainOrganization = $organization;
	}

    /**
     * @return Organization
     */
    public function getMainOrganization()
    {
        return $this->mainOrganization;
    }

	
	/**
	 * @When I want to log in
	 */
	public function iWantToLogIn()
	{
		$session = $this->minkContext->getSession();
		$url = $this->buildUrl('lang/auth');
		$session->visit($url);
	}
	
	/**
	 * @When I specify the username as :username
	 */
	public function iSpecifyTheUsernameAs($username)
	{
		$this->minkContext->fillField('Login name',$username);
	}
	
	/**
	 * @When I specify the password as :password
	 */
	public function iSpecifyThePasswordAs($password)
	{
		$this->minkContext->fillField('Password',$password);
	}
	
	/**
	 * @Given I am logged in as :username identified by :password
	 */
	public function iAmLoggedInAsIdentifiedBy($username, $password)
	{
		$repo = $this->getUserRepository();
		$user = $repo->findByLogin($username);
		
		if(!$user instanceof User){
			throw new \Exception(sprintf('There is no user with this login: "%s"',$username));
		}
		$this->iWantToLogIn();
		$this->iSpecifyTheUsernameAs($username);
		$this->iSpecifyThePasswordAs($password);
		$this->iLogIn();
        $this->currentUser = $user;
	}
	
	/**
	 * @When I log in
	 */
	public function iLogIn()
	{
		$this->minkContext->pressButton('login');
	}
	
	/**
	 * @When I press logout link
	 */
	public function iPressLogoutLink()
	{
		$url = $this->buildUrl('auth-logout');
		$this->visit($url);
	}
	
	/**
	 * @Given I log in with username :username and password :password
	 */
	public function iLogInWith($username, $password)
	{
		$repo = $this->getUserRepository();
		$user = $repo->findByLogin($username);
		$this->iWantToLogIn();
		$this->iSpecifyTheUsernameAs($username);
		$this->iSpecifyThePasswordAs($password);
		$this->iLogIn();
		$this->loggedInUser = $user;
	}
	
	/**
	 * @When I go to profile page
	 */
	public function iGoToProfilePage()
	{
		$url = $this->buildUrl('lang/my');
		$this->visit($url);
	}
	
	/**
	 * @Given there is a user with the following:
	 */
	public function thereIsAUserWithTheFollowing(TableNode $table)
	{
		$repo = $this->getUserRepository();
		$data = $table->getRowsHash();
		$email = isset($data['email']) ? $data['email']:'[email protected]';
		$password = isset($data['password']) ? $data['password']:'test';
		$fullname = isset($data['fullname']) ? $data['fullname']:'Test User';
		$role = isset($data['role']) ? $data['role']:User::ROLE_RECRUITER;
		
		if(!is_object($user=$repo->findByLogin($email))){
			$user = $this->createUser($email,$password,$role,$fullname);
		}
		$this->currentUser = $user;

		$this->addCreatedUser($user);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
	}
	
	private function addCreatedUser(UserInterface $user)
	{
		if(!in_array($user,static::$users)){
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
			static::$users[] = $user;
class YourClass
{
    private static $someVariable;

    public static function getSomeVariable()
    {
        return static::$someVariable;
    }
}
		}
	}
	
	/**
	 * @When I want to change my password
	 */
	public function iWantToChangeMyPassword()
	{
		$url = $this->buildUrl('lang/my-password');
		$this->visit($url);
	}

    /**
     * @return User
     * @throws FailedExpectationException
     */
	public function getCurrentUser()
    {
        if(!$this->currentUser instanceof User){
            throw new FailedExpectationException('Need to login first before use this step');
        }
        return $this->currentUser;
    }
}



Pull Request — develop (#462)

UserContext D

Complexity

Size/Duplication

Coupling/Cohesion

Importance

26 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

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			use Auth\Entity\User as User;
13			use Auth\Entity\UserInterface;
14			use Auth\Repository\User as UserRepository;
15			use Auth\Service\Register;
16			use Behat\Behat\Context\Context;
17			use Behat\Behat\Hook\Scope\BeforeScenarioScope;
18			use Behat\Gherkin\Node\TableNode;
19			use Behat\MinkExtension\Context\MinkContext;
20			use Core\Entity\Permissions;
21			use Doctrine\Common\Util\Inflector;
22			use Doctrine\ODM\MongoDB\DocumentManager;
23			use Doctrine\ODM\MongoDB\Event\LifecycleEventArgs;
24			use Doctrine\ODM\MongoDB\Events;
25			use Organizations\Entity\Organization;
26			use Organizations\Entity\OrganizationName;
27			use Organizations\Repository\Organization as OrganizationRepository;
28			use Yawik\Behat\Exception\FailedExpectationException;
29
30			class UserContext implements Context
31			{
32			use CommonContextTrait;
33
34			/**
35			* @var User[]
36			*/
37			static private $users = [];
38
39			/**
40			* @var UserRepository

cross-solution / YAWIK

Pull Request — develop (#462)

UserContext D

Complexity

Size/Duplication

Coupling/Cohesion

Importance

26 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like