Eccube\Command\GeneratorCommand\AbstractPluginGenerator

Complexity

Total Complexity

73

Size/Duplication

Total Lines	480
Duplicated Lines	8.96 %

Coupling/Cohesion

Components	1
Dependencies	7

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
	getHeader()	0	1	?
	start()	0	1	?
	initFieldSet()	0	1	?
A	__construct()	0	5	1
A	init()	0	7	1
C	run()	0	43	8
A	exitGenerator()	0	4	1
D	makeLineRequest()	0	98	28
A	getNestingLevel()	0	4	1
A	setNestingLevel()	0	4	1
A	getPluginCodes()	0	15	2
B	generateEntities()	10	37	4
A	generateMigration()	5	16	3
B	makeMigration()	0	39	6
B	makeCreateParts()	0	40	6
A	makeDropParts()	0	9	2
D	completeMessage()	28	38	9

<?php

/*
 * This file is part of EC-CUBE
 *
 * Copyright(c) 2000-2015 LOCKON CO.,LTD. All Rights Reserved.
 *
 * http://www.lockon.co.jp/
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

namespace Eccube\Command\GeneratorCommand;

use Doctrine\Common\Inflector\Inflector;
use Doctrine\ORM\Mapping\ClassMetadataInfo;
use Doctrine\ORM\Tools\EntityGenerator;
use Doctrine\ORM\Tools\EntityRepositoryGenerator;
use Eccube\Application;
use Symfony\Component\Console\Question\Question;
use Symfony\Component\Finder\Finder;

abstract class AbstractPluginGenerator

Missing class doc comment

{

    const DEFAULT_NESTING_LEVEL = 100;
    const NEW_HOOK_VERSION = '3.0.9';
    const STOP_PROCESS = 'quit';
    const INPUT_OPEN = '[';
    const INPUT_CLOSE = ']';
    const PLUGIN_PREFIX = 'plg_';

    /**
     * app
     *
     * @var \Eccube\Application
     */
    protected $app;

    /**
     * QuestionHelper
     *
     * @var \Symfony\Component\Console\Helper\QuestionHelper
     */
    protected $dialog;

    /**
     * InputInterface
     *
     * @var \Symfony\Component\Console\Input\InputInterface
     */
    protected $input;

    /**
     * InputInterface
     *
     * @var \Symfony\Component\Console\Output\OutputInterface
     */
    protected $output;

    /**
     * $paramList
     * @var array $paramList
     */
    protected $paramList;

    /**
     *
     * @var int
     */
    private $nestingLevel;

    /**
     * ヘッダー
     */
    abstract protected function getHeader();

    /**
     * start()
     */
    abstract protected function start();

    /**
     * フィルドーセット
     */
    abstract protected function initFieldSet();

    public function __construct(Application $app)

Missing function doc comment

    {
        $this->app = $app;
        $this->nestingLevel = self::DEFAULT_NESTING_LEVEL;
    }

    /**
     *
     * @param \Symfony\Component\Console\Helper\QuestionHelper $dialog

Expected 2 spaces after parameter type; 1 found

     * @param \Symfony\Component\Console\Input\InputInterface $input

Expected 3 spaces after parameter type; 1 found

     * @param \Symfony\Component\Console\Output\OutputInterface $output
     */
    public function init($dialog, $input, $output)

Declare public methods first, then protected ones and finally private ones

    {
        $this->dialog = $dialog;
        $this->input = $input;
        $this->output = $output;
        $this->initFieldSet();
    }

    public function run()

Missing function doc comment

    {
        // ヘッダー部分
        $this->getHeader();

        foreach ($this->paramList as $paramKey => $params) {
            $value = $this->makeLineRequest($params);
            if ($value === false) {
                $this->exitGenerator();

                return;
            }
            $this->paramList[$paramKey]['value'] = $value;
        }

        $this->output->writeln('');
        $this->output->writeln('---Entry confirmation');
        foreach ($this->paramList as $paramKey => $params) {
            if (is_array($params['value'])) {
                $this->output->writeln($params['label']);
                foreach ($params['value'] as $keys => $val) {
                    $this->output->writeln('<info>  '.$keys.'</info>');
                }
            } else {
                if (isset($params['show'])) {
                    $disp = $params['show'][$params['value']];
                } else {
                    $disp = $params['value'];
                }
                $this->output->writeln($params['label'].' <info>'.$disp.'</info>');
            }
        }
        $this->output->writeln('');
        $Question = new Question('<comment>[confirm] Do you want to proceed? [y/n] : </comment>', '');
        $value = $this->dialog->ask($this->input, $this->output, $Question);
        if ($value != 'y') {
            $this->exitGenerator();

            return;
        }

        $this->start();
    }

    protected function exitGenerator($msg = 'Quitting Bye bye.')
    {
        $this->output->writeln($msg);
    }

    protected function makeLineRequest($params)
    {
        // nesting loop protection
        if ($this->getNestingLevel() < 0) {
            rewind($this->output->getStream());

It seems like you code against a concrete implementation and not the interface Symfony\Component\Console\Output\OutputInterface as the method getStream() does only exist in the following implementations of said interface: Symfony\Component\Console\Output\ConsoleOutput, Symfony\Component\Console\Output\StreamOutput.

            $display = stream_get_contents($this->output->getStream());

It seems like you code against a concrete implementation and not the interface Symfony\Component\Console\Output\OutputInterface as the method getStream() does only exist in the following implementations of said interface: Symfony\Component\Console\Output\ConsoleOutput, Symfony\Component\Console\Output\StreamOutput.

            throw new \Exception($display);
        }
        $this->nestingLevel--;

        $this->output->writeln($params['name']);
        $Question = new Question('<comment>Input'.self::INPUT_OPEN.$params['no'].self::INPUT_CLOSE.' : </comment>', '');
        $value = $this->dialog->ask($this->input, $this->output, $Question);
        $value = trim($value);
        if ($value === self::STOP_PROCESS) {
            return false;
        }
        foreach ($params['validation'] as $key => $row) {

Blank line found at start of control structure

            if ($key == 'isRequired' && $row == true) {
                if ($value === '' || strlen($value) == 0) {

Blank line found at start of control structure

                    $this->output->writeln('[!] Value cannot be empty.');

                    return $this->makeLineRequest($params);
                }
            } elseif ($key == 'pattern' && preg_match($row, $value) == false) {

It seems like you are loosely comparing preg_match($row, $value) of type integer to the boolean false. If you are specifically checking for 0, consider using something more explicit like === 0 instead.

                $this->output->writeln('<error>[!] Value is not valid.</error>');

                return $this->makeLineRequest($params);
            } elseif ($key == 'isCode') {

Blank line found at start of control structure

                if (in_array($value, $row)) {
                    $this->output->writeln('<error>[!] Plugin with this code already exists.</error>');

                    return $this->makeLineRequest($params);
                }
            } elseif ($key == 'isNotCode') {

Blank line found at start of control structure

                if (!in_array($value, $row)) {
                    $this->output->writeln('<error>[!] This plugin code does not exist.</error>');

                    return $this->makeLineRequest($params);
                }

Blank line found at end of control structure

            } elseif ($key == 'inArray' || $key == 'choice') {

Blank line found at start of control structure

                if (is_string($row)) {
                    $row = $this->$row();
                }
                if ($value == '') {
                    return $params['value'];
                }
                if (isset($row[$value])) {
                    if (!is_array($params['value'])) {
                        $value = $row[$value];
                        continue;
                    }
                    $params['value'][$value] = $row[$value];
                    $this->output->writeln('<info>--- your entry list</info>');
                    foreach ($params['value'] as $subKey => $node) {
                        $this->output->writeln('<info> - '.$subKey.'</info>');
                    }
                    $this->output->writeln('');
                    $this->output->writeln('--- Press Enter to move to the next step ---');

                    return $this->makeLineRequest($params);
                } else {
                    $searchList = array();
                    $max = 16;
                    foreach ($row as $eventKey => $eventConst) {
                        if (strpos($eventKey, $value) !== false || strpos($eventConst, $value) !== false) {
                            if (count($searchList) >= $max) {
                                $searchList['-- there are more then '.$max.''] = '';
                                break;
                            }
                            $searchList[$eventKey] = $eventConst;
                        }
                    }
                    $this->output->writeln('<error>[!] No results have been found</error>');
                    if (!empty($searchList)) {
                        $this->output->writeln('--- there are more then one search result');
                    }
                    foreach ($searchList as $subKey => $node) {
                        $this->output->writeln(' - '.$subKey);
                    }

                    if (!empty($searchList)) {
                        $this->output->writeln('');
                    }

                    return $this->makeLineRequest($params);
                }
            }
        }

        return $value;
    }

    protected function getNestingLevel()
    {
        return $this->nestingLevel;
    }

    protected function setNestingLevel($nestingLevel)
    {
        $this->nestingLevel = $nestingLevel;
    }


    /**
     * app/Plugin直下にあるディレクトリ名(プラグインコード)を取得
     *
     * @return array
     */
    protected function getPluginCodes()
    {
        $finder = new Finder();

        $finder->directories()->depth('== 0');

        $dirs = $finder->in($this->app['config']['root_dir'].'/app/Plugin/');

        $codes = array();
        foreach ($dirs as $item) {
            $codes[] = $item->getRelativePathname();
        }

        return $codes;
    }

    /**
     * Entity、Repositoryファイルの作成
     *
     * @param array $metadatas
     * @param array $fsList
     */
    protected function generateEntities(array $metadatas, array &$fsList)
    {
        /** @var ClassMetadataInfo $class */
        foreach ($metadatas as $class) {

Blank line found at start of control structure

            // Entity作成
            $EntityGenerator = new EntityGenerator();
            $EntityGenerator->setBackupExisting(false);
            $EntityGenerator->setClassToExtend('Eccube\\Entity\\AbstractEntity');
            $EntityGenerator->setGenerateAnnotations(false);
            $EntityGenerator->setRegenerateEntityIfExists(true);
            $EntityGenerator->setGenerateStubMethods(true);
            $EntityGenerator->setUpdateEntityIfExists(false);

            $appPath = $this->app['config']['root_dir'].'/app/';
            $EntityGenerator->generate(array($class), $appPath);

            $filename = $appPath.str_replace('\\', DIRECTORY_SEPARATOR, $class->name).'.php';
            if (is_file($filename)) {
                $fsList['file'][$filename] = true;
            } else {
                $fsList['file'][$filename] = false;
            }

            // Repository作成
            $RepositoryGenerator = new EntityRepositoryGenerator();
            $RepositoryGenerator->writeEntityRepositoryClass($class->customRepositoryClassName, $appPath);

            $filename = $appPath.str_replace('\\', DIRECTORY_SEPARATOR, $class->customRepositoryClassName).'.php';
            if (is_file($filename)) {
                $fsList['file'][$filename] = true;
            } else {
                $fsList['file'][$filename] = false;
            }
        }

    }


    /**
     * migraionファイルの作成
     *
     * @param array $metadatas
     * @param array $fsList
     * @param $pluginCode
     * @param $codePath
     */
    protected function generateMigration(array $metadatas, array &$fsList = array(), $pluginCode, $codePath)

Parameters which have default values should be placed at the end.

    {
        if (count($metadatas)) {
            $migrationContent = $this->makeMigration($pluginCode, $metadatas);
            $date = date('YmdHis');
            $migrationContent = str_replace('[datetime]', $date, $migrationContent);
            $migPath = $codePath.'/Resource/doctrine/migration/Version'.$date.'.php';

            file_put_contents($migPath, $migrationContent);
            if (is_file($migPath)) {
                $fsList['file'][$migPath] = true;
            } else {
                $fsList['file'][$migPath] = false;
            }
        }
    }


    /**
     * migrationファイルの作成
     *
     * @param $pluginCode
     * @param array $metadatas
     * @return mixed|string
     */
    protected function makeMigration($pluginCode, array $metadatas)
    {
        if ($this->paramList['supportFlag']['value']) {
            $migrationFileCont = file_get_contents($this->app['config']['root_dir'].'/src/Eccube/Command/GeneratorCommand/generatortemplate/MigrationVersionSupport.php');
        } else {
            $migrationFileCont = file_get_contents($this->app['config']['root_dir'].'/src/Eccube/Command/GeneratorCommand/generatortemplate/MigrationVersion.php');
        }

        $migrationFileCont = str_replace('[code]', $pluginCode, $migrationFileCont);

        $entityList = array();
        foreach ($metadatas as $metadata) {
            $entityList[] = '        \''.$metadata->name.'\'';
        }

        $entityListStr = join(','.PHP_EOL, $entityList);
        $migrationFileCont = str_replace('[entityList]', $entityListStr, $migrationFileCont);
        if ($this->paramList['supportFlag']['value']) {
            $createParts = $this->makeCreateParts($metadatas);
            $tableNameArr = array();
            foreach ($createParts as $tableName => $tableArr) {
                $tableNameArr[] = '            $this->createTable'.$tableName.'($schema);';
            }
            $tableNameStr = join(PHP_EOL, $tableNameArr);
            $migrationFileCont = str_replace('[createTable]', $tableNameStr, $migrationFileCont);

            $createPartsStr = '';
            foreach ($createParts as $parts) {
                $createPartsStr .= join(PHP_EOL, $parts);
            }
            $migrationFileCont = str_replace('[createFunction]', $createPartsStr, $migrationFileCont);

            $dropParts = $this->makeDropParts($metadatas);
            $dropPartsStr = join(PHP_EOL, $dropParts);
            $migrationFileCont = str_replace('[dropTable]', $dropPartsStr, $migrationFileCont);
        }

        return $migrationFileCont;
    }


    protected function makeCreateParts($metadatas)
    {
        $ret = array();
        foreach ($metadatas as $metadata) {

Blank line found at start of control structure

            $nameFormated = Inflector::camelize($metadata->table['name']);
            $tmp = array();
            $tmp[] = '';
            $tmp[] = '    /**';
            $tmp[] = '     * @param Schema $schema';
            $tmp[] = '     */';
            $tmp[] = '    public function createTable'.ucfirst($nameFormated).'(Schema $schema)';
            $tmp[] = '    {';
            $tmp[] = '        $table = $schema->createTable(\''.$metadata->table['name'].'\');';
            $columns = $metadata->fieldMappings;
            foreach ($columns as $column) {

Blank line found at start of control structure

                $typeName = $column['type'];
                $tmp[] = '        $table->addColumn(\''.$column['columnName'].'\', \''.$typeName.'\', array(';
                $param = array();
                if (isset($column['nullable']) && $column['nullable']) {
                    $param['notnull'] = 'true';
                } else {
                    $param['notnull'] = 'false';
                }

                foreach ($param as $parKey => $parVal) {
                    $tmp[] = '            \''.$parKey.'\' => '.$parVal.',';
                }
                $tmp[] = '        ));';
            }


            $tmp[] = '    }';
            $tmp[] = '';
            $ret[ucfirst($nameFormated)] = $tmp;
        }

        return $ret;
    }

    protected function makeDropParts($metadatas)
    {
        $ret = array();
        foreach ($metadatas as $metadata) {
            $ret[] = '            $schema->dropTable(\''.$metadata->table['name'].'\');';
        }

        return $ret;
    }


    /**
     * メッセージ表示
     *
     * @param array $fsList
     */
    protected function completeMessage(array $fsList)
    {

        $dirFileNg = array();
        $dirFileOk = array();
        foreach ($fsList['dir'] as $path => $flag) {
            if ($flag) {
                $dirFileOk[] = $path;
            } else {
                $dirFileNg[] = $path;
            }
        }
        foreach ($fsList['file'] as $path => $flag) {
            if ($flag) {
                $dirFileOk[] = $path;
            } else {
                $dirFileNg[] = $path;
            }
        }
        $this->output->writeln('');
        $this->output->writeln('[+]File system');
        if (!empty($dirFileOk)) {
            $this->output->writeln('');
            $this->output->writeln(' this files and folders were created.');
            foreach ($dirFileOk as $path) {
                $this->output->writeln('<info> - '.$path.'</info>');
            }
        }

        if (!empty($dirFileNg)) {
            $this->output->writeln('');
            $this->output->writeln(' this files and folders was not created.');
            foreach ($dirFileOk as $path) {
                $this->output->writeln('<error> - '.$path.'</error>');
            }
        }

    }
}