Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\AddTableNamePrivateStatic

Complexity

Total Complexity

13

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getTitle()	0	3	1
A	getDescription()	0	3	1
B	runActualTask()	0	42	10
A	hasCommitAndPush()	0	3	1

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

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

class AddTableNamePrivateStatic extends Task
{
    protected $taskStep = 's10';

    protected $listToSearchFor = [
        '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 private static table_name';
    }

    public function getDescription()
    {
        return '
            Adds a private static variable called "table_name" to any class that looks like a data object.';
    }

    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?

            $fileFinder = new FindFiles();
            $searchPath = $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?

            if (file_exists($searchPath)) {
                $flatArray = $fileFinder
                    ->setSearchPath($searchPath)
                    ->setExtensions(['php'])
                    ->getFlatFileArray();
                if (is_array($flatArray) && count($flatArray)) {
                    foreach ($flatArray as $path) {
                        $tableName = basename($path, '.php');
                        $newLine = 'private static $table_name = \'' . $tableName . '\';';
                        $filecontent = file_get_contents($path);
                        $hasNewLine = strpos($filecontent, 'private static $table_name');
                        if (! $hasNewLine) {
                            $positionOfPrivateStatic = 0;
                            foreach ($this->listToSearchFor as $item) {
                                $positionOfPrivateStatic = strpos($filecontent, $item);
                                if ($positionOfPrivateStatic) {
                                    break;
                                }
                            }
                            if ($positionOfPrivateStatic) {
                                $this->mu()->colourPrint('Adding  ' . $newLine . ' to ' . $path, 'green');

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

                                $filecontent =
                                    substr($filecontent, 0, $positionOfPrivateStatic) .
                                    "\r\n" . "\r\n" . '    ' . $newLine . "\r\n" . "\r\n" .
                                    substr($filecontent, $positionOfPrivateStatic);
                                file_put_contents($path, $filecontent);
                            }
                        }
                    }
                } else {
                    $this->mu()->colourPrint('Could not find any files in ' . $searchPath, 'red');
                }
            } else {
                $this->mu()->colourPrint('Could not find ' . $searchPath, 'blue');
            }
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        return true;
    }
}