Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks\AddVendorExposeDataToComposer

Complexity

Total Complexity

9

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getDescription()	0	3	1
A	getTitle()	0	3	1
A	runActualTask()	0	30	6
A	hasCommitAndPush()	0	3	1

<?php

namespace Sunnysideup\UpgradeToSilverstripe4\Tasks\IndividualTasks;

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

/**
 * Updates the composer requirements to reflect the new version and package names
 * in the composer file of your module
 */
class AddVendorExposeDataToComposer extends Task
{
    protected $taskStep = 's50';

    protected $toExpose = [
        'javascript',
        'images',
        'img',
        'css',
        'fonts',
        'js',
        'client/javascript',
        'client/images',
        'client/img',
        'client/css',
        'client/fonts',
        'client/js',
    ];

    public function getTitle()
    {
        return 'Adds vendor expose data to composer';
    }

    public function getDescription()
    {
        return '
            By default we expose all the client related files (images, css and javascript)';
    }

    public function runActualTask($params = []): ?string
    {
        $expose = [];
        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?

            foreach ($this->toExpose as $folder) {
                if (file_exists($moduleDir . '/' . $folder)) {
                    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.

                        //expose "javascript"
                        $expose[] = $folder;
                    } else {
                        //expose "app/javascript"
                        $expose[] = basename($moduleDir) . '/' . $folder;
                    }
                }
            }
        }
        if (count($expose)) {
            $command =
            'if(!isset($data["extra"]["expose"])) { '
                . '    $data["extra"]["expose"] = ["' . implode('", "', $expose) . '"]; '
                . '}';
            ComposerJsonFixes::inst($this->mu())->UpdateJSONViaCommandLine(
                $this->mu()->getGitRootDir(),

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

                $command,
                'exposing: ' . implode(', ', $expose)
            );

            $this->setCommitMessage('API:  exposing folders' . implode(',', $expose));
        }
        return null;
    }

    protected function hasCommitAndPush()
    {
        return true;
    }
}