Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\FixBadUseStatements

Complexity

Total Complexity

14

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setReplacementArray()	0	5	1
A	setIgnoreFolderArray()	0	5	1
A	getDescription()	0	3	1
A	getTitle()	0	3	1
A	hasCommitAndPush()	0	3	1
B	runActualTask()	0	57	9

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\UpgradeToSilverstripe4\Api\SearchAndReplaceAPI;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Task;

/**
 * Replaces a bunch of code snippets in preparation of the upgrade.
 * Controversial replacements will be replaced with a comment
 * next to it so you can review replacements easily.
 */
class FixBadUseStatements extends Task
{
    protected $taskStep = 's50';

    protected $debug = false;

    protected $replacementArray = [
        'src' => [
            'php' => [
                'use bool;',
                'use string;',
                'use int;',
                'use array;',
            ],
        ],
    ];

    private $ignoreFolderArray = [
        '.git',
    ];

    public function getTitle()
    {
        return 'Look for single use statements and comment them out as they are not correct.';
    }

    public function getDescription()
    {
        return '
            Goes through code and removes, for example, "use bool;", lines, as they do not make sense.';
    }

    public function setIgnoreFolderArray($a)
    {
        $this->ignoreFolderArray = $a;

        return $this;
    }

    public function setReplacementArray($a)
    {
        $this->replacementArray = $a;

        return $this;
    }

    public function runActualTask($params = []): ?string
    {
        //replacement data patterns that will be searched for

        if ($this->debug) {
            $this->mu()->colourPrint($this->replacementArray);

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

        }
        foreach ($this->mu()->getExistingModuleDirLocations() as $moduleDir) {

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

            //Start search machine from the module location. replace API
            $textSearchMachine = new SearchAndReplaceAPI($moduleDir);
            $textSearchMachine->setIsReplacingEnabled(true);
            $textSearchMachine->addToIgnoreFolderArray($this->ignoreFolderArray);

            /*For all the different patterns listed in the replacement array
            * iterate over them such that the $path would be 'src' and $patharray would be 'php'
            * together making it ['src']['php']
            */
            foreach ($this->replacementArray as $path => $pathArray) {
                $path = $moduleDir . '/' . $path ?: '';
                $path = $this->mu()->checkIfPathExistsAndCleanItUp($path);

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

                if (! file_exists($path)) {
                    $this->mu()->colourPrint("SKIPPING ${path} as it does not exist.");
                } else {
                    $textSearchMachine->setSearchPath($path);
                    foreach ($pathArray as $extension => $extensionArray) {
                        //setting extensions to search files within
                        $textSearchMachine->setExtensions(explode('|', $extension));
                        foreach ($extensionArray as $find) {
                            $caseSensitive = false;
                            $replacementType = 'BASIC';

                            // $this->mu()->colourPrint(
                            //     "++++++++++++++++++++++++++++++++++++\n".
                            //     "CHECKING\n".
                            //     "IN $path\n".
                            //     "FOR $extension FILES\n".
                            //     "BASE ".$moduleDir."\n".
                            //     "FIND '".$find."'\n".
                            //     "REPLACE ''\n".
                            //     "++++++++++++++++++++++++++++++++++++\n"
                            // );
                            $textSearchMachine->setSearchKey($find, $caseSensitive, $replacementType);
                            $textSearchMachine->setReplacementKey('');
                            $textSearchMachine->startSearchAndReplace();
                        }
                        //SHOW TOTALS
                        $replacements = $textSearchMachine->showFormattedSearchTotals();
                        if (! $replacements) {
                            //flush output anyway!
                            $this->mu()->colourPrint("No replacements for  ${extension}");
                        }
                        $this->mu()->colourPrint($textSearchMachine->getOutput());
                    }
                }
            }
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        return true;
    }
}