Lanin\Laravel\SetupWizard\Commands\Steps\DotEnv

Complexity

Total Complexity

22

Size/Duplication

Total Lines	249
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	9
Bugs	2	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	prompt()	0	4	2
A	envFileExist()	0	4	1
A	envFilePath()	0	4	1
A	prepare()	0	17	2
A	getVariableOptions()	0	9	1
A	envFileToUseForDefaults()	0	13	3
A	runInput()	0	4	1
A	runSelect()	0	8	1
A	runRandom()	0	11	2
A	getRandomKey()	0	9	2
A	preview()	0	4	1
A	generatePrompt()	0	4	1
B	finish()	0	30	2
A	saveFile()	0	10	2

<?php namespace Lanin\Laravel\SetupWizard\Commands\Steps;

use Illuminate\Support\Str;

class DotEnv extends AbstractStep
{
    const RANDOM = 'random';
    const SELECT = 'select';
    const INPUT  = 'input';

    /**
     * Array of bootstrappers to reload Application config.
     *
     * @var array
     */
    protected $boostrappers = [
        'Lanin\Laravel\SetupWizard\Support\Bootstrap\DetectEnvironment',
        'Lanin\Laravel\SetupWizard\Support\Bootstrap\LoadConfiguration',
        'Illuminate\Foundation\Bootstrap\ConfigureLogging',
    ];

    /**
     * Return short command description.
     *
     * @return string
     */
    public function prompt()
    {
        return 'Do you want to ' . ($this->envFileExist() ? 'update' : 'create') . ' .env file?';
    }

    /**
     * Check if .env file exist
     *
     * @return bool
     */
    protected function envFileExist()
    {
        return file_exists($this->envFilePath('.env'));
    }

    /**
     * Return path where to search .env files.
     *
     * @param  string $file
     * @return string
     */
    protected function envFilePath($file = '.env')
    {
        return base_path($file);
    }

    /**
     * Proceed step.
     *
     * @return array
     */
    public function prepare()
    {
        $result = [];

        $file = $this->envFileToUseForDefaults();

        \Lanin\Laravel\SetupWizard\Support\DotEnv::load($this->envFilePath(), $file);

        foreach (\Lanin\Laravel\SetupWizard\Support\DotEnv::$variables as $name => $default)
        {
            $options = $this->getVariableOptions($name);

            $result[$name] = $this->{'run' . $options['type']}($name, $options, $default);
        }

        return $result;
    }

    /**
     * Get variable options from configs.
     *
     * @param  string $name
     * @return array
     */
    protected function getVariableOptions($name)
    {
        $options = config(
            'setup.dot_env.variables.' . $name,
            ['type' => self::INPUT, 'prompt' => 'Provide value for environment variable']
        );

        return $options;
    }

    /**
     * Chooses what env file to use.
     *
     * @return string
     */
    protected function envFileToUseForDefaults()
    {
        $file = config('setup.dot_env.default_file');

        if ($this->envFileExist() &&
            $this->command->confirm('Existing .env file was found. Use it for defaults?', true)
        )
        {
            $file = '.env';
        }

        return $file;
    }

    /**
     * Run input prompt.
     *
     * @param  string $name
     * @param  array $options
     * @param  string|null $default
     * @return string
     */
    protected function runInput($name, array $options, $default = null)
    {
        return $this->command->ask($this->generatePrompt($name, $options['prompt']), $default);
    }

    /**
     * Run select prompt.
     *
     * @param  string $name
     * @param  array $options
     * @param  string|null $default
     * @return string
     */
    protected function runSelect($name, array $options, $default = null)
    {
        return $this->command->choice(
            $this->generatePrompt($name, $options['prompt']),
            $options['options'],
            array_search($default, $options['options'])
        );
    }

    /**
     * Run random prompt.
     *
     * @param  string $name
     * @param  array $options
     * @param  string $default
     * @return string
     */
    protected function runRandom($name, array $options, $default = 'SomeRandomString')
    {
        $value = $this->command->ask($this->generatePrompt($name, $options['prompt']), $default);

        if ($value === 'SomeRandomString')
        {
            $value = $this->getRandomKey(config('app.cipher'));
        }

        return $value;
    }

    /**
     * Generate a random key for the application.
     *
     * @param  string $cipher
     * @return string
     */
    protected function getRandomKey($cipher)
    {
        if ($cipher === 'AES-128-CBC')
        {
            return Str::random(16);
        }

        return Str::random(32);
    }

    /**
     * Preview results.
     *
     * @param  mixed $results
     * @return void
     */
    public function preview($results)
    {
        $this->command->table(['Variable', 'Value'], $this->arrayToTable($results));
    }

    /**
     * Generate prompt text.
     *
     * @param  string $name
     * @param  string $prompt
     * @return string
     */
    protected function generatePrompt($name, $prompt)
    {
        return $prompt . ' <comment>' . $name . '=?</comment>';
    }

    /**
     * Finish step.
     *
     * @param  mixed $results
     * @return bool
     */
    public function finish($results)
    {
        if ($return = $this->saveFile($results))
        {
            $this->command->info('New .env file was saved.');

            /*
             * "Rebootstrap" Application to load new env variables to the config
             * using native Application::bootstrapWith([]) method with custom bootstrappers.
             *
             * First of all we have to make Dotenv mutable in order to overwrite environment variables.
             *
             * Next we have to update config.
             * In current Laravel implementation there is no method to reload Application config fully or Application itself.
             * Problem is that after reloading Config Repository it looses data from packages' config files
             * that are not currently published in /config directory. They are loaded only once after Application is bootstrapped.
             * And you can't force it to "rebootstrap" fully manually from outside (protected methods/properties).
             *
             * So the only way to "rebootstrap" it partly with custom Bootstrapper that uses existing Config Repository to
             * reload all /config files.
             */
            $this->command->getLaravel()->bootstrapWith($this->boostrappers);
        }
        else
        {
            $this->command->error('Failed to save .env file. Check permissions please.');
        }

        return $return;
    }

    /**
     * Save .env file.
     *
     * @param $results
     * @return bool
     */
    protected function saveFile($results)
    {
        $file = fopen($this->envFilePath('.env'), 'w+');
        foreach ($results as $variable => $value)
        {
            fwrite($file, $variable . '=' . $value . PHP_EOL);
        }

        return fclose($file);
    }
}