Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\AddNamespace

Complexity

Total Complexity

10

Size/Duplication

Total Lines	81
Duplicated Lines	0 %

Importance

Changes

0

4 Methods

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

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\UpgradeToSilverstripe4\Tasks\Task;

/**
 * Places all your code into namespaces (provided by silvertripe/runActualTask),
 * using the PSR-4 approach (matching folders and namespaces)
 */
class AddNamespace extends Task
{
    protected $taskStep = 's40';

    public function getTitle()
    {
        return 'Name Spaces';
    }

    public function getDescription()
    {
        return '
            Places all your code into namespaces (provided by silvertripe/runActualTask),
            using the PSR-4 approach (matching folders and namespaces).';
    }

    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?

        $dirsDone = [];
        foreach ($codeDirs as $baseNameSpace => $codeDir) {
            $directories = new \RecursiveDirectoryIterator($codeDir);
            foreach (new \RecursiveIteratorIterator($directories) as $file => $fileObject) {
                if ($fileObject->getExtension() === 'php') {
                    $dirName = realpath(dirname($file));

It seems like $file can also be of type null and true; however, parameter $path of dirname() does only seem to accept string, maybe add an additional type check?

                    if (! isset($dirsDone[$dirName])) {
                        $dirsDone[$dirName] = true;
                        $nameSpaceAppendix = str_replace($codeDir, '', $dirName);
                        $nameSpaceAppendix = trim($nameSpaceAppendix, '/');
                        $nameSpaceAppendix = str_replace('/', '\\', $nameSpaceAppendix);
                        //prepend $baseNameSpace
                        $nameSpace = $baseNameSpace . '\\' . $nameSpaceAppendix;
                        //turn into array
                        $nameSpaceArray = explode('\\', $nameSpace);
                        $nameSpaceArrayNew = [];
                        foreach ($nameSpaceArray as $nameSpaceSnippet) {
                            if ($nameSpaceSnippet) {
                                $nameSpaceArrayNew[] = $this->mu()->cleanCamelCase($nameSpaceSnippet);

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

                            }
                        }
                        $nameSpace = implode('\\', $nameSpaceArrayNew);
                        $this->mu()->execMe(

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

                            $codeDir,
                            'php ' . $this->mu()->getLocationOfSSUpgradeModule() . ' add-namespace "' . $nameSpace . '" ' . $dirName . ' --root-dir=' . $this->mu()->getWebRootDirLocation() . ' --write --psr4 -vvv',

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

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

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

                            'adding namespace: ' . $nameSpace . ' to ' . $dirName,
                            false
                        );
                    }
                }
            }
            // } else {
            //     //@todo: we assume 'code' for now ...
            //     $codeDirs = $this->mu()->findNameSpaceAndCodeDirs();
            //     foreach ($codeDirs as $codeDir) {
            //         $this->mu()->execMe(
            //             $this->mu()->getLocationOfSSUpgradeModule(),
            //             'find '.$codeDir.' -mindepth 1 -maxdepth 2 -type d -exec '.
            //                 'sh -c '.
            //                     '\'dir=${1##*/}; '.
            //                     'php '.$this->mu()->getLocationOfSSUpgradeModule().' add-namespace "'.$this->mu()->getVendorNamespace().'\\'.$this->mu()->getPackageNamespace().'\\$dir" "$dir" --write --psr4 -vvv'.
            //                 '\' _ {} '.
            //             '\;',
            //             'adding name spaces',
            //             false
            //         );
            //     }
            // }
            $this->mu()->execMe(
                $codeDir,
                'php ' . $this->mu()->getLocationOfSSUpgradeModule() . ' add-namespace "' . $baseNameSpace . '\" ' . $codeDir . ' --root-dir=' . $this->mu()->getWebRootDirLocation() . ' --write --psr4 -vvv',
                'adding namespace: ' . $baseNameSpace . ' to ' . $codeDir,
                false
            );
            $this->setCommitMessage('API:  adding namespaces');
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        return true;
    }
}