Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\FixTemplateIncludeStatements

Complexity

Total Complexity

10

Size/Duplication

Total Lines	94
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

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

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

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

class FixTemplateIncludeStatements extends Task
{
    protected $taskStep = 's30';

    protected $debug = false;

    private $extensionArray = [
        'ss',
    ];

    private $findArray = [
        '<% include ',
    ];

    public function getTitle()
    {
        return 'Add Namespacing to include statements in templates.';
    }

    public function getDescription()
    {
        return '
            Go through all templates and fix the include statements by adding namespacing e.g. % include Order % becomes % include Sunnysideup\Ecommerce\Includes\Order %.';
    }

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

        return $this;
    }

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

        return $this;
    }

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

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

        $caseSensitive = false;
        foreach ($codeDirs as $baseNameSpace => $codeDir) {
            $baseDir = dirname($codeDir);
            //Start search machine from the module location. replace API
            $textSearchMachine = new SearchAndReplaceAPI($baseDir);
            $textSearchMachine->setIsReplacingEnabled(true);
            // $textSearchMachine->setFileNameMustContain('<% include');
            $this->mu()->colourPrint("Checking ${baseDir}");

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

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

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($baseDir)) {
                $this->mu()->colourPrint("SKIPPING ${baseDir} as it does not exist.");
            } else {
                $textSearchMachine->setSearchPath($baseDir);
                $textSearchMachine->setExtensions($this->extensionArray); //setting extensions to search files within
                $this->mu()->colourPrint(
                    "++++++++++++++++++++++++++++++++++++\n" .
                    "CHECKING\n" .
                    "IN ${baseDir}\n" .
                    'FOR ' . implode(',', $this->extensionArray) . " FILES\n" .
                    'BASE ' . $baseDir . "\n" .
                    "++++++++++++++++++++++++++++++++++++\n"
                );

                foreach ($this->findArray as $finalFind) {
                    $replacementType = 'BASIC';
                    $finalReplace = '<% include ' . $baseNameSpace . '\Includes';
                    $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;
    }
}