Router::scanFolderRecursively() - Code Metrics - Inspection of "Refactored scanning function" - SamsonPHP/resource - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( c14408...ca9cbd )

by Vitaly

created 2016-07-08 12:20 UTC

Router::scanFolderRecursively() B

↳ Parent: Router::createAssets()

Complexity

Conditions	1
Paths	1

Size

Total Lines	28
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes	8
Bugs	2	Features	5

Metric	Value
cc	1
eloc	12
c	8
b	2
f	5
nc	1
nop	2
dl	0
loc	28
rs	8.8571

<?php
namespace samsonphp\resource;

use Aws\CloudFront\Exception\Exception;
use samson\core\ExternalModule;
use samson\core\Module;
use samsonframework\resource\ResourceMap;
use samsonphp\event\Event;
use samsonphp\resource\exception\ResourceNotFound;

/**
 * Resource router for serving static resource from unreachable web-root paths.
 *
 * @author Vitaly Iegorov <[email protected]>
 * @author Nikita Kotenko <[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 = 'resourcer.preload';
    /** Event for resources compiling */
    const E_RESOURCE_COMPILE = 'resourcer.compile';

    /** Collection of registered resource types */
    protected $types = ['less', 'css', 'js', 'coffee', 'ts'];

    /** @var array Assets cache */
    protected $cache = [];

    /** @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 = [];

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

    /** @see ModuleConnector::init() */
    public function init(array $params = array())
    {
        // Subscribe for CSS handling
        Event::subscribe(self::E_RESOURCE_COMPILE, [new CSS(), 'compile']);

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

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

        // Event for modification of module list
        Event::fire(self::E_MODULES, array(&$moduleList));

        $projectRoot = dirname(getcwd()).'/';

        // Add module paths
        foreach ($moduleList as $module) {
            if ($module->path() !== $projectRoot) {
                $paths[] = $module->path();
            }
        }
        $paths[] = getcwd();

        $files = Resource::scan($paths, $this->types);

        $this->createAssets($files);

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

    private function getAssetPathData($resource, $extension = null)
    {
        $extension = $extension === null ? pathinfo($resource, PATHINFO_EXTENSION) : $extension;
        switch ($extension) {
            case 'css':
            case 'less':
            case 'scss':
            case 'sass': $extension = 'css'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
            case 'ts':
            case 'cofee': $extension = 'js'; break;
switch ($expr) {
case "A":
    doSomething(); //right
    break;
case "B":

    doSomethingElse(); //wrong
    break;
        }

        $wwwRoot = getcwd();
        $projectRoot = dirname($wwwRoot).'/';
        $relativePath = str_replace($projectRoot, '', $resource);

        $fileName = pathinfo($resource, PATHINFO_FILENAME);

        return dirname($this->cache_path.$relativePath).'/'.$fileName.'.'.$extension;
    }

    /**
     * Create static assets.
     *
     * @param array  $files Collection of paths for gathering resources
     */
    public function createAssets(array $files)
    {
        $wwwRoot = getcwd();

        $assets = [];

        // Scan folder and gather
        foreach ($files as $file) {
            // Generate cached resource path with possible new extension after compiling
            $assets[$file] = $this->getAssetPathData($file);
            $extension = pathinfo($assets[$file], PATHINFO_EXTENSION);

            // If cached assets was modified or new
            if (!file_exists($assets[$file]) || filemtime($file) !== filemtime($assets[$file])) {
                // Read asset content
                $this->cache[$file] = file_get_contents($file);

                // Fire event for analyzing resource
                Event::fire(self::E_RESOURCE_PRELOAD, [$file, pathinfo($file, PATHINFO_EXTENSION), &$this->cache[$file]]);
            } else {
                // Add this resource to resource collection grouped by resource type
                $this->resources[$extension][] = $assets[$file];
                $this->resourceUrls[$extension][] = str_replace($wwwRoot, '', $assets[$file]);
            }
        }

        $wwwRoot = getcwd();
        foreach ($this->cache as $file => $content) {
            $extension = pathinfo($file, PATHINFO_EXTENSION);

            $compiled = $content;
            Event::fire(self::E_RESOURCE_COMPILE, [$file, &$extension, &$compiled]);

            // Create folder structure and file only if it is not empty
            $resource = $this->getAssetPathData($file, $extension);

            // Create cache path
            $path = dirname($resource);
            if (!file_exists($path)) {
                mkdir($path, 0777, true);
            }

            file_put_contents($resource, $compiled);

            // Sync cached file with source file
            touch($resource, filemtime($file));

            // Add this resource to resource collection grouped by resource type
            $this->resources[$extension][] = $resource;
            $this->resourceUrls[$extension][] = str_replace($wwwRoot, '', $resource);
        }
    }

    /**
     * Template rendering handler by injecting static assets url
     * in appropriate.
     *
     * @param $view
     *
     * @return mixed
     */
    public function renderTemplate(&$view)
    {
        foreach ($this->resourceUrls as $type => $urls) {
            // 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 async type="text/javascript" src="' . $value . '"></script>';
                    }
                }, $urls)) . "\n" . $this->templateMarkers[$type],
                $view
            );
        }

        return $view;
    }
}


1			<?php
2			namespace samsonphp\resource;
3
4			use Aws\CloudFront\Exception\Exception;
5			use samson\core\ExternalModule;
6			use samson\core\Module;
7			use samsonframework\resource\ResourceMap;
8			use samsonphp\event\Event;
9			use samsonphp\resource\exception\ResourceNotFound;
10
11			/**
12			* Resource router for serving static resource from unreachable web-root paths.
13			*
14			* @author Vitaly Iegorov <[email protected]>
15			* @author Nikita Kotenko <[email protected]>
16			*/
17			class Router extends ExternalModule
18			{
19			/** @deprecated Use E_MODULES */
20			const EVENT_START_GENERATE_RESOURCES = 'resourcer.modulelist';
21			/** Event for modifying modules */
22			const E_MODULES = 'resourcer.modulelist';
23			/** Event for resources preloading */
24			const E_RESOURCE_PRELOAD = 'resourcer.preload';
25			/** Event for resources compiling */
26			const E_RESOURCE_COMPILE = 'resourcer.compile';
27
28			/** Collection of registered resource types */
29			protected $types = ['less', 'css', 'js', 'coffee', 'ts'];
30
31			/** @var array Assets cache */
32			protected $cache = [];
33
34			/** @var array Template markers for inserting assets */
35			protected $templateMarkers = [
36			'css' => '</head>',
37			'js' => '</body>'
38			];
39
40			/** @var array Collection of static resources */
41			protected $resources = [];
42			/** @var array Collection of static resource URLs */
43			protected $resourceUrls = [];
44
45			/** Identifier */
46			protected $id = STATIC_RESOURCE_HANDLER;
47
48			/** @see ModuleConnector::init() */
49			public function init(array $params = array())
50			{
51			// Subscribe for CSS handling
52			Event::subscribe(self::E_RESOURCE_COMPILE, [new CSS(), 'compile']);
53
54			$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...
55			$paths = [];
56
57			// Event for modification of module list
58			Event::fire(self::E_MODULES, array(&$moduleList));
59
60			$projectRoot = dirname(getcwd()).'/';
61
62			// Add module paths
63			foreach ($moduleList as $module) {
64			if ($module->path() !== $projectRoot) {
65			$paths[] = $module->path();
66			}
67			}
68			$paths[] = getcwd();
69
70			$files = Resource::scan($paths, $this->types);
71
72			$this->createAssets($files);
73
74			// Subscribe to core template rendering event
75			Event::subscribe('core.rendered', [$this, 'renderTemplate']);
76			}
77
78			private function getAssetPathData($resource, $extension = null)
79			{
80			$extension = $extension === null ? pathinfo($resource, PATHINFO_EXTENSION) : $extension;
81			switch ($extension) {
82			case 'css':
83			case 'less':
84			case 'scss':
85			case 'sass': $extension = 'css'; break;
			0 ignored issues – show Coding Style introduced 2016-07-08 11:14 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-07-08 11:14 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-07-08 11:14 UTC by Report Bug Copy Issue Report It is generally recommended to place each PHP statement on a line by itself. Let’s take a look at an example: // Bad $a = 5; $b = 6; $c = 7; // Good $a = 5; $b = 6; $c = 7; Loading history...
86			case 'ts':
87			case 'cofee': $extension = 'js'; break;
			0 ignored issues – show Coding Style introduced 2016-07-08 11:14 UTC by Report Bug Copy Issue Report The case body in a switch statement must start on the line following the statement. According to the PSR-2, the body of a case statement must start on the line immediately following the case statement. switch ($expr) { case "A": doSomething(); //right break; case "B": doSomethingElse(); //wrong break; } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-07-08 11:14 UTC by Report Bug Copy Issue Report Terminating statement must be on a line by itself As per the PSR-2 coding standard, the `break` (or other terminating) statement must be on a line of its own. switch ($expr) { case "A": doSomething(); break; //wrong case "B": doSomething(); break; //right case "C:": doSomething(); return true; //right } To learn more about the PSR-2 coding standard, please refer to the PHP-Fig. Loading history... Coding Style introduced 2016-07-08 11:14 UTC by Report Bug Copy Issue Report It is generally recommended to place each PHP statement on a line by itself. Let’s take a look at an example: // Bad $a = 5; $b = 6; $c = 7; // Good $a = 5; $b = 6; $c = 7; Loading history...
88			}
89
90			$wwwRoot = getcwd();
91			$projectRoot = dirname($wwwRoot).'/';
92			$relativePath = str_replace($projectRoot, '', $resource);
93
94			$fileName = pathinfo($resource, PATHINFO_FILENAME);
95
96			return dirname($this->cache_path.$relativePath).'/'.$fileName.'.'.$extension;
97			}
98
99			/**
100			* Create static assets.
101			*
102			* @param array $files Collection of paths for gathering resources
103			*/
104			public function createAssets(array $files)
105			{
106			$wwwRoot = getcwd();
107
108			$assets = [];
109
110			// Scan folder and gather
111			foreach ($files as $file) {
112			// Generate cached resource path with possible new extension after compiling
113			$assets[$file] = $this->getAssetPathData($file);
114			$extension = pathinfo($assets[$file], PATHINFO_EXTENSION);
115
116			// If cached assets was modified or new
117			if (!file_exists($assets[$file]) \|\| filemtime($file) !== filemtime($assets[$file])) {
118			// Read asset content
119			$this->cache[$file] = file_get_contents($file);
120
121			// Fire event for analyzing resource
122			Event::fire(self::E_RESOURCE_PRELOAD, [$file, pathinfo($file, PATHINFO_EXTENSION), &$this->cache[$file]]);
123			} else {
124			// Add this resource to resource collection grouped by resource type
125			$this->resources[$extension][] = $assets[$file];
126			$this->resourceUrls[$extension][] = str_replace($wwwRoot, '', $assets[$file]);
127			}
128			}
129
130			$wwwRoot = getcwd();
131			foreach ($this->cache as $file => $content) {
132			$extension = pathinfo($file, PATHINFO_EXTENSION);
133
134			$compiled = $content;
135			Event::fire(self::E_RESOURCE_COMPILE, [$file, &$extension, &$compiled]);
136
137			// Create folder structure and file only if it is not empty
138			$resource = $this->getAssetPathData($file, $extension);
139
140			// Create cache path
141			$path = dirname($resource);
142			if (!file_exists($path)) {
143			mkdir($path, 0777, true);
144			}
145
146			file_put_contents($resource, $compiled);
147
148			// Sync cached file with source file
149			touch($resource, filemtime($file));
150
151			// Add this resource to resource collection grouped by resource type
152			$this->resources[$extension][] = $resource;
153			$this->resourceUrls[$extension][] = str_replace($wwwRoot, '', $resource);
154			}
155			}
156
157			/**
158			* Template rendering handler by injecting static assets url
159			* in appropriate.
160			*
161			* @param $view
162			*
163			* @return mixed
164			*/
165			public function renderTemplate(&$view)
166			{
167			foreach ($this->resourceUrls as $type => $urls) {
168			// Replace template marker by type with collection of links to resources of this type
169			$view = str_ireplace(
170			$this->templateMarkers[$type],
171			implode("\n", array_map(function($value) use ($type) {
			0 ignored issues – show Coding Style introduced 2016-07-07 16:40 UTC by Report Bug Copy Issue Report Expected 1 space after FUNCTION keyword; 0 found Loading history...
172			if ($type === 'css') {
173			return '<link type="text/css" rel="stylesheet" property="stylesheet" href="' . $value . '">';
174			} elseif ($type === 'js') {
175			return '<script async type="text/javascript" src="' . $value . '"></script>';
176			}
177			}, $urls)) . "\n" . $this->templateMarkers[$type],
178			$view
179			);
180			}
181
182			return $view;
183			}
184			}
185

SamsonPHP / resource

Push — master ( c14408...ca9cbd )

Router::scanFolderRecursively() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like