Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\AddLegacyBranch

Complexity

Total Complexity

4

Size/Duplication

Total Lines	40
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getTitle()	0	3	1
A	getDescription()	0	5	1
A	runActualTask()	0	9	1
A	hasCommitAndPush()	0	3	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 AddLegacyBranch extends Task
{
    protected $taskStep = 's10';

    /**
     * @var string what should the legacy branch be called
     */
    protected $nameOfLegacyBranch = '3';

    public function getTitle()
    {
        return 'Add Legacy Branch';
    }

    public function getDescription()
    {
        return '
            Creates a legacy branch: "' . $this->nameOfLegacyBranch . '" of your module
            from the "' . $this->mu()->getNameOfBranchForBaseCode() . '" branch so that you

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?

            can keep making bugfixes to older versions.
            In the recipes you can see how to set the name of the legacy branch.';
    }

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

        Git::inst($this->mu())->createNewBranchIfItDoesNotExist(
            $gitRootDir,
            $this->nameOfLegacyBranch,
            $this->mu()->getNameOfBranchForBaseCode()
        );
        return null;
    }

    protected function hasCommitAndPush()
    {
        return false;
    }
}