Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\AddPSR4Autoloading

Complexity

Total Complexity

8

Size/Duplication

Total Lines	97
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	1

5 Methods

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

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

use Sunnysideup\UpgradeToSilverstripe4\Tasks\Helpers\Composer;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Helpers\ComposerJsonFixes;
use Sunnysideup\UpgradeToSilverstripe4\Tasks\Task;

/**
 * Fixes the folder name cases in to make them PSR4 compatible
 * e.g.
 * yourmodule/src/model becomes yourmodule/src/Model
 */
class AddPSR4Autoloading extends Task
{
    protected $taskStep = 's50';

    public function getTitle()
    {
        return 'Add PSR-4 Autoloading to the composer file.';
    }

    public function getDescription()
    {
        return '
            Goes through all the folders in the code or src dir and adds them to the composer.json file as autoloader.
            This must run after the folder names have been changed to CamelCase (see: UpperCaseFolderNamesForPSR4).
        ';
    }

    public function runActualTask($params = []): ?string
    {
        //project composer.json
        // - app/src/...
        // - app2/src/...
        // DO FOR BOTH
        //module composor.json
        //  ONLY FOR module
        $baseCommands = '
            if(! isset($data["autoload"])) {
                $data["autoload"] = [];
            }
            if(! isset($data["autoload"]["psr-4"])) {
                $data["autoload"]["psr-4"] = [];
            }
        ';
        $addPage = '';
        if ($this->mu()->getIsModuleUpgrade()) {

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

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

            $addPage = '
            if(! isset($data["autoload"]["files"])) {
                $data["autoload"]["files"] = [
                    "app/src/Page.php",
                    "app/src/PageController.php"
                ];
            }';
        }

        $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?

        $webRootLocation = $this->mu()->getWebRootDirLocation();

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

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

        $command = $baseCommands . $addPage;
        $comment = 'Adding autoload Page and Page controller details in ' . $webRootLocation . '/composer.json';
        ComposerJsonFixes::inst($this->mu())->UpdateJSONViaCommandLine(
            $webRootLocation,
            $command,
            $comment
        );
        foreach ($codeDirs as $baseNameSpace => $codeDir) {
            $location = trim(str_replace($webRootLocation, '', $codeDir), '/') . '/';

It seems like $webRootLocation can also be of type Sunnysideup\UpgradeToSilverstripe4\ModuleUpgrader and Sunnysideup\UpgradeToSilverstripe4\Traits\Creator; however, parameter $search of str_replace() does only seem to accept string|string[], maybe add an additional type check?

            //update webroot composer file
            //location:
            $command = $baseCommands . '
            $data["autoload"]["psr-4"]["' . $this->doubleSlash($baseNameSpace) . '"] = "' . $location . '";';
            $comment = 'Adding autoload psr-4 details in ' .
                $webRootLocation . '/composer.json: ' .
                $baseNameSpace . ' => ' . $location;
            ComposerJsonFixes::inst($this->mu())->UpdateJSONViaCommandLine(
                $webRootLocation,
                $command,
                $comment
            );
            if ($this->mu()->getIsModuleUpgrade()) {
                $moduleLocation = dirname($codeDir);
                $location = trim(basename($codeDir), '/') . '/';
                $command = $baseCommands . '
                $data["autoload"]["psr-4"]["' .
                $this->doubleSlash($baseNameSpace) . '"] = "' .
                ltrim($location, '/') . '";';
                $comment = 'Adding autoload psr-4 details in ' .
                    $moduleLocation . '/composer.json: ' .
                    $baseNameSpace . ' => ' . $location;
                ComposerJsonFixes::inst($this->mu())->UpdateJSONViaCommandLine(
                    $moduleLocation,
                    $command,
                    $comment
                );
            }
        }
        Composer::inst($this->mu())
            ->DumpAutoload();
        return null;
    }

    protected function hasCommitAndPush()
    {
        return true;
    }

    protected function doubleSlash($str)
    {
        return str_replace('\\', '\\\\', $str);
    }
}