TildBJ / seeder

Classes/Command/SeederCommandController.php

<?php
namespace TildBJ\Seeder\Command;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2016 Dennis Römmich <dennis@roemmich.eu>
 *
 *  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<dennis@roemmich.eu>
 * @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)

function seedCommand() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

    {
        $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:

This code seems to be duplicated across your project.

                        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:

This code seems to be duplicated across your project.

                        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)

function makeCommand() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

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

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

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

This code seems to be duplicated across your project.

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

Consider using a different name than the parameter $informations. This often makes code more readable.

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

Consider using a different name than the parameter $informations. This often makes code more readable.

        $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];

Consider using a different name than the parameter $className. This often makes code more readable.

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

        return $className;
    }
}