ComposerCompatibilityCheckerStep2::runInner() - Code Metrics - Inspection of "ENH: better composer fixes" - sunnysideup/silverstripe-upgrade_to_silverstripe_4 - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 444806...d96591 )

by Nicolaas

created 2024-03-02 02:34 UTC

ComposerCompatibilityCheckerStep2::runInner() C

↳ Parent: ComposerCompatibilityCheckerStep2

Complexity

Conditions	14
Paths	98

Size

Total Lines	60
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	38
c	0
b	0
f	0
dl	0
loc	60
rs	6.2666
cc	14
nc	98
nop	0

How to fix Long Method Complexity

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\UpgradeToSilverstripe4\Api\FileSystemFixes;
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',
    ];

    public function getTitle()
    {
        if ($this->mu()->getIsModuleUpgrade()) {
        if ($this->mu()->/** @scrutinizer ignore-call */ getIsModuleUpgrade()) {
            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
     * @return string|null
     */
    public function runActualTask($params = [])
    {
        if ($this->mu()->getIsModuleUpgrade()) {
            return null;
        }

        return null;
    }

    public function runInner()
    {
        $composerData = ComposerJsonFixes::inst($this->mu())->getJSON(
            $this->mu()->getGitRootDir()
            $this->mu()->/** @scrutinizer ignore-call */ getGitRootDir()
        );
        foreach (['require', 'require-dev'] as $section) {
            if(! empty($composerData[$section])) {
                $composerData[$section.'-tmp'] = $composerData[$section];
                unset($composerData[$section]);
            }
            foreach($this->alwaysKeepArray as $package) {
                if(isset($composerData[$section.'-tmp'][$package])) {
                    $composerData[$section][$package] = $composerData[$section.'-tmp'][$package];
                }
            }
        }
        ComposerJsonFixes::inst($this->mu())->setJSON(
            $this->mu()->getGitRootDir(),
            $composerData
        );
        foreach (['require-tmp', 'require-dev-tmp'] as $section) {
            if (isset($composerData[$section]) && is_array($composerData[$section]) && count($composerData[$section])) {
                foreach ($composerData[$section] as $package => $version) {
                    if (in_array($package, $this->alwaysKeepArray)) {
                        // Skip silverstripe/recipe-cms since it's already included
                        continue;
                    }

                    $this->mu()->colourPrint('trying to add '.$package.':'.$version, 'yellow', 1);
                    $this->mu()->/** @scrutinizer ignore-call */ colourPrint('trying to add '.$package.':'.$version, 'yellow', 1);

                    // Attempt to require the package
                    $output = '';
                    exec("composer require $package:$version --no-update", $output, $returnVar);
                    exec("composer require $package:$version --no-update", /** @scrutinizer ignore-type */ $output, $returnVar);
                    $this->mu()->colourPrint('result'.print_r($output), 'yellow', 1);
                    $this->mu()->colourPrint('result'./** @scrutinizer ignore-type */ print_r($output), 'yellow', 1);
                    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');
                        }
                    }
                }
            }
        }

        if ($this->mu()->getIsProjectUpgrade()) {
        if ($this->mu()->/** @scrutinizer ignore-call */ getIsProjectUpgrade()) {
            $this->mu()->execMe(
            $this->mu()->/** @scrutinizer ignore-call */ execMe(
                $this->mu()->getGitRootDir(),
                'composer update -vvv --no-interaction',
                'run composer update',
                false
            );
        }
    }


    /**
     * Update composer.json to add, remove, or suggest a package.
     */
    public function updateComposerJson(string $section, string $package, string $version, string $action, string $message = ''): void
    public function updateComposerJson(string $section, string $package, string $version, string $action, /** @scrutinizer ignore-unused */ string $message = ''): void
    {
        $composerData = ComposerJsonFixes::inst($this->mu())->getJSON(
            $this->mu()->getGitRootDir()
        );
        switch ($action) {
            case 'remove':
                unset($composerJson[$section][$package]);

                $composerJson['suggest'][$package] = 'Could not load with version '.$version;

                $this->mu()->colourPrint('removing to add '.$package.':'.$version, 'red', 1);
                break;
            case 'add':
                $this->mu()->colourPrint('adding '.$package.':'.$version, 'green', 1);
                $composerJson[$section][$package] = $version;
                break;
        }
        ComposerJsonFixes::inst($this->mu())->setJSON(
            $this->mu()->getGitRootDir(),
            $composerData
        );
    }



    protected function hasCommitAndPush()
    {
        return false;
    }
}


sunnysideup / silverstripe-upgrade_to_silverstripe_4

Push — master ( 444806...d96591 )

ComposerCompatibilityCheckerStep2::runInner() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like