UserManager - Code Metrics - Inspection of "Extend GenerateCommand to generate migration for e..." - kaliop-uk/ezmigrationbundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#91)

unknown

created 2017-01-25 13:54 UTC

UserManager B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	234
Duplicated Lines	2.56 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

83.21%

Importance

Changes

Metric	Value
wmc	45
c	0
b	0
f	0
lcom	1
cbo	9
dl	6
loc	234
ccs	109
cts	131
cp	0.8321
rs	8.3673

6 Methods

Rating	Name	Duplication	Size	Complexity
C	update()	3	68	17
A	__construct()	0	4	1
B	create()	3	44	4
A	delete()	0	12	2
C	matchUsers()	0	39	14
C	setReferences()	0	28	7

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 UserManager 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 UserManager, and based on these observations, apply Extract Interface, too.

<?php

namespace Kaliop\eZMigrationBundle\Core\Executor;

use Kaliop\eZMigrationBundle\API\Collection\UserCollection;
use Kaliop\eZMigrationBundle\Core\Matcher\UserMatcher;

/**
 * Handles user migrations.
 */
class UserManager extends RepositoryExecutor
{
    protected $supportedStepTypes = array('user');

    protected $userMatcher;

    public function __construct(UserMatcher $userMatcher)
    {
        $this->userMatcher = $userMatcher;
    }

    /**
     * Creates a user based on the DSL instructions.
     *
     * @todo allow setting extra profile attributes!
     */
    protected function create()
    {
        if (!isset($this->dsl['groups'])) {
            throw new \Exception('No user groups set to create user in.');
        }

        if (!is_array($this->dsl['groups'])) {

            $this->dsl['groups'] = array($this->dsl['groups']);
        }

        $userService = $this->repository->getUserService();
        $contentTypeService = $this->repository->getContentTypeService();

        $userGroups = array();
        foreach ($this->dsl['groups'] as $groupId) {
            $groupId = $this->referenceResolver->resolveReference($groupId);
            $userGroup = $userService->loadUserGroup($groupId);

            // q: in which case can we have no group? And should we throw an exception?
            //if ($userGroup) {

                $userGroups[] = $userGroup;
            //}
        }

        // FIXME: Hard coding content type to user for now
        $userContentType = $contentTypeService->loadContentTypeByIdentifier(self::USER_CONTENT_TYPE);

        $userCreateStruct = $userService->newUserCreateStruct(
            $this->dsl['username'],
            $this->dsl['email'],
            $this->dsl['password'],
            $this->getLanguageCode(),
            $userContentType
        );
        $userCreateStruct->setField('first_name', $this->dsl['first_name']);
        $userCreateStruct->setField('last_name', $this->dsl['last_name']);

        // Create the user
        $user = $userService->createUser($userCreateStruct, $userGroups);

        $this->setReferences($user);

        return $user;
    }

    /**
     * Method to handle the update operation of the migration instructions
     *
     * @todo allow setting extra profile attributes!
     */
    protected function update()
    {
        $userCollection = $this->matchUsers('user');

        if (count($userCollection) > 1 && isset($this->dsl['references'])) {
            throw new \Exception("Can not execute User update because multiple user match, and a references section is specified in the dsl. References can be set when only 1 user matches");
        }

        if (count($userCollection) > 1 && isset($this->dsl['email'])) {
            throw new \Exception("Can not execute User update because multiple user match, and an email section is specified in the dsl.");
        }

        $userService = $this->repository->getUserService();

        foreach($userCollection as $key => $user) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }

            $userUpdateStruct = $userService->newUserUpdateStruct();

            if (isset($this->dsl['email'])) {
                $userUpdateStruct->email = $this->dsl['email'];
            }
            if (isset($this->dsl['password'])) {
                $userUpdateStruct->password = (string)$this->dsl['password'];
            }
            if (isset($this->dsl['enabled'])) {
                $userUpdateStruct->enabled = $this->dsl['enabled'];
            }

            $user = $userService->updateUser($user, $userUpdateStruct);

            if (isset($this->dsl['groups'])) {
                if (!is_array($this->dsl['groups'])) {

                    $this->dsl['groups'] = array($this->dsl['groups']);
                }

                $assignedGroups = $userService->loadUserGroupsOfUser($user);

                // Assigning new groups to the user
                foreach ($this->dsl['groups'] as $groupToAssignId) {
                    $present = false;
                    foreach ($assignedGroups as $assignedGroup) {
                        // Make sure we assign the user only to groups he isn't already assigned to
                        if ($assignedGroup->id == $groupToAssignId) {
                            $present = true;
                            break;
                        }
                    }
                    if (!$present) {
                        $groupToAssign = $userService->loadUserGroup($groupToAssignId);
                        $userService->assignUserToUserGroup($user, $groupToAssign);
                    }
                }

                // Unassigning groups that are not in the list in the migration
                foreach ($assignedGroups as $assignedGroup) {
                    if (!in_array($assignedGroup->id, $this->dsl['groups'])) {
                        $userService->unAssignUserFromUserGroup($user, $assignedGroup);
                    }
                }
            }

            $userCollection[$key] = $user;
        }

        $this->setReferences($userCollection);
/** @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);
    }
}

        return $userCollection;
    }

    /**
     * Method to handle the delete operation of the migration instructions
     */
    protected function delete()
    {
        $userCollection = $this->matchUsers('delete');

        $userService = $this->repository->getUserService();

        foreach($userCollection as $user) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            $userService->deleteUser($user);
        }

        return $userCollection;
    }

    /**
     * @param string $action
     * @return RoleCollection
     * @throws \Exception
     */
    protected function matchUsers($action)
    {
        if (!isset($this->dsl['id']) && !isset($this->dsl['user_id']) && !isset($this->dsl['email']) && !isset($this->dsl['username']) && !isset($this->dsl['match'])) {
            throw new \Exception("The id, email or username of a user or a match condition is required to $action it.");
        }

        // Backwards compat
        if (!isset($this->dsl['match'])) {
            $conds = array();
            if (isset($this->dsl['id'])) {
                 $conds['id'] = $this->dsl['id'];
            }
            if (isset($this->dsl['user_id'])) {
                $conds['id'] = $this->dsl['user_id'];
            }
            if (isset($this->dsl['email'])) {
                $conds['email'] = $this->dsl['email'];
            }
            if (isset($this->dsl['username'])) {
                $conds['login'] = $this->dsl['username'];
            }
            $this->dsl['match'] = $conds;
        }

        $match = $this->dsl['match'];

        // convert the references passed in the match
        foreach ($match as $condition => $values) {
            if (is_array($values)) {
                foreach ($values as $position => $value) {
                    $match[$condition][$position] = $this->referenceResolver->resolveReference($value);
                }
            } else {
                $match[$condition] = $this->referenceResolver->resolveReference($values);
            }
        }

        return $this->userMatcher->match($match);
    }

    /**
     * Sets references to object attributes.
     *
     * The User manager currently only supports setting references to user_id.
     *
     * @param \eZ\Publish\API\Repository\Values\User\User|UserCollection $user
     * @throws \InvalidArgumentException when trying to set references to unsupported attributes
     * @return boolean
     */
    protected function setReferences($user)
    {
        if (!array_key_exists('references', $this->dsl)) {
            return false;
        }

        if ($user instanceof UserCollection) {
            if (count($user) > 1) {
                throw new \InvalidArgumentException('User Manager does not support setting references for creating/updating of multiple users');
            }
            $user = reset($user);
        }

        foreach ($this->dsl['references'] as $reference) {
            switch ($reference['attribute']) {
                case 'user_id':
                case 'id':
                    $value = $user->id;
                    break;
                default:
                    throw new \InvalidArgumentException('User Manager does not support setting references for attribute ' . $reference['attribute']);
            }

            $this->referenceResolver->addReference($reference['identifier'], $value);
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.
    }
}
        }

        return true;
    }
}


1			<?php
2
3			namespace Kaliop\eZMigrationBundle\Core\Executor;
4
5			use Kaliop\eZMigrationBundle\API\Collection\UserCollection;
6			use Kaliop\eZMigrationBundle\Core\Matcher\UserMatcher;
7
8			/**
9			* Handles user migrations.
10			*/
11			class UserManager extends RepositoryExecutor
12			{
13			protected $supportedStepTypes = array('user');
14
15			protected $userMatcher;
16
17	27		public function __construct(UserMatcher $userMatcher)
18			{
19	27		$this->userMatcher = $userMatcher;
20	27		}
21
22			/**
23			* Creates a user based on the DSL instructions.
24			*
25			* @todo allow setting extra profile attributes!
26			*/
27	2		protected function create()
28			{
29	2		if (!isset($this->dsl['groups'])) {
30			throw new \Exception('No user groups set to create user in.');
31			}
32
33	2	View Code Duplication	if (!is_array($this->dsl['groups'])) {
			0 ignored issues – show Duplication introduced 2016-08-22 12:20 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...
34			$this->dsl['groups'] = array($this->dsl['groups']);
35			}
36
37	2		$userService = $this->repository->getUserService();
38	2		$contentTypeService = $this->repository->getContentTypeService();
39
40	2		$userGroups = array();
41	2		foreach ($this->dsl['groups'] as $groupId) {
42	2		$groupId = $this->referenceResolver->resolveReference($groupId);
43	2		$userGroup = $userService->loadUserGroup($groupId);
44
45			// q: in which case can we have no group? And should we throw an exception?
46			//if ($userGroup) {
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-10-06 08:36 UTC by Report Bug Copy Issue Report `72%` 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...
47	2		$userGroups[] = $userGroup;
48			//}
49	2		}
50
51			// FIXME: Hard coding content type to user for now
52	2		$userContentType = $contentTypeService->loadContentTypeByIdentifier(self::USER_CONTENT_TYPE);
53
54	2		$userCreateStruct = $userService->newUserCreateStruct(
55	2		$this->dsl['username'],
56	2		$this->dsl['email'],
57	2		$this->dsl['password'],
58	2		$this->getLanguageCode(),
59			$userContentType
60	2		);
61	2		$userCreateStruct->setField('first_name', $this->dsl['first_name']);
62	2		$userCreateStruct->setField('last_name', $this->dsl['last_name']);
63
64			// Create the user
65	2		$user = $userService->createUser($userCreateStruct, $userGroups);
66
67	2		$this->setReferences($user);
68
69	2		return $user;
70			}
71
72			/**
73			* Method to handle the update operation of the migration instructions
74			*
75			* @todo allow setting extra profile attributes!
76			*/
77	2		protected function update()
78			{
79	1		$userCollection = $this->matchUsers('user');
80
81	1		if (count($userCollection) > 1 && isset($this->dsl['references'])) {
82			throw new \Exception("Can not execute User update because multiple user match, and a references section is specified in the dsl. References can be set when only 1 user matches");
83			}
84
85	1		if (count($userCollection) > 1 && isset($this->dsl['email'])) {
86			throw new \Exception("Can not execute User update because multiple user match, and an email section is specified in the dsl.");
87			}
88
89	1		$userService = $this->repository->getUserService();
90
91	1		foreach($userCollection as $key => $user) {
			0 ignored issues – show Bug introduced 2016-09-25 01:10 UTC by Report Bug Copy Issue Report The expression `$userCollection` of type `object<Kaliop\eZMigratio...on\UserCollection>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
92
93	1		$userUpdateStruct = $userService->newUserUpdateStruct();
94
95	1		if (isset($this->dsl['email'])) {
96	1		$userUpdateStruct->email = $this->dsl['email'];
97	1		}
98	1		if (isset($this->dsl['password'])) {
99	1		$userUpdateStruct->password = (string)$this->dsl['password'];
100	1		}
101	1		if (isset($this->dsl['enabled'])) {
102	1		$userUpdateStruct->enabled = $this->dsl['enabled'];
103	1		}
104
105	1		$user = $userService->updateUser($user, $userUpdateStruct);
106
107	1		if (isset($this->dsl['groups'])) {
108	1	View Code Duplication	if (!is_array($this->dsl['groups'])) {
			0 ignored issues – show Duplication introduced 2016-08-22 12:20 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	1		$this->dsl['groups'] = array($this->dsl['groups']);
110	1		}
111
112	1		$assignedGroups = $userService->loadUserGroupsOfUser($user);
113
114			// Assigning new groups to the user
115	1		foreach ($this->dsl['groups'] as $groupToAssignId) {
116	1		$present = false;
117	1		foreach ($assignedGroups as $assignedGroup) {
118			// Make sure we assign the user only to groups he isn't already assigned to
119	1		if ($assignedGroup->id == $groupToAssignId) {
120	1		$present = true;
121	1		break;
122			}
123	1		}
124	1		if (!$present) {
125	1		$groupToAssign = $userService->loadUserGroup($groupToAssignId);
126	1		$userService->assignUserToUserGroup($user, $groupToAssign);
127	1		}
128	1		}
129
130			// Unassigning groups that are not in the list in the migration
131	1		foreach ($assignedGroups as $assignedGroup) {
132	2		if (!in_array($assignedGroup->id, $this->dsl['groups'])) {
133	1		$userService->unAssignUserFromUserGroup($user, $assignedGroup);
134	1		}
135	1		}
136	1		}
137
138	1		$userCollection[$key] = $user;
139	1		}
140
141	1		$this->setReferences($userCollection);
			0 ignored issues – show Bug introduced 2016-09-25 01:10 UTC by Report Bug Copy Issue Report It seems like `$userCollection` defined by `$this->matchUsers('user')` on line `79` can be `null`; however, `Kaliop\eZMigrationBundle...anager::setReferences()` 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...
142
143	1		return $userCollection;
144			}
145
146			/**
147			* Method to handle the delete operation of the migration instructions
148			*/
149	2		protected function delete()
150			{
151	2		$userCollection = $this->matchUsers('delete');
152
153	2		$userService = $this->repository->getUserService();
154
155	2		foreach($userCollection as $user) {
			0 ignored issues – show Bug introduced 2016-09-25 01:10 UTC by Report Bug Copy Issue Report The expression `$userCollection` of type `object<Kaliop\eZMigratio...on\UserCollection>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
156	2		$userService->deleteUser($user);
157	2		}
158
159	2		return $userCollection;
160			}
161
162			/**
163			* @param string $action
164			* @return RoleCollection
165			* @throws \Exception
166			*/
167	2		protected function matchUsers($action)
168			{
169	2		if (!isset($this->dsl['id']) && !isset($this->dsl['user_id']) && !isset($this->dsl['email']) && !isset($this->dsl['username']) && !isset($this->dsl['match'])) {
170			throw new \Exception("The id, email or username of a user or a match condition is required to $action it.");
171			}
172
173			// Backwards compat
174	2		if (!isset($this->dsl['match'])) {
175	1		$conds = array();
176	1		if (isset($this->dsl['id'])) {
177	1		$conds['id'] = $this->dsl['id'];
178	1		}
179	1		if (isset($this->dsl['user_id'])) {
180			$conds['id'] = $this->dsl['user_id'];
181			}
182	1		if (isset($this->dsl['email'])) {
183			$conds['email'] = $this->dsl['email'];
184			}
185	1		if (isset($this->dsl['username'])) {
186			$conds['login'] = $this->dsl['username'];
187			}
188	1		$this->dsl['match'] = $conds;
189	1		}
190
191	2		$match = $this->dsl['match'];
192
193			// convert the references passed in the match
194	2		foreach ($match as $condition => $values) {
195	2		if (is_array($values)) {
196			foreach ($values as $position => $value) {
197			$match[$condition][$position] = $this->referenceResolver->resolveReference($value);
198			}
199			} else {
200	2		$match[$condition] = $this->referenceResolver->resolveReference($values);
201			}
202	2		}
203
204	2		return $this->userMatcher->match($match);
205			}
206
207			/**
208			* Sets references to object attributes.
209			*
210			* The User manager currently only supports setting references to user_id.
211			*
212			* @param \eZ\Publish\API\Repository\Values\User\User\|UserCollection $user
213			* @throws \InvalidArgumentException when trying to set references to unsupported attributes
214			* @return boolean
215			*/
216	2		protected function setReferences($user)
217			{
218	2		if (!array_key_exists('references', $this->dsl)) {
219	1		return false;
220			}
221
222	2		if ($user instanceof UserCollection) {
223			if (count($user) > 1) {
224			throw new \InvalidArgumentException('User Manager does not support setting references for creating/updating of multiple users');
225			}
226			$user = reset($user);
227			}
228
229	2		foreach ($this->dsl['references'] as $reference) {
230	2		switch ($reference['attribute']) {
231	2		case 'user_id':
232	2		case 'id':
233	2		$value = $user->id;
234	2		break;
235			default:
236			throw new \InvalidArgumentException('User Manager does not support setting references for attribute ' . $reference['attribute']);
237	2		}
238
239	2		$this->referenceResolver->addReference($reference['identifier'], $value);
			0 ignored issues – show Bug introduced 2016-11-17 09:56 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Kaliop\eZMigrationBundle...erenceResolverInterface` as the method `addReference()` does only exist in the following implementations of said interface: `Kaliop\eZMigrationBundle...ver\ChainPrefixResolver`, `Kaliop\eZMigrationBundle...ver\ChainRegexpResolver`, `Kaliop\eZMigrationBundle...eResolver\ChainResolver`, `Kaliop\eZMigrationBundle...CustomReferenceResolver`. 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...
240	2		}
241
242	2		return true;
243			}
244			}
245

kaliop-uk / ezmigrationbundle

Pull Request — master (#91)

UserManager B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Duplication Side-by-Side

Filter issues like