Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\AddUpgradeStarterBranch

Complexity

Total Complexity

4

Size/Duplication

Total Lines	35
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	5	1
A	getTitle()	0	3	1
A	hasCommitAndPush()	0	3	1
A	runActualTask()	0	8	1

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

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

/**
 * This task adds a legacy branch to the git repo of the original to act as a backup/legacy version for
 * holding a version of the module before it was changed
 */
class AddUpgradeStarterBranch extends Task
{
    protected $taskStep = 's10';

    public function getTitle()
    {
        return 'Creates a start branch for upgrading';
    }

    public function getDescription()
    {
        return '
            Creates a starter branch: "' . $this->mu()->getNameOfUpgradeStarterBranch() . '" of your module/app

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

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

            from the "' . $this->mu()->getNameOfBranchForBaseCode() . '" branch.

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

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

            If it does not exist.
            These branch names can be customised with setNameOfUpgradeStarterBranch and setNameOfBranchForBaseCode.
            ';
    }

    /**
     * @param  array  $params not currently used for this task
     */
    public function runActualTask($params = []): ?string
    {
        Git::inst($this->mu())->createNewBranchIfItDoesNotExist(
            $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?

            $this->mu()->getNameOfUpgradeStarterBranch(),
            $this->mu()->getNameOfBranchForBaseCode()
        );
        return null;
    }

    protected function hasCommitAndPush()
    {
        return false;
    }
}