Router::getAssets() - Code Metrics - Inspection of "Made 100% code coverage" - SamsonPHP/resource - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 05656e...1f6dd4 )

by Vitaly

created 2016-07-18 19:50 UTC

Router::getAssets() A

↳ Parent: Router

Complexity

Conditions	3
Paths	3

Size

Total Lines	21
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	3

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
cc	3
eloc	8
c	2
b	0
f	1
nc	3
nop	1
dl	0
loc	21
ccs	10
cts	10
cp	1
crap	3
rs	9.3142

<?php
namespace samsonphp\resource;

use samson\core\ExternalModule;
use samsonphp\event\Event;

/**
 * Resource router for serving static resource from unreachable web-root paths.
 *
 * TODO: Validate old files that do not exists anymore to remove them
 *
 * @author Vitaly Iegorov <[email protected]>
 */
class Router extends ExternalModule
{
    /** @deprecated Use E_MODULES */
    const EVENT_START_GENERATE_RESOURCES = 'resourcer.modulelist';
    /** Event for modifying modules */
    const E_MODULES = 'resourcer.modulelist';
    /** Event for resources preloading */
    const E_RESOURCE_PRELOAD = ResourceManager::E_ANALYZE;
    /** Event for resources compiling */
    const E_RESOURCE_COMPILE = ResourceManager::E_COMPILE;
    /** Event when recourse management is finished */
    const E_FINISHED = 'resourcer.finished';

    /** @deprecated Identifier */
    protected $id = STATIC_RESOURCE_HANDLER;

    /** @var array Template markers for inserting assets */
    protected $templateMarkers = ['css' => '</head>', 'js' => '</body>'];

    /** @var array Collection of static resources */
    protected $resources = [];

    /** @var array Collection of static resource URLs */
    protected $resourceUrls = [];

    /**
     * Module initialization stage.
     *
     * @see ModuleConnector::init()
     *
     * @param array $params Initialization parameters
     *
     * @return bool True if resource successfully initialized
     */
    public function init(array $params = array())
    {
        // Subscribe for CSS handling
        Event::subscribe(self::E_RESOURCE_COMPILE, [new CSS(), 'compile']);

        // Subscribe to core template rendering event
        Event::subscribe('core.rendered', [$this, 'renderTemplate']);

        $resourceManager = new ResourceManager(new FileManager());
        $resourceManager::$cacheRoot = $this->cache_path;
        $resourceManager::$webRoot = getcwd();
        $resourceManager::$projectRoot = dirname($resourceManager::$webRoot) . '/';

        // Get loaded modules
        $moduleList = $this->system->module_stack;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}

        // Event for modification of resource list
        Event::fire(self::E_MODULES, [&$moduleList]);

        $appResourcePaths = $this->getAssets($moduleList);

        // Get assets
        $this->resources = $resourceManager->manage($appResourcePaths);

        // Fire completion event
        Event::fire(self::E_FINISHED, [&$this->resources]);

        // Get asset URLs
        $this->resourceUrls = array_map([$this, 'getAssetCachedUrl'], $this->resources);

        // Continue parent initialization
        return parent::init($params);
    }

    /**
     * Get asset files from modules.
     *
     * @param array $moduleList Collection of modules
     *
     * @return array Resources paths
     */
    private function getAssets($moduleList)
    {
        $projectRoot = dirname(getcwd()) . '/';

        // Add resource paths
        $paths = [];
        foreach ($moduleList as $module) {
            /**
             * We need to exclude project root because vendor folder will be scanned
             * and all assets from there would be added.
             */
            if ($module->path() !== $projectRoot) {
                $paths[] = $module->path();
            }
        }

        // Add web-root as last path
        $paths[] = getcwd();

        return $paths;
    }

    /**
     * Template rendering handler by injecting static assets url
     * in appropriate.
     *
     * @param $view
     *
     * @return mixed
     */
    public function renderTemplate(&$view)
    {
        foreach ($this->resourceUrls as $type => $urls) {
            if (array_key_exists($type, $this->templateMarkers)) {
                // Replace template marker by type with collection of links to resources of this type
                $view = str_ireplace(
                    $this->templateMarkers[$type],
                    implode("\n", array_map(function ($value) use ($type) {
                        if ($type === 'css') {
                            return '<link type="text/css" rel="stylesheet" property="stylesheet" href="' . $value . '">';
                        } elseif ($type === 'js') {
                            return '<script type="text/javascript" src="' . $value . '"></script>';
                        }
                    }, $urls)) . "\n" . $this->templateMarkers[$type],
                    $view
                );
            }
        }

        return $view;
    }

    /**
     * Get cached asset URL.
     *
     * @param string $cachedAsset Full path to cached asset
     *
     * @return mixed Cached asset URL
     */
    private function getAssetCachedUrl($cachedAsset)
    {
        return str_replace(ResourceManager::$webRoot, '', $cachedAsset);
    }
}


1		<?php
2		namespace samsonphp\resource;
3
4		use samson\core\ExternalModule;
5		use samsonphp\event\Event;
6
7		/**
8		* Resource router for serving static resource from unreachable web-root paths.
9		*
10		* TODO: Validate old files that do not exists anymore to remove them
11		*
12		* @author Vitaly Iegorov <[email protected]>
13		*/
14		class Router extends ExternalModule
15		{
16		/** @deprecated Use E_MODULES */
17		const EVENT_START_GENERATE_RESOURCES = 'resourcer.modulelist';
18		/** Event for modifying modules */
19		const E_MODULES = 'resourcer.modulelist';
20		/** Event for resources preloading */
21		const E_RESOURCE_PRELOAD = ResourceManager::E_ANALYZE;
22		/** Event for resources compiling */
23		const E_RESOURCE_COMPILE = ResourceManager::E_COMPILE;
24		/** Event when recourse management is finished */
25		const E_FINISHED = 'resourcer.finished';
26
27		/** @deprecated Identifier */
28		protected $id = STATIC_RESOURCE_HANDLER;
29
30		/** @var array Template markers for inserting assets */
31		protected $templateMarkers = ['css' => '</head>', 'js' => '</body>'];
32
33		/** @var array Collection of static resources */
34		protected $resources = [];
35
36		/** @var array Collection of static resource URLs */
37		protected $resourceUrls = [];
38
39		/**
40		* Module initialization stage.
41		*
42		* @see ModuleConnector::init()
43		*
44		* @param array $params Initialization parameters
45		*
46		* @return bool True if resource successfully initialized
47		*/
48	1	public function init(array $params = array())
49		{
50		// Subscribe for CSS handling
51	1	Event::subscribe(self::E_RESOURCE_COMPILE, [new CSS(), 'compile']);
52
53		// Subscribe to core template rendering event
54	1	Event::subscribe('core.rendered', [$this, 'renderTemplate']);
55
56	1	$resourceManager = new ResourceManager(new FileManager());
57	1	$resourceManager::$cacheRoot = $this->cache_path;
58	1	$resourceManager::$webRoot = getcwd();
59	1	$resourceManager::$projectRoot = dirname($resourceManager::$webRoot) . '/';
60
61		// Get loaded modules
62	1	$moduleList = $this->system->module_stack;
		0 ignored issues – show Bug introduced 2016-06-16 10:31 UTC by Report Bug Copy Issue Report Accessing `module_stack` on the interface `samsonframework\core\SystemInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
63
64		// Event for modification of resource list
65	1	Event::fire(self::E_MODULES, [&$moduleList]);
66
67	1	$appResourcePaths = $this->getAssets($moduleList);
68
69		// Get assets
70	1	$this->resources = $resourceManager->manage($appResourcePaths);
71
72		// Fire completion event
73	1	Event::fire(self::E_FINISHED, [&$this->resources]);
74
75		// Get asset URLs
76	1	$this->resourceUrls = array_map([$this, 'getAssetCachedUrl'], $this->resources);
77
78		// Continue parent initialization
79	1	return parent::init($params);
80		}
81
82		/**
83		* Get asset files from modules.
84		*
85		* @param array $moduleList Collection of modules
86		*
87		* @return array Resources paths
88		*/
89	1	private function getAssets($moduleList)
90		{
91	1	$projectRoot = dirname(getcwd()) . '/';
92
93		// Add resource paths
94	1	$paths = [];
95	1	foreach ($moduleList as $module) {
96		/**
97		* We need to exclude project root because vendor folder will be scanned
98		* and all assets from there would be added.
99		*/
100	1	if ($module->path() !== $projectRoot) {
101	1	$paths[] = $module->path();
102	1	}
103	1	}
104
105		// Add web-root as last path
106	1	$paths[] = getcwd();
107
108	1	return $paths;
109		}
110
111		/**
112		* Template rendering handler by injecting static assets url
113		* in appropriate.
114		*
115		* @param $view
116		*
117		* @return mixed
118		*/
119	1	public function renderTemplate(&$view)
120		{
121	1	foreach ($this->resourceUrls as $type => $urls) {
122	1	if (array_key_exists($type, $this->templateMarkers)) {
123		// Replace template marker by type with collection of links to resources of this type
124	1	$view = str_ireplace(
125	1	$this->templateMarkers[$type],
126	1	implode("\n", array_map(function ($value) use ($type) {
127	1	if ($type === 'css') {
128	1	return '<link type="text/css" rel="stylesheet" property="stylesheet" href="' . $value . '">';
129	1	} elseif ($type === 'js') {
130	1	return '<script type="text/javascript" src="' . $value . '"></script>';
131		}
132	1	}, $urls)) . "\n" . $this->templateMarkers[$type],
133		$view
134	1	);
135	1	}
136	1	}
137
138	1	return $view;
139		}
140
141		/**
142		* Get cached asset URL.
143		*
144		* @param string $cachedAsset Full path to cached asset
145		*
146		* @return mixed Cached asset URL
147		*/
148	1	private function getAssetCachedUrl($cachedAsset)
149		{
150	1	return str_replace(ResourceManager::$webRoot, '', $cachedAsset);
151		}
152		}
153

SamsonPHP / resource

Push — master ( 05656e...1f6dd4 )

Router::getAssets() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like