Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\UpgradeDevBuild

Complexity

Total Complexity

4

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Importance

Changes	2
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	3	1
A	getTitle()	0	3	1
A	runActualTask()	0	22	1
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 UpgradeDevBuild extends Task
{
    protected $taskStep = 's20';

    protected $package = '';

    protected $newVersion = '';

    protected $newPackage = '';

    public function getTitle()
    {
        return 'Upgrade references to sake';
    }

    public function getDescription()
    {
        return '
            Upgrades any reference to framework/sake or framework/cli-script.php';
    }

    public function runActualTask($params = []): ?string
    {
        $command = <<<'EOT'

        if (isset($data["scripts"])) {
            foreach ($data["scripts"] as $type => $commands) {
                foreach ($commands as $key => $command) {
                    $data[$type][$key] = str_replace("php framework/cli-script.php", "vendor/bin/sake", $command);
                    $data[$type][$key] = str_replace("framework/sake ", "vendor/bin/sake ", $command);
                }
            }
        }

EOT;
        $comment = 'Updating framework/sake to vendor/bin/sake';
        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('MINOR: Updating framework/sake to vendor/bin/sake');
        return null;
    }

    protected function hasCommitAndPush()
    {
        return $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?

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.

    }
}