MagentoHackathon\Composer\Magento\ProjectConfig

Complexity

Total Complexity

58

Size/Duplication

Total Lines	467
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

52.03%

Importance

Changes	5
Bugs	1	Features	2

40 Methods

Rating	Name	Duplication	Size	Complexity
A	hasMagentoRootDir()	0	4	1
A	hasMagentoForce()	0	4	1
A	transformArrayKeysToLowerCase()	0	4	1
A	getComposerRepositories()	0	4	1
A	skipSuggestComposerRepositories()	0	4	1
A	setIncludeRootPackage()	0	4	1
A	getIncludeRootPackage()	0	4	1
A	getVendorDir()	0	8	2
A	fetchVarFromExtraConfig()	0	4	1
A	applyMagentoConfig()	0	5	1
A	getLibraryPath()	0	4	1
A	getLibraryConfigByPackagename()	0	4	1
A	setMagentoRootDir()	0	4	1
A	getMagentoVarDir()	0	4	1
A	setDeployStrategy()	0	4	1
A	getDeployStrategy()	0	4	1
A	hasDeployStrategy()	0	4	1
A	hasDeployStrategyOverwrite()	0	4	1
A	hasMagentoDeployIgnore()	0	4	1
A	setMagentoForce()	0	4	1
A	getMagentoForce()	0	4	1
A	getMagentoForceByPackageName()	0	4	1
A	hasAutoAppendGitignore()	0	4	1
A	getPathMappingTranslations()	0	4	1
A	hasPathMappingTranslations()	0	4	1
A	hasExtraField()	0	4	1
A	updateExtraConfig()	0	5	1
A	mustApplyBootstrapPatch()	0	4	1
A	__construct()	0	9	2
A	fetchVarFromConfigArray()	0	10	2
A	getMagentoRootDir()	0	12	1
A	getDeployStrategyOverwrite()	0	6	1
A	getModuleSpecificDeployStrategy()	0	10	2
A	getModuleSpecificSortValue()	0	13	3
A	getMagentoDeployIgnore()	0	6	1
A	getModuleSpecificDeployIgnores()	0	17	4
A	getMagentoDeployOverwrite()	0	6	1
A	getMagentoMapOverwrite()	0	6	1
C	updateExtraJson()	0	32	8
A	updateFileCleanly()	0	16	3

<?php
/**
 *
 *
 *
 *
 */

namespace MagentoHackathon\Composer\Magento;

use Composer\Factory;
use Composer\Json\JsonFile;
use Composer\Json\JsonManipulator;
use SebastianBergmann\Exporter\Exception;

class ProjectConfig
{
    // Config Keys
    const EXTRA_KEY = 'extra';

    const SORT_PRIORITY_KEY = 'magento-deploy-sort-priority';

    const MAGENTO_ROOT_DIR_KEY = 'magento-root-dir';

    const MAGENTO_PROJECT_KEY = 'magento-project';

    const MAGENTO_DEPLOY_STRATEGY_KEY = 'magento-deploystrategy';
    const MAGENTO_DEPLOY_STRATEGY_OVERWRITE_KEY = 'magento-deploystrategy-overwrite';
    const MAGENTO_MAP_OVERWRITE_KEY = 'magento-map-overwrite';
    const MAGENTO_DEPLOY_IGNORE_KEY = 'magento-deploy-ignore';

    const MAGENTO_FORCE_KEY = 'magento-force';

    const AUTO_APPEND_GITIGNORE_KEY = 'auto-append-gitignore';

    const PATH_MAPPINGS_TRANSLATIONS_KEY = 'path-mapping-translations';

    const INCLUDE_ROOT_PACKAGE_KEY = 'include-root-package';

    // Default Values
    const DEFAULT_MAGENTO_ROOT_DIR = 'root';

    const EXTRA_WITH_BOOTSTRAP_PATCH_KEY = 'with-bootstrap-patch';

    const EXTRA_WITH_SKIP_SUGGEST_KEY = 'skip-suggest-repositories';

    protected $libraryPath;
    protected $libraryPackages;
    protected $extra;
    protected $composerConfig;

    /**
     * @param array $extra
     * @param array $composerConfig
     */
    public function __construct(array $extra, array $composerConfig)
    {
        $this->extra = $extra;
        $this->composerConfig = $composerConfig;

        if (!is_null($projectConfig = $this->fetchVarFromConfigArray($this->extra, self::MAGENTO_PROJECT_KEY))) {
            $this->applyMagentoConfig($projectConfig);
        }
    }

    /**
     * @param array $array
     * @param string|integer $key
     * @param mixed $default
     *
     * @return mixed
     */
    protected function fetchVarFromConfigArray($array, $key, $default = null)
    {
        $array = (array)$array;
        $result = $default;
        if (isset($array[$key])) {
            $result = $array[$key];
        }

        return $result;
    }

    /**
     * @param      $key
     * @param null $default
     *
     * @return null
     */
    protected function fetchVarFromExtraConfig($key, $default = null)
    {
        return $this->fetchVarFromConfigArray($this->extra, $key, $default);
    }

    /**
     * @param $config
     */
    protected function applyMagentoConfig($config)
    {
        $this->libraryPath = $this->fetchVarFromConfigArray($config, 'libraryPath');
        $this->libraryPackages = $this->fetchVarFromConfigArray($config, 'libraries');
    }

    /**
     * @return mixed
     */
    public function getLibraryPath()
    {
        return $this->libraryPath;
    }

    /**
     * @param $packagename
     *
     * @return null
     */
    public function getLibraryConfigByPackagename($packagename)
    {
        return $this->fetchVarFromConfigArray($this->libraryPackages, $packagename);
    }

    /**
     * @return string
     */
    public function getMagentoRootDir()
    {
        return rtrim(
            trim(
                $this->fetchVarFromExtraConfig(
                    self::MAGENTO_ROOT_DIR_KEY,
                    self::DEFAULT_MAGENTO_ROOT_DIR
                )
            ),
            DIRECTORY_SEPARATOR
        );
    }

    /**
     * @param $rootDir
     */
    public function setMagentoRootDir($rootDir)
    {
        $this->updateExtraConfig(self::MAGENTO_ROOT_DIR_KEY, rtrim(trim($rootDir), DIRECTORY_SEPARATOR));
    }

    /**
     * @return bool
     */
    public function hasMagentoRootDir()
    {
        return $this->hasExtraField(self::MAGENTO_ROOT_DIR_KEY);
    }

    public function getMagentoVarDir()
    {
        return $this->getMagentoRootDir().'var'.DIRECTORY_SEPARATOR;
    }

    /**
     * @param $deployStrategy
     */
    public function setDeployStrategy($deployStrategy)
    {
        $this->updateExtraConfig(self::MAGENTO_DEPLOY_STRATEGY_KEY, trim($deployStrategy));
    }

    /**
     * @return string
     */
    public function getDeployStrategy()
    {
        return trim((string)$this->fetchVarFromExtraConfig(self::MAGENTO_DEPLOY_STRATEGY_KEY));
    }

    /**
     * @return bool
     */
    public function hasDeployStrategy()
    {
        return $this->hasExtraField(self::MAGENTO_DEPLOY_STRATEGY_KEY);
    }

    /**
     * @return array
     */
    public function getDeployStrategyOverwrite()
    {
        return (array)$this->transformArrayKeysToLowerCase(
            $this->fetchVarFromExtraConfig(self::MAGENTO_DEPLOY_STRATEGY_OVERWRITE_KEY, array())
        );
    }

    /**
     * @return bool
     */
    public function hasDeployStrategyOverwrite()
    {
        return $this->hasExtraField(self::MAGENTO_DEPLOY_STRATEGY_OVERWRITE_KEY);
    }

    /**
     * @param $packagename
     *
     * @return integer
     */
    public function getModuleSpecificDeployStrategy($packagename)
    {
        $moduleSpecificDeployStrategies = $this->getDeployStrategyOverwrite();

        $strategyName = $this->getDeployStrategy();
        if (isset($moduleSpecificDeployStrategies[$packagename])) {
            $strategyName = $moduleSpecificDeployStrategies[$packagename];
        }
        return $strategyName;
    }

    /**
     * @param $packagename
     *
     * @return integer
     */
    public function getModuleSpecificSortValue($packagename)
    {
        $sortPriorityArray = $this->fetchVarFromExtraConfig(self::SORT_PRIORITY_KEY, array());

Are you sure the assignment to $sortPriorityArray is correct as $this->fetchVarFromExtraConfig(self::SORT_PRIORITY_KEY, array()) (which targets MagentoHackathon\Composer\Magento\ProjectConfig::fetchVarFromExtraConfig()) seems to always return null.

        if (isset($sortPriorityArray[$packagename])) {
            $sortValue = $sortPriorityArray[$packagename];
        } else {
            $sortValue = 100;
            if ($this->getModuleSpecificDeployStrategy($packagename) === 'copy') {

The strict comparison === seems to always evaluate to false as the types of $this->getModuleSpecificDeployStrategy($packagename) (integer) and 'copy' (string) can never be identical. Maybe you want to use a loose comparison == instead?

                $sortValue++;
            }
        }
        return $sortValue;
    }

    /**
     * @return array
     */
    public function getMagentoDeployIgnore()
    {
        return (array)$this->transformArrayKeysToLowerCase(
            $this->fetchVarFromExtraConfig(self::MAGENTO_DEPLOY_IGNORE_KEY)
        );
    }

    /**
     * @param $packagename
     *
     * @return array
     */
    public function getModuleSpecificDeployIgnores($packagename)
    {
        $moduleSpecificDeployIgnores = array();
        if ($this->hasMagentoDeployIgnore()) {
            $magentoDeployIgnore = $this->getMagentoDeployIgnore();
            if (isset($magentoDeployIgnore['*'])) {
                $moduleSpecificDeployIgnores = $magentoDeployIgnore['*'];
            }
            if (isset($magentoDeployIgnore[$packagename])) {
                $moduleSpecificDeployIgnores = array_merge(
                    $moduleSpecificDeployIgnores,
                    $magentoDeployIgnore[$packagename]
                );
            }
        }
        return $moduleSpecificDeployIgnores;
    }

    /**
     * @return bool
     */
    public function hasMagentoDeployIgnore()
    {
        return $this->hasExtraField(self::MAGENTO_DEPLOY_IGNORE_KEY);
    }

    /**
     * @param $magentoForce
     */
    public function setMagentoForce($magentoForce)
    {
        $this->updateExtraConfig(self::MAGENTO_FORCE_KEY, trim($magentoForce));
    }

    /**
     * @return string
     */
    public function getMagentoForce()
    {
        return (bool)$this->fetchVarFromExtraConfig(self::MAGENTO_FORCE_KEY);
    }

    /**
     * @return bool
     */
    public function hasMagentoForce()
    {
        return $this->hasExtraField(self::MAGENTO_FORCE_KEY);
    }

    public function getMagentoForceByPackageName($packagename)

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

    {
        return $this->getMagentoForce();
    }

    /**
     * @return bool
     */
    public function hasAutoAppendGitignore()
    {
        return $this->hasExtraField(self::AUTO_APPEND_GITIGNORE_KEY);
    }

    /**
     * @return array
     */
    public function getPathMappingTranslations()
    {
        return (array)$this->fetchVarFromExtraConfig(self::PATH_MAPPINGS_TRANSLATIONS_KEY);
    }

    /**
     * @return bool
     */
    public function hasPathMappingTranslations()
    {
        return $this->hasExtraField(self::PATH_MAPPINGS_TRANSLATIONS_KEY);
    }

    /**
     * @return array
     */
    public function getMagentoDeployOverwrite()
    {
        return (array)$this->transformArrayKeysToLowerCase(
            $this->fetchVarFromExtraConfig(self::MAGENTO_DEPLOY_STRATEGY_OVERWRITE_KEY)
        );
    }

    public function getMagentoMapOverwrite()
    {
        return $this->transformArrayKeysToLowerCase(
            (array)$this->fetchVarFromExtraConfig(self::MAGENTO_MAP_OVERWRITE_KEY)
        );
    }
    protected function hasExtraField($key)
    {
        return (bool)!is_null($this->fetchVarFromExtraConfig($key));
    }

    /**
     * @param $key
     * @param $value
     */
    protected function updateExtraConfig($key, $value)
    {
        $this->extra[$key] = $value;
        $this->updateExtraJson();
    }

    /**
     * @throws \Exception
     */
    protected function updateExtraJson()
    {
        $composerFile = Factory::getComposerFile();

        if (!file_exists($composerFile) && !file_put_contents($composerFile, "{\n}\n")) {
            throw new Exception(sprintf('%s could not be created', $composerFile));
        }

        if (!is_readable($composerFile)) {
            throw new Exception(sprintf('%s is not readable', $composerFile));
        }

        if (!is_writable($composerFile)) {
            throw new Exception(sprintf('%s is not writable', $composerFile));
        }

        $json = new JsonFile($composerFile);
        $composer = $json->read();

        $baseExtra = array_key_exists(self::EXTRA_KEY, $composer)
            ? $composer[self::EXTRA_KEY]
            : array();

        if (!$this->updateFileCleanly($json, $baseExtra, $this->extra, self::EXTRA_KEY)) {
            foreach ($this->extra as $key => $value) {
                $baseExtra[$key] = $value;
            }

            $composer[self::EXTRA_KEY] = $baseExtra;
            $json->write($composer);
        }
    }

    /**
     * @param JsonFile $json
     * @param array    $base
     * @param array    $new
     * @param          $rootKey
     *
     * @return bool
     */
    private function updateFileCleanly(JsonFile $json, array $base, array $new, $rootKey)

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

    {
        $contents = file_get_contents($json->getPath());

        $manipulator = new JsonManipulator($contents);

        foreach ($new as $childKey => $childValue) {
            if (!$manipulator->addLink($rootKey, $childKey, $childValue)) {
                return false;
            }
        }

        file_put_contents($json->getPath(), $manipulator->getContents());

        return true;
    }

    /**
     * @param array $array
     *
     * @return array
     */
    public function transformArrayKeysToLowerCase(array $array)
    {
        return array_change_key_case($array, CASE_LOWER);
    }

    public function getComposerRepositories()
    {
        return $this->fetchVarFromConfigArray($this->composerConfig, 'repositories', array());
    }

    /**
     * Get Composer vendor directory
     *
     * @return string
     */
    public function getVendorDir()
    {
        return $this->fetchVarFromConfigArray(
            isset($this->composerConfig['config']) ? $this->composerConfig['config'] : array(),
            'vendor-dir',
            getcwd() . '/vendor'
        );
    }

    /**
     * @return boolean
     */
    public function mustApplyBootstrapPatch()
    {
        return (bool) $this->fetchVarFromExtraConfig(self::EXTRA_WITH_BOOTSTRAP_PATCH_KEY, true);
    }

    /**
     * @return boolean
     */
    public function skipSuggestComposerRepositories()
    {
        return (bool) $this->fetchVarFromExtraConfig(self::EXTRA_WITH_SKIP_SUGGEST_KEY, false);
    }

    /**
     * @param $includeRootPackage
     */
    public function setIncludeRootPackage($includeRootPackage)
    {
        $this->updateExtraConfig(self::INCLUDE_ROOT_PACKAGE_KEY, trim($includeRootPackage));
    }

    /**
     * @return bool
     */
    public function getIncludeRootPackage()
    {
        return (bool)$this->fetchVarFromExtraConfig(self::INCLUDE_ROOT_PACKAGE_KEY);
    }
}