EntitiesGeneratorService::generateDao() - Code Metrics - Inspection of "Add the SMCREATORID,MODIFIEDBY,Created Time,Modifi..." - Wabel/zoho-crm-orm - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — 1.1 (#26)

by Raphaël
created 2017-07-20 10:10 UTC
EntitiesGeneratorService::generateDao() F

↳ Parent: EntitiesGeneratorService
Complexity

Conditions	23
Paths	12424
Size

Total Lines	136
Code Lines	97
Duplication

Lines	18
Ratio	13.24 %
Importance

Changes
Metric	Value
c	0
b	0
f	0
dl	18
loc	136
rs	2
cc	23
eloc	97
nc	12424
nop	8
How to fix Long Method Complexity Many Parameters

<?php

namespace Wabel\Zoho\CRM\Service;

use gossi\codegen\generator\CodeFileGenerator;
use gossi\codegen\model\PhpClass;
use gossi\codegen\model\PhpMethod;
use gossi\codegen\model\PhpParameter;
use gossi\codegen\model\PhpProperty;
use Psr\Log\LoggerInterface;
use Wabel\Zoho\CRM\ZohoClient;
use Wabel\Zoho\CRM\Exception\ZohoCRMException;

/**
 * This class is in charge of generating Zoho entities.
 */
class EntitiesGeneratorService
{
    private $zohoClient;
    private $logger;

    public function __construct(ZohoClient $zohoClient, LoggerInterface $logger)
    {
        $this->zohoClient = $zohoClient;
        $this->logger = $logger;
    }

    /**
     * Generate ALL entities for all Zoho modules.
     *
     * @param string $targetDirectory
     * @param string $namespace
     *
     * @return array Array containing each fully qualified dao class name
     */
    public function generateAll($targetDirectory, $namespace)
    {
        $modules = $this->zohoClient->getModules();
        $zohoModules = [];
        foreach ($modules->getRecords() as $module) {
            try {
                $zohoModules[] = $this->generateModule($module['key'], $module['pl'], $module['sl'], $targetDirectory, $namespace);
            } catch (ZohoCRMException $e) {
                $this->logger->notice('Error thrown when retrieving fields for module {module}. Error message: {error}.',
                    [
                        'module' => $module['key'],
                        'error' => $e->getMessage(),
                        'exception' => $e,
                    ]);
            }
        }

        return $zohoModules;
    }

    /**
     * Generate a dao for a zoho module.
     *
     * @param string $moduleName
     * @param string $modulePlural
     * @param string $moduleSingular
     * @param string $targetDirectory
     * @param string $namespace
     *
     * @return string The fully qualified Dao class name
     */
    public function generateModule($moduleName, $modulePlural, $moduleSingular, $targetDirectory, $namespace)
    {
        $fields = $this->zohoClient->getFields($moduleName);

        if (!file_exists($targetDirectory)) {
            mkdir($targetDirectory, 0775, true);
        }

        $namespace = trim($namespace, '\\');
        $className = self::upperCamelCase($moduleSingular);
        $daoClassName = $className.'ZohoDao';

        $fieldRecords = $fields->getRecords();

        // Case is a reserved keyword. Let's rename it.
        if ($className === 'Case') {
            $className = 'ZohoCase';
        }

        $this->generateBean($fieldRecords, $namespace, $className, $moduleName, $targetDirectory, $moduleSingular);
        $this->generateDao($fieldRecords, $namespace, $className, $daoClassName, $moduleName, $targetDirectory, $moduleSingular, $modulePlural);

        return $namespace.'\\'.$daoClassName;
    }

    public function generateBean($fields, $namespace, $className, $moduleName, $targetDirectory, $moduleSingular)
    {

//        if (class_exists($namespace."\\".$className)) {

//            $class = PhpClass::fromReflection(new \ReflectionClass($namespace."\\".$className));
//        } else {
            $class = PhpClass::create();
//        }

        $class->setName($className)
            ->setNamespace($namespace)
            ->addInterface('\\Wabel\\Zoho\\CRM\\ZohoBeanInterface')
            ->setMethod(PhpMethod::create('__construct'));

        // Let's add the ZohoID property
        self::registerProperty($class, 'zohoId', "The ID of this record in Zoho\nType: string\n", 'string');

        $usedIdentifiers = [];

        foreach ($fields as &$fieldCategory) {
            foreach ($fieldCategory as $name => &$field) {
                $req = $field['req'];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                $type = $field['type'];
                $isreadonly = $field['isreadonly'];
                $maxlength = $field['maxlength'];
                $label = $field['label'];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                $dv = $field['dv'];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                $customfield = $field['customfield'];
                $nullable = false;

                switch ($type) {

                    case 'DateTime':
                    case 'Date':
                        $phpType = '\\DateTimeInterface';
                        $nullable = true;
                        break;
                    case 'Boolean':
                        $phpType = 'bool';
                        break;
                    case 'Integer':
                        $phpType = 'int';
                        break;
                    default:
                        $phpType = 'string';
                        break;
                }

                $field['phpType'] = $phpType;

                $identifier = $this->getUniqueIdentifier($name, $usedIdentifiers);
                $usedIdentifiers[$identifier] = true;

                self::registerProperty($class, $identifier, 'Zoho field '.$name."\n".
                    'Type: '.$type."\n".
                    'Read only: '.($isreadonly ? 'true' : 'false')."\n".
                    'Max length: '.$maxlength."\n".
                    'Custom field: '.($customfield ? 'true' : 'false')."\n", $phpType, $nullable);

                // Adds a ID field for lookups
                if ($type === 'Lookup') {
                    $generateId = false;

                    if ($customfield) {
                        $name .= '_ID';
                        $generateId = true;
                    } elseif ($name === $moduleSingular.' Owner') {
                        // Check if this is a "owner" field.
                        $name = 'SMOWNERID';
                        $generateId = true;
                    } else {
                        $mapping = [
                            'Account Name' => 'ACCOUNTID',
                            'Contact Name' => 'CONTACTID',
                            'Parent Account' => 'PARENTACCOUNTID',
                            'Campaign Source' => 'CAMPAIGNID',
                        ];
                        if (isset($mapping[$name])) {
                            $name = $mapping[$name];
                            $generateId = true;
                        } else {
                            $this->logger->warning('Unable to set a ID for the field {name} of the {module} module', [
                                    'name' => $name,
                                    'module' => $moduleName,
                            ]);
                        }
                    }

                    if ($generateId) {
                        $req = false;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                        $type = 'Lookup ID';
                        $isreadonly = true;
                        $maxlength = $field['maxlength'];
                        $label = $field['label'];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                        $dv = $field['dv'];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

                        $field['phpType'] = $phpType;

                        self::registerProperty($class, ($customfield ? self::camelCase($name) : $name), 'Zoho field '.$name."\n".
                            'Type: '.$type."\n".
                            'Read only: '.($isreadonly ? 'true' : 'false')."\n".
                            'Max length: '.$maxlength."\n".
                            'Custom field: '.($customfield ? 'true' : 'false')."\n", 'string');
                    }
                }
            }
        }

        self::registerProperty($class, 'createdTime', "The time the record was created in Zoho\nType: DateTime\n", '\\DateTime');
        self::registerProperty($class, 'modifiedTime', "The last time the record was modified in Zoho\nType: DateTime\n", '\\DateTime');

        $method = PhpMethod::create('isDirty');
        $method->setDescription('Returns whether a property is changed or not.');
        $method->addParameter(PhpParameter::create('name'));
        $method->setBody("\$propertyName = 'dirty'.ucfirst(\$name);\nreturn \$this->\$propertyName;");
        $method->setType('bool');
        $class->setMethod($method);

        $generator = new CodeFileGenerator();
        $code = $generator->generate($class);

        if (!file_put_contents(rtrim($targetDirectory, '/').'/'.$className.'.php', $code)) {

            throw new ZohoCRMException("An error occurred while creating the class $className. Please verify the target directory or the rights of the file.");
        }
    }

    /**
     * Returns a unique identifier from the name.
     *
     * @param $name
     * @param array $usedNames
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    private function getUniqueIdentifier($name, array $usedIdentifiers)
    {
        $id = self::camelCase($name);
        if (isset($usedIdentifiers[$id])) {
            $counter = 2;
            while (isset($usedIdentifiers[$id.'_'.$counter])) {
                ++$counter;
            }

            return $id.'_'.$counter;
        } else {
            return $id;
        }
    }

    public function generateDao($fields, $namespace, $className, $daoClassName, $moduleName, $targetDirectory, $moduleSingular, $modulePlural)
    {
        //        if (class_exists($namespace."\\".$className)) {

//            $class = PhpClass::fromReflection(new \ReflectionClass($namespace."\\".$daoClassName));
//        } else {
            $class = PhpClass::create();
//        }

        $class->setName($daoClassName)
            ->setNamespace($namespace)
            ->setParentClassName('\\Wabel\\Zoho\\CRM\\AbstractZohoDao');

        $usedIdentifiers = [];

        foreach ($fields as $key => $fieldCategory) {
            foreach ($fieldCategory as $name => $field) {
                $type = $field['type'];

                switch ($type) {

                    case 'DateTime':
                    case 'Date':
                        $phpType = '\\DateTime';
                        break;
                    case 'Boolean':
                        $phpType = 'bool';
                        break;
                    case 'Integer':
                        $phpType = 'int';
                        break;
                    default:
                        $phpType = 'string';
                        break;
                }

                $fields[$key][$name]['phpType'] = $phpType;
                $identifier = $this->getUniqueIdentifier($name, $usedIdentifiers);
                $usedIdentifiers[$identifier] = true;
                $fields[$key][$name]['getter'] = 'get'.ucfirst($identifier);
                $fields[$key][$name]['setter'] = 'set'.ucfirst($identifier);
                $fields[$key][$name]['name'] = $identifier;

                $specialOwnerFieldsMapping = [
                    'Created By' => 'SMCREATORID',
                    'Modified By' =>'MODIFIEDBY',
                ];

                $specialDateFieldsMapping = [
                    'Created Time' => 'createdTime',
                    'Modified Time' =>'modifiedTime'
                ];
                //Detect Special Fields from Zoho - Using API, you cannot create or update these system-generated fields:
                $systemGenerated = false;
                if (isset($specialOwnerFieldsMapping[$field['label']]) || isset($specialDateFieldsMapping[$field['label']])){
                   $systemGenerated = true;
                }
                if($systemGenerated){
                    $dateSpecialField = false;
                    if (isset($specialOwnerFieldsMapping[$field['label']])) {
                        $name = $specialOwnerFieldsMapping[$field['label']];
                        $generateId = true;
                    }
                    if (isset($specialDateFieldsMapping[$field['label']])) {
                        $name = $specialDateFieldsMapping[$field['label']];
                        $generateId = true;
                        $dateSpecialField = true;
                    }
                    if ($generateId) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                        $fields[$key][$name]['req'] = false;
                        $fields[$key][$name]['type'] = !$dateSpecialField?'Lookup ID':'Date';
                        $fields[$key][$name]['isreadonly'] = !$dateSpecialField?true:false;
                        $fields[$key][$name]['maxlength'] = !$dateSpecialField?100:20;
                        $fields[$key][$name]['label'] = $name;
                        $fields[$key][$name]['dv'] = $name;
                        $fields[$key][$name]['customfield'] = true;
                        $fields[$key][$name]['phpType'] = !$dateSpecialField?$phpType:'\\DateTime';
                        $fields[$key][$name]['getter'] = 'get'.ucfirst(self::camelCase($name));
                        $fields[$key][$name]['setter'] = 'set'.ucfirst(self::camelCase($name));
                        $fields[$key][$name]['name'] = self::camelCase($name);
                    }
                }
                if ($type === 'Lookup') {
                    $generateId = false;

                    if ($field['customfield']) {
                        $name .= '_ID';
                        $generateId = true;
                    } elseif ($field['label'] === $moduleSingular.' Owner') {
                        // Check if this is a "owner" field.
                        $name = 'SMOWNERID';
                        $generateId = true;
                    } else {
                        $mapping = [
                            'Account Name' => 'ACCOUNTID',
                            'Contact Name' => 'CONTACTID',
                            'Parent Account' => 'PARENTACCOUNTID',
                            'Campaign Source' => 'CAMPAIGNID',
                        ];
                        if (isset($mapping[$field['label']])) {
                            $name = $mapping[$field['label']];
                            $generateId = true;
                        }
                    }
                    if ($generateId) {
                        $fields[$key][$name]['req'] = false;
                        $fields[$key][$name]['type'] = 'Lookup ID';
                        $fields[$key][$name]['isreadonly'] = true;
                        $fields[$key][$name]['maxlength'] = 100;
                        $fields[$key][$name]['label'] = $name;
                        $fields[$key][$name]['dv'] = $name;
                        $fields[$key][$name]['customfield'] = true;
                        $fields[$key][$name]['phpType'] = $phpType;
                        $fields[$key][$name]['getter'] = 'get'.ucfirst(self::camelCase($name));
                        $fields[$key][$name]['setter'] = 'set'.ucfirst(self::camelCase($name));
                        $fields[$key][$name]['name'] = self::camelCase($name);
                    }
                }
            }
        }

        $class->setMethod(PhpMethod::create('getModule')->setBody('return '.var_export($moduleName, true).';'));

        $class->setMethod(PhpMethod::create('getSingularModuleName')->setBody('return '.var_export($moduleSingular, true).';'));

        $class->setMethod(PhpMethod::create('getPluralModuleName')->setBody('return '.var_export($modulePlural, true).';'));

        $class->setMethod(PhpMethod::create('getFields')->setBody('return '.var_export($fields, true).';'));

        $class->setMethod(PhpMethod::create('getBeanClassName')->setBody('return '.var_export($namespace.'\\'.$className, true).';'));

        $generator = new CodeFileGenerator();
        $code = $generator->generate($class);

        if (!file_put_contents(rtrim($targetDirectory, '/').'/'.$daoClassName.'.php', $code)) {

            throw new ZohoCRMException("An error occurred while creating the DAO $daoClassName. Please verify the target directory exists or the rights of the file.");
        }
    }

    private static function camelCase($str, array $noStrip = [])
    {
        $str = self::upperCamelCase($str, $noStrip);
        $str = lcfirst($str);

        return $str;
    }

    private static function upperCamelCase($str, array $noStrip = [])
    {
        // non-alpha and non-numeric characters become spaces
        $str = preg_replace('/[^a-z0-9'.implode('', $noStrip).']+/i', ' ', $str);
        $str = trim($str);
        // uppercase the first character of each word
        $str = ucwords($str);
        $str = str_replace(' ', '', $str);

        return $str;
    }

    private static function registerProperty(PhpClass $class, $name, $description, $type, $nullable = false)
    {
        if (!$class->hasProperty($name)) {

            $property = PhpProperty::create($name);
            $property->setDescription($description);
            $property->setType($type);
            $property->setVisibility('protected');

            $class->setProperty($property);
        }

        $isDirtyName = 'dirty'.ucfirst($name);
        if (!$class->hasProperty($isDirtyName)) {

            $dirtyProperty = PhpProperty::create($isDirtyName);
            $dirtyProperty->setDescription("Whether '$name' has been changed or not.");
            $dirtyProperty->setType('bool');
            $dirtyProperty->setVisibility('protected');
            $dirtyProperty->setDefaultValue(false);


            $class->setProperty($dirtyProperty);
        }

        $getterName = 'get'.ucfirst($name);
        $getterDescription = 'Get '.lcfirst($description);
        $setterName = 'set'.ucfirst($name);
        $setterDescription = 'Set '.lcfirst($description);

        if (!$class->hasMethod($getterName)) {
            $method = PhpMethod::create($getterName);
            $method->setDescription($getterDescription);
            $method->setBody("return \$this->{$name};");
            $class->setMethod($method);
        }

        if (!$class->hasMethod($setterName)) {
            $method = PhpMethod::create($setterName);
            $method->setDescription($setterDescription);
            $parameter = PhpParameter::create($name)->setType($type);
            if ($nullable) {
                $parameter->setValue(null);
            }
            $method->addParameter($parameter);
            $method->setBody("\$this->{$name} = \${$name};\n".
                             '$this->dirty'.ucfirst($name)." = true;\n".
                             'return $this;');
            $class->setMethod($method);
        }
    }
}

1			<?php
2
3			namespace Wabel\Zoho\CRM\Service;
4
5			use gossi\codegen\generator\CodeFileGenerator;
6			use gossi\codegen\model\PhpClass;
7			use gossi\codegen\model\PhpMethod;
8			use gossi\codegen\model\PhpParameter;
9			use gossi\codegen\model\PhpProperty;
10			use Psr\Log\LoggerInterface;
11			use Wabel\Zoho\CRM\ZohoClient;
12			use Wabel\Zoho\CRM\Exception\ZohoCRMException;
13
14			/**
15			* This class is in charge of generating Zoho entities.
16			*/
17			class EntitiesGeneratorService
18			{
19			private $zohoClient;
20			private $logger;
21
22			public function __construct(ZohoClient $zohoClient, LoggerInterface $logger)
23			{
24			$this->zohoClient = $zohoClient;
25			$this->logger = $logger;
26			}
27
28			/**
29			* Generate ALL entities for all Zoho modules.
30			*
31			* @param string $targetDirectory
32			* @param string $namespace
33			*
34			* @return array Array containing each fully qualified dao class name
35			*/
36			public function generateAll($targetDirectory, $namespace)
37			{
38			$modules = $this->zohoClient->getModules();
39			$zohoModules = [];
40			foreach ($modules->getRecords() as $module) {
Wabel / zoho-crm-orm

Pull Request — 1.1 (#26)

EntitiesGeneratorService::generateDao() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity Many Parameters

Long Method

Many Parameters

Available Fixes

Duplication Side-by-Side

Filter issues like
