Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\PHPCompatabilityCheck

Complexity

Total Complexity

8

Size/Duplication

Total Lines	98
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

5 Methods

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

<?php

//requires https://github.com/squizlabs/PHP_CodeSniffer
//requires https://github.com/PHPCompatibility/PHPCompatibility\
//see: https://decentproductivity.com/codesniffer-and-phpcompatibility/'

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

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

/**
 * Delete the web root directory to allow for a fresh install.
 */
class PHPCompatabilityCheck extends Task
{
    protected $taskStep = 's00';

    protected $composerOptions = '';

    protected $phpVersion = '7.4';

    public function getTitle()
    {
        return 'PHP Compatibility Check';
    }

    public function getDescription()
    {
        return 'Outputs a file showing errors prevent code from being compatible with php ' . $this->phpVersion;
    }

    public function setPhpVersion(string $phpVersion)
    {
        $this->phpVersion = $phpVersion;

        return $this;
    }

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

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.

        if (PHP2CommandLineSingleton::commandExists('sslint-compat')) {
            foreach ($this->mu()->findNameSpaceAndCodeDirs() as $codeDir) {

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

                // $file = str_replace('\\', '-', $baseNameSpace);
                $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?

                    'sslint-compat ' . $codeDir,
                    'Running PHP Compatibility Check in: ' . $codeDir,
                    false
                );
            }
        } else {
            Composer::inst($this->mu())
                ->RequireDev(
                    'squizlabs/php_codesniffer',
                    '',
                    $this->composerOptions
                )
                ->RequireDev(
                    'phpcompatibility/php-compatibility',
                    '',
                    $this->composerOptions
                );

            $this->mu()->execMe(
                $webRoot,
                './vendor/bin/phpcs --config-set installed_paths vendor/phpcompatibility/php-compatibility',
                'Adding php compatability info',
                false
            );
            $this->mu()->execMe(
                $webRoot,
                './vendor/bin/phpcs --config-set colors 1',
                'Adding colour',
                false
            );
            $this->mu()->execMe(
                $webRoot,
                './vendor/bin/phpcs --config-set severity 1',
                'Showing all errors',
                false
            );
            $this->mu()->execMe(
                $webRoot,
                './vendor/bin/phpcs --config-show',
                'Showing all errors',
                false
            );
            foreach ($this->mu()->findNameSpaceAndCodeDirs() as $codeDir) {
                // $file = str_replace('\\', '-', $baseNameSpace);
                $this->mu()->execMe(
                    $webRoot,
                    './vendor/bin/phpcs' .
                    ' -p ' . $codeDir .
                    ' --standard=PHPCompatibility' .
                    ' --extensions=php ' .
                    ' --runtime-set testVersion ' . $this->phpVersion,
                    'Running PHP Compatibility Check in: ' . $codeDir,
                    false
                );
            }
            Composer::inst($this->mu())
                ->Remove('squizlabs/php_codesniffer', true)
                ->Remove('phpcompatibility/php-compatibility', true);
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        return false;
    }
}