Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\ApplyPSR2

Complexity

Total Complexity

7

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Importance

Changes	11
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getTitle()	0	3	1
A	getDescription()	0	3	1
A	hasCommitAndPush()	0	3	1
A	runActualTask()	0	57	4

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\PHP2CommandLine\PHP2CommandLineSingleton;
use Sunnysideup\UpgradeToSilverstripe4\Api\FileSystemFixes;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Helpers\Composer;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Task;

/**
 * Adds a new branch to your repository that is going to be used for upgrading it.
 */
class ApplyPSR2 extends Task
{
    protected $taskStep = 's60';

    protected $composerOptions = '';

    protected $lintingIssuesFileName = 'LINTING_ERRORS';

    public function getTitle()
    {
        return 'Apply PSR2 Cleanup.';
    }

    public function getDescription()
    {
        return '
            Applies a light cleanup of the code to match PSR-2 standards.';
    }

    public function runActualTask($params = []): ?string
    {
        $webRoot = $this->mu()->getWebRootDirLocation();

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

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

        $localInstall = (bool) PHP2CommandLineSingleton::commandExists('sake-ling-all');
        $commandAdd = '';
        if ($localInstall) {
            $commandAdd = 'vendor/bin/';
            Composer::inst($this->mu())
                ->RequireDev(
                    'sunnysideup/easy-coding-standards',
                    'dev-master',
                    $this->composerOptions
                );
        }

        //1. apply
        foreach ($this->mu()->findNameSpaceAndCodeDirs() as $baseNameSpace => $codeDir) {

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

            $knownIssuesFileName = $codeDir . '/' . $this->lintingIssuesFileName;
            $relativeDir = str_replace($webRoot, '', $codeDir);

It seems like $webRoot can also be of type Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader and Sunnysideup\UpgradeToSilverstripe4\Traits\Creator; however, parameter $search of str_replace() does only seem to accept string|string[], maybe add an additional type check?

            $relativeDir = ltrim($relativeDir, '/');
            FileSystemFixes::inst($this->mu())
                ->removeDirOrFile($knownIssuesFileName);
            $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?

                $webRoot,

It seems like $webRoot 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?

                $commandAdd . 'sake-lint-all ' . $relativeDir,
                'Apply easy coding standards to ' . $relativeDir . ' (' . $baseNameSpace . ')',
                false
            );
            $this->mu()->execMe(
                $webRoot,
                $commandAdd . 'sake-lint-all ' . $relativeDir,
                'Apply easy coding standards a second time ' . $relativeDir . ' (' . $baseNameSpace . ')',
                false
            );
            $this->mu()->execMe(
                $webRoot,
                $commandAdd . 'sake-lint-all ' . $relativeDir . ' > ' . $knownIssuesFileName,
                'Apply easy coding standards a third time ' . $relativeDir . ' (' . $baseNameSpace . ') and saving to ' . $knownIssuesFileName,
                false
            );
            $this->mu()->execMe(
                $webRoot,
                $commandAdd . 'sslint-stan ' . $relativeDir . ' >> ' . $knownIssuesFileName,
                'Apply phpstan. to ' . $relativeDir . ' (' . $baseNameSpace . ') and saving to: ' . $knownIssuesFileName,
                false
            );
        }
        if ($localInstall) {
            $commandAdd = 'vendor/bin/';

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

            Composer::inst($this->mu())
                ->RemoveDev(
                    'sunnysideup/easy-coding-standards',
                    'dev-master',
                    $this->composerOptions
                );
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        return true;
    }
}