Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\ComposerCompatibilityCheckerStep2

Complexity

Total Complexity

20

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getTitle()	0	6	2
A	getDescription()	0	3	1
A	runActualTask()	0	18	2
A	hasCommitAndPush()	0	3	1
B	testEachRequirement()	0	28	6
A	moveToTmpVar()	0	23	5
A	updateComposerJson()	0	20	3

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

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

//use either of the following to create the info.json file required
//your project will also require a composer.json.default file
//this file is used to reset the project to the default state before attempting to install each library
//composer info --format=json > info.json
//composer info --direct --format=json > info.json

class ComposerCompatibilityCheckerStep2 extends Task
{
    protected $taskStep = 's10';

    protected $alwaysKeepArray = [
        'silverstripe/recipe-cms',
    ];

    protected $appendixToKey = '-tmp';

    public function getTitle()
    {
        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?

            return 'For module upgrades, this is not being used right now.';
        }
        return 'Check what composer requirements can be added.';
    }

    public function getDescription()
    {
        return 'Goes through all the composer requirements and adds them one by one....';
    }

    /**
     * @param array $params
     */
    public function runActualTask($params = []): ?string
    {
        $this->mu()->setBreakOnAllErrors(true);

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

        if ($this->mu()->getIsModuleUpgrade()) {
            return null;
        }
        $this->moveToTmpVar();
        $this->testEachRequirement();

        $this->mu()->execMe(

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

            $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?

            'composer update -vvv --no-interaction',
            'run composer update',
            false
        );
        $this->mu()->setBreakOnAllErrors(false);

        return null;
    }

    protected function moveToTmpVar()
    {
        $composerData = ComposerJsonFixes::inst($this->mu())->getJSON(
            $this->mu()->getGitRootDir()
        );
        foreach (['require', 'require-dev'] as $section) {
            $tmpSection = $section . $this->appendixToKey;
            // move all
            if (! empty($composerData[$section])) {
                $composerData[$tmpSection] = $composerData[$section];
                unset($composerData[$section]);
            }
            // move the keeps back!
            foreach ($this->alwaysKeepArray as $package) {
                if (isset($composerData[$tmpSection][$package])) {
                    $composerData[$section][$package] = $composerData[$tmpSection][$package];
                    unset($composerData[$tmpSection][$package]);
                }
            }
        }
        ComposerJsonFixes::inst($this->mu())->setJSON(
            $this->mu()->getGitRootDir(),
            $composerData
        );
    }

    protected function testEachRequirement()
    {
        $composerData = ComposerJsonFixes::inst($this->mu())->getJSON(
            $this->mu()->getGitRootDir()
        );
        foreach (['require', 'require-dev'] as $section) {
            $tmpSection = $section . $this->appendixToKey;
            if (! empty($composerData[$tmpSection])) {
                foreach ($composerData[$tmpSection] as $package => $version) {
                    $this->mu()->colourPrint('trying to add ' . $package . ':' . $version, 'yellow', 1);

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

                    // Attempt to require the package
                    $output = '';
                    exec("composer require $package:$version --no-update", $output, $returnVar);

$output of type string is incompatible with the type array expected by parameter $output of exec().

                    if ($returnVar !== 0) {
                        $this->mu()->colourPrint("$package:$version could not be added. Skipping...", 'red', 1);
                        $this->updateComposerJson($section, $package, $version, 'remove');
                        // Skip adding to suggest or removing since it's being processed dynamically
                    } else {
                        // If require was successful, update composer
                        $output = '';
                        exec('composer update', $output, $updateReturnVar);
                        if ($updateReturnVar !== 0) {
                            // If update fails, revert the require
                            $this->mu()->colourPrint("Update failed after requiring $package. Reverting...", 'red', 1);
                            $this->updateComposerJson($section, $package, $version, 'remove');
                        } else {
                            $this->updateComposerJson($section, $package, $version, 'add');
                        }
                    }
                }
            }
        }
    }

    /**
     * Update composer.json to add, remove, or suggest a package.
     */
    protected function updateComposerJson(string $section, string $package, string $version, string $action, string $message = ''): void

The parameter $message is not used and could be removed.

    {
        $composerData = ComposerJsonFixes::inst($this->mu())->getJSON(
            $this->mu()->getGitRootDir()
        );
        switch ($action) {
            case 'remove':
                $this->mu()->colourPrint('removing ' . $package . ':' . $version, 'red', 1);
                unset($composerData[$section][$package]);
                $composerData[$section . '-tmp'][$package] = $version;
                break;
            case 'add':
                $this->mu()->colourPrint('adding ' . $package . ':' . $version, 'green', 1);
                $composerData[$section][$package] = $version;
                unset($composerData[$section . '-tmp'][$package]);
                break;
        }
        ComposerJsonFixes::inst($this->mu())->setJSON(
            $this->mu()->getGitRootDir(),
            $composerData
        );
    }

    protected function hasCommitAndPush()
    {
        return false;
    }
}