SeederCommandController::resolveSeederClass() - Code Metrics - TildBJ/seeder - Measure and Improve Code Quality continuously with Scrutinizer

SeederCommandController::resolveSeederClass() A
last analyzed 2018-11-16 08:00 UTC

↳ Parent: SeederCommandController

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	3.3332

Importance

Changes

Metric	Value
dl	0
loc	11
ccs	4
cts	6
cp	0.6667
rs	9.9
c	0
b	0
f	0
cc	3
nc	4
nop	1
crap	3.3332

<?php
namespace TildBJ\Seeder\Command;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2016 Dennis Römmich <[email protected]>
 *
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project 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.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script 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.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use TildBJ\Seeder\Domain\Model\ColumnInterface;
use TildBJ\Seeder\Generator\MethodNameGenerator;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * SeederCommandController
 *
 * @author Dennis Römmich<[email protected]>
 * @copyright Copyright belongs to the respective authors
 * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3 or later
 */
class SeederCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandController
{
    /**
     * namespace
     *
     * @var string $namespace
     */
    protected $namespace = 'TildBJ\Seeder\Seeder';

    /**
     * path
     *
     * @var string $path
     */
    protected $path = 'seeder/Classes/Seeder/';

    /**
     * stub
     *
     * @var string $stub
     */
    protected $stub = 'seeder/Classes/Seeder/stubs/seeder.stub';

    /**
     * @var MethodNameGenerator
     */
    protected $methodNameGenerator;

    /**
     * @var \TildBJ\Seeder\Utility\OutputUtility
     * @inject
     */
    protected $outputUtility;

    public function __construct()
    {
        $faker = \TildBJ\Seeder\Factory\FakerFactory::createFaker();
        $this->methodNameGenerator = GeneralUtility::makeInstance(MethodNameGenerator::class, $faker);
    }

    /**
     * This command allows you to run predifined Seeds
     *
     * @param string $seed ClassName or Alias defined in $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['seeder']['alias'] of your seed
     * @return boolean
     */
    public function seedCommand($seed)

    {
        $class = $this->resolveSeederClass($seed);

        /** @var \TildBJ\Seeder\Seeder $seeder */
        $seeder = new $class;
        $seeder->run();
        $seeder->seed();

        return true;
    }

    /**
     * @param $tableName
     * @return array
     * @throws \Exception
     */
    protected function detectSeederInformations($tableName)
    {
        $informations = [];
        $faker = \TildBJ\Seeder\Factory\FakerFactory::createFaker();
        $table = \TildBJ\Seeder\Factory\TableFactory::createTable($tableName);

        /** @var ColumnInterface $column */
        foreach ($table->getColumns() as $column) {
            if (in_array($column->getName(), \TildBJ\Seeder\Provider\Faker::$skippedProvider)) {
                continue;
            }
            $provider = $faker->guessProviderName($column->getName());
            $informationClassName = 'TildBJ\\Seeder\\Information\\' . ucfirst(GeneralUtility::underscoredToLowerCamelCase($column->getName()) . 'Information');
            $relationInformationAvailable = false;
            if ($column->getName() !== 'abstract' && class_exists($informationClassName)) {
                $information = GeneralUtility::makeInstance($informationClassName);
            } elseif ($this->isRelation($column)) {
                $information = GeneralUtility::makeInstance(\TildBJ\Seeder\Information\RelationInformation::class);
                $relationInformationAvailable = true;
            } else {
                $information = GeneralUtility::makeInstance(\TildBJ\Seeder\Information\NullInformation::class);
                $information->setDefaultValue($provider);
            }
            if (!$information instanceof \TildBJ\Seeder\Information) {
                throw new \Exception($informationClassName . ' must implement ' . \TildBJ\Seeder\Information::class);
            }

            if ($this->isRelation($column) && $relationInformationAvailable) {
                $createNewSeeder = $this->askOrSelect($information->getQuestion([$column->getName()]), 'n');
                if (strtolower($createNewSeeder) === 'y' || strtolower($createNewSeeder) === 'yes' || $createNewSeeder == 1) {
                    $className = '';
                    while (!$className) {
                        $className = $this->outputUtility->ask('<fg=yellow>Please specify the required argument "--class-name" (<fg=green>' . $column->getForeignTable() . '</>):</> ');
                    }
                    $this->makeCommand($className, $column->getForeignTable());
                    $informations[$column->getName()] = '$this->call(' . $className . '::class)';
                }
            } else {
                switch ($information->getType()) {
                    case \TildBJ\Seeder\Information::INFORMATION_TYPE_ASK:

                        if (!is_null($response = $this->askOrSelect($information->getQuestion([$column->getName(), $provider]), $information->getDefaultValue()))) {
                            if ($this->methodNameGenerator->generate($response)) {
                                $informations[$column->getName()] = $this->methodNameGenerator->generate($response);
                            }
                        }
                        break;
                    case \TildBJ\Seeder\Information::INFORMATION_TYPE_SELECT:
                    case \TildBJ\Seeder\Information::INFORMATION_TYPE_SELECTMULTIPLE:

                        if (!is_null($response = $this->askOrSelect($information->getQuestion([$column->getName(), $provider]), $information->getDefaultValue(), $information->getChoices()))) {
                            if ($this->methodNameGenerator->generate($response)) {
                                $informations[$column->getName()] = $this->methodNameGenerator->generate($response);
                            }
                        }
                        break;
                    default:
                        if ($this->methodNameGenerator->generate($column->getName())) {
                            $informations[$column->getName()] = $this->methodNameGenerator->generate($column->getName());
                        }
                }
            }
        }

        if (!isset($informations['pid'])) {
            /** @var \TildBJ\Seeder\Information $information */
            $information = GeneralUtility::makeInstance(\TildBJ\Seeder\Information\PidInformation::class);
            $informations['pid'] = $this->outputUtility->ask($information->getQuestion(), $information->getDefaultValue());
        }

        return $informations;
    }

    /**
     * @param ColumnInterface $column
     * @return bool
     */
    protected function isRelation(ColumnInterface $column)
    {
        return (
        (
            $column instanceof \TildBJ\Seeder\Domain\Model\Column\Select ||
            $column instanceof \TildBJ\Seeder\Domain\Model\Column\Inline ||
            $column instanceof \TildBJ\Seeder\Domain\Model\Column\Group
        ) &&
            $column->getForeignTable()
        );
    }

    /**
     * @param $question
     * @param $defaultValue
     * @param null $choices
     * @return array|int|string
     */
    protected function askOrSelect($question, $defaultValue, $choices = null)
    {
        if (is_null($choices)) {
            return $this->outputUtility->ask($question, $defaultValue);
        }
        return $this->outputUtility->select($question, $choices, $defaultValue);
    }

    /**
     * This command allows you to create new Seeds.
     *
     * @param string $className
     * @param string $tableName
     * @return boolean
     */
    public function makeCommand($className, $tableName)

    {
        $class = $this->namespace . '\\' . $className;

        if (class_exists($class)) {
            throw new \InvalidArgumentException('Class ' . $class . ' already exists.');
        }

        if (!isset($GLOBALS['TCA'][$tableName])) {

            throw new \InvalidArgumentException('Configuration for ' . $tableName . ' not Found!');
        }
        $informations = $this->detectSeederInformations($tableName);

        $seederClass = $this->getSeederClass($this->namespace, $className, $tableName, $informations);
        $file = fopen(__DIR__ . '/../../../' . $this->path . $className . '.php', 'w');
        fwrite($file, $seederClass);
        fclose($file);

        $this->outputUtility->success(
            __DIR__ . '/../../../' . $this->path . $className . '.php' . ' successfully created</>'
        );

        return true;
    }

    /**
     * getSeederClass
     *
     * @param string $namespace
     * @param string $className
     * @param array $informations
     * @return string
     */
    protected function getSeederClass($namespace, $className, $tableName, $informations)
    {
        $stub = file_get_contents(__DIR__ . '/../../../' . $this->stub);

        $stub = str_replace('{namespace}', $namespace, $stub);
        $stub = str_replace('{ClassName}', $className, $stub);
        $stub = str_replace('{TableName}', $tableName, $stub);
        $informations = var_export($informations, true);

        $pattern = '/(\'.*\'\s=>\s)\'(\$.+->\w+\(.*\))\'/';
        $replacement = '${1}${2}';
        $informations = preg_replace($pattern, $replacement, $informations);

        $stub = str_replace('{informations}', $informations, $stub);

        return $stub;
    }

    /**
     * @param string $className
     * @return string
     */
    protected function resolveSeederClass($className)
    {
        if (isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['seeder']['alias'][$className])) {
            $className = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['seeder']['alias'][$className];

        }
        if (!class_exists($className)) {
            throw new \InvalidArgumentException('Class ' . $className . ' does not exist.');
        }

        return $className;
    }
}


1			<?php
2			namespace TildBJ\Seeder\Command;
3
4			/***************************************************************
5			* Copyright notice
6			*
7			* (c) 2016 Dennis Römmich <[email protected]>
8			*
9			* All rights reserved
10			*
11			* This script is part of the TYPO3 project. The TYPO3 project is
12			* free software; you can redistribute it and/or modify
13			* it under the terms of the GNU General Public License as published by
14			* the Free Software Foundation; either version 2 of the License, or
15			* (at your option) any later version.
16			*
17			* The GNU General Public License can be found at
18			* http://www.gnu.org/copyleft/gpl.html.
19			*
20			* This script is distributed in the hope that it will be useful,
21			* but WITHOUT ANY WARRANTY; without even the implied warranty of
22			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23			* GNU General Public License for more details.
24			*
25			* This copyright notice MUST APPEAR in all copies of the script!
26			***************************************************************/
27
28			use TildBJ\Seeder\Domain\Model\ColumnInterface;
29			use TildBJ\Seeder\Generator\MethodNameGenerator;
30			use TYPO3\CMS\Core\Utility\GeneralUtility;
31
32			/**
33			* SeederCommandController
34			*
35			* @author Dennis Römmich<[email protected]>
36			* @copyright Copyright belongs to the respective authors
37			* @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3 or later
38			*/
39			class SeederCommandController extends \TYPO3\CMS\Extbase\Mvc\Controller\CommandController
40			{
41			/**
42			* namespace
43			*
44			* @var string $namespace
45			*/
46			protected $namespace = 'TildBJ\Seeder\Seeder';
47
48			/**
49			* path
50			*
51			* @var string $path
52			*/
53			protected $path = 'seeder/Classes/Seeder/';
54
55			/**
56			* stub
57			*
58			* @var string $stub
59			*/
60			protected $stub = 'seeder/Classes/Seeder/stubs/seeder.stub';
61
62			/**
63			* @var MethodNameGenerator
64			*/
65			protected $methodNameGenerator;
66
67			/**
68			* @var \TildBJ\Seeder\Utility\OutputUtility
69			* @inject
70			*/
71			protected $outputUtility;
72
73	3		public function __construct()
74			{
75	3		$faker = \TildBJ\Seeder\Factory\FakerFactory::createFaker();
76	3		$this->methodNameGenerator = GeneralUtility::makeInstance(MethodNameGenerator::class, $faker);
77	3		}
78
79			/**
80			* This command allows you to run predifined Seeds
81			*
82			* @param string $seed ClassName or Alias defined in $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['seeder']['alias'] of your seed
83			* @return boolean
84			*/
85	1		public function seedCommand($seed)
			0 ignored issues – show Coding Style introduced 2018-01-24 11:47 UTC by Report Bug Copy Issue Report `function seedCommand()` does not seem to conform to the naming convention (`^(?:is\|has\|should\|may\|supports)`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
86			{
87	1		$class = $this->resolveSeederClass($seed);
88
89			/** @var \TildBJ\Seeder\Seeder $seeder */
90			$seeder = new $class;
91			$seeder->run();
92			$seeder->seed();
93
94			return true;
95			}
96
97			/**
98			* @param $tableName
99			* @return array
100			* @throws \Exception
101			*/
102			protected function detectSeederInformations($tableName)
103			{
104			$informations = [];
105			$faker = \TildBJ\Seeder\Factory\FakerFactory::createFaker();
106			$table = \TildBJ\Seeder\Factory\TableFactory::createTable($tableName);
107
108			/** @var ColumnInterface $column */
109			foreach ($table->getColumns() as $column) {
110			if (in_array($column->getName(), \TildBJ\Seeder\Provider\Faker::$skippedProvider)) {
111			continue;
112			}
113			$provider = $faker->guessProviderName($column->getName());
114			$informationClassName = 'TildBJ\\Seeder\\Information\\' . ucfirst(GeneralUtility::underscoredToLowerCamelCase($column->getName()) . 'Information');
115			$relationInformationAvailable = false;
116			if ($column->getName() !== 'abstract' && class_exists($informationClassName)) {
117			$information = GeneralUtility::makeInstance($informationClassName);
118			} elseif ($this->isRelation($column)) {
119			$information = GeneralUtility::makeInstance(\TildBJ\Seeder\Information\RelationInformation::class);
120			$relationInformationAvailable = true;
121			} else {
122			$information = GeneralUtility::makeInstance(\TildBJ\Seeder\Information\NullInformation::class);
123			$information->setDefaultValue($provider);
124			}
125			if (!$information instanceof \TildBJ\Seeder\Information) {
126			throw new \Exception($informationClassName . ' must implement ' . \TildBJ\Seeder\Information::class);
127			}
128
129			if ($this->isRelation($column) && $relationInformationAvailable) {
130			$createNewSeeder = $this->askOrSelect($information->getQuestion([$column->getName()]), 'n');
131			if (strtolower($createNewSeeder) === 'y' \|\| strtolower($createNewSeeder) === 'yes' \|\| $createNewSeeder == 1) {
132			$className = '';
133			while (!$className) {
134			$className = $this->outputUtility->ask('<fg=yellow>Please specify the required argument "--class-name" (<fg=green>' . $column->getForeignTable() . '</>):</> ');
135			}
136			$this->makeCommand($className, $column->getForeignTable());
137			$informations[$column->getName()] = '$this->call(' . $className . '::class)';
138			}
139			} else {
140			switch ($information->getType()) {
141		View Code Duplication	case \TildBJ\Seeder\Information::INFORMATION_TYPE_ASK:
			0 ignored issues – show Duplication introduced 2018-01-24 11:47 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
142			if (!is_null($response = $this->askOrSelect($information->getQuestion([$column->getName(), $provider]), $information->getDefaultValue()))) {
143			if ($this->methodNameGenerator->generate($response)) {
144			$informations[$column->getName()] = $this->methodNameGenerator->generate($response);
145			}
146			}
147			break;
148			case \TildBJ\Seeder\Information::INFORMATION_TYPE_SELECT:
149		View Code Duplication	case \TildBJ\Seeder\Information::INFORMATION_TYPE_SELECTMULTIPLE:
			0 ignored issues – show Duplication introduced 2018-01-24 11:47 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
150			if (!is_null($response = $this->askOrSelect($information->getQuestion([$column->getName(), $provider]), $information->getDefaultValue(), $information->getChoices()))) {
151			if ($this->methodNameGenerator->generate($response)) {
152			$informations[$column->getName()] = $this->methodNameGenerator->generate($response);
153			}
154			}
155			break;
156			default:
157			if ($this->methodNameGenerator->generate($column->getName())) {
158			$informations[$column->getName()] = $this->methodNameGenerator->generate($column->getName());
159			}
160			}
161			}
162			}
163
164			if (!isset($informations['pid'])) {
165			/** @var \TildBJ\Seeder\Information $information */
166			$information = GeneralUtility::makeInstance(\TildBJ\Seeder\Information\PidInformation::class);
167			$informations['pid'] = $this->outputUtility->ask($information->getQuestion(), $information->getDefaultValue());
168			}
169
170			return $informations;
171			}
172
173			/**
174			* @param ColumnInterface $column
175			* @return bool
176			*/
177			protected function isRelation(ColumnInterface $column)
178			{
179			return (
180			(
181			$column instanceof \TildBJ\Seeder\Domain\Model\Column\Select \|\|
182			$column instanceof \TildBJ\Seeder\Domain\Model\Column\Inline \|\|
183			$column instanceof \TildBJ\Seeder\Domain\Model\Column\Group
184			) &&
185			$column->getForeignTable()
186			);
187			}
188
189			/**
190			* @param $question
191			* @param $defaultValue
192			* @param null $choices
193			* @return array\|int\|string
194			*/
195			protected function askOrSelect($question, $defaultValue, $choices = null)
196			{
197			if (is_null($choices)) {
198			return $this->outputUtility->ask($question, $defaultValue);
199			}
200			return $this->outputUtility->select($question, $choices, $defaultValue);
201			}
202
203			/**
204			* This command allows you to create new Seeds.
205			*
206			* @param string $className
207			* @param string $tableName
208			* @return boolean
209			*/
210	2		public function makeCommand($className, $tableName)
			0 ignored issues – show Coding Style introduced 2018-01-24 11:47 UTC by Report Bug Copy Issue Report `function makeCommand()` does not seem to conform to the naming convention (`^(?:is\|has\|should\|may\|supports)`). This check examines a number of code elements and verifies that they conform to the given naming conventions. You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods. Loading history...
211			{
212	2		$class = $this->namespace . '\\' . $className;
213
214	2		if (class_exists($class)) {
215	1		throw new \InvalidArgumentException('Class ' . $class . ' already exists.');
216			}
217
218	1	View Code Duplication	if (!isset($GLOBALS['TCA'][$tableName])) {
			0 ignored issues – show Duplication introduced 2018-11-16 08:00 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
219	1		throw new \InvalidArgumentException('Configuration for ' . $tableName . ' not Found!');
220			}
221			$informations = $this->detectSeederInformations($tableName);
222
223			$seederClass = $this->getSeederClass($this->namespace, $className, $tableName, $informations);
224			$file = fopen(__DIR__ . '/../../../' . $this->path . $className . '.php', 'w');
225			fwrite($file, $seederClass);
226			fclose($file);
227
228			$this->outputUtility->success(
229			__DIR__ . '/../../../' . $this->path . $className . '.php' . ' successfully created</>'
230			);
231
232			return true;
233			}
234
235			/**
236			* getSeederClass
237			*
238			* @param string $namespace
239			* @param string $className
240			* @param array $informations
241			* @return string
242			*/
243			protected function getSeederClass($namespace, $className, $tableName, $informations)
244			{
245			$stub = file_get_contents(__DIR__ . '/../../../' . $this->stub);
246
247			$stub = str_replace('{namespace}', $namespace, $stub);
248			$stub = str_replace('{ClassName}', $className, $stub);
249			$stub = str_replace('{TableName}', $tableName, $stub);
250			$informations = var_export($informations, true);
			0 ignored issues – show Coding Style introduced 2018-01-24 11:47 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$informations`. This often makes code more readable. Loading history...
251			$pattern = '/(\'.\'\s=>\s)\'(\$.+->\w+\(.\))\'/';
252			$replacement = '${1}${2}';
253			$informations = preg_replace($pattern, $replacement, $informations);
			0 ignored issues – show Coding Style introduced 2018-01-24 11:47 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$informations`. This often makes code more readable. Loading history...
254			$stub = str_replace('{informations}', $informations, $stub);
255
256			return $stub;
257			}
258
259			/**
260			* @param string $className
261			* @return string
262			*/
263	1		protected function resolveSeederClass($className)
264			{
265	1		if (isset($GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['seeder']['alias'][$className])) {
266			$className = $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['seeder']['alias'][$className];
			0 ignored issues – show Coding Style introduced 2018-01-24 11:47 UTC by Report Bug Copy Issue Report Consider using a different name than the parameter `$className`. This often makes code more readable. Loading history...
267			}
268	1		if (!class_exists($className)) {
269	1		throw new \InvalidArgumentException('Class ' . $className . ' does not exist.');
270			}
271
272			return $className;
273			}
274			}
275

TildBJ / seeder

SeederCommandController::resolveSeederClass() A last analyzed 2018-11-16 08:00 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

SeederCommandController::resolveSeederClass() A
last analyzed 2018-11-16 08:00 UTC