Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\ComposerInstallProject

Complexity

Total Complexity

21

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Importance

Changes	4
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	4	2
A	getTitle()	0	3	1
A	workoutExtraRequirementsFromModule()	0	16	6
A	hasCommitAndPush()	0	3	1
C	runActualTask()	0	89	11

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\UpgradeToSilverstripe4\Api\FileSystemFixes;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Helpers\Composer;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Helpers\ComposerJsonFixes;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Helpers\Git;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Task;

/**
 * Install a basic / standard install of Silverstripe ('.$this->versionToLoad.')
 * using composer' ;
 */
class ComposerInstallProject extends Task
{
    protected $taskStep = 's20';

    protected $versionToLoad = '';

    /**
     * e.g. sunnysideup/ecommerce => master
     * e.g. sunnysideup/test => 1.2.3
     * @var array
     */
    protected $alsoRequire = [];

    protected $installModuleAsVendorModule = false;

    /**
     * @var array
     */
    protected $ignoredPackageForModuleRequirements = [
        'php',
        'silverstripe/recipe-plugin',
        'silverstripe/recipe-cms',
        'silverstripe/admin',
        'silverstripe/asset-admin',
        'silverstripe/assets',
        'silverstripe/campaign-admin',
        'silverstripe/config',
        'silverstripe/cms',
        'silverstripe/framework',
        'silverstripe/errorpage',
        'silverstripe/reports',
        'silverstripe/siteconfig',
        'silverstripe/versioned-admin',
        'silverstripe/versioned',
    ];

    protected $allowedPlugins = [
        'composer/installers',
        'silverstripe/recipe-plugin',
        'silverstripe/vendor-plugin',
    ];

    /**
     * @var string
     */
    protected $composerOptions = '--prefer-source --update-no-dev';

    protected $defaultSilverstripeProject = 'silverstripe/installer';

    public function getTitle()
    {
        return 'use Composer to install vanilla Silverstripe project and add project / module to it.';
    }

    public function getDescription()
    {
        return '
            Install a basic / standard install of Silverstripe (' . ($this->versionToLoad ?: $this->mu()->getFrameworkComposerRestraint()) . ')

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

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

            using composer and install module / project into the vanilla silverstripe install.';
    }

    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?

        $fixer = FileSystemFixes::inst($this->mu())

The assignment to $fixer is dead and can be removed.

            ->removeDirOrFile($this->mu()->getWebRootDirLocation(), $this->mu()->getAboveWebRootDirLocation())

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

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

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

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

            ->mkDir($this->mu()->getWebRootDirLocation(), $this->mu()->getAboveWebRootDirLocation());
        if (! $this->versionToLoad) {
            $this->versionToLoad = $this->mu()->getFrameworkComposerRestraint();
        }

        //install project / silverstripe clean.
        $altBranch = $this->mu()->getParentProjectForModuleBranchOrTag();

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

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

        if (! $altBranch) {
            $altBranch = 'master';
        }
        if ($this->mu()->getIsModuleUpgrade()) {

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

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

            $alternativeGitLink = $this->mu()->getParentProjectForModule();

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

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

            if ($alternativeGitLink) {
                Git::inst($this->mu())
                    ->Clone(
                        $this->mu()->getWebRootDirLocation(),
                        $alternativeGitLink,
                        $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?

                        $altBranch
                    );
            } else {
                $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()->getAboveWebRootDirLocation(),

It seems like $this->mu()->getAboveWebRootDirLocation() can also be of type Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader and Sunnysideup\UpgradeToSilverstripe4\Traits\Creator and null; however, parameter $newDir of Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader::execMe() does only seem to accept string, maybe add an additional type check?

                    $this->mu()->getComposerEnvironmentVars() . ' composer create-project -n ' . $this->defaultSilverstripeProject . ' ' . $this->mu()->getWebRootDirLocation() . ' ' . $this->versionToLoad,

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

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

                    'set up vanilla install of ' . $this->defaultSilverstripeProject . ' - version: ' . $this->versionToLoad,
                    false
                );
                foreach($this->allowedPlugins as $plugin) {
                    $this->mu()->execMe(
                        $this->mu()->getWebRootDirLocation(),
                        $this->mu()->getComposerEnvironmentVars() . 'composer config --no-interaction allow-plugins.' . $plugin . ' true',
                        'composer config --no-interaction allow-plugins.' . $plugin . ' true',
                        false
                    );
                }
            }
        }
        if ($this->installModuleAsVendorModule) {
            Composer::inst($this->mu())
                ->ClearCache()
                ->Require(
                    $this->mu()->getVendorName() . '/' . $this->mu()->getPackageName(),

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

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

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

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

                    'dev-' . $this->mu()->getNameOfTempBranch(),

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

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

                    $this->composerOptions
                );
            $branch = $this->mu()->getParentProjectForModuleBranchOrTag() ?: 'master';
            if($this->mu()->getNameOfTempBranch() !== $branch) {
                $gitLink = $this->mu()->getGitLink();

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

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

                $command = '
                    git init;
                    git remote add origin ' . $gitLink . ';
                    git pull origin ' . $altBranch . ';
                    git status;';
                $this->mu()->execMe(
                    $this->mu()->getGitRootDir(),
                    $command,
                    'Make sure it is a git repo',
                    false
                );
            }
        } else {
            Git::inst($this->mu())
                ->Clone(
                    $this->mu()->getWebRootDirLocation(),
                    $this->mu()->getGitLink(),
                    $this->mu()->getGitRootDir(),
                    $this->mu()->getNameOfTempBranch()
                );
            if ($this->mu()->getIsModuleUpgrade()) {
                $this->workoutExtraRequirementsFromModule();
            }
        }
        foreach ($this->alsoRequire as $package => $version) {
            Composer::inst($this->mu())
                ->ClearCache()
                ->Require(
                    $package,
                    $version,
                    $this->composerOptions
                );
        }

        $this->mu()->setBreakOnAllErrors(false);
        return null;
    }

    protected function workoutExtraRequirementsFromModule()
    {
        $composerJson = ComposerJsonFixes::inst($this->mu())
            ->getJSON($this->mu()->getGitRootDir());
        if (isset($composerJson['require'])) {
            foreach ($composerJson['require'] as $package => $version) {
                if (in_array($package, $this->ignoredPackageForModuleRequirements, true)) {
                    $this->mu()->colourPrint('Skipping ' . $package . ' as requirement');

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

                } else {
                    if ($version === 'dev-master') {
                        $this->mu()->colourPrint('Sticking with dev-master as version for ' . $package);
                    } else {
                        $version = '*';
                    }
                    if (! isset($this->alsoRequire[$package])) {
                        $this->alsoRequire[$package] = $version;
                    }
                }
            }
        }
    }

    protected function hasCommitAndPush()
    {
        return false;
    }
}