Bee-Lab / bowerphp

src/Bowerphp/Config/Config.php

<?php

/*
 * This file is part of Bowerphp.
 *
 * (c) Massimiliano Arione <massimiliano.arione@bee-lab.net>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Bowerphp\Config;

use Bowerphp\Package\PackageInterface;
use Bowerphp\Util\Filesystem;
use RuntimeException;

/**
 * Config
 */
class Config implements ConfigInterface
{
    protected $cacheDir;

    protected $installDir;

    protected $filesystem;

    protected $basePackagesUrl = 'http://registry.bower.io/packages/';

    protected $saveToBowerJsonFile = false;

    protected $bowerFileNames = ['bower.json', 'package.json'];

    protected $stdBowerFileName = 'bower.json';

    /**
     * @param Filesystem $filesystem
     */
    public function __construct(Filesystem $filesystem)
    {
        $this->filesystem = $filesystem;
        $this->cacheDir = $this->getHomeDir() . '/.cache/bowerphp';
        $this->installDir = getcwd() . '/bower_components';
        $rc = getcwd() . '/.bowerrc';

        if ($this->filesystem->exists($rc)) {
            $json = json_decode($this->filesystem->read($rc), true);
            if (is_null($json)) {
                throw new RuntimeException('Invalid .bowerrc file.');
            }
            if (isset($json['directory'])) {
                $this->installDir = getcwd() . '/' . $json['directory'];
            }
            if (isset($json['storage']) && isset($json['storage']['packages'])) {
                $this->cacheDir = $json['storage']['packages'];
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getBasePackagesUrl()
    {
        return $this->basePackagesUrl;
    }

    /**
     * {@inheritdoc}
     */
    public function getCacheDir()
    {
        return $this->cacheDir;
    }

    /**
     * {@inheritdoc}
     */
    public function getInstallDir()
    {
        return $this->installDir;
    }

    /**
     * {@inheritdoc}
     */
    public function isSaveToBowerJsonFile()
    {
        return $this->saveToBowerJsonFile;
    }

    /**
     * {@inheritdoc}
     */
    public function setSaveToBowerJsonFile($flag = true)
    {
        $this->saveToBowerJsonFile = $flag;
    }

    /**
     * {@inheritdoc}
     */
    public function initBowerJsonFile(array $params)
    {
        $file = getcwd() . '/' . $this->stdBowerFileName;
        $json = json_encode($this->createAClearBowerFile($params), JSON_PRETTY_PRINT);

        return $this->filesystem->write($file, $json);
    }

    /**
     * {@inheritdoc}
     */
    public function updateBowerJsonFile(PackageInterface $package)
    {
        if (!$this->isSaveToBowerJsonFile()) {
            return 0;
        }

        $decode = $this->getBowerFileContent();
        $decode['dependencies'][$package->getName()] = $package->getRequiredVersion();
        $file = getcwd() . '/' . $this->stdBowerFileName;
        $json = json_encode($decode, JSON_PRETTY_PRINT);

        return $this->filesystem->write($file, $json);
    }

    /**
     * {@inheritdoc}
     */
    public function updateBowerJsonFile2(array $old, array $new)
    {
        $json = json_encode(array_merge($old, $new), JSON_PRETTY_PRINT);
        $file = getcwd() . '/' . $this->stdBowerFileName;

        return $this->filesystem->write($file, $json);
    }

    /**
     * {@inheritdoc}
     */
    public function getBowerFileContent()
    {
        if (!$this->bowerFileExists()) {
            throw new RuntimeException('No ' . $this->stdBowerFileName . ' found. You can run "init" command to create it.');
        }
        $bowerJson = $this->filesystem->read(getcwd() . '/' . $this->stdBowerFileName);
        if (empty($bowerJson) || !is_array($decode = json_decode($bowerJson, true))) {
            throw new RuntimeException(sprintf('Malformed JSON in %s: %s.', $this->stdBowerFileName, $bowerJson));
        }

        return $decode;
    }

    /**
     * {@inheritdoc}
     */
    public function getOverridesSection()
    {
        if ($this->bowerFileExists()) {
            $bowerData = $this->getBowerFileContent();
            if ($bowerData && array_key_exists('overrides', $bowerData)) {

The expression $bowerData of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

                return $bowerData['overrides'];
            }
        }

        return [];
    }

    /**
     * {@inheritdoc}
     */
    public function getOverrideFor($packageName)
    {
        $overrides = $this->getOverridesSection();
        if (array_key_exists($packageName, $overrides)) {
            return $overrides[$packageName];
        }

        return [];
    }

    /**
     * {@inheritdoc}
     */
    public function getPackageBowerFileContent(PackageInterface $package)
    {
        $file = $this->getInstallDir() . '/' . $package->getName() . '/.bower.json';
        if (!$this->filesystem->exists($file)) {
            throw new RuntimeException(sprintf('Could not find .bower.json file for package %s.', $package->getName()));
        }
        $bowerJson = $this->filesystem->read($file);
        $bower = json_decode($bowerJson, true);
        if (is_null($bower)) {
            throw new RuntimeException(sprintf('Invalid content in .bower.json for package %s.', $package->getName()));
        }

        return $bower;

The return type of return $bower; (object|integer|double|string|array|boolean) is incompatible with the return type declared by the interface Bowerphp\Config\ConfigInterface::getPackageBowerFileContent of type array.

    }

    /**
     * {@inheritdoc}
     */
    public function bowerFileExists()
    {
        return $this->filesystem->exists(getcwd() . '/' . $this->stdBowerFileName);
    }

    /**
     * @param  array $params
     * @return array
     */
    protected function createAClearBowerFile(array $params)
    {
        $structure = [
            'name'    => $params['name'],
            'authors' => [
                0 => 'Beelab <info@bee-lab.net>',
                1 => $params['author'],
            ],
            'private'      => true,
            'dependencies' => new \StdClass(),
        ];

        return $structure;
    }

    /**
     * @return string
     */
    protected function getHomeDir()
    {
        if (defined('PHP_WINDOWS_VERSION_MAJOR')) {
            $appData = getenv('APPDATA');
            if (empty($appData)) {
                throw new \RuntimeException('The APPDATA environment variable must be set for bowerphp to run correctly');
            }

            return strtr($appData, '\\', '/');
        }
        $home = getenv('HOME');
        if (empty($home)) {
            throw new \RuntimeException('The HOME environment variable must be set for bowerphp to run correctly');
        }

        return rtrim($home, '/');
    }
}