Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\RemoveComposerRequirements

Complexity

Total Complexity

6

Size/Duplication

Total Lines	57
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

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

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

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

/**
 * Updates the composer requirements to reflect the new version and package names
 * in the composer file of your module
 */
class RemoveComposerRequirements extends Task
{
    protected $taskStep = 's20';

    protected $packages = [
        'silverstripe/recipe-cms',
        'silverstripe/admin',
        'silverstripe/assets',
        'silverstripe/config',
        'silverstripe/admin',

        'silverstripe/cms',
        'silverstripe/framework',
        'silverstripe/asset-admin',
        'silverstripe/campaign-admin',
        'silverstripe/errorpage',
        'silverstripe/graphql',
        'silverstripe/reports',
        'silverstripe/siteconfig',
        'silverstripe/versioned-admin',
        'silverstripe/versioned',
        'php',
    ];

    public function getTitle()
    {
        return 'Remove composer.json requirements for basic packages like silverstripe/framework, silverstripe/admin, etc.';
    }

    public function getDescription()
    {
        return '
            Remove requirements in composer.json file for
            ' . (count($this->packages) ? implode(', ', $this->packages) : 'old packages - if any') . '
            For example, we remove silverstripe/framework requirement from 3 to 4.';
    }

    public function runActualTask($params = []): ?string
    {
        foreach ($this->packages as $package) {
            $command = 'unset($data["require"]["' . $package . '"]);';

            $comment = 'remove the requirement for ' . $package . ' from ' . $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?

            ComposerJsonFixes::inst($this->mu())->UpdateJSONViaCommandLine(
                $this->mu()->getGitRootDir(),
                $command,
                $comment
            );
        }
        $this->setCommitMessage('API:  remove composer requirements - removing requirements for: ' . implode(', ', $this->packages));
        return null;
    }

    protected function hasCommitAndPush()
    {
        return true;
    }
}