GeneratorApi - Code Metrics - Inspection of "Added migration, refactored generator" - samsoncms/api - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#21)

unknown
created 2016-02-15 11:09 UTC
GeneratorApi A

↳ Parent: Project
Complexity

Total Complexity
Size/Duplication

Total Lines	378
Duplicated Lines	9.52 %
Coupling/Cohesion

Components	1
Dependencies	4
Importance

Changes	1
Bugs	0	Features	1
Metric	Value
wmc	20
c	1
b	0
f	1
lcom	1
cbo	4
dl	36
loc	378
rs	10
12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	generateFieldConditionMethod()	0	14	1
A	generateLocalizedFieldConditionMethod()	0	14	1
A	generateTableFieldMethod()	0	12	1
A	generateConstructorTableClass()	0	15	1
A	generateConstructorApplicationClass()	18	18	1
A	generateConstructorApplicationCollectionClass()	18	18	1
B	createTableRowClass()	0	27	2
B	createTableClass()	0	39	2
B	createEntityClass()	0	42	3
B	createQueryClass()	0	39	2
B	createEntityClasses()	0	34	4
How to fix Duplicated Code

<?php
//[PHPCOMPRESSOR(remove,start)]
/**
 * Created by PhpStorm.
 * User: VITALYIEGOROV
 * Date: 09.12.15
 * Time: 14:34
 */
namespace samsoncms\api;

use samsoncms\api\generator\Metadata;
use samsoncms\api\generator\Generator;
use samsoncms\api\generator\exception\ParentEntityNotFound;
use samsonframework\orm\DatabaseInterface;

/**
 * Entity classes generator.
 * @package samsoncms\api
 */
class GeneratorApi extends Generator
{

    /**
     * Generator constructor.
     * @param DatabaseInterface $database Database instance
     * @throws ParentEntityNotFound
     * @throws \samsoncms\api\exception\AdditionalFieldTypeNotFound
     */
    public function __construct(DatabaseInterface $database)
    {
        parent::__construct($database);

        /**
         * Fill metadata only with structures which have to be generated
         */
        $this->fillMetadata();
    }

    /**
     * Generate Query::where() analog for specific field.
     *
     * @param string $fieldName Field name
     * @param string $fieldId Field primary identifier
     * @param string $fieldType Field PHP type
     * @return string Generated PHP method code
     */
    protected function generateFieldConditionMethod($fieldName, $fieldId, $fieldType)
    {
        $code = "\n\t" . '/**';
        $code .= "\n\t" . ' * Add '.$fieldName.'(#' . $fieldId . ') field query condition.';
        $code .= "\n\t" . ' * @param '.$fieldType.' $value Field value';
        $code .= "\n\t" . ' * @return $this Chaining';
        $code .= "\n\t" . ' * @see Generic::where()';
        $code .= "\n\t" . ' */';
        $code .= "\n\t" . 'public function ' . $fieldName . '($value, $relation = ArgumentInterface::EQUAL)';
        $code .= "\n\t" . "{";
        $code .= "\n\t\t" . 'return $this->where("'.$fieldName.'", $value, $relation);';

        return $code . "\n\t" . "}"."\n";
    }

    /**
     * Generate Query::where() analog for specific field.
     *
     * @param string $fieldName Field name
     * @param string $fieldId Field primary identifier
     * @param string $fieldType Field PHP type
     * @return string Generated PHP method code
     */
    protected function generateLocalizedFieldConditionMethod($fieldName, $fieldId, $fieldType)
    {
        $code = "\n\t" . '/**';
        $code .= "\n\t" . ' * Add '.$fieldName.'(#' . $fieldId . ') field query condition.';
        $code .= "\n\t" . ' * @param '.Field::phpType($fieldType).' $value Field value';
        $code .= "\n\t" . ' * @return $this Chaining';
        $code .= "\n\t" . ' * @see Generic::where()';
        $code .= "\n\t" . ' */';
        $code .= "\n\t" . 'public function ' . $fieldName . '($value)';
        $code .= "\n\t" . "{";
        $code .= "\n\t\t" . 'return $this->where("'.$fieldName.'", $value);';

        return $code . "\n\t" . "}"."\n";
    }

    /**
     * Generate FieldsTable::values() analog for specific field.
     *
     * @param string $fieldName Field name
     * @param string $fieldId Field primary identifier
     * @param string $fieldType Field PHP type
     * @return string Generated PHP method code
     */
    protected function generateTableFieldMethod($fieldName, $fieldId, $fieldType)
    {
        $code = "\n\t" . '/**';
        $code .= "\n\t" . ' * Get table column '.$fieldName.'(#' . $fieldId . ') values.';
        $code .= "\n\t" . ' * @return array Collection('.Field::phpType($fieldType).') of table column values';
        $code .= "\n\t" . ' */';
        $code .= "\n\t" . 'public function ' . $fieldName . '()';
        $code .= "\n\t" . "{";
        $code .= "\n\t\t" . 'return $this->values('.$fieldId.');';

        return $code . "\n\t" . "}"."\n";
    }

    /**
     * Generate constructor for table class.
     */
    protected function generateConstructorTableClass()
    {
        $class = "\n\t".'/**';
        $class .= "\n\t".' * @param QueryInterface $query Database query instance';
        $class .= "\n\t".' * @param ViewInterface $renderer Rendering instance';
        $class .= "\n\t".' * @param integer $entityID Entity identifier to whom this table belongs';
        $class .= "\n\t".' * @param string $locale Localization identifier';
        $class .= "\n\t".' */';
        $class .= "\n\t".'public function __construct(QueryInterface $query, ViewInterface $renderer, $entityID, $locale = null)';
        $class .= "\n\t".'{';
        $class .= "\n\t\t".'parent::__construct($query, $renderer, static::$navigationIDs, $entityID, $locale);';
        $class .= "\n\t".'}'."\n";

        return $class;
    }

    /**
     * Generate constructor for application class.
     */
    protected function generateConstructorApplicationClass()

    {
        $class = "\n\t".'/**';
        $class .= "\n\t".' * Render materials list with pager';
        $class .= "\n\t".' *';
        $class .= "\n\t".' * @param string $navigationId Structure identifier';
        $class .= "\n\t".' * @param string $search Keywords to filter table';
        $class .= "\n\t".' * @param int $page Current table page';
        $class .= "\n\t".' * @return array Asynchronous response containing status and materials list with pager on success';
        $class .= "\n\t".' * or just status on asynchronous controller failure';
        $class .= "\n\t".' */';
        $class .= "\n\t".'public function __async_collection($navigationId = \'0\', $search = \'\', $page = 1)';
        $class .= "\n\t".'{';
        $class .= "\n\t\t".'return parent::__async_collection(self::$navigation, $search, $page);';
        $class .= "\n\t".'}'."\n";

        return $class;
    }

    /**
     * Generate constructor for application class.
     */
    protected function generateConstructorApplicationCollectionClass()

    {
        $class = "\n\t".'/**';
        $class .= "\n\t".' * Generic collection constructor';
        $class .= "\n\t".' *';
        $class .= "\n\t".' * @param RenderInterface $renderer View render object';
        $class .= "\n\t".' * @param QueryInterface $query Query object';
        $class .= "\n\t".' */';
        $class .= "\n\t".'public function __async_collection($renderer, $query = null, $pager = null)';
        $class .= "\n\t".'{';
        $class .= "\n\t\t".'return parent::__async_collection($renderer, $query = null, $pager = null);';
        $class .= "\n\t\t".'$this->fields = array(';
        $class .= "\n\t\t\t".'new Control(),';
        $class .= "\n\t\t".');';
        $class .= "\n\t".'}'."\n";

        return $class;
    }

    /**
     * Create fields table row PHP class code.
     *
     * @param Metadata $metadata metadata of entity
     * @param string $namespace Namespace of generated class
     *
     * @return string Generated entity query PHP class code
     * @throws exception\AdditionalFieldTypeNotFound
     */
    protected function createTableRowClass(Metadata $metadata, $namespace = __NAMESPACE__)

    {
        $this->generator
            ->multiComment(array('Class for getting "' . $metadata->entityRealName . '" fields table rows'))
            ->defClass($this->entityName($metadata->entityRealName) . 'TableRow', 'Row');

        $fieldIDs = array();
        foreach ($this->navigationFields($metadata->entityID) as $fieldID => $fieldRow) {
            $fieldName = $this->fieldName($fieldRow['Name']);

            // Fill field ids array
            $fieldIDs[$fieldName] = $fieldID;

            $this->generator
                ->commentVar($metadata->allFieldTypes[$fieldID], $fieldRow['Description'] . ' Field #' . $fieldID . ' variable name')
                ->defClassConst('F_' . strtoupper($fieldName), $fieldName)
                ->commentVar($metadata->allFieldTypes[$fieldID], $fieldRow['Description'] . ' Field #' . $fieldID . ' row value')
                ->defVar('public $' . $fieldName)
                ->text("\n");
        }

        return $this->generator
            ->commentVar('array', 'Collection of additional fields identifiers')
            ->defClassVar('$fieldIDs', 'public static', $fieldIDs)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->endClass()
            ->flush();
    }

    /**
     * Create fields table PHP class code.
     *
     * @param Metadata $metadata metadata of entity
     * @param string $namespace Namespace of generated class
     *
     * @return string Generated entity query PHP class code
     * @throws exception\AdditionalFieldTypeNotFound
     */
    protected function createTableClass(Metadata $metadata, $namespace = __NAMESPACE__)

    {
        $this->generator
            ->multiComment(array('Class for getting "'.$metadata->entityRealName.'" fields table'))
            ->defClass($this->entityName($metadata->entityRealName) . 'Table', 'FieldsTable');

        // Iterate additional fields
        $fields = array();
        foreach ($this->navigationFields($metadata->entityID) as $fieldID => $fieldRow) {
            $fieldName = $this->fieldName($fieldRow['Name']);

            $this->generator
                ->text($this->generateTableFieldMethod(
                    $fieldName,
                    $fieldRow[Field::F_PRIMARY],
                    $fieldRow[Field::F_TYPE]
                ))
                ->commentVar($metadata->allFieldTypes[$fieldID], $fieldRow['Description'] . ' Field #' . $fieldID . ' variable name')
                ->defClassConst('F_' . $fieldName, $fieldName);

            // Collection original to new one field names
            $fields[$fieldRow['Name']] = $fieldName;
        }

        // TODO: Add generator method generation logic
        $constructor = $this->generateConstructorTableClass();

        $this->generator->text($constructor);

        return $this->generator
            ->commentVar('array', 'Collection of real additional field names')
            ->defClassVar('$fieldsRealNames', 'public static', $fields)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->commentVar('array', 'Collection of navigation identifiers')
            ->defClassVar('$navigationIDs', 'protected static', array($metadata->entityID))
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->commentVar('string', 'Row class name')
            ->defClassVar('$identifier', 'protected', $this->fullEntityName($this->entityName($metadata->entityRealName) . 'TableRow'))
            ->endClass()
            ->flush();
    }

    /**
     * Create entity PHP class code.
     *
     * @param Metadata $metadata Entity metadata
     * @param string $namespace Namespace of generated class
     * @return string Generated entity query PHP class code
     */
    protected function createEntityClass(Metadata $metadata, $namespace = __NAMESPACE__)
    {
        /**
         * TODO: Parent problem
         * Should be changed to merging fields instead of extending with OOP for structure_relation support
         * or creating traits and using them on shared parent entities.
         */

        $this->generator
            ->multiComment(array('"'.$metadata->entityRealName.'" entity class'))
            ->defClass($metadata->entity, null !== $metadata->parent ? $this->fullEntityName($metadata->parent->entity, $namespace) : 'Entity')
            ->commentVar('string', '@deprecated Entity full class name, use ::class')
            ->defClassConst('ENTITY', $this->fullEntityName($metadata->entity, $namespace))
            ->commentVar('string', 'Entity manager full class name')
            ->defClassConst('MANAGER', $this->fullEntityName($metadata->entity, $namespace).'Query')
            ->commentVar('string', 'Entity database identifier')
            ->defClassConst('IDENTIFIER', $metadata->entityID)
            ->commentVar('string', 'Not transliterated entity name')
            ->defClassVar('$viewName', 'protected static', $metadata->entityRealName);

        foreach ($metadata->allFieldIDs as $fieldID => $fieldName) {
            $this->generator
                ->commentVar('string', $metadata->fieldDescriptions[$fieldID].' variable name')
                ->defClassConst('F_' . $fieldName, $fieldName)
                ->commentVar($metadata->allFieldTypes[$fieldID], $metadata->fieldDescriptions[$fieldID])
                ->defClassVar('$' . $fieldName, 'public');
        }

        return $this->generator
            ->defClassVar('$_sql_select', 'public static ', $metadata->arSelect)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->defClassVar('$_attributes', 'public static ', $metadata->arAttributes)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->defClassVar('$_map', 'public static ', $metadata->arMap)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->defClassVar('$_sql_from', 'public static ', $metadata->arFrom)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->defClassVar('$_own_group', 'public static ', $metadata->arGroup)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->defClassVar('$_relation_alias', 'public static ', $metadata->arRelationAlias)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->defClassVar('$_relation_type', 'public static ', $metadata->arRelationType)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->defClassVar('$_relations', 'public static ', $metadata->arRelations)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->defClassVar('$fieldIDs', 'protected static ', $metadata->allFieldIDs)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->defClassVar('$fieldValueColumns', 'protected static ', $metadata->allFieldValueColumns)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->endClass()
            ->flush();
    }

    /**
     * Create entity query PHP class code.
     *
     * @param Metadata $metadata Entity metadata
     * @param string   $suffix Generated class name suffix
     * @param string   $defaultParent Parent class name
     * @param string $namespace Namespace of generated class
     *
     * @return string Generated entity query PHP class code
     */
    protected function createQueryClass(Metadata $metadata, $suffix = 'Query', $defaultParent = '\samsoncms\api\query\Entity', $namespace = __NAMESPACE__)
    {
        //$navigationID, $navigationName, $entityName, $navigationFields, $parentClass = '\samsoncms\api\query\Entity'
        $this->generator
            ->multiComment(array('Class for fetching "'.$metadata->entityRealName.'" instances from database'))
            ->defClass($metadata->entity.$suffix, $defaultParent)
        ;

        foreach ($metadata->allFieldIDs as $fieldID => $fieldName) {
            // TODO: Add different method generation depending on their field type
            $this->generator->text($this->generateFieldConditionMethod(
                $fieldName,
                $fieldID,
                $metadata->allFieldTypes[$fieldID]
            ));
        }

        return $this->generator
            ->commentVar('array', 'Collection of real additional field names')
            ->defClassVar('$fieldRealNames', 'public static', $metadata->realNames)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->commentVar('array', 'Collection of additional field names')
            ->defClassVar('$fieldNames', 'public static', $metadata->allFieldNames)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            // TODO: two above fields should be protected
            ->commentVar('array', 'Collection of navigation identifiers')
            ->defClassVar('$navigationIDs', 'protected static', array($metadata->entityID))
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->commentVar('string', 'Entity full class name')
            ->defClassVar('$identifier', 'protected static', $this->fullEntityName($metadata->entity, $namespace))
            ->commentVar('array', 'Collection of localized additional fields identifiers')
            ->defClassVar('$localizedFieldIDs', 'protected static', $metadata->localizedFieldIDs)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->commentVar('array', 'Collection of NOT localized additional fields identifiers')
            ->defClassVar('$notLocalizedFieldIDs', 'protected static', $metadata->notLocalizedFieldIDs)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->commentVar('array', 'Collection of localized additional fields identifiers')
            ->defClassVar('$fieldIDs', 'protected static', $metadata->allFieldIDs)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->commentVar('array', 'Collection of additional fields value column names')
            ->defClassVar('$fieldValueColumns', 'protected static', $metadata->allFieldValueColumns)
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            ->endClass()
            ->flush()
        ;
    }

    /**
     * Generate entity classes.
     *
     * @param string $namespace Base namespace for generated classes
     * @return string Generated PHP code for entity classes
     * @throws ParentEntityNotFound
     * @throws \samsoncms\api\exception\AdditionalFieldTypeNotFound
     */
    public function createEntityClasses($namespace = __NAMESPACE__)
    {

        $classes = "\n" . 'namespace ' . $namespace . ';';
        $classes .= "\n";
        $classes .= "\n" . 'use '.$namespace.'\renderable\FieldsTable;';
        $classes .= "\n" . 'use '.$namespace.'\field\Row;';
        $classes .= "\n" . 'use \samsonframework\core\ViewInterface;';
        $classes .= "\n" . 'use \samsonframework\orm\ArgumentInterface;';
        $classes .= "\n" . 'use \samsonframework\orm\QueryInterface;';
        $classes .= "\n" . 'use \samson\activerecord\dbQuery;';
        $classes .= "\n";

        // Iterate all entities metadata
        foreach ($this->metadata as $metadata) {

            // Generate classes of default type
            if ($metadata->type === Metadata::TYPE_DEFAULT) {

                $classes .= $this->createEntityClass($metadata);
                $classes .= $this->createQueryClass($metadata);
                $classes .= $this->createQueryClass($metadata, 'Collection', '\samsoncms\api\renderable\Collection');

                // Generate classes of table type
            } else if ($metadata->type === Metadata::TYPE_TABLE) {

                $classes .= $this->createTableRowClass($metadata);
                $classes .= $this->createTableClass($metadata);
            }
        }

        // Make correct code formatting
        return $this->formatTab($classes);
    }
}

//[PHPCOMPRESSOR(remove,end)]

samsoncms / api

Pull Request — master (#21)

GeneratorApi A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

12 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like
