Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\AddTableName

Complexity

Total Complexity

10

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	setFindArray()	0	5	1
A	getDescription()	0	3	1
A	setExtensionArray()	0	5	1
A	getTitle()	0	3	1
A	hasCommitAndPush()	0	3	1
B	runActualTask()	0	54	5

<?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 AddTableName extends Task
{
    protected $taskStep = 's10';

    protected $debug = false;

    private $ignoreFolderArray = [
        'extensions',
        'Extensions',
    ];

    private $extensionArray = [
        'php',
    ];

    private $findArray = [
        'private static $db',
        'private static $has_one' .
        'private static $belongs_to =',
        'private static $has_many =',
        'private static $many_many =',
        'private static $belongs_many_many =',
    ];

    public function getTitle()
    {
        return 'Add the table name ';
    }

    public function getDescription()
    {
        return '
            Finds $db and $has_one and adds the private static $table_name for the class...';
    }

    public function setExtensionArray($a)
    {
        $this->extensionArray = $a;

        return $this;
    }

    public function setFindArray($a)
    {
        $this->findArray = $a;

        return $this;
    }

    public function runActualTask($params = []): ?string
    {
        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?

            $moduleDir = $this->mu()->findMyCodeDir($moduleDir);

It seems like findMyCodeDir() 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->setFileReplacementMaxCount(1);
            $textSearchMachine->setIgnoreFileIfFound(['private static $table_name']);
            $textSearchMachine->addToIgnoreFolderArray($this->ignoreFolderArray);
            $this->mu()->colourPrint("Checking ${moduleDir}");

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

            $moduleDir = $this->mu()->checkIfPathExistsAndCleanItUp($moduleDir);

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($moduleDir)) {
                $this->mu()->colourPrint("SKIPPING ${moduleDir} as it does not exist.");
            } else {
                $textSearchMachine->setSearchPath($moduleDir);
                $textSearchMachine->setExtensions($this->extensionArray); //setting extensions to search files within
                $this->mu()->colourPrint(
                    "++++++++++++++++++++++++++++++++++++\n" .
                    "CHECKING\n" .
                    "IN ${moduleDir}\n" .
                    'FOR ' . implode(',', $this->extensionArray) . " FILES\n" .
                    'BASE ' . $moduleDir . "\n" .
                    "++++++++++++++++++++++++++++++++++++\n"
                );
                foreach ($this->findArray as $finalFind) {
                    $caseSensitive = true;
                    $replacementType = 'COMPLEX';
                    $comment = 'Check that is class indeed extends DataObject and that it is not a data-extension!';
                    $finalReplace = '
    private static $table_name = \'[SEARCH_REPLACE_CLASS_NAME_GOES_HERE]\';

    ' . $finalFind;
                    $this->mu()->colourPrint(
                        '    --- FIND: ' . $finalFind . "\n" .
                        '    --- REPLACE: ' . $finalReplace . "\n"
                    );

                    $textSearchMachine->setSearchKey($finalFind, $caseSensitive, $replacementType);
                    $textSearchMachine->setReplacementKey($finalReplace);
                    $textSearchMachine->setComment($comment);
                    $textSearchMachine->startSearchAndReplace();
                }

                //SHOW TOTALS
                $replacements = $textSearchMachine->showFormattedSearchTotals();
                if (! $replacements) {
                    //flush output anyway!
                    $this->mu()->colourPrint('No replacements for  ' . implode(',', $this->extensionArray));
                }
                $this->mu()->colourPrint($textSearchMachine->getOutput());
            }
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        return true;
    }
}