carono / yii2-bower-asset

src/Asset.php

<?php


namespace carono\yii2bower;

use yii\helpers\ArrayHelper;
use yii\helpers\Inflector;
use yii\helpers\StringHelper;
use yii\helpers\VarDumper;
use yii\web\AssetBundle;
use yii\web\View;

class Asset extends AssetBundle
{
    public $packageNamespace = 'app\runtime\bower';
    public $packages = [];
    public $alias = '@bower';
    public $config = 'bower.json';
    protected static $_installedPackages = [];

    public function init()
    {
        $timestamp = $this->getFileTimestamp(static::getClassFile(get_class($this)));
        static::loadPackages($this->alias, $this->config);
        foreach ($this->packages as $idx => $value) {
            $package = is_numeric($idx) ? $value : $idx;
            $files = is_numeric($idx) ? [] : $value;
            if (!static::packageInstalled($package, $this->alias) && !static::packageAsFolder($package, $this->alias)) {
                continue;
            }
            if (!$this->assetExists($package) || $this->needRewrite($package)) {
                if ($classFile = static::createAssetClass($package, $this->packageNamespace, $this->alias, $files)) {
                    touch($classFile, (int)$timestamp);
                }
            };
            $this->depends[] = static::getPackageClass($package, $this->packageNamespace);
        }
        parent::init();
    }

    /**
     * @param $package
     * @param $namespace
     * @return string
     */
    public static function getPackageClass($package, $namespace)
    {
        return $namespace . '\\' . static::formClassNameFromPackage($package);
    }

    /**
     * @param $package
     * @return string
     */
    public static function formClassNameFromPackage($package)
    {
        return Inflector::camelize($package);
    }

    /**
     * @param $package
     * @param $namespace
     * @return string
     */
    protected static function getPackageFile($package, $namespace)
    {
        return static::getClassFile(static::getPackageClass($package, $namespace));
    }

    public static function packageAsFolder($package, $alias)
    {
        return is_dir(\Yii::getAlias("$alias/$package"));

It seems like Yii::getAlias($alias.'/'.$package) can also be of type false; however, parameter $filename of is_dir() does only seem to accept string, maybe add an additional type check?

    }

    public static function packageInstalled($package, $alias, $config = 'bower.json')
    {
        if (!static::$_installedPackages) {

The expression static::_installedPackages 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.

            static::loadPackages($alias, $config);
        }
        return isset(static::$_installedPackages[$package]);
    }

    public static function loadPackages($alias, $config)
    {
        static::$_installedPackages = [];
        foreach (glob(\Yii::getAlias("$alias/**/$config"), GLOB_BRACE) as $file) {

It seems like Yii::getAlias($alias.'/**/'.$config) can also be of type false; however, parameter $pattern of glob() does only seem to accept string, maybe add an additional type check?

            $json = json_decode(file_get_contents($file), true);
            if (($name = ArrayHelper::getValue($json, 'name'))) {
                static::$_installedPackages[$name] = $file;
            }
        }
    }

    public static function getPackageJson($package, $alias)
    {
        if (isset(static::$_installedPackages[$package])) {
            $file = static::$_installedPackages[$package];
            return json_decode(file_get_contents($file), true);
        }

        if (static::packageAsFolder($package, $alias)) {
            return [];
        }

        return null;
    }

    public static function getPackageDir($package, $alias)
    {
        if (isset(static::$_installedPackages[$package])) {
            $file = static::$_installedPackages[$package];
            return basename(dirname($file));
        }

        if (static::packageAsFolder($package, $alias)) {
            return $package;
        }

        return null;
    }

    protected static function filesToConfig($files)
    {
        $config = [];
        foreach ($files as $key => $file) {
            if (!is_numeric($key)) {
                $config[$key] = $file;
                continue;
            }
            if (StringHelper::endsWith($file, '.css')) {
                $config['css'][] = ltrim($file, "./\\");
            }
            if (StringHelper::endsWith($file, '.js')) {
                $config['js'][] = ltrim($file, "./\\");
            }
        }
        return $config;
    }

    /**
     * @param $package
     * @param $namespace
     * @param $alias
     * @param array $files
     * @return mixed|string
     */
    public static function createAssetClass($package, $namespace, $alias, $files = [])
    {
        $configJson = static::getPackageJson($package, $alias);

        if ($configJson === null) {
            \Yii::warning("Bower $package package not found");
            return false;
        }

        $main = ArrayHelper::getValue($configJson, 'main');

        $dir = static::getPackageDir($package, $alias);

        $defaultConfig = [
            'baseUrl' => '@web',
            'jsOptions' => ['position' => View::POS_END]
        ];
        $packageConfig = self::filesToConfig($files ?: (array)$main);
        $sourcePath = implode('/', array_filter([
            $alias,
            $dir,
            trim((string)ArrayHelper::remove($packageConfig, 'sourcePath', ''), '/')
        ]));
        $config = ArrayHelper::merge($defaultConfig, $packageConfig, ['sourcePath' => $sourcePath]);
        $str = '';
        foreach ($config as $key => $value) {
            $str .= '    public $' . $key . ' = ' . VarDumper::export($value) . ";\n";
        }
        $class = static::formClassNameFromPackage($package);
        $template = <<<PHP
<?php

namespace $namespace;


use yii\web\AssetBundle;
use yii\web\View;

class $class extends AssetBundle
{
$str
}
PHP;
        $dir = \Yii::getAlias('@' . str_replace('\\', '/', ltrim($namespace, '\\')));
        if (!is_dir($dir)) {

It seems like $dir can also be of type false; however, parameter $filename of is_dir() does only seem to accept string, maybe add an additional type check?

            if (!mkdir($dir, 0777, true) && !is_dir($dir)) {

It seems like $dir can also be of type false; however, parameter $directory of mkdir() does only seem to accept string, maybe add an additional type check?

                throw new \RuntimeException(sprintf('Directory "%s" was not created', $dir));

It seems like $dir can also be of type false; however, parameter $values of sprintf() does only seem to accept double|integer|string, maybe add an additional type check?

            }
        }
        $file = $dir . DIRECTORY_SEPARATOR . $class . '.php';

Are you sure $dir of type false|string can be used in concatenation?

        file_put_contents($file, $template);
        return $file;
    }

    /**
     * @param $package
     * @return bool
     */
    protected function assetExists($package)
    {
        return class_exists(static::getPackageClass($package, $this->packageNamespace));
    }

    /**
     * @param $package
     * @return bool
     */
    protected function needRewrite($package)
    {
        $timestamp = $this->getFileTimestamp(static::getPackageFile($package, $this->packageNamespace));
        if ($timestamp) {

The expression $timestamp of type false|integer is loosely compared to true; this is ambiguous if the integer can be 0. You might want to explicitly use !== false instead.

            $assetTimestamp = $this->getFileTimestamp(static::getClassFile(get_class($this)));
            return $timestamp != $assetTimestamp;
        }
        return false;
    }

    /**
     * @param $class
     * @return string
     */
    protected static function getClassFile($class)
    {
        return \Yii::getAlias('@' . ltrim(str_replace('\\', '/', $class), '/')) . '.php';

Are you sure Yii::getAlias('@' . ltrim(str_replace('\', '/', $class), '/')) of type false|string can be used in concatenation?

    }

    /**
     * @param $file
     * @return bool|int
     */
    protected function getFileTimestamp($file)
    {
        if ($timestamp = @filemtime($file)) {
            $timestamp = (int)$timestamp / 100 * 100;
        }
        return $timestamp;
    }
}