Asset::resolve() - Code Metrics - Inspection of "add index.php to public dir" - zikula/core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c681fc...9457d4 )

by Craig

created 2020-01-27 02:02 UTC

Asset::resolve() B

↳ Parent: Asset

Complexity

Conditions	10
Paths	47

Size

Total Lines	54
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes	9
Bugs	3	Features	0

Metric	Value
cc	10
eloc	30
c	9
b	3
f	0
nc	47
nop	1
dl	0
loc	54
rs	7.6666

How to fix Long Method Complexity

<?php

declare(strict_types=1);

/*
 * This file is part of the Zikula package.
 *
 * Copyright Zikula Foundation - https://ziku.la/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Zikula\ThemeModule\Engine;

use InvalidArgumentException;
use Symfony\Component\Asset\Packages;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\HttpKernel\Bundle\Bundle;
use Symfony\Component\Routing\RouterInterface;
use Zikula\Bundle\CoreBundle\AbstractBundle;
use Zikula\Bundle\CoreBundle\HttpKernel\ZikulaHttpKernelInterface;

/**
 * Class Asset
 *
 * This class locates assets accounting for possible overrides in public/overrides/$bundleName or in the
 * active theme. It is foremost used by the zasset() Twig template plugin, but can be utilized as a standalone
 * service as well. All asset types (js, css, images) will work.
 *
 * Asset paths must begin with `@` in order to be processed (and possibly overridden) by this class.
 * Assets that do not contain `@` are passed through to the standard symfony asset management.
 *
 * Overrides are in this order:
 *  1) public/overrides/$bundleName/*
 *  2) public/themes/$theme/$bundleName/*
 *  3) public/modules/$bundleName/*
 */
class Asset
{
    /**
     * @var ZikulaHttpKernelInterface
     */
    private $kernel;

    /**
     * @var Packages
     */
    private $assetPackages;

    /**
     * @var RouterInterface
     */
    private $router;

    /**
     * @var Filesystem
     */
    private $fileSystem;

    /**
     * @var Engine
     */
    private $themeEngine;

    public function __construct(
        ZikulaHttpKernelInterface $kernel,
        Packages $assetPackages,
        RouterInterface $router,
        Filesystem $fileSystem,
        Engine $themeEngine
    ) {
        $this->kernel = $kernel;
        $this->assetPackages = $assetPackages;
        $this->router = $router;
        $this->fileSystem = $fileSystem;
        $this->themeEngine = $themeEngine;
    }

    /**
     * Returns path for asset.
     * Confirms actual file existence before returning path
     */
    public function resolve(string $path): string
    {
        $projectDir = $this->kernel->getProjectDir();
        $publicDir = $projectDir . '/public';
        $basePath = $this->router->getContext()->getBaseUrl();
        $httpRootDir = str_replace($basePath, '', $publicDir);

        // return immediately for straight asset paths
        if ('@' !== $path[0]) {
            if (0 === mb_strpos($path, '/')) {
                $path = mb_substr($path, 1);
            }
            $publicPath = $this->assetPackages->getUrl($path);
            if (false !== realpath($httpRootDir . $publicPath)) {
                return $publicPath;
            }
        }

        [$bundleName, $originalPath] = explode(':', $path);

        // try to locate asset in public override path
        $overridePath = $publicDir . '/overrides/' . mb_substr($bundleName, 1) . '/' . $originalPath;
        if (false !== $fullPath = realpath($overridePath)) {

            $publicPath = $this->assetPackages->getUrl($overridePath);
            if (false !== realpath($httpRootDir . $publicPath)) {
                return $publicPath;
            }
        }

        // try to locate asset in public theme path
        $themeName = $this->themeEngine->getTheme()->getName();
        $overridePath = $publicDir . '/themes/' . strtolower($themeName) . '/' . mb_substr($bundleName, 1) . '/' . $originalPath;
        if (false !== $fullPath = realpath($overridePath)) {
            $publicPath = $this->assetPackages->getUrl($overridePath);
            if (false !== realpath($httpRootDir . $publicPath)) {
                return $publicPath;
            }
        }

        // try to locate asset in it's normal public directory
        $path = $this->mapZikulaAssetPath($bundleName, $originalPath);
        if (false !== $fullPath = realpath($publicDir . '/' . $path)) {
            $publicPath = $this->assetPackages->getUrl($path);
            if (false !== realpath($httpRootDir . $publicPath)) {
                return $publicPath;
            }
        }

        // Asset not found in public.
        // copy the asset from the Bundle directory to /public and then call this method again
        $fullPath = $this->kernel->locateResource($bundleName . '/Resources/public/' . $originalPath);
        $this->fileSystem->copy($fullPath, $publicDir . '/' . $path);

        return $this->resolve($bundleName . ':' . $originalPath);
    }

    /**
     * Maps zasset path argument
     * e.g. "@AcmeBundle:css/foo.css" to `AcmeBundle/Resources/public/css/foo.css`
     */
    private function mapZikulaAssetPath(?string $bundleName, ?string $path): string
    {
        if (!isset($bundleName) || !isset($path)) {
            throw new InvalidArgumentException('No bundle name resolved, must be like "@AcmeBundle:css/foo.css"');
        }
        $bundle = $this->kernel->getBundle(mb_substr($bundleName, 1));
        if ($bundle instanceof Bundle) {
            $path = '/' . $path;
            if ($bundle instanceof AbstractBundle) {
                $path = $bundle->getRelativeAssetPath() . $path;
            } else {
                $path = mb_strtolower('Bundles/' . mb_substr($bundle->getName(), 0, -mb_strlen('Bundle'))) . $path;
            }
        }

        return $path;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Zikula package.
7			*
8			* Copyright Zikula Foundation - https://ziku.la/
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Zikula\ThemeModule\Engine;
15
16			use InvalidArgumentException;
17			use Symfony\Component\Asset\Packages;
18			use Symfony\Component\Filesystem\Filesystem;
19			use Symfony\Component\HttpKernel\Bundle\Bundle;
20			use Symfony\Component\Routing\RouterInterface;
21			use Zikula\Bundle\CoreBundle\AbstractBundle;
22			use Zikula\Bundle\CoreBundle\HttpKernel\ZikulaHttpKernelInterface;
23
24			/**
25			* Class Asset
26			*
27			* This class locates assets accounting for possible overrides in public/overrides/$bundleName or in the
28			* active theme. It is foremost used by the zasset() Twig template plugin, but can be utilized as a standalone
29			* service as well. All asset types (js, css, images) will work.
30			*
31			* Asset paths must begin with `@` in order to be processed (and possibly overridden) by this class.
32			* Assets that do not contain `@` are passed through to the standard symfony asset management.
33			*
34			* Overrides are in this order:
35			* 1) public/overrides/$bundleName/*
36			* 2) public/themes/$theme/$bundleName/*
37			* 3) public/modules/$bundleName/*
38			*/
39			class Asset
40			{
41			/**
42			* @var ZikulaHttpKernelInterface
43			*/
44			private $kernel;
45
46			/**
47			* @var Packages
48			*/
49			private $assetPackages;
50
51			/**
52			* @var RouterInterface
53			*/
54			private $router;
55
56			/**
57			* @var Filesystem
58			*/
59			private $fileSystem;
60
61			/**
62			* @var Engine
63			*/
64			private $themeEngine;
65
66			public function __construct(
67			ZikulaHttpKernelInterface $kernel,
68			Packages $assetPackages,
69			RouterInterface $router,
70			Filesystem $fileSystem,
71			Engine $themeEngine
72			) {
73			$this->kernel = $kernel;
74			$this->assetPackages = $assetPackages;
75			$this->router = $router;
76			$this->fileSystem = $fileSystem;
77			$this->themeEngine = $themeEngine;
78			}
79
80			/**
81			* Returns path for asset.
82			* Confirms actual file existence before returning path
83			*/
84			public function resolve(string $path): string
85			{
86			$projectDir = $this->kernel->getProjectDir();
87			$publicDir = $projectDir . '/public';
88			$basePath = $this->router->getContext()->getBaseUrl();
89			$httpRootDir = str_replace($basePath, '', $publicDir);
90
91			// return immediately for straight asset paths
92			if ('@' !== $path[0]) {
93			if (0 === mb_strpos($path, '/')) {
94			$path = mb_substr($path, 1);
95			}
96			$publicPath = $this->assetPackages->getUrl($path);
97			if (false !== realpath($httpRootDir . $publicPath)) {
98			return $publicPath;
99			}
100			}
101
102			[$bundleName, $originalPath] = explode(':', $path);
103
104			// try to locate asset in public override path
105			$overridePath = $publicDir . '/overrides/' . mb_substr($bundleName, 1) . '/' . $originalPath;
106			if (false !== $fullPath = realpath($overridePath)) {
			0 ignored issues – show Unused Code introduced 2020-01-26 09:21 UTC by Report Bug Copy Issue Report The assignment to `$fullPath` is dead and can be removed. Loading history...
107			$publicPath = $this->assetPackages->getUrl($overridePath);
108			if (false !== realpath($httpRootDir . $publicPath)) {
109			return $publicPath;
110			}
111			}
112
113			// try to locate asset in public theme path
114			$themeName = $this->themeEngine->getTheme()->getName();
115			$overridePath = $publicDir . '/themes/' . strtolower($themeName) . '/' . mb_substr($bundleName, 1) . '/' . $originalPath;
116			if (false !== $fullPath = realpath($overridePath)) {
117			$publicPath = $this->assetPackages->getUrl($overridePath);
118			if (false !== realpath($httpRootDir . $publicPath)) {
119			return $publicPath;
120			}
121			}
122
123			// try to locate asset in it's normal public directory
124			$path = $this->mapZikulaAssetPath($bundleName, $originalPath);
125			if (false !== $fullPath = realpath($publicDir . '/' . $path)) {
126			$publicPath = $this->assetPackages->getUrl($path);
127			if (false !== realpath($httpRootDir . $publicPath)) {
128			return $publicPath;
129			}
130			}
131
132			// Asset not found in public.
133			// copy the asset from the Bundle directory to /public and then call this method again
134			$fullPath = $this->kernel->locateResource($bundleName . '/Resources/public/' . $originalPath);
135			$this->fileSystem->copy($fullPath, $publicDir . '/' . $path);
136
137			return $this->resolve($bundleName . ':' . $originalPath);
138			}
139
140			/**
141			* Maps zasset path argument
142			* e.g. "@AcmeBundle:css/foo.css" to `AcmeBundle/Resources/public/css/foo.css`
143			*/
144			private function mapZikulaAssetPath(?string $bundleName, ?string $path): string
145			{
146			if (!isset($bundleName) \|\| !isset($path)) {
147			throw new InvalidArgumentException('No bundle name resolved, must be like "@AcmeBundle:css/foo.css"');
148			}
149			$bundle = $this->kernel->getBundle(mb_substr($bundleName, 1));
150			if ($bundle instanceof Bundle) {
151			$path = '/' . $path;
152			if ($bundle instanceof AbstractBundle) {
153			$path = $bundle->getRelativeAssetPath() . $path;
154			} else {
155			$path = mb_strtolower('Bundles/' . mb_substr($bundle->getName(), 0, -mb_strlen('Bundle'))) . $path;
156			}
157			}
158
159			return $path;
160			}
161			}
162

zikula / core

Push — master ( c681fc...9457d4 )

Asset::resolve() B

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like