Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\AddResourceGitIgnore

Complexity

Total Complexity

5

Size/Duplication

Total Lines	51
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	3	1
A	hasCommitAndPush()	0	3	1
A	getTitle()	0	3	1
A	updateModuleConfigFile()	0	2	1
A	runActualTask()	0	4	1

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

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

/**
 * Runs through the source code and adds hidden Silverstripe property and method documentation to classes
 * based on the database array and has many lists
 */
class AddResourceGitIgnore extends Task
{
    protected $taskStep = 's60';

    protected $resourcesFolder = 'resources';

    protected $string = <<<txt
    *
    !.htaccess
    !.gitignore
txt;

    public function getTitle()
    {
        return 'Add git ignore to resources folder. TO BE COMPLETED';
    }

    public function getDescription()
    {
        return 'Adds a gitignore file to the resources folder';
    }

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

The assignment to $dir is dead and can be removed.

The method getWebRootDirLocation() does not exist on Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader. Since you implemented __call, consider adding a @method annotation.

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

        return null;
    }

    protected function updateModuleConfigFile(string $moduleName)

The parameter $moduleName is not used and could be removed.

    {
        // $moduleLocation = $this->findModuleNameLocation($moduleName);

        // $fileLocation = $this->mu()->getWebRootDirLocation() . '/' . $moduleLocation . '/_config/' . $this->configFileName;
        // FileSystemFixes::inst($this->mu())
        //     ->removeDirOrFile($fileLocation);
        // $ideannotatorConfigForModule = $this->ideannotatorConfig;
        // $ideannotatorConfigForModule = str_replace(self::REPLACER, $moduleName, $ideannotatorConfigForModule);
        // $this->mu()->execMe(
        //     $this->mu()->getWebRootDirLocation(),
        //     'echo \'' . str_replace('\'', '"', $ideannotatorConfigForModule) . '\' > ' . $fileLocation,
        //     'Adding IDEAnnotator configuration',
        //     false
        // );
        // if (! file_exists($fileLocation)) {
        //     user_error('Could not locate ' . $fileLocation);
        // }
    }

    protected function hasCommitAndPush(): bool
    {
        return true;
    }
}