ProfileValidate - Code Metrics - Inspection of "Fix bugs" - itstructure/yii2-users-module - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 831484...fa61bb )

by Andrey

created 2018-05-13 13:53 UTC

ProfileValidate B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	413
Duplicated Lines	2.42 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
wmc	44
lcom	1
cbo	5
dl	10
loc	413
rs	8.3396
c	0
b	0
f	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	6	3
B	rules()	0	90	6
A	scenarios()	0	8	1
A	attributes()	0	21	3
A	attributeLabels()	0	21	3
B	__get()	0	17	6
A	__set()	0	4	1
A	getProfileModel()	0	4	1
A	setProfileModel()	0	6	1
A	setAuthManager()	0	4	1
A	validateRoles()	0	9	2
C	save()	0	29	8
A	getId()	0	4	1
A	checkProfileModel()	10	14	3
A	assignRoles()	0	18	4

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

<?php

namespace Itstructure\UsersModule\models;

use yii\db\ActiveRecordInterface;
use yii\helpers\ArrayHelper;
use yii\web\IdentityInterface;
use yii\rbac\ManagerInterface;
use yii\base\{Model, InvalidConfigException};
use Itstructure\UsersModule\interfaces\ModelInterface;

/**
 * Class for validation user fields.
 *
 * @property array  $rules
 * @property array  $attributes
 * @property array  $attributeLabels
 * @property bool  $rbacManage
 * @property bool  $customRewrite
 * @property IdentityInterface|ActiveRecordInterface  $profileModel
 * @property ManagerInterface  $authManager
 * @property string  $name
 * @property string  $login
 * @property string  $email
 * @property integer  $status
 * @property string  $password
 * @property string  $passwordRepeat
 *
 * @package Itstructure\UsersModule\models
 */
class ProfileValidate extends Model implements ModelInterface
{
    /**
     * Validate fields with rules.
     *
     * @var array
     */
    public $rules = [];

    /**
     * Attributes.
     *
     * @var array
     */
    public $attributes = [];

    /**
     * Attribute labels.
     *
     * @var array
     */
    public $attributeLabels = [];

    /**
     * Set manage for roles.
     *
     * @var bool
     */
    public $rbacManage = false;

    /**
     * Rewrite rules, labels, attributes by custom.
     *
     * @var bool
     */
    public $customRewrite = false;

    /**
     * Current profile (user) model.
     *
     * @var IdentityInterface|ActiveRecordInterface
     */
    private $profileModel;

    /**
     * Auth manager.
     *
     * @var ManagerInterface
     */
    private $authManager;

    /**
     * Scenarios constants.
     */
    const SCENARIO_CREATE = 'create';
    const SCENARIO_UPDATE = 'update';

    /**
     * Initialize.
     */
    public function init()
    {
        if ($this->rbacManage && null === $this->authManager){
            throw new InvalidConfigException('The authManager is not defined.');
        }
    }

    /**
     * @inheritdoc
     */
    public function rules()
    {
        $rules = $this->customRewrite ? $this->rules : ArrayHelper::merge(
            [
                'required' => [
                    [
                        'name',
                        'login',
                        'email',
                        'status'
                    ],
                    'required',
                ],
                'requiredOnCreate' => [
                    [
                        'password',
                        'passwordRepeat',
                    ],
                    'required',
                    'on' => self::SCENARIO_CREATE,
                ],
                'string' => [
                    [
                        'name',
                        'login',
                        'email',
                        'password',
                        'passwordRepeat',
                    ],
                    'string',
                    'max' => 255,
                ],
                'integer' => [
                    [
                        'status',
                    ],
                    'integer',
                ],
                'name' => [
                    'name',
                    'unique',
                    'skipOnError'     => true,
                    'targetClass'     => \Yii::$app->user->identityClass,
                    'targetAttribute' => ['name' => 'name'],
                    'filter' => $this->getScenario() == self::SCENARIO_UPDATE ? 'id != '.$this->id : ''
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                ],
                'login' => [
                    'login',
                    'unique',
                    'skipOnError'     => true,
                    'targetClass'     => \Yii::$app->user->identityClass,
                    'targetAttribute' => ['login' => 'login'],
                    'filter' => $this->getScenario() == self::SCENARIO_UPDATE ? 'id != '.$this->id : ''
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                ],
                'email' => [
                    'email',
                    'unique',
                    'skipOnError'     => true,
                    'targetClass'     => \Yii::$app->user->identityClass,
                    'targetAttribute' => ['email' => 'email'],
                    'filter' => $this->getScenario() == self::SCENARIO_UPDATE ? 'id != '.$this->id : ''
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                ],
                'password' => [
                    'password',
                    'compare',
                    'compareAttribute' => 'passwordRepeat',
                ],
                'passwordRepeat' => [
                    'passwordRepeat',
                    'compare',
                    'compareAttribute' => 'password',
                ]
            ],
            $this->rules
        );

        return $this->rbacManage ? ArrayHelper::merge(
            $rules,
            [
                'requiredRoles' => [
                    'roles',
                    'required',
                ],
                'validateRoles' => [
                    'roles',
                    'validateRoles',
                ],
            ]
        ) : $rules;
    }

    /**
     * Scenarios.
     *
     * @return array
     */
    public function scenarios()
    {
        return [
            self::SCENARIO_CREATE => $this->attributes(),
            self::SCENARIO_UPDATE => $this->attributes(),
            self::SCENARIO_DEFAULT => $this->attributes(),
        ];
    }

    /**
     * List if attributes.
     *
     * @return array
     */
    public function attributes()
    {
        $attributes = $this->customRewrite ? $this->attributes : ArrayHelper::merge(
            [
                'name',
                'login',
                'email',
                'status',
                'password',
                'passwordRepeat',
            ],
            $this->attributes
        );

        return $this->rbacManage ? ArrayHelper::merge(
            $attributes,
            [
                'roles',
            ]
        ) : $attributes;
    }

    /**
     * List if attribute labels.
     *
     * @inheritdoc
     */
    public function attributeLabels()
    {
        $attributeLabels = $this->customRewrite ? $this->attributeLabels : ArrayHelper::merge(
            [
                'name' => 'Name',
                'login' => 'Login',
                'email' => 'Email',
                'status' => 'Status',
                'password' => 'Password',
                'passwordRepeat' => 'Password confirm',
            ],
            $this->attributeLabels
        );

        return $this->rbacManage ? ArrayHelper::merge(
            $attributeLabels,
            [
                'roles' => 'Roles',
            ]
        ) : $attributeLabels;
    }

    /**
     * Get field value.
     *
     * @param string $name field name.
     *
     * @return mixed
     */
    public function __get($name)
    {
        if ($this->profileModel->getIsNewRecord()){
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            return $this->{$name} ?? '';
        }

        if ($this->rbacManage && 'roles' === $name){
            $roles = $this->authManager->getRolesByUser($this->profileModel->getId());
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            return array_keys($roles);
        }

        if ($this->rbacManage && 'authManager' === $name){
            return $this->authManager;
        }

        return $this->profileModel->{$name} ?? '';
    }

    /**
     * Set field value.
     *
     * @param string $name  name of field.
     * @param mixed  $value value to be stored in field.
     *
     * @return void
     */
    public function __set($name, $value)
    {
        $this->{$name} = $value;
    }

    /**
     * Returns profile (user) model.
     *
     * @return mixed
     */
    public function getProfileModel()
    {
        return $this->profileModel;
    }

    /**
     * Set profile (user) model.
     *
     * @param $model.
     *
     * @throws InvalidConfigException
     *
     * @return void
     */
    public function setProfileModel($model): void
    {
        self::checkProfileModel($model);

        $this->profileModel = $model;
    }

    /**
     * Set auth manager.
     *
     * @param ManagerInterface $authManager
     */
    public function setAuthManager(ManagerInterface $authManager): void
    {
        $this->authManager = $authManager;
    }

    /**
     * Validate roles data format.
     *
     * @param $attribute
     *
     * @return bool
     */
    public function validateRoles($attribute): bool
    {
        if (!is_array($this->roles)){
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->addError($attribute, 'Incorrect roles data format.');
            return false;
        }

        return true;
    }

    /**
     * Save user data.
     *
     * @return bool
     */
    public function save(): bool
    {
        if ($this->profileModel->getIsNewRecord()){
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            $this->setScenario(self::SCENARIO_CREATE);
        } else {
            $this->setScenario(self::SCENARIO_UPDATE);
        }

        if (!$this->validate()){
            return false;
        }

        foreach ($this->attributes() as $attribute) {

            if (null !== $this->{$attribute} && 'roles' !== $attribute){
                $this->profileModel->{$attribute} = $this->{$attribute};
            }
        }

        if (!$this->profileModel->save()){
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            return false;
        }

        if ($this->rbacManage){
            $this->assignRoles();
        }

        return true;
    }

    /**
     * Returns current model id.
     *
     * @return int
     */
    public function getId(): int
    {
        return $this->profileModel->getId();
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
    }

    /**
     * Check profileModel for instances.
     *
     * @throws InvalidConfigException
     *
     * @param $model
     *
     * @return void
     */
    public static function checkProfileModel($model)
    {
        if (!($model instanceof ActiveRecordInterface)){

            $modelClass = (new\ReflectionClass($model));
            throw new InvalidConfigException($modelClass->getNamespaceName() .
                '\\' . $modelClass->getShortName().' class  must be implemented from yii\db\ActiveRecordInterface.');
        }

        if (!($model instanceof IdentityInterface)){

            $modelClass = (new\ReflectionClass($model));
            throw new InvalidConfigException($modelClass->getNamespaceName() .
                '\\' . $modelClass->getShortName().' class  must be implemented from yii\web\IdentityInterface.');
        }
    }

    /**
     * Assign roles.
     *
     * @return void
     */
    private function assignRoles(): void
    {
        if (!$this->profileModel->getIsNewRecord()){
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            $this->authManager->revokeAll(
                $this->profileModel->getId()
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            );
        }

        foreach ($this->roles as $role){
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $role = $this->authManager->getRole($role);

            if (null === $role){
                continue;
            }

            $this->authManager->assign($role, $this->profileModel->getId());
        }
    }
}


Push — master ( 831484...fa61bb )

ProfileValidate B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

itstructure / yii2-users-module

Push — master ( 831484...fa61bb )

ProfileValidate B

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like