Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\AddDotEnvFile

Complexity

Total Complexity

7

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getTitle()	0	3	1
A	getDescription()	0	3	1
A	runActualTask()	0	19	3
A	getEnvtContentAddValues()	0	6	1
A	hasCommitAndPush()	0	3	1

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\UpgradeToSilverstripe4\Api\FileFixes;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Task;

/**
 * Run a dev/build as a smoke test to see if all is well
 */
class AddDotEnvFile extends Task
{
    protected $taskStep = 's60';

    protected $envContent = [
        'SS_DATABASE_CLASS="MySQLDatabase"',
        'SS_DATABASE_NAME="--DB-NAME--HERE--"',
        'SS_DATABASE_PASSWORD="x"',
        'SS_DATABASE_SERVER="localhost"',
        'SS_DATABASE_USERNAME="root"',
        '',
        'SS_DEFAULT_ADMIN_PASSWORD="x"',
        'SS_DEFAULT_ADMIN_USERNAME="x"',
        '',
        'SS_ENVIRONMENT_TYPE="dev"',
    ];

    public function getTitle()
    {
        return 'Adds a .env file';
    }

    public function getDescription()
    {
        return 'Adds a basic .env file in case that is needed.';
    }

    public function runActualTask($params = []): ?string
    {
        if (! file_exists($this->mu()->getWebRootDirLocation() . '/.env')) {

The method getWebRootDirLocation() does not exist on Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader. Since you implemented __call, consider adding a @method annotation.

It seems like getWebRootDirLocation() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            foreach ($this->envContent as $line) {
                $line = $this->getEnvtContentAddValues($line);
                $this->mu()->execMe(

It seems like execMe() must be provided by classes using this trait. How about adding it as abstract method to this trait?

                    $this->mu()->getWebRootDirLocation(),

It seems like $this->mu()->getWebRootDirLocation() can also be of type Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader and Sunnysideup\UpgradeToSilverstripe4\Traits\Creator and null; however, parameter $newDir of Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader::execMe() does only seem to accept string, maybe add an additional type check?

                    'echo \'' . \addcslashes($line, '\'') . '\' >> .env',
                    'adding a line to .env: ' . $line,
                    false
                );
            }
            FileFixes::inst($this->mu())
                ->addLineToFileIfItDoesNotExist(
                    '.gitignore',
                    '.env'
                );
        }
        return null;
    }

    protected function getEnvtContentAddValues(string $string)
    {
        return str_replace(
            '--DB-NAME--HERE--',
            'upgrader' . $this->mu()->getVendorNamespace() . $this->mu()->getPackageNamespace(),

It seems like getVendorNamespace() must be provided by classes using this trait. How about adding it as abstract method to this trait?

The method getVendorNamespace() does not exist on Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader. Since you implemented __call, consider adding a @method annotation.

The method getPackageNamespace() does not exist on Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader. Since you implemented __call, consider adding a @method annotation.

It seems like getPackageNamespace() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $string
        );
    }

    protected function hasCommitAndPush()
    {
        return false;
    }
}