Kunstmaan / KunstmaanBundlesCMS

src/Kunstmaan/GeneratorBundle/Helper/InputAssistant.php

<?php

namespace Kunstmaan\GeneratorBundle\Helper;

use Sensio\Bundle\GeneratorBundle\Command\Helper\QuestionHelper;
use Sensio\Bundle\GeneratorBundle\Command\Validators;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\Question;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpKernel\Kernel;

/**
 * @deprecated the functions in this class should be moved to the KunstmaanGenerateCommand class
 */
class InputAssistant
{
    /** @var InputInterface */
    private $input;

    /** @var OutputInterface */
    private $output;

    /** @var QuestionHelper */
    private $questionHelper;

    /** @var Kernel */
    private $kernel;

    /** @var ContainerInterface */
    private $container;

    public function __construct(InputInterface &$input, OutputInterface $output, QuestionHelper $questionHelper, Kernel $kernel, ContainerInterface $container)
    {
        $this->input = $input;
        $this->output = $output;
        $this->questionHelper = $questionHelper;
        $this->kernel = $kernel;
        $this->container = $container;
    }

    /**
     * Asks for the namespace and sets it on the InputInterface as the 'namespace' option, if this option is not set yet.
     *
     * @param array $text what you want printed before the namespace is asked

Should the type for parameter $text not be null|array? Also, consider making the array more specific, something like array<String>, or String[].

     *
     * @return string The namespace. But it's also been set on the InputInterface.
     */
    public function askForNamespace(array $text = null)
    {
        $namespace = $this->input->hasOption('namespace') ? $this->input->getOption('namespace') : null;

        // When the Namespace is filled in return it immediately if valid.
        try {
            if (!is_null($namespace) && !empty($namespace)) {
                Validators::validateBundleNamespace($namespace);

                return $namespace;
            }
        } catch (\Exception $error) {
            $this->writeError(["Namespace '$namespace' is incorrect. Please provide a correct value.", $error->getMessage()]);
            exit;
        }

        $ownBundles = $this->getOwnBundles();
        if (count($ownBundles) <= 0) {
            $this->writeError("Looks like you don't have created a bundle for your project, create one first.", true);
        }

        $namespace = '';

        // If we only have 1 or more bundles, we can prefill it.
        if (count($ownBundles) > 0) {
            $namespace = $ownBundles[1]['namespace'] . '/' . $ownBundles[1]['name'];
        }

        $namespaces = $this->getNamespaceAutoComplete($this->kernel);

        if (!is_null($text) && (count($text) > 0)) {
            $this->output->writeln($text);
        }

        $question = new Question($this->questionHelper->getQuestion('Bundle Namespace', $namespace), $namespace);
        $question->setValidator(['Sensio\Bundle\GeneratorBundle\Command\Validators', 'validateBundleNamespace']);
        $question->setAutocompleterValues($namespaces);
        $namespace = $this->questionHelper->ask($this->input, $this->output, $question);

        if ($this->input->hasOption('namespace')) {
            $this->input->setOption('namespace', $namespace);
        }

        return $namespace;
    }

    /**
     * Helper function to display errors in the console.
     *
     * @param $message
     * @param bool $exit
     */
    private function writeError($message, $exit = false)

This method seems to be duplicated in your project.

    {
        $this->output->writeln($this->questionHelper->getHelperSet()->get('formatter')->formatBlock($message, 'error'));
        if ($exit) {
            exit;
        }
    }

    /**
     * Get an array with all the bundles the user has created.
     *
     * @return array
     */
    public function getOwnBundles()
    {
        $bundles = [];
        $counter = 1;

        $dir = dirname($this->container->getParameter('kernel.root_dir') . '/') . '/src/';
        $files = scandir($dir);
        foreach ($files as $file) {
            if (is_dir($dir . $file) && !in_array($file, ['.', '..'])) {
                $bundleFiles = scandir($dir . $file);
                foreach ($bundleFiles as $bundleFile) {
                    if (is_dir($dir . $file . '/' . $bundleFile) && !in_array($bundleFile, ['.', '..'])) {
                        $bundles[$counter++] = [
                            'name' => $bundleFile,
                            'namespace' => $file,
                            'dir' => $dir . $file . '/' . $bundleFile,
                        ];
                    }
                }
            }
        }

        return $bundles;
    }

    /**
     * Returns a list of namespaces as array with a forward slash to split the namespace & bundle.
     *
     * @return array
     */
    private function getNamespaceAutoComplete(Kernel $kernel)
    {
        $ret = [];
        foreach ($kernel->getBundles() as $k => $v) {
            $ret[] = $this->fixNamespace($v->getNamespace());
        }

        return $ret;
    }

    /**
     * Replaces '\' with '/'.
     *
     * @param $namespace
     *
     * @return mixed

Consider making the return type a bit more specific; maybe use string.

     */
    private function fixNamespace($namespace)
    {
        return strtr($namespace, ['\\Bundle\\' => '/', '\\' => '/']);
    }

    /**
     * Asks for the prefix and sets it on the InputInterface as the 'prefix' option, if this option is not set yet.
     * Will set the default to a snake_cased namespace when the namespace has been set on the InputInterface.
     *
     * @param array  $text      What you want printed before the prefix is asked. If null is provided it'll write a default text.

Should the type for parameter $text not be null|array? Also, consider making the array more specific, something like array<String>, or String[].

     * @param string $namespace An optional namespace. If this is set it'll create the default based on this prefix.
     *                          If it's not provided it'll check if the InputInterface already has the namespace option.
     *
     * @return string The prefix. But it's also been set on the InputInterface.
     */
    public function askForPrefix(array $text = null, $namespace = null)
    {
        $prefix = $this->input->hasOption('prefix') ? $this->input->getOption('prefix') : null;

        if (is_null($text)) {
            $text = [
                '',
                'You can add a prefix to the table names of the generated entities for example: <comment>projectname_bundlename_</comment>',
                'Enter an underscore \'_\' if you don\'t want a prefix.',
                '',
            ];
        }

        while (is_null($prefix)) {
            if (count($text) > 0) {
                $this->output->writeln($text);
            }

            if (is_null($namespace) || empty($namespace)) {
                $namespace = $this->input->hasOption('namespace') ? $this->input->getOption('namespace') : null;
            } else {
                $namespace = $this->fixNamespace($namespace);
            }
            $defaultPrefix = GeneratorUtils::cleanPrefix($this->convertNamespaceToSnakeCase($namespace));
            $question = new Question($this->questionHelper->getQuestion('Tablename prefix', $defaultPrefix), $defaultPrefix);
            $prefix = $this->questionHelper->ask($this->input, $this->output, $question);
            $prefix = GeneratorUtils::cleanPrefix($prefix);
            if ($this->input->hasOption('prefix')) {
                $this->input->setOption('prefix', $prefix);
            }

            if ($prefix == '') {
                break;
            }

            if (!preg_match('/^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*$/', $prefix)) {
                $this->output->writeln(sprintf('<bg=red> "%s" contains invalid characters</>', $prefix));
                $prefix = $text = null;

                continue;
            }
        }

        return $prefix;
    }

    /**
     * Converts something like Namespace\BundleNameBundle to namspace_bundlenamebundle.
     *
     * @param string $namespace
     *
     * @return string
     */
    private function convertNamespaceToSnakeCase($namespace)
    {
        if (is_null($namespace)) {
            return null;
        }

        return str_replace('/', '_', strtolower($this->fixNamespace($namespace)));
    }
}