OrganizationContext::findOrganizationByName() - 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

OrganizationContext::findOrganizationByName() A

↳ Parent: OrganizationContext

Complexity

Conditions	4
Paths	4

Size

Total Lines	13
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.2
c	0
b	0
f	0
cc	4
eloc	8
nc	4
nop	2

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

namespace Yawik\Behat;

use Behat\Behat\Context\Context;
use Behat\Behat\Hook\Scope\BeforeScenarioScope;
use Behat\Gherkin\Node\TableNode;
use Core\Entity\Permissions;
use Doctrine\Common\Util\Inflector;
use Organizations\Entity\Organization;
use Organizations\Entity\OrganizationName;
use Organizations\Entity\OrganizationReference;
use Yawik\Behat\Exception\FailedExpectationException;
use Organizations\Repository\Organization as OrganizationRepository;
use Jobs\Repository\Job as JobRepository;

/**
 * Class OrganizationContext
 *
 * @author  Anthonius Munthi <[email protected]>
 * @since   0.29
 * @package Yawik\Behat
 */
class OrganizationContext implements Context
{
	use CommonContextTrait;

    /**
     * @var JobContext
     */
	private $jobContext;

    /**
     * @BeforeScenario
     *
     * @param BeforeScenarioScope $scope
     */
    public function setupContext(BeforeScenarioScope $scope)
    {
        $this->jobContext = $scope->getEnvironment()->getContext(JobContext::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.
    }
}
    }

	/**
	 * @Given I go to my organization page
	 */
	public function iGoToMyOrganizationPage()
	{
        $url = $this->buildUrl('lang/my-organization');
		$this->visit($url);
	}
	
	/**
	 * @When I hover over name form
	 */
	public function iMouseOverOrganizationNameForm()
	{
		$locator = '#sf-nameForm .sf-summary';
		$this->coreContext->iHoverOverTheElement($locator);
	}
	
	/**
	 * @Given I go to create new organization page
	 */
	public function iGoToCreateNewOrganizationPage()
	{
		//$this->visit('/organizations/edit');

        $url = $this->buildUrl('lang/organizations/edit');
        $this->visit($url);
	}
	
	/**
	 * @Given I go to organization overview page
	 */
	public function iGoToOrganizationOverviewPage()
	{
		//$this->visit('/organizations');

		$url = $this->buildUrl('lang/organizations');
		$this->visit($url);
	}

    /**
     * @Given I want to see list organization profiles
     */
	public function iWantToSeeListOrganizationProfiles()
    {
       $url = $this->generateUrl('lang/organizations/profile');

       $this->visit($url);
    }

    /**
     * @Given I have organization :name
     *
     * @internal param string $name
     * @internal param TableNode|null $table
     */
	public function iHaveOrganization($name)
    {
        $user = $this->getUserContext()->getCurrentUser();
        $organization = $this->findOrganizationByName($name,false);
        $repo = $this->getRepository('Organizations/Organization');
        if(!$organization instanceof Organization){


            $organization = new Organization();
            $organizationName = new OrganizationName($name);
            $organization->setOrganizationName($organizationName);
            $organization->setIsDraft(false);
        }
        /* @var OrganizationReference $orgReference */
        $orgReference = $user->getOrganization();
        $parent = $orgReference->getOrganization();
        $organization->setParent($parent);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        $organization->setProfileSetting(Organization::PROFILE_ALWAYS_ENABLE);
        $permissions = $organization->getPermissions();
        $permissions->grant($user,Permissions::PERMISSION_ALL);

        $repo->store($organization);
        $repo->getDocumentManager()->refresh($organization);
        $repo->getDocumentManager()->refresh($user);
    }

    /**
     * @Given organization :name have jobs:
     */
    public function organizationHavePublishedJob($name,TableNode $table)
    {
        $user = $this->getUserContext()->getCurrentUser();
        if(is_null($user)){
            throw new FailedExpectationException('Need to login first');
        }

        $organization = $this->findOrganizationByName($name);
        foreach($table->getColumnsHash() as $index=>$definitions){
            $definitions['user'] = $user->getLogin();
            $status = isset($definitions['status']) ? $definitions['status']:'draft';
            unset($definitions['status']);
            $this->jobContext->buildJob($status,$definitions,$organization);
        }
    }

    /**
     * @Given profile setting for :name is :setting
     * @param $name
     * @param $setting
     */
    public function profileSetting($name,$setting)
    {
        $repo = $this->getRepository('Organizations/Organization');
        $organization = $this->findOrganizationByName($name);

        $organization->setProfileSetting($setting);
        $repo->store($organization);
        $repo->getDocumentManager()->refresh($organization);
    }

    /**
     * @Given I define contact for :organization organization with:
     * @param TableNode $table
     */
    public function iDefineContactWith($name, TableNode $table)
    {
        $organization = $this->findOrganizationByName($name);
        $contact = $organization->getContact();

        $definitions = $table->getRowsHash();
        foreach($definitions as $name=>$value){
            $field = Inflector::camelize($name);
            $method = 'set'.$field;
            $callback = array($contact,$method);
            if(is_callable($callback)){
                call_user_func_array($callback,[$value]);
            }
        }
        $this->getRepository('Organizations/Organization')->store($organization);
    }

    /**
     * @Given I go to profile page for organization :name
     * @param string $name
     * @throws FailedExpectationException
     */
    public function iGoToOrganizationProfilePage($name)
    {
        $organization = $this->findOrganizationByName($name);
        $url = $this->generateUrl('lang/organizations/profileDetail',[

            'id' => $organization->getId()
        ]);

        $this->visit($url);
    }

    /**
     * @param string $name
     * @return Organization
     * @throws FailedExpectationException
     */
    public function findOrganizationByName($name, $throwException = true)
    {
        /* @var OrganizationRepository $repo */
        $repo = $this->getRepository('Organizations/Organization');
        $result = $repo->findByName($name);
        $organization = count($result) > 0 ? $result[0]:null;
        if(!$organization instanceof Organization && $throwException){
            throw new FailedExpectationException(
                sprintf('Organization %s is not found.',$name)
            );
        }
        return $organization;
    }

    /**
     * @Given organization :name have no job
     *
     * @param string $name
     */
    public function organizationHaveNoJob($name)
    {
        $org = $this->findOrganizationByName($name);

        /* @var JobRepository $jobRepo */
        $jobRepo = $this->getRepository('Jobs/Job');
        $result = $jobRepo->findByOrganization($org->getId());

        foreach($result as $job){
            $jobRepo->remove($job,true);
        }
    }
}


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 Behat\Behat\Context\Context;
13		use Behat\Behat\Hook\Scope\BeforeScenarioScope;
14		use Behat\Gherkin\Node\TableNode;
15		use Core\Entity\Permissions;
16		use Doctrine\Common\Util\Inflector;
17		use Organizations\Entity\Organization;
18		use Organizations\Entity\OrganizationName;
19		use Organizations\Entity\OrganizationReference;
20		use Yawik\Behat\Exception\FailedExpectationException;
21		use Organizations\Repository\Organization as OrganizationRepository;
22		use Jobs\Repository\Job as JobRepository;
23
24		/**
25		* Class OrganizationContext
26		*
27		* @author Anthonius Munthi <[email protected]>
28		* @since 0.29
29		* @package Yawik\Behat
30		*/
31		class OrganizationContext implements Context
32		{
33		use CommonContextTrait;
34
35		/**
36		* @var JobContext
37		*/
38		private $jobContext;
39
40		/**
41		* @BeforeScenario
42		*
43		* @param BeforeScenarioScope $scope
44		*/
45		public function setupContext(BeforeScenarioScope $scope)
46		{
47		$this->jobContext = $scope->getEnvironment()->getContext(JobContext::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...
48		}
49
50		/**
51		* @Given I go to my organization page
52		*/
53		public function iGoToMyOrganizationPage()
54		{
55		$url = $this->buildUrl('lang/my-organization');
56		$this->visit($url);
57		}
58
59		/**
60		* @When I hover over name form
61		*/
62		public function iMouseOverOrganizationNameForm()
63		{
64		$locator = '#sf-nameForm .sf-summary';
65		$this->coreContext->iHoverOverTheElement($locator);
66		}
67
68		/**
69		* @Given I go to create new organization page
70		*/
71		public function iGoToCreateNewOrganizationPage()
72		{
73		//$this->visit('/organizations/edit');
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-21 08:05 UTC by Report Bug Copy Issue Report `86%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
74		$url = $this->buildUrl('lang/organizations/edit');
75		$this->visit($url);
76		}
77
78		/**
79		* @Given I go to organization overview page
80		*/
81		public function iGoToOrganizationOverviewPage()
82		{
83		//$this->visit('/organizations');
		0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-21 08:05 UTC by Report Bug Copy Issue Report `86%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
84		$url = $this->buildUrl('lang/organizations');
85		$this->visit($url);
86		}
87
88		/**
89		* @Given I want to see list organization profiles
90		*/
91		public function iWantToSeeListOrganizationProfiles()
92		{
93		$url = $this->generateUrl('lang/organizations/profile');
		0 ignored issues – show Bug introduced 2018-02-14 02:09 UTC by Report Bug Copy Issue Report The method `generateUrl()` does not seem to exist on `object<Yawik\Behat\OrganizationContext>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
94		$this->visit($url);
95		}
96
97		/**
98		* @Given I have organization :name
99		*
100		* @internal param string $name
101		* @internal param TableNode\|null $table
102		*/
103		public function iHaveOrganization($name)
104		{
105		$user = $this->getUserContext()->getCurrentUser();
106		$organization = $this->findOrganizationByName($name,false);
107		$repo = $this->getRepository('Organizations/Organization');
108	View Code Duplication	if(!$organization instanceof Organization){
		0 ignored issues – show Duplication introduced 2018-02-09 00:14 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
109
110		$organization = new Organization();
111		$organizationName = new OrganizationName($name);
112		$organization->setOrganizationName($organizationName);
113		$organization->setIsDraft(false);
114		}
115		/* @var OrganizationReference $orgReference */
116		$orgReference = $user->getOrganization();
117		$parent = $orgReference->getOrganization();
118		$organization->setParent($parent);
		0 ignored issues – show Bug introduced 2018-02-09 00:14 UTC by Report Bug Copy Issue Report It seems like `$parent` defined by `$orgReference->getOrganization()` on line `117` can be `null`; however, `Organizations\Entity\Organization::setParent()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
119		$organization->setProfileSetting(Organization::PROFILE_ALWAYS_ENABLE);
120		$permissions = $organization->getPermissions();
121		$permissions->grant($user,Permissions::PERMISSION_ALL);
122
123		$repo->store($organization);
124		$repo->getDocumentManager()->refresh($organization);
125		$repo->getDocumentManager()->refresh($user);
126		}
127
128		/**
129		* @Given organization :name have jobs:
130		*/
131		public function organizationHavePublishedJob($name,TableNode $table)
132		{
133		$user = $this->getUserContext()->getCurrentUser();
134		if(is_null($user)){
135		throw new FailedExpectationException('Need to login first');
136		}
137
138		$organization = $this->findOrganizationByName($name);
139		foreach($table->getColumnsHash() as $index=>$definitions){
140		$definitions['user'] = $user->getLogin();
141		$status = isset($definitions['status']) ? $definitions['status']:'draft';
142		unset($definitions['status']);
143		$this->jobContext->buildJob($status,$definitions,$organization);
144		}
145		}
146
147		/**
148		* @Given profile setting for :name is :setting
149		* @param $name
150		* @param $setting
151		*/
152		public function profileSetting($name,$setting)
153		{
154		$repo = $this->getRepository('Organizations/Organization');
155		$organization = $this->findOrganizationByName($name);
156
157		$organization->setProfileSetting($setting);
158		$repo->store($organization);
159		$repo->getDocumentManager()->refresh($organization);
160		}
161
162		/**
163		* @Given I define contact for :organization organization with:
164		* @param TableNode $table
165		*/
166		public function iDefineContactWith($name, TableNode $table)
167		{
168		$organization = $this->findOrganizationByName($name);
169		$contact = $organization->getContact();
170
171		$definitions = $table->getRowsHash();
172		foreach($definitions as $name=>$value){
173		$field = Inflector::camelize($name);
174		$method = 'set'.$field;
175		$callback = array($contact,$method);
176		if(is_callable($callback)){
177		call_user_func_array($callback,[$value]);
178		}
179		}
180		$this->getRepository('Organizations/Organization')->store($organization);
181		}
182
183		/**
184		* @Given I go to profile page for organization :name
185		* @param string $name
186		* @throws FailedExpectationException
187		*/
188		public function iGoToOrganizationProfilePage($name)
189		{
190		$organization = $this->findOrganizationByName($name);
191		$url = $this->generateUrl('lang/organizations/profileDetail',[
		0 ignored issues – show Bug introduced 2018-02-14 02:09 UTC by Report Bug Copy Issue Report The method `generateUrl()` does not seem to exist on `object<Yawik\Behat\OrganizationContext>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
192		'id' => $organization->getId()
193		]);
194
195		$this->visit($url);
196		}
197
198		/**
199		* @param string $name
200		* @return Organization
201		* @throws FailedExpectationException
202		*/
203		public function findOrganizationByName($name, $throwException = true)
204		{
205		/* @var OrganizationRepository $repo */
206		$repo = $this->getRepository('Organizations/Organization');
207		$result = $repo->findByName($name);
208		$organization = count($result) > 0 ? $result[0]:null;
209		if(!$organization instanceof Organization && $throwException){
210		throw new FailedExpectationException(
211		sprintf('Organization %s is not found.',$name)
212		);
213		}
214		return $organization;
215		}
216
217		/**
218		* @Given organization :name have no job
219		*
220		* @param string $name
221		*/
222		public function organizationHaveNoJob($name)
223		{
224		$org = $this->findOrganizationByName($name);
225
226		/* @var JobRepository $jobRepo */
227		$jobRepo = $this->getRepository('Jobs/Job');
228		$result = $jobRepo->findByOrganization($org->getId());
229
230		foreach($result as $job){
231		$jobRepo->remove($job,true);
232		}
233		}
234		}
235

cross-solution / YAWIK

Pull Request — develop (#462)

OrganizationContext::findOrganizationByName() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like