ModelAccessor - Code Metrics - Inspection of "commit message" - flipbox/spark - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5a9c7e...e00e24 )

by Nate

created 2017-03-28 00:16 UTC

ModelAccessor C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	709
Duplicated Lines	29.2 %

Coupling/Cohesion

Components	1
Dependencies	8

Importance

Changes

Metric	Value
wmc	69
lcom	1
cbo	8
dl	207
loc	709
rs	5
c	0
b	0
f	0

34 Methods

Rating	Name	Duplication	Size	Complexity
	modelClass()	0	1	?
A	modelClassInstance()	0	4	1
A	create()	23	23	3
A	createFromRecord()	0	19	3
B	findAll()	24	24	4
A	getAll()	0	12	2
B	find()	0	26	5
A	get()	0	13	2
B	findById()	25	25	3
A	getById()	13	13	2
A	freshFindById()	14	14	2
A	freshGetById()	12	12	2
A	findAllByQuery()	12	12	2
A	findByQuery()	11	11	2
A	findAllByCondition()	0	17	3
A	getAllByCondition()	0	12	2
A	findByCondition()	11	11	2
A	getByCondition()	0	12	2
A	findAllByCriteria()	18	18	3
A	getAllByCriteria()	0	12	2
A	findByCriteria()	11	11	2
A	getByCriteria()	0	12	2
A	findByRecord()	17	17	2
A	getByRecord()	0	4	1
A	findCache()	16	16	3
A	findCacheById()	0	13	2
A	isCachedById()	0	4	1
A	cacheById()	0	14	2
A	findCacheByRecord()	0	12	2
A	addToCache()	0	7	1
A	notFoundException()	0	10	1
A	notFoundByIdException()	0	11	1
A	notFoundByCriteriaException()	0	11	1
A	notFoundByConditionException()	0	11	1

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

<?php

/**
 * @package    Spark
 * @author     Flipbox Factory <[email protected]>
 * @copyright  2010-2016 Flipbox Digital Limited
 * @license    https://github.com/FlipboxFactory/Craft3-Spark/blob/master/LICENSE
 * @link       https://github.com/FlipboxFactory/Craft3-Spark
 * @since      Class available since Release 1.0.0
 */

namespace flipbox\spark\services;

use craft\helpers\Json as JsonHelper;
use flipbox\spark\exceptions\ModelNotFoundException;
use flipbox\spark\helpers\ArrayHelper;
use flipbox\spark\helpers\ModelHelper;
use flipbox\spark\models\Model;
use flipbox\spark\records\Record;
use flipbox\spark\services\traits\ModelRecordBehavior;
use yii\base\Component;
use yii\base\InvalidConfigException;
use yii\db\QueryInterface;

abstract class ModelAccessor extends Component
{

    use ModelRecordBehavior;

    /**
     * @var Model[]
     */
    protected $_cacheAll;

    /**
     * @var Model[]
     */
    protected $_cacheById = [];


    /*******************************************
     * MODEL CLASSES
     *******************************************/

    /**
     * @return string
     */
    public abstract static function modelClass(): string;


    /**
     * @return string
     */
    public static function modelClassInstance(): string
    {
        return Model::class;
    }

    /*******************************************
     * CREATE
     *******************************************/

    /**
     * @param array $config
     * @param string|null $toScenario
     * @throws InvalidConfigException
     * @return Model
     */
    public function create($config = [], string $toScenario = null): Model

    {

        // Treat records as known data and set via config
        if ($config instanceof Record) {
            return $this->createFromRecord($config, $toScenario);
        }

        // Force Array
        if (!is_array($config)) {
            $config = ArrayHelper::toArray($config, [], false);
        }

        // Set the model class
        $config['class'] = static::modelClass();

        return ModelHelper::create(
            $config,
            static::modelClassInstance(),
            $toScenario
        );

    }

    /**
     * @param Record $record
     * @param string|null $toScenario
     * @throws InvalidConfigException
     * @return Model
     */
    protected function createFromRecord(Record $record, string $toScenario = null): Model
    {

        if (null !== $toScenario) {
            $record->setScenario($toScenario);
        }

        $modelClass = static::modelClass();

        /** @var Model $model */
        $model = new $modelClass($record);

        if (null !== $toScenario) {
            $model->setScenario($toScenario);
        }

        return $model;

    }

    /*******************************************
     * FIND/GET ALL
     *******************************************/

    /**
     * @param string $toScenario
     * @return Model[]
     */
    public function findAll(string $toScenario = null)

    {

        // Check addToCache
        if (is_null($this->_cacheAll)) {

            $this->_cacheAll = [];

            // Find record in db
            if ($records = $this->findAllRecords()) {

                foreach ($records as $record) {

                    $this->_cacheAll[] = $this->findByRecord($record, $toScenario);

                }

            }

        }

        return $this->_cacheAll;

    }

    /**
     * @param string $toScenario
     * @return Model[]
     * @throws ModelNotFoundException
     */
    public function getAll(string $toScenario = null): array
    {

        if (!$models = $this->findAll($toScenario)) {

            $this->notFoundException();

        }

        return $models;

    }

    /*******************************************
     * FIND/GET
     *******************************************/

    /**
     * @param $identifier
     * @param string $toScenario
     * @return Model|null
     */
    public function find($identifier, string $toScenario = null)
    {

        if ($identifier instanceof Model) {

            $this->addToCache($identifier);

            if (null !== $toScenario) {
                $identifier->setScenario($toScenario);
            }

            return $identifier;

        } elseif ($identifier instanceof Record) {

            return $this->findByRecord($identifier, $toScenario);

        } elseif (is_numeric($identifier)) {

            return $this->findById($identifier, $toScenario);

        }

        return null;

    }

    /**
     * @param $identifier
     * @param string $toScenario
     * @return Model
     * @throws ModelNotFoundException
     */
    public function get($identifier, string $toScenario = null): Model
    {

        // Find model by ID
        if (!$model = $this->find($identifier, $toScenario)) {

            $this->notFoundException();

        }

        return $model;

    }

    /*******************************************
     * FIND/GET BY ID
     *******************************************/

    /**
     * @param int $id
     * @param string|null $toScenario
     * @return Model|null
     */
    public function findById(int $id, string $toScenario = null)

    {

        // Check cache
        if (!$model = $this->findCacheById($id)) {

            // Find record in db
            if ($record = $this->findRecordById($id)) {

                // Perhaps in cache
                $model = $this->findByRecord($record, $toScenario);

            } else {

                $this->_cacheById[$id] = null;

                return null;

            }

        }

        return $model;

    }

    /**
     * @param int $id
     * @param string|null $toScenario
     * @return Model
     * @throws ModelNotFoundException
     */
    public function getById(int $id, string $toScenario = null): Model

    {

        // Find by ID
        if (!$model = $this->findById($id, $toScenario)) {

            $this->notFoundByIdException($id);

        }

        return $model;

    }

    /**
     * @param int $id
     * @param string|null $toScenario
     * @return Model|null
     */
    public function freshFindById(int $id, string $toScenario = null)

    {

        // Find record in db
        if ($record = $this->findRecordById($id)) {

            // Create
            return $this->createFromRecord($record, $toScenario);

        }

        return null;

    }

    /**
     * @param int $id
     * @param string|null $toScenario
     * @return Model
     * @throws ModelNotFoundException
     */
    public function freshGetById(int $id, string $toScenario = null): Model

    {

        if (!$model = $this->freshFindById($id, $toScenario)) {

            $this->notFoundByIdException($id);

        }

        return $model;

    }

    /*******************************************
     * FIND/GET BY QUERY
     *******************************************/

    /**
     * @param QueryInterface $query
     * @param string $toScenario
     * @return Model[]
     */
    public function findAllByQuery(QueryInterface $query, string $toScenario = null): array

    {

        $models = array();

        foreach ($query->all() as $record) {
            $models[] = $this->findByRecord($record, $toScenario);
        }

        return $models;

    }

    /**
     * @param QueryInterface $query
     * @param string $toScenario
     * @return Model|null
     */
    public function findByQuery(QueryInterface $query, string $toScenario = null)

    {

        /** @var Record $record */
        if (!$record = $query->one()) {
            return null;
        }

        return $this->findByRecord($record, $toScenario);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

    }

    /*******************************************
     * FIND/GET BY CONDITION
     *******************************************/

    /**
     * @param $condition
     * @param string $toScenario
     * @return Model[]
     */
    public function findAllByCondition($condition, string $toScenario = null): array
    {

        $models = [];

        // Find record in db
        if ($records = $this->findAllRecordsByCondition($condition)) {

            foreach ($records as $record) {
                $models[] = $this->findByRecord($record, $toScenario);
            }

        }

        return $models;

    }

    /**
     * @param $condition
     * @param string $toScenario
     * @return Model[]
     * @throws ModelNotFoundException
     */
    public function getAllByCondition($condition, string $toScenario = null): array
    {

        if (!$models = $this->findAllByCondition($condition, $toScenario)) {

            $this->notFoundByConditionException($condition);

        }

        return $models;

    }

    /**
     * @param $condition
     * @param string $toScenario
     * @return Model|null
     */
    public function findByCondition($condition, string $toScenario = null)

    {

        // Find record in db
        if ($record = $this->findRecordByCondition($condition)) {
            return $this->findByRecord($record, $toScenario);
        }

        return null;

    }

    /**
     * @param $condition
     * @param string $toScenario
     * @return Model
     * @throws ModelNotFoundException
     */
    public function getByCondition($condition, string $toScenario = null): Model
    {

        if (!$model = $this->findByCondition($condition, $toScenario)) {

            $this->notFoundByConditionException($condition);

        }

        return $model;

    }

    /*******************************************
     * FIND/GET BY CRITERIA
     *******************************************/

    /**
     * @param $criteria
     * @param string $toScenario
     * @return Model[]
     */
    public function findAllByCriteria($criteria, string $toScenario = null): array

    {

        $models = [];

        // Find record in db
        if ($records = $this->findAllRecordsByCriteria($criteria)
        ) {

            foreach ($records as $record) {
                $models[] = $this->findByRecord($record, $toScenario);
            }

        }

        return $models;

    }

    /**
     * @param $criteria
     * @param string $toScenario
     * @return Model[]
     * @throws ModelNotFoundException
     */
    public function getAllByCriteria($criteria, string $toScenario = null): array
    {

        if (!$models = $this->findAllByCriteria($criteria, $toScenario)) {

            $this->notFoundByCriteriaException($criteria);

        }

        return $models;

    }

    /**
     * @param $criteria
     * @param string $toScenario
     * @return Model|null
     */
    public function findByCriteria($criteria, string $toScenario = null)

    {

        // Find record in db
        if ($record = $this->findRecordByCriteria($criteria)) {
            return $this->findByRecord($record, $toScenario);
        }

        return null;

    }

    /**
     * @param $criteria
     * @param string $toScenario
     * @return Model
     * @throws ModelNotFoundException
     */
    public function getByCriteria($criteria, string $toScenario = null): Model
    {

        if (!$model = $this->findByCriteria($criteria, $toScenario)) {

            $this->notFoundByCriteriaException($criteria);

        }

        return $model;

    }


    /*******************************************
     * FIND/GET BY RECORD
     *******************************************/

    /**
     * @param Record $record
     * @param string $toScenario
     * @return Model
     */
    public function findByRecord(Record $record, string $toScenario = null): Model

    {

        // Check addToCache
        if (!$model = $this->findCacheByRecord($record)) {

            // New model
            $model = $this->createFromRecord($record, $toScenario);

            // Cache it
            $this->addToCache($model);

        }

        return $model;

    }

    /**
     * @param Record $record
     * @param string $toScenario
     * @return Model
     */
    public function getByRecord(Record $record, string $toScenario = null): Model
    {
        return $this->findByRecord($record, $toScenario);
    }


    /*******************************************
     * CACHE
     *******************************************/

    /**
     * @param $identifier
     * @return Model|null
     */
    public function findCache($identifier)

    {

        if ($identifier instanceof Record) {

            return $this->findCacheByRecord($identifier);

        } elseif (is_numeric($identifier)) {

            return $this->findCacheById($identifier);

        }

        return null;

    }

    /**
     * Find an existing cache by ID
     *
     * @param $id
     * @return Model|null
     */
    public function findCacheById(int $id)
    {

        // Check if already in addToCache
        if ($this->isCachedById($id)) {

            return $this->_cacheById[$id];

        }

        return null;

    }

    /**
     * Identify whether in cache by ID
     *
     * @param $id
     * @return bool
     */
    protected function isCachedById(int $id)
    {
        return array_key_exists($id, $this->_cacheById);
    }

    /**
     * @param Model $model
     * @return $this
     */
    protected function cacheById(Model $model)
    {

        // Check if already in cache
        if (!$id = $this->isCachedById($model->id)) {

            // Cache it
            $this->_cacheById[$id] = $model;

        }

        return $this;

    }

    /**
     * @param Record $record
     * @return Model|null
     */
    public function findCacheByRecord(Record $record)
    {

        // Check if already in addToCache by id
        if ($id = $this->isCachedById($record->id)) {

            return $this->findCacheById($id);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        }

        return null;
    }

    /**
     * @param Model $model
     * @return static
     */
    public function addToCache(Model $model)
    {

        $this->cacheById($model);

        return $this;
    }


    /*******************************************
     * EXCEPTIONS
     *******************************************/

    /**
     * @throws ModelNotFoundException
     */
    protected function notFoundException()
    {

        throw new ModelNotFoundException(
            sprintf(
                "Model does not exist."
            )
        );

    }

    /**
     * @param int|null $id
     * @throws ModelNotFoundException
     */
    protected function notFoundByIdException(int $id = null)
    {

        throw new ModelNotFoundException(
            sprintf(
                'Model does not exist with the id "%s".',
                (string)$id
            )
        );

    }

    /**
     * @param null $criteria
     * @throws ModelNotFoundException
     */
    protected function notFoundByCriteriaException($criteria = null)
    {

        throw new ModelNotFoundException(
            sprintf(
                'Model does not exist with the criteria "%s".',
                (string)JsonHelper::encode($criteria)
            )
        );

    }

    /**
     * @param null $condition
     * @throws ModelNotFoundException
     */
    protected function notFoundByConditionException($condition = null)
    {

        throw new ModelNotFoundException(
            sprintf(
                'Model does not exist with the condition "%s".',
                (string)JsonHelper::encode($condition)
            )
        );

    }

}


flipbox / spark