Tenside\Core\Composer\ComposerJson

Complexity

Total Complexity

28

Size/Duplication

Total Lines	314
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

20 Methods

Rating	Name	Duplication	Size	Complexity
A	requirePackage()	0	4	1
A	requirePackageDev()	0	4	1
A	replacePackage()	0	4	1
A	providePackage()	0	4	1
A	getRequire()	0	4	1
A	getRequireDev()	0	4	1
A	getReplace()	0	4	1
A	getProvide()	0	4	1
A	isRequiring()	0	4	1
A	isRequiringDev()	0	4	1
A	isReplacing()	0	4	1
A	isProviding()	0	4	1
A	setLink()	0	6	1
A	hasLink()	0	4	1
A	getLink()	0	4	1
A	isLocked()	0	4	1
A	lockPackage()	0	23	3
B	unlockPackage()	0	24	3
A	setLock()	0	8	2
A	cleanEmptyArraysInPath()	0	13	4

<?php

/**
 * This file is part of tenside/core.
 *
 * (c) Christian Schiffler <c.schiffler@cyberspectrum.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * This project is provided in good faith and hope to be usable by anyone.
 *
 * @package    tenside/core
 * @author     Christian Schiffler <c.schiffler@cyberspectrum.de>
 * @copyright  2015 Christian Schiffler <c.schiffler@cyberspectrum.de>
 * @license    https://github.com/tenside/core/blob/master/LICENSE MIT
 * @link       https://github.com/tenside/core
 * @filesource
 */

namespace Tenside\Core\Composer;

use Composer\Package\PackageInterface;
use Tenside\Core\Util\JsonFile;

/**
 * This class abstracts the composer.json file manipulation.
 *
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 */
class ComposerJson extends JsonFile
{
    /**
     * Add a requirement to composer.json.
     *
     * @param string $name       The package name.
     *
     * @param string $constraint The version constraint.
     *
     * @return ComposerJson
     */
    public function requirePackage($name, $constraint)
    {
        return $this->setLink('require', $name, $constraint);
    }

    /**
     * Add a requirement to composer.json for dev.
     *
     * @param string $name       The package name.
     *
     * @param string $constraint The version constraint.
     *
     * @return ComposerJson
     */
    public function requirePackageDev($name, $constraint)
    {
        return $this->setLink('require-dev', $name, $constraint);
    }

    /**
     * Add a replacement to composer.json.
     *
     * @param string $name       The package name.
     *
     * @param string $constraint The version constraint.
     *
     * @return ComposerJson
     */
    public function replacePackage($name, $constraint)
    {
        return $this->setLink('replace', $name, $constraint);
    }

    /**
     * Add a replacement to composer.json.
     *
     * @param string $name       The package name.
     *
     * @param string $constraint The version constraint.
     *
     * @return ComposerJson
     */
    public function providePackage($name, $constraint)
    {
        return $this->setLink('provide', $name, $constraint);
    }

    /**
     * Get a requirement from composer.json.
     *
     * @param string $name The package name.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getRequire($name)
    {
        return $this->getLink('require', $name);
    }

    /**
     * Get a requirement from composer.json for dev.
     *
     * @param string $name The package name.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getRequireDev($name)
    {
        return $this->getLink('require-dev', $name);
    }

    /**
     * Get a requirement from composer.json.
     *
     * @param string $name The package name.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getReplace($name)
    {
        return $this->getLink('replace', $name);
    }

    /**
     * Get a requirement from composer.json.
     *
     * @param string $name The package name.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    public function getProvide($name)
    {
        return $this->getLink('provide', $name);
    }

    /**
     * Check if a require entry has been defined.
     *
     * @param string $name The package name.
     *
     * @return bool
     */
    public function isRequiring($name)
    {
        return $this->hasLink('require', $name);
    }

    /**
     * Check if a require-dev entry has been defined.
     *
     * @param string $name The package name.
     *
     * @return bool
     */
    public function isRequiringDev($name)
    {
        return $this->hasLink('require-dev', $name);
    }

    /**
     * Check if a replacement entry has been defined.
     *
     * @param string $name The package name.
     *
     * @return bool
     */
    public function isReplacing($name)
    {
        return $this->hasLink('replace', $name);
    }

    /**
     * Check if a provide entry has been defined.
     *
     * @param string $name The package name.
     *
     * @return bool
     */
    public function isProviding($name)
    {
        return $this->hasLink('provide', $name);
    }

    /**
     * Set a link on a dependency to a constraint.
     *
     * @param string $type       The link type (require, require-dev, provide, replace).
     *
     * @param string $name       The package name.
     *
     * @param string $constraint The version constraint.
     *
     * @return ComposerJson
     */
    private function setLink($type, $name, $constraint)
    {
        $this->set($type . '/' . $this->escape($name), $constraint);

        return $this;
    }

    /**
     * Check if a link has been defined.
     *
     * @param string $type The link type (require, require-dev, provide, replace).
     *
     * @param string $name The package name.
     *
     * @return bool
     */
    private function hasLink($type, $name)
    {
        return $this->has($type . '/' . $this->escape($name));
    }

    /**
     * Check if a link has been defined.
     *
     * @param string $type The link type (require, require-dev, provide, replace).
     *
     * @param string $name The package name.
     *
     * @return string|null

Should the return type not be array|string|integer|null? Also, consider making the array more specific, something like array<String>, or String[].

     */
    private function getLink($type, $name)
    {
        return $this->get($type . '/' . $this->escape($name));
    }

    /**
     * Check if a package is locked.
     *
     * @param string $packageName The name of the package to test.
     *
     * @return bool
     */
    public function isLocked($packageName)
    {
        return $this->has('extra/tenside/version-locks/' . $this->escape($packageName));
    }

    /**
     * Unlock a locked package version.
     *
     * @param PackageInterface $package The repository holding the packages to convert.
     *
     * @return ComposerJson
     */
    public function lockPackage(PackageInterface $package)
    {
        $name = $package->getPrettyName();
        $lock = 'extra/tenside/version-locks/' . $this->escape($name);

        // Nothing to do?
        if ($this->has($lock)) {
            return $this;
        }

        if ($this->isRequiring($name)) {
            $this->set($lock, $this->getRequire($name));
        } else {
            $this->set($lock, false);
        }

        $this->requirePackage(
            $package->getPrettyName(),
            PackageConverter::convertPackageVersion($package, true)
        );

        return $this;
    }

    /**
     * Unlock a locked package version.
     *
     * @param PackageInterface $package The repository holding the packages to convert.
     *
     * @return ComposerJson
     */
    public function unlockPackage(PackageInterface $package)
    {
        $name = $package->getPrettyName();
        $lock = 'extra/tenside/version-locks/' . $this->escape($name);

        // Nothing to do?
        if (!$this->has($lock)) {
            return $this;
        }

        if (false === ($constraint = $this->get($lock))) {
            $this->remove($lock);
            $this->requirePackage($name, null);
            $this->cleanEmptyArraysInPath('extra/tenside');

            return $this;
        }

        $this->requirePackage($name, $constraint);
        $this->remove($lock);
        $this->cleanEmptyArraysInPath('extra/tenside');

        return $this;
    }

    /**
     * Set the locking state for the passed package.
     *
     * @param PackageInterface $package The package to lock.
     *
     * @param bool             $state   The desired state.
     *
     * @return ComposerJson
     */
    public function setLock(PackageInterface $package, $state)
    {
        if ((bool) $state) {
            return $this->lockPackage($package);
        }

        return $this->unlockPackage($package);
    }

    /**
     * Cleanup the array section at the given path by removing empty sub arrays.
     *
     * @param string $path The base path to remove empty elements from.
     *
     * @return void
     */
    private function cleanEmptyArraysInPath($path)
    {
        $subs = $this->getEntries($path);
        if (!empty($subs)) {
            foreach ($subs as $subPath) {
                $this->cleanEmptyArraysInPath($subPath);
            }
        }

        if ([] === $this->get($path)) {
            $this->remove($path);
        }
    }
}