PluginGenerator::createFilesAndFolders() - Code Metrics - Inspection of "Merge pull request #1915 from trebla-on/cmd_line_p..." - EC-CUBE/ec-cube - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions
Push — master ( 27ab61...b61ce7 )

by Yangsin
created 2016-12-19 00:50 UTC
PluginGenerator::createFilesAndFolders() F

↳ Parent: PluginGenerator
Complexity

Conditions	34
Paths	> 20000
Size

Total Lines	304
Code Lines	220
Duplication

Lines	113
Ratio	37.17 %
Importance

Changes
Metric	Value
cc	34
eloc	220
c	0
b	0
f	0
nc	141557760
nop	2
dl	113
loc	304
rs	2
How to fix Long Method Complexity

<?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\PluginCommand;

use Eccube\Common\Constant;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Yaml\Yaml;
use Eccube\Entity\Plugin;
use Eccube\Entity\PluginEventHandler;
use Eccube\Command\PluginCommand\AbstractPluginGenerator;

class PluginGenerator extends AbstractPluginGenerator

{

    /**
     *
     * @var array
     */
    private $hookPoints = null;

    /**
     *
     * @var array
     */
    private $events = null;

    protected function getHeader()

    {
        $this->output->writeln('------------------------------------------------------');
        $this->output->writeln('---Plugin Generator');
        $this->output->writeln('---[*]You can exit from Console Application, by typing ' . self::STOP_PROCESS . ' instead of typing another word.');

        $this->output->writeln('------------------------------------------------------');
        $this->output->writeln('');
    }

    protected function initFildset()
    {
        $this->paramList = array(

            'pluginName' => array(

                'no' => 1,
                'label' => '[+]Plugin Name: ',
                'value' => null,
                'name' => '[+]Please enter Plugin Name',
                'validation' => array(
                    'isRequired' => true,
                )
            ),
            'pluginCode' => array(

                'no' => 2,
                'label' => '[+]Plugin Code: ',
                'value' => null,
                'name' => '[+]Please enter Plugin Name (only pascal case letters numbers are allowed)',
                'validation' => array(

                    'isRequired' => true,
                    'patern' => '/^[A-Z][0-9a-zA-Z]*$/'
                )
            ),
            'version' => array(

                'no' => 3,
                'label' => '[+]Version: ',
                'value' => null,
                'name' => '[+]Please enter version (correct format is x.y.z)',
                'validation' => array(

                    'isRequired' => true,
                    'patern' => '/^\d+.\d+.\d+$/'
                )
            ),
            'author' => array(

                'no' => 4,
                'label' => '[+]Author: ',
                'value' => null,
                'name' => '[+]Please enter author name or company',
                'validation' => array(
                    'isRequired' => true,
                )
            ),
            'supportFlag' => array(

                'no' => 5,
                'label' => '[+]Old version support: ',
                'value' => null,
                'name' => '[+]Do you want to support old versions too? [y/n]',
                'show' => array(1 => 'Yes' ,0 => 'No'),

                'validation' => array(

                    'isRequired' => true,
                    'choice' => array('y' => 1, 'n' => 0)
                )
            ),
            'events' => array(

                'no' => 6,
                'label' => '[+]Site events: ',
                'value' => array(),
                'name' => '[+]Please enter site events(you can find documentation here http://www.ec-cube.net/plugin/)',
                'validation' => array(

                    'isRequired' => false,
                    'inArray' => 'getEvents'
                )
            ),
            'hookPoints' => array(

                'no' => 7,
                'label' => '[+]Hook points: ',
                'value' => array(),
                'name' => '[+]Please enter hook point, sample：front.cart.up.initialize',
                'validation' => array(

                    'isRequired' => false,
                    'inArray' => $this->getHookPoints()
                )
            )
        );
    }

    private function getHookPoints()
    {
        if ($this->hookPoints === null) {
            $Ref = new \ReflectionClass('\Eccube\Event\EccubeEvents');
            $this->hookPoints = array_flip($Ref->getConstants());
        }
        return $this->hookPoints;

    }

    protected function getEvents()

    {
        if (!isset($this->paramList['supportFlag']['value'])) {
            return array();
        }
        if ($this->events === null) {
            $this->events = array();
            $routeEvents = array();
            if ($this->paramList['supportFlag']['value']) {
                $this->events = include $this->app['config']['root_dir'] . '/src/Eccube/Command/PluginCommand/Resource/eventsList.php';

                $routeEvents['eccube.event.controller.__route__.before'] = 'Controller__route__Before';
                $routeEvents['eccube.event.controller.__route__.after'] = 'Controller__route__After';
                $routeEvents['eccube.event.controller.__route__.finish'] = 'Controller__route__Finish';
                $routeEvents['eccube.event.render.__route__.before'] = 'Render__route__Before';
            }
            $this->events += include $this->app['config']['root_dir'] . '/src/Eccube/Command/PluginCommand/Resource/eventsListNew.php';


            $routeEvents['eccube.event.route.__route__.request'] = 'Route__route__Request';
            $routeEvents['eccube.event.route.__route__.controller'] = 'Route__route__Controller';
            $routeEvents['eccube.event.route.__route__.response'] = 'Route__route__Response';
            $routeEvents['eccube.event.route.__route__.exception'] = 'Route__route__Exception';
            $routeEvents['eccube.event.route.__route__.terminate'] = 'Route__route__Terminate';
            $allRoutes = array();

            $controllers = $this->app['controllers'];
            $collection = $controllers->flush();
            foreach ($collection as $eventName => $dummy) {
                $allRoutes[] = $eventName;
            }

            $routes = $this->app['routes']->all();

            foreach ($routes as $eventName => $dummy) {
                $allRoutes[] = $eventName;
            }

            foreach ($allRoutes as $eventName) {
                $eventOnFunc = join(array_map('ucfirst', explode('_', strtolower($eventName))));

                foreach ($routeEvents as $keys => $node) {
                    $this->events[str_replace('__route__', $eventName, $keys)] = str_replace('__route__', $eventOnFunc, $node);
                }
            }
        }

        return $this->events;
    }

    protected function start()
    {
        $pluginCode = $this->paramList['pluginCode']['value'];

        $Plugin = $this->app['eccube.repository.plugin']->findOneBy(array('code' => $pluginCode));
        if ($Plugin) {
            $this->exitGenerator('<error>Plugin with this name already exists</error>');
            return;

        }
        $this->createFilesAndFolders($pluginCode, $this->paramList);
        $this->createDbRecords($pluginCode, $this->paramList);
        $this->exitGenerator('Plugin was created successfully');
    }

    private function createFilesAndFolders($code, $paramList)
    {
        $fsList = array(
            'dir' => array(),
            'file' => array(),
        );

        // config.ymlを作成
        $config = array();
        $config['name'] = $paramList['pluginName']['value'];
        $config['code'] = $code;
        $config['version'] = $paramList['version']['value'];
        if (!empty($paramList['hookPoints']['value'])) {
            $config['event'] = $code . 'Event';

        }
        $config['service'] = array($code . 'ServiceProvider');


        $codePath = $this->app['config']['root_dir'] . '/app/Plugin/' . $code;


        $file = new Filesystem();
        $file->mkdir($codePath);
        if (is_dir($codePath)) {
            $fsList['dir'][$codePath] = true;
        } else {
            $fsList['dir'][$codePath] = false;
        }

        $srcPath = $codePath . '/config.yml';

        file_put_contents($srcPath, Yaml::dump($config));
        if (is_file($srcPath)) {

            $fsList['file'][$srcPath] = true;
        } else {
            $fsList['file'][$srcPath] = false;
        }

        $author = $paramList['pluginName']['value'];
        $year = date('Y');

        // PluginManager
        $pluginFileBefore = file_get_contents($this->app['config']['root_dir'] . '/src/Eccube/Command/PluginCommand/Resource/PluginManager.php');

        $from = '/\[code\]/';
        $pluginFileAfter = preg_replace($from, $code, $pluginFileBefore);
        $from = '/\[author\]/';
        $pluginFileAfter = preg_replace($from, $author, $pluginFileAfter);
        $from = '/\[year\]/';
        $pluginFileAfter = preg_replace($from, $year, $pluginFileAfter);

        $srcPath = $codePath . '/PluginManager.php';

        file_put_contents($srcPath, $pluginFileAfter);
        if (is_file($srcPath)) {

            $fsList['file'][$srcPath] = true;
        } else {
            $fsList['file'][$srcPath] = false;
        }

        // ServiceProvider
        $pluginFileBefore = file_get_contents($this->app['config']['root_dir'] . '/src/Eccube/Command/PluginCommand/Resource/ServiceProvider.php');

        $from = '/\[code\]/';
        $pluginFileAfter = preg_replace($from, $code, $pluginFileBefore);
        $from = '/\[author\]/';
        $pluginFileAfter = preg_replace($from, $author, $pluginFileAfter);
        $from = '/\[year\]/';
        $pluginFileAfter = preg_replace($from, $year, $pluginFileAfter);

        $file->mkdir($codePath . '/ServiceProvider');

        if (is_dir($codePath . '/ServiceProvider')) {

            $fsList['dir'][$codePath . '/ServiceProvider'] = true;

        } else {
            $fsList['dir'][$codePath . '/ServiceProvider'] = false;

        }

        $srcPath = $codePath . '/ServiceProvider/' . $code . 'ServiceProvider.php';

        file_put_contents($srcPath, $pluginFileAfter);
        if (is_file($srcPath)) {

            $fsList['file'][$srcPath] = true;
        } else {
            $fsList['file'][$srcPath] = false;
        }

        // ConfigController
        $pluginFileBefore = file_get_contents($this->app['config']['root_dir'] . '/src/Eccube/Command/PluginCommand/Resource/ConfigController.php');

        $from = '/\[code\]/';
        $pluginFileAfter = preg_replace($from, $code, $pluginFileBefore);
        $from = '/\[author\]/';
        $pluginFileAfter = preg_replace($from, $author, $pluginFileAfter);
        $from = '/\[year\]/';
        $pluginFileAfter = preg_replace($from, $year, $pluginFileAfter);
        $from = '/\[code_name\]/';
        $pluginFileAfter = preg_replace($from, mb_strtolower($code), $pluginFileAfter);

        $file->mkdir($codePath . '/Controller');

        if (is_dir($codePath . '/Controller')) {

            $fsList['dir'][$codePath . '/Controller'] = true;

        } else {
            $fsList['dir'][$codePath . '/Controller'] = false;

        }

        $srcPath = $codePath . '/Controller/ConfigController.php';

        file_put_contents($srcPath, $pluginFileAfter);
        if (is_file($srcPath)) {

            $fsList['file'][$srcPath] = true;
        } else {
            $fsList['file'][$srcPath] = false;
        }

        // Controller
        $pluginFileBefore = file_get_contents($this->app['config']['root_dir'] . '/src/Eccube/Command/PluginCommand/Resource/Controller.php');

        $from = '/\[code\]/';
        $pluginFileAfter = preg_replace($from, $code, $pluginFileBefore);
        $from = '/\[author\]/';
        $pluginFileAfter = preg_replace($from, $author, $pluginFileAfter);
        $from = '/\[year\]/';
        $pluginFileAfter = preg_replace($from, $year, $pluginFileAfter);
        $from = '/\[code_name\]/';
        $pluginFileAfter = preg_replace($from, mb_strtolower($code), $pluginFileAfter);

        $srcPath = $codePath . '/Controller/' . $code . 'Controller.php';

        file_put_contents($srcPath, $pluginFileAfter);
        if (is_file($srcPath)) {

            $fsList['file'][$srcPath] = true;
        } else {
            $fsList['file'][$srcPath] = false;
        }

        // Form
        $pluginFileBefore = file_get_contents($this->app['config']['root_dir'] . '/src/Eccube/Command/PluginCommand/Resource/ConfigType.php');

        $from = '/\[code\]/';
        $pluginFileAfter = preg_replace($from, $code, $pluginFileBefore);
        $from = '/\[author\]/';
        $pluginFileAfter = preg_replace($from, $author, $pluginFileAfter);
        $from = '/\[year\]/';
        $pluginFileAfter = preg_replace($from, $year, $pluginFileAfter);
        $from = '/\[code_name\]/';
        $pluginFileAfter = preg_replace($from, mb_strtolower($code), $pluginFileAfter);

        $file->mkdir($codePath . '/Form/Type');

        if (is_dir($codePath . '/Form/Type')) {

            $fsList['dir'][$codePath . '/Form/Type'] = true;

        } else {
            $fsList['dir'][$codePath . '/Form/Type'] = false;

        }

        $srcPath = $codePath . '/Form/Type/' . $code . 'ConfigType.php';

        file_put_contents($codePath . '/Form/Type/' . $code . 'ConfigType.php', $pluginFileAfter);

        if (is_file($srcPath)) {

            $fsList['file'][$srcPath] = true;
        } else {
            $fsList['file'][$srcPath] = false;
        }

        // Twig
        $pluginFileBefore = file_get_contents($this->app['config']['root_dir'] . '/src/Eccube/Command/PluginCommand/Resource/config.twig');

        $from = '/\[code\]/';
        $pluginFileAfter = preg_replace($from, $code, $pluginFileBefore);

        $file->mkdir($codePath . '/Resource/template/admin');

        if (is_dir($codePath . '/Resource/template/admin')) {

            $fsList['dir'][$codePath . '/Resource/template/admin'] = true;

        } else {
            $fsList['dir'][$codePath . '/Resource/template/admin'] = false;

        }

        $srcPath = $codePath . '/Resource/template/admin/config.twig';

        file_put_contents($srcPath, $pluginFileAfter);
        if (is_file($srcPath)) {

            $fsList['file'][$srcPath] = true;
        } else {
            $fsList['file'][$srcPath] = false;
        }

        // index.twig
        $pluginFileBefore = file_get_contents($this->app['config']['root_dir'] . '/src/Eccube/Command/PluginCommand/Resource/index.twig');

        $from = '/\[code\]/';
        $pluginFileAfter = preg_replace($from, $code, $pluginFileBefore);

        $file->mkdir($codePath . '/Resource/template/admin');

        if (is_dir($codePath . '/Resource/template/admin')) {

            $fsList['dir'][$codePath . '/Resource/template/admin'] = true;

        } else {
            $fsList['dir'][$codePath . '/Resource/template/admin'] = false;

        }

        $srcPath = $codePath . '/Resource/template/index.twig';

        file_put_contents($srcPath, $pluginFileAfter);
        if (is_file($srcPath)) {

            $fsList['file'][$srcPath] = true;
        } else {
            $fsList['file'][$srcPath] = false;
        }

        $onFunctions = array();
        $onEvents = array();

        //イベント
        $events = $paramList['events']['value'];
        if (count($events) > 0) {
            foreach ($events as $eventKey => $eventConst) {
                $onEvents[$eventKey] = array(array('on' . $eventConst . ', NORMAL'));

                $onFunctions[] = 'on' . $eventConst;

            }
        }

        //フックポイント
        $hookPoints = $paramList['hookPoints']['value'];
        if (count($hookPoints)) {
            foreach ($hookPoints as $hookKey => $hookConst) {
                $onName = 'on' . join(array_map('ucfirst', explode('_', strtolower($hookConst))));

                $onEvents[$hookKey] = array(array($onName . ', NORMAL'));

                $onFunctions[] = $onName;
            }
        }

        if (count($onEvents)) {
            $srcPath = $codePath . '/event.yml';

            file_put_contents($srcPath, str_replace('\'', '', Yaml::dump($onEvents)));
            if (is_file($srcPath)) {

                $fsList['file'][$srcPath] = true;
            } else {
                $fsList['file'][$srcPath] = false;
            }

            $pluginFileBefore = file_get_contents($this->app['config']['root_dir'] . '/src/Eccube/Command/PluginCommand/Resource/EventHookpoint2.php');


            // Event
            $from = '/\[code\]/';
            $pluginFileAfter = preg_replace($from, $code, $pluginFileBefore);
            $from = '/\[author\]/';
            $pluginFileAfter = preg_replace($from, $author, $pluginFileAfter);
            $from = '/\[year\]/';
            $pluginFileAfter = preg_replace($from, $year, $pluginFileAfter);

            $functions = '';
            foreach ($onFunctions as $functionName) {
                $functions .= "    public function " . $functionName . "(EventArgs \$event)\n    {\n    }\n\n";

            }
            $from = '/\[hookpoint_function\]/';
            $pluginFileAfter = preg_replace($from, $functions, $pluginFileAfter);
            $srcPath = $codePath . '/' . $code . 'Event.php';

            file_put_contents($srcPath, $pluginFileAfter);
            if (is_file($srcPath)) {

                $fsList['file'][$srcPath] = true;
            } else {
                $fsList['file'][$srcPath] = false;
            }
        }

        // config.ymlを再作成
        $config = array();
        $config['name'] = $paramList['pluginName']['value'];
        $config['code'] = $code;
        $config['version'] = $paramList['version']['value'];
        $config['event'] = $code . 'Event';

        $config['service'] = array($code . 'ServiceProvider');

        $srcPath = $codePath . '/config.yml';

        file_put_contents($srcPath, Yaml::dump($config));
        if (is_file($srcPath)) {

            $fsList['file'][$srcPath] = true;
        } else {
            $fsList['file'][$srcPath] = false;
        }

        // LICENSE
        $srcPath = $codePath . '/LICENSE';

        $file->copy($this->app['config']['root_dir'] . '/src/Eccube/Command/PluginCommand/Resource/LICENSE', $srcPath);

        if (is_file($srcPath)) {

            $fsList['file'][$srcPath] = true;
        } else {
            $fsList['file'][$srcPath] = false;
        }

        $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>');

            }
        }
    }

    private function createDbRecords($code, $paramList)
    {
        // DB登録
        $Plugin = new Plugin();
        $Plugin->setName($paramList['pluginName']['value']);
        $Plugin->setCode($code);
        $Plugin->setClassName('');
        $Plugin->setVersion($paramList['version']['value']);
        $Plugin->setEnable(Constant::DISABLED);
        $Plugin->setSource(0);
        $Plugin->setDelFlg(Constant::DISABLED);

        $this->app['orm.em']->persist($Plugin);
        $this->app['orm.em']->flush($Plugin);

        $this->output->writeln('');
        $this->output->writeln('[+]Database');
        if ($Plugin->getId()) {
            $this->output->writeln('<info> Plugin information was added to table [DB.Plugin] (id=' . $Plugin->getId() . ')</info>');

        } else {
            $this->output->writeln('<error> there was a problem inserting plugin information to table [DB.Plugin] (id=' . $Plugin->getId() . ')</error>');

        }

        $hookPoints = $paramList['hookPoints']['value'];
        if (empty($hookPoints)) {
            return;
        }

        $eventCount = 0;
        foreach ($hookPoints as $hookKey => $hookConst) {
            $PluginEventHandler = new PluginEventHandler();
            $functionName = 'on' . join(array_map('ucfirst', explode('_', strtolower($hookConst))));

            $PluginEventHandler->setPlugin($Plugin)
                ->setEvent($hookKey)
                ->setPriority($this->app['eccube.repository.plugin_event_handler']->calcNewPriority($hookKey, $functionName))
                ->setHandler($functionName)
                ->setHandlerType('NORMAL')
                ->setDelFlg(Constant::DISABLED);
            $this->app['orm.em']->persist($PluginEventHandler);
            $eventCount++;
        }
        $this->app['orm.em']->flush();
        if ($eventCount) {
            $this->output->writeln('');
            $this->output->writeln('<info> Plugin information was added to table [DB.PluginEventHandler] (inserts number=' . $eventCount . ') </info>');

        }
    }
}

1			<?php
2
3			/*
4			* This file is part of EC-CUBE
5			*
6			* Copyright(c) 2000-2015 LOCKON CO.,LTD. All Rights Reserved.
7			*
8			* http://www.lockon.co.jp/
9			*
10			* This program is free software; you can redistribute it and/or
11			* modify it under the terms of the GNU General Public License
12			* as published by the Free Software Foundation; either version 2
13			* of the License, or (at your option) any later version.
14			*
15			* This program is distributed in the hope that it will be useful,
16			* but WITHOUT ANY WARRANTY; without even the implied warranty of
17			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18			* GNU General Public License for more details.
19			*
20			* You should have received a copy of the GNU General Public License
21			* along with this program; if not, write to the Free Software
22			* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23			*/
24
25			namespace Eccube\Command\PluginCommand;
26
27			use Eccube\Common\Constant;
28			use Symfony\Component\Filesystem\Filesystem;
29			use Symfony\Component\Yaml\Yaml;
30			use Eccube\Entity\Plugin;
31			use Eccube\Entity\PluginEventHandler;
32			use Eccube\Command\PluginCommand\AbstractPluginGenerator;
33
34			class PluginGenerator extends AbstractPluginGenerator
			0 ignored issues – show introduced 2016-11-09 07:31 UTC by Report Bug Copy Issue Report Missing class doc comment Loading history...
35			{
36
37			/**
38			*
39			* @var array
EC-CUBE / ec-cube

Push — master ( 27ab61...b61ce7 )

PluginGenerator::createFilesAndFolders() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like
