Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\RemoveInstallerFolder

Complexity

Total Complexity

5

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	3	1
A	getTitle()	0	3	1
A	runActualTask()	0	16	2
A	hasCommitAndPush()	0	3	1

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\UpgradeToSilverstripe4\Tasks\Helpers\ComposerJsonFixes;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Task;

/**
 * Remove installer folder from composer.json file so that package
 * installs into vendor folder.
 */
class RemoveInstallerFolder extends Task
{
    protected $taskStep = 's20';

    protected $package = '';

    protected $newVersion = '';

    protected $newPackage = '';

    public function getTitle()
    {
        return 'Remove installer-name from composer.json';
    }

    public function getDescription()
    {
        return '
            Remove installer folder from composer.json file so that package
            installs into vendor folder.';
    }

    public function runActualTask($params = []): ?string
    {
        if ($this->mu()->getIsModuleUpgrade()) {

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

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

            $command =
            'if(isset($data["extra"]["installer-name"])) { '
            . '    unset($data["extra"]["installer-name"]);'
            . '}';
            $comment = 'Removing extra.installer-name variable';
            ComposerJsonFixes::inst($this->mu())->UpdateJSONViaCommandLine(
                $this->mu()->getGitRootDir(),

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

                $command,
                $comment
            );
            $this->setCommitMessage('API:  Removing extra.installer-name variable');
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        return $this->mu()->getIsModuleUpgrade();

The expression return $this->mu()->getIsModuleUpgrade() also could return the type Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader|Sunnysideup\UpgradeToSilverstripe4\Traits\Creator which is incompatible with the return type mandated by Sunnysideup\UpgradeToSilverstripe4\Tasks\Task::hasCommitAndPush() of boolean.

    }
}