nystudio107\transcoder\helpers\Manifest

Complexity

Total Complexity

52

Size/Duplication

Total Lines	445
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	getFileContents()	0	39	5
B	getModule()	0	28	8
A	reportError()	0	7	3
A	includeJsModule()	0	21	5
A	getFileFromUri()	0	17	5
A	getJsonFile()	0	3	1
A	getModuleEntry()	0	23	4
A	includeCssModule()	0	15	3
A	registerCssModules()	0	8	3
A	registerJsModules()	0	8	3
B	getManifestFile()	0	33	6
A	__constructStatic()	0	14	2
A	combinePaths()	0	24	3
A	invalidateCaches()	0	5	1

<?php
/**
 * Twigpack plugin for Craft CMS 3.x
 *
 * Twigpack is the conduit between Twig and webpack, with manifest.json &
 * webpack-dev-server HMR support
 *
 * @link      https://nystudio107.com/

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2018 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\transcoder\helpers;

use nystudio107\transcoder\assetbundles\transcoder\TranscoderAsset;

use Craft;
use craft\helpers\Json as JsonHelper;
use craft\helpers\UrlHelper;

use yii\base\Exception;
use yii\base\InvalidConfigException;
use yii\caching\TagDependency;
use yii\web\NotFoundHttpException;

/**

Missing short description in doc comment

 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   Twigpack

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @link tag in class comment

Missing @category tag in class comment

Missing @license tag in class comment

class Manifest
{
    // Constants
    // =========================================================================

    const ASSET_CLASS = TranscoderAsset::class;

    const CACHE_KEY = 'twigpack-' . self::ASSET_CLASS;
    const CACHE_TAG = 'twigpack-' . self::ASSET_CLASS;

    const DEVMODE_CACHE_DURATION = 1;

    const SUPPRESS_ERRORS_FOR_MODULES = [
        'styles.js',
        'commons.js',
        'vendors.js',
        'vendors.css',
        'styles.css',
    ];

    // Protected Static Properties
    // =========================================================================

    protected static $config = [
        // If `devMode` is on, use webpack-dev-server to all for HMR (hot module reloading)
        'useDevServer' => false,
        // Manifest names
        'manifest' => [
            'legacy' => 'manifest.json',
            'modern' => 'manifest.json',
        ],
        // Public server config
        'server' => [
            'manifestPath' => '/',
            'publicPath' => '/',
        ],
        // webpack-dev-server config
        'devServer' => [
            'manifestPath' => 'http://127.0.0.1:8080',
            'publicPath' => '/',
        ],
    ];

    /**

Missing short description in doc comment

     * @var array
     */
    protected static $files;

    /**

Missing short description in doc comment

     * @var bool
     */
    protected static $isHot = false;

    // Public Static Methods
    // =========================================================================

    /**
     * Simulate a static constructor
     *
     * ManifestVariable constructor.
     * @noinspection MagicMethodsValidityInspection

There must be exactly one blank line before the tags in a doc comment

     */

Missing @return tag in function comment

    public static function __constructStatic()

Public method name "Manifest::__constructStatic" must not be prefixed with an underscore

Method name "Manifest::__constructStatic" is invalid; only PHP magic methods should be prefixed with a double underscore

    {
        self::invalidateCaches();
        $assetClass = self::ASSET_CLASS;
        $bundle = new $assetClass;
        $baseAssetsUrl = Craft::$app->assetManager->getPublishedUrl(
            $bundle->sourcePath,
            true

The call to yii\web\AssetManager::getPublishedUrl() has too many arguments starting with true.

        );
        self::$config['server']['manifestPath'] = Craft::getAlias($bundle->sourcePath);
        self::$config['server']['publicPath'] = $baseAssetsUrl;
        $useDevServer = getenv('NYS_PLUGIN_DEVSERVER');
        if ($useDevServer !== false) {
            self::$config['useDevServer'] = (bool)$useDevServer;
        }
    }

    /**
     * Get the passed in JS modules from the manifest, and register them in the current Craft view
     *
     * @param array $modules

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

Missing parameter comment

     * @throws NotFoundHttpException

Tag @throws cannot be grouped with parameter tags in a doc comment

     * @throws InvalidConfigException

Tag @throws cannot be grouped with parameter tags in a doc comment

     */

Missing @return tag in function comment

    public static function registerJsModules(array $modules)
    {
        $view = Craft::$app->getView();
        foreach($modules as $module) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $jsModule = self::getModule(self::$config, $module, 'modern');
            if ($jsModule) {
                $view->registerJsFile($jsModule, [

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'depends' => self::ASSET_CLASS
                ]);

For multi-line function calls, the closing parenthesis should be on a new line.

            }
        }
    }

    /**
     * Get the passed in CS modules from the manifest, and register them in the current Craft view
     *
     * @param array $modules

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @throws NotFoundHttpException

Tag @throws cannot be grouped with parameter tags in a doc comment

     * @throws InvalidConfigException

Tag @throws cannot be grouped with parameter tags in a doc comment

     */

Missing @return tag in function comment

    public static function registerCssModules(array $modules)
    {
        $view = Craft::$app->getView();
        foreach($modules as $module) {

Expected "foreach (...) {\n"; found "foreach(...) {\n"

            $cssModule = self::getModule(self::$config, $module, 'legacy');
            if ($cssModule) {
                $view->registerCssFile($cssModule, [

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'depends' => self::ASSET_CLASS
                ]);

For multi-line function calls, the closing parenthesis should be on a new line.

            }
        }
    }

    /**
     * Get the passed in JS module from the manifest, then output a `<script src="">` tag for it in the HTML
     *
     * @param string $moduleName

Missing parameter comment

     * @param bool   $async

Missing parameter comment

     *
     * @return null|string
     * @throws NotFoundHttpException
     */
    public static function includeJsModule(string $moduleName, bool $async)
    {
        $legacyModule = self::getModule(self::$config, $moduleName, 'legacy');
        if ($legacyModule === null) {
            return '';
        }
        if ($async) {
            $modernModule = self::getModule(self::$config, $moduleName, 'modern');
            if ($modernModule === null) {
                return '';
            }
        }
        $lines = [];
        if ($async) {
            $lines[] = "<script type=\"module\" src=\"{$modernModule}\"></script>";

The variable $modernModule does not seem to be defined for all execution paths leading up to this point.

            $lines[] = "<script nomodule src=\"{$legacyModule}\"></script>";
        } else {
            $lines[] = "<script src=\"{$legacyModule}\"></script>";
        }

        return implode("\r\n", $lines);
    }

    /**
     * Get the passed in CS module from the manifest, then output a `<link>` tag for it in the HTML
     *
     * @param string $moduleName

Missing parameter comment

     * @param bool   $async

Missing parameter comment

     *
     * @return string
     * @throws NotFoundHttpException
     */
    public static function includeCssModule(string $moduleName, bool $async): string
    {
        $legacyModule = self::getModule(self::$config, $moduleName, 'legacy', true);
        if ($legacyModule === null) {
            return '';
        }
        $lines = [];
        if ($async) {
            $lines[] = "<link rel=\"preload\" href=\"{$legacyModule}\" as=\"style\" onload=\"this.onload=null;this.rel='stylesheet'\" />";
            $lines[] = "<noscript><link rel=\"stylesheet\" href=\"{$legacyModule}\"></noscript>";
        } else {
            $lines[] = "<link rel=\"stylesheet\" href=\"{$legacyModule}\" />";
        }

        return implode("\r\n", $lines);
    }

    // Protected Static Methods
    // =========================================================================

    /**
     * Return the URI to a module
     *
     * @param array  $config

Missing parameter comment

     * @param string $moduleName

Missing parameter comment

     * @param string $type

Missing parameter comment

     * @param bool   $soft

Missing parameter comment

     *
     * @return null|string
     * @throws NotFoundHttpException
     */
    protected static function getModule(array $config, string $moduleName, string $type = 'modern', bool $soft = false)
    {
        // Get the module entry
        $module = self::getModuleEntry($config, $moduleName, $type, $soft);
        if ($module !== null) {
            $prefix = self::$isHot
                ? $config['devServer']['publicPath']
                : $config['server']['publicPath'];
            // If the module isn't a full URL, prefix it
            if (!UrlHelper::isAbsoluteUrl($module)) {
                $module = self::combinePaths($prefix, $module);
            }
            // Resolve any aliases
            $alias = Craft::getAlias($module, false);
            if ($alias) {
                $module = $alias;
            }
            // Make sure it's a full URL
            if (!UrlHelper::isAbsoluteUrl($module) && !is_file($module)) {

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

It seems like $module can also be of type true; however, parameter $url of craft\helpers\UrlHelper::isAbsoluteUrl() does only seem to accept string, maybe add an additional type check?

                try {
                    $module = UrlHelper::siteUrl($module);

It seems like $module can also be of type true; however, parameter $path of craft\helpers\UrlHelper::siteUrl() does only seem to accept string, maybe add an additional type check?

                } catch (Exception $e) {
                    Craft::error($e->getMessage(), __METHOD__);
                }
            }
        }

        return $module;

The expression return $module also could return the type true which is incompatible with the documented return type null|string.

    }

    /**
     * Return a module's raw entry from the manifest
     *
     * @param array  $config

Missing parameter comment

     * @param string $moduleName

Missing parameter comment

     * @param string $type

Missing parameter comment

     * @param bool   $soft

Missing parameter comment

     *
     * @return null|string
     * @throws NotFoundHttpException
     */
    protected static function getModuleEntry(array $config, string $moduleName, string $type = 'modern', bool $soft = false)
    {
        $module = null;
        // Get the manifest file
        $manifest = self::getManifestFile($config, $type);
        if ($manifest !== null) {
            // Make sure it exists in the manifest
            if (empty($manifest[$moduleName])) {
                // Don't report errors for any files in SUPPRESS_ERRORS_FOR_MODULES
                if (!in_array($moduleName, self::SUPPRESS_ERRORS_FOR_MODULES)) {
                    self::reportError(Craft::t(

The opening parenthesis of a multi-line function call should be the last content on the line.

                        'transcoder',
                        'Module does not exist in the manifest: {moduleName}',
                        ['moduleName' => $moduleName]
                    ), $soft);

For multi-line function calls, the closing parenthesis should be on a new line.

                }

                return null;
            }
            $module = $manifest[$moduleName];
        }

        return $module;
    }

    /**
     * Return a JSON-decoded manifest file
     *
     * @param array  $config

Missing parameter comment

     * @param string $type

Missing parameter comment

     *
     * @return null|array
     * @throws NotFoundHttpException
     */
    protected static function getManifestFile(array $config, string $type = 'modern')
    {
        $manifest = null;
        // Determine whether we should use the devServer for HMR or not
        $devMode = Craft::$app->getConfig()->getGeneral()->devMode;
        self::$isHot = ($devMode && $config['useDevServer']);
        // Try to get the manifest
        while ($manifest === null) {
            $manifestPath = self::$isHot
                ? $config['devServer']['manifestPath']
                : $config['server']['manifestPath'];
            // Normalize the path
            $path = self::combinePaths($manifestPath, $config['manifest'][$type]);
            $manifest = self::getJsonFile($path);
            // If the manifest isn't found, and it was hot, fall back on non-hot
            if ($manifest === null) {
                // We couldn't find a manifest; throw an error
                self::reportError(Craft::t(

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'transcoder',
                    'Manifest file not found at: {manifestPath}',
                    ['manifestPath' => $manifestPath]
                ), true);

For multi-line function calls, the closing parenthesis should be on a new line.

                if (self::$isHot) {
                    // Try again, but not with home module replacement
                    self::$isHot = false;
                } else {
                    // Give up and return null
                    return null;
                }
            }
        }

        return $manifest;
    }

    /**
     * Return the contents of a JSON file from a URI path
     *
     * @param string $path

Missing parameter comment

     *
     * @return null|array
     */
    protected static function getJsonFile(string $path)
    {
        return self::getFileFromUri($path, [JsonHelper::class, 'decodeIfJson']);
    }

    /**
     * Invalidate all of the manifest caches
     */

Missing @return tag in function comment

    public static function invalidateCaches()
    {
        $cache = Craft::$app->getCache();
        TagDependency::invalidate($cache, self::CACHE_TAG);
        Craft::info('All manifest caches cleared', __METHOD__);
    }

    /**
     * Return the contents of a file from a URI path
     *
     * @param string        $path

Missing parameter comment

     * @param callable|null $callback

Missing parameter comment

     *
     * @return null|mixed
     */
    protected static function getFileFromUri(string $path, callable $callback = null)
    {
        // Resolve any aliases
        $alias = Craft::getAlias($path, false);
        if ($alias) {
            $path = (string)$alias;
        }
        // Make sure it's a full URL
        if (!UrlHelper::isAbsoluteUrl($path) && !is_file($path)) {
            try {
                $path = UrlHelper::siteUrl($path);
            } catch (Exception $e) {
                Craft::error($e->getMessage(), __METHOD__);
            }
        }

        return self::getFileContents($path, $callback);
    }

    /**
     * Return the contents of a file from the passed in path
     *
     * @param string   $path

Missing parameter comment

     * @param callable $callback

Missing parameter comment

     *
     * @return null|mixed
     */
    protected static function getFileContents(string $path, callable $callback = null)
    {
        // Return the memoized manifest if it exists
        if (!empty(self::$files[$path])) {
            return self::$files[$path];
        }
        // Create the dependency tags
        $dependency = new TagDependency([

The opening parenthesis of a multi-line function call should be the last content on the line.

            'tags' => [
                self::CACHE_TAG,
                self::CACHE_TAG.$path,
            ],
        ]);

For multi-line function calls, the closing parenthesis should be on a new line.

        // Set the cache duration based on devMode
        $cacheDuration = Craft::$app->getConfig()->getGeneral()->devMode
            ? self::DEVMODE_CACHE_DURATION
            : null;
        // Get the result from the cache, or parse the file
        $cache = Craft::$app->getCache();
        $file = $cache->getOrSet(
            self::CACHE_KEY.$path,
            function () use ($path, $callback) {
                $result = null;
                $contents = @file_get_contents($path);
                if ($contents) {
                    $result = $contents;
                    if ($callback) {
                        $result = $callback($result);
                    }
                }

                return $result;
            },
            $cacheDuration,
            $dependency
        );
        self::$files[$path] = $file;

        return $file;
    }

    /**
     * Combined the passed in paths, whether file system or URL
     *
     * @param string ...$paths

Missing parameter comment

     *
     * @return string
     */
    protected static function combinePaths(string ...$paths): string
    {
        $last_key = count($paths) - 1;
        array_walk($paths, function (&$val, $key) use ($last_key) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            switch ($key) {
                case 0:

Line indented incorrectly; expected 12 spaces, found 16

                    $val = rtrim($val, '/ ');
                    break;
                case $last_key:

Line indented incorrectly; expected 12 spaces, found 16

                    $val = ltrim($val, '/ ');
                    break;
                default:

Line indented incorrectly; expected 12 spaces, found 16

                    $val = trim($val, '/ ');
                    break;
            }
        });

For multi-line function calls, the closing parenthesis should be on a new line.

        $first = array_shift($paths);
        $last = array_pop($paths);
        $paths = array_filter($paths);
        array_unshift($paths, $first);
        $paths[] = $last;

        return implode('/', $paths);
    }

    /**

Missing short description in doc comment

     * @param string $error

Missing parameter comment

     * @param bool   $soft

Missing parameter comment

     *
     * @throws NotFoundHttpException
     */

Missing @return tag in function comment

    protected static function reportError(string $error, $soft = false)
    {
        $devMode = Craft::$app->getConfig()->getGeneral()->devMode;
        if ($devMode && !$soft) {
            throw new NotFoundHttpException($error);
        }
        Craft::error($error, __METHOD__);
    }
}

// Simulate a static constructor
Manifest::__constructStatic();