ResourceManager::getAssetCachedPath() - Code Metrics - Inspection of "Removed asset analyzer as not needed" - SamsonPHP/resource - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 30530b...953066 )

by Vitaly

created 2016-07-29 15:23 UTC

ResourceManager::getAssetCachedPath() A

↳ Parent: ResourceManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	4
c	0
b	0
f	0
nc	1
nop	1
dl	0
loc	9
rs	9.6666
ccs	4
cts	4
cp	1
crap	1

<?php
/**
 * Created by Vitaly Iegorov <[email protected]>.
 * on 15.05.16 at 10:52
 */
namespace samsonphp\resource;

use samsonframework\filemanager\FileManagerInterface;
use samsonphp\event\Event;

/**
 * Resource assets management class.
 *
 * @package samsonphp\resource
 */
class ResourceManager
{
    /** Event for resources analyzing */
    const E_ANALYZE = 'resource.analyze';
    /** Event for resources compiling */
    const E_COMPILE = 'resource.compile';

    /** Assets types */
    const T_CSS = 'css';
    const T_LESS = 'less';
    const T_SCSS = 'scss';
    const T_SASS = 'sass';
    const T_JS = 'js';
    const T_TS = 'ts';
    const T_COFFEE = 'coffee';
    const T_JPG = 'jpg';
    const T_JPEG = 'jpeg';
    const T_PNG = 'png';
    const T_GIF = 'gif';
    const T_SVG = 'svg';
    const T_TTF = 'ttf';
    const T_WOFF = 'woff';
    const T_WOFF2 = 'woff2';
    const T_EOT = 'eot';

    /** Assets types collection */
    const TYPES = [
        self::T_CSS,
        self::T_LESS,
        self::T_SCSS,
        self::T_SASS,
        self::T_JS,
        self::T_TS,
        self::T_COFFEE,
        /*self::T_JPG,
        self::T_JPEG,
        self::T_PNG,
        self::T_GIF,
        self::T_SVG,
        self::T_TTF,
        self::T_WOFF,
        self::T_WOFF2,
        self::T_EOT,*/
    ];

    /** Assets converter */
    const CONVERTER = [
        self::T_JS => self::T_JS,
        self::T_TS => self::T_JS,
        self::T_COFFEE => self::T_JS,
        self::T_CSS => self::T_CSS,
        self::T_LESS => self::T_CSS,
        self::T_SCSS => self::T_CSS,
        self::T_SASS => self::T_CSS,
    ];

    /** Collection of excluding scanning folder patterns */
    public static $excludeFolders = [
        '*/cache/*',
        '*/tests/*',
        '*/vendor/*/vendor/*'
    ];

    /** @var string Full path to project web root directory */
    public static $webRoot;

    /** @var string Full path to project root directory */
    public static $projectRoot;

    /** @var string Full path to project cache root directory */
    public static $cacheRoot;

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

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

    /** @var FileManagerInterface */
    protected $fileManager;

    /**
     * Resource constructor.
     *
     * @param FileManagerInterface $fileManager File managing class
     */
    public function __construct(FileManagerInterface $fileManager)
    {
        $this->fileManager = $fileManager;
    }

    /**
     * Recursively process asset
     * @param array $dependencies Collection of assets for compilation
     */
    protected function processAsset($dependencies)
    {
        foreach ($dependencies as $source => $nothing) {
            // Read asset content
            $content = $this->fileManager->read($source);

            $extension = pathinfo($source, PATHINFO_EXTENSION);

            // Resource dependant resources
            $innerDependencies = [];

            // Compile content
            $compiled = $content;
            Event::fire(self::E_COMPILE, [$source, &$extension, &$compiled, &$innerDependencies]);

            // Write compiled asset
            $target = $this->getAssetProcessedPath($source);
            $this->fileManager->write($target, $compiled);
            $this->fileManager->touch($target, $this->fileManager->lastModified($source));

            // Go deeper in recursion
            $this->processAsset($innerDependencies);
        }
    }

    /**
     * Create static assets.
     *
     * @param string[] $paths Collection of paths for gathering assets
     *
     * @return string[] Cached assets full paths collection
     */
    public function manage(array $paths)
    {
        // Get assets list
        $assets = $this->fileManager->scan($paths, self::TYPES, self::$excludeFolders);

        // Iterate all assets for analyzing
        foreach ($assets as $asset) {
            // Build path to processed asset
            $cachedAsset = $this->getAssetProcessedPath($asset);

            // If cached assets was modified or new
            if (!$this->isValid($asset, $cachedAsset)) {
                // Recursively process asset and possible dependencies
                $this->processAsset([$asset => []]);
                // Store processed asset
                $this->assets[pathinfo($cachedAsset, PATHINFO_EXTENSION)][] = $cachedAsset;
            }
        }

        return $this->assets;
    }

    /**
     * Get asset cached path with extension conversion.
     *
     * @param string $asset Asset full path
     *
     * @return string Full path to cached asset
     */
    protected function getAssetProcessedPath($asset)
    {
        // Build asset project root relative path
        $relativePath = str_replace(self::$projectRoot, '', $asset);

        // Build full cached asset path
        return dirname(self::$cacheRoot . $relativePath) . '/'
        . pathinfo($asset, PATHINFO_FILENAME) . '.' . $this->convertType($asset);
    }

    /**
     * Get asset final type.
     *
     * @param string $asset Full asset path
     *
     * @return string Asset final type
     */
    public function convertType($asset)
    {
        // Convert input extension
        $extension = pathinfo($asset, PATHINFO_EXTENSION);

        return array_key_exists($extension, self::CONVERTER)
            ? self::CONVERTER[$extension]
            : $extension;
    }

    /**
     * Define if asset is not valid.
     *
     * @param string $asset       Full path to asset
     *
     * @param string $cachedAsset Full path to cached asset
     *
     * @return bool True if cached asset is valid
     */
    protected function isValid($asset, $cachedAsset)
    {
        // If cached asset does not exists or is invalid
        return $this->fileManager->exists($cachedAsset) !== false
        && $this->fileManager->lastModified($cachedAsset) === $this->fileManager->lastModified($asset);
    }
}


1		<?php
2		/**
3		* Created by Vitaly Iegorov <[email protected]>.
4		* on 15.05.16 at 10:52
5		*/
6		namespace samsonphp\resource;
7
8		use samsonframework\filemanager\FileManagerInterface;
9		use samsonphp\event\Event;
10
11		/**
12		* Resource assets management class.
13		*
14		* @package samsonphp\resource
15		*/
16		class ResourceManager
17		{
18		/** Event for resources analyzing */
19		const E_ANALYZE = 'resource.analyze';
20		/** Event for resources compiling */
21		const E_COMPILE = 'resource.compile';
22
23		/** Assets types */
24		const T_CSS = 'css';
25		const T_LESS = 'less';
26		const T_SCSS = 'scss';
27		const T_SASS = 'sass';
28		const T_JS = 'js';
29		const T_TS = 'ts';
30		const T_COFFEE = 'coffee';
31		const T_JPG = 'jpg';
32		const T_JPEG = 'jpeg';
33		const T_PNG = 'png';
34		const T_GIF = 'gif';
35		const T_SVG = 'svg';
36		const T_TTF = 'ttf';
37		const T_WOFF = 'woff';
38		const T_WOFF2 = 'woff2';
39		const T_EOT = 'eot';
40
41		/** Assets types collection */
42		const TYPES = [
43		self::T_CSS,
44		self::T_LESS,
45		self::T_SCSS,
46		self::T_SASS,
47		self::T_JS,
48		self::T_TS,
49		self::T_COFFEE,
50		/*self::T_JPG,
51		self::T_JPEG,
52		self::T_PNG,
53		self::T_GIF,
54		self::T_SVG,
55		self::T_TTF,
56		self::T_WOFF,
57		self::T_WOFF2,
58		self::T_EOT,*/
59		];
60
61		/** Assets converter */
62		const CONVERTER = [
63		self::T_JS => self::T_JS,
64		self::T_TS => self::T_JS,
65		self::T_COFFEE => self::T_JS,
66		self::T_CSS => self::T_CSS,
67		self::T_LESS => self::T_CSS,
68		self::T_SCSS => self::T_CSS,
69		self::T_SASS => self::T_CSS,
70		];
71
72		/** Collection of excluding scanning folder patterns */
73		public static $excludeFolders = [
74		'/cache/',
75		'/tests/',
76		'/vendor//vendor/*'
77		];
78
79		/** @var string Full path to project web root directory */
80		public static $webRoot;
81
82		/** @var string Full path to project root directory */
83		public static $projectRoot;
84
85		/** @var string Full path to project cache root directory */
86		public static $cacheRoot;
87
88		/** @var array Cached assets */
89		protected $cache = [];
90
91		/** @var array Collection of assets */
92		protected $assets = [];
93
94		/** @var FileManagerInterface */
95		protected $fileManager;
96
97		/**
98		* Resource constructor.
99		*
100		* @param FileManagerInterface $fileManager File managing class
101		*/
102	2	public function __construct(FileManagerInterface $fileManager)
103		{
104	2	$this->fileManager = $fileManager;
105	2	}
106
107		/**
108		* Recursively process asset
109		* @param array $dependencies Collection of assets for compilation
110		*/
111	2	protected function processAsset($dependencies)
112		{
113	2	foreach ($dependencies as $source => $nothing) {
114		// Read asset content
115	2	$content = $this->fileManager->read($source);
116
117	2	$extension = pathinfo($source, PATHINFO_EXTENSION);
118
119		// Resource dependant resources
120	2	$innerDependencies = [];
121
122		// Compile content
123	2	$compiled = $content;
124	2	Event::fire(self::E_COMPILE, [$source, &$extension, &$compiled, &$innerDependencies]);
125
126		// Write compiled asset
127	2	$target = $this->getAssetProcessedPath($source);
128	2	$this->fileManager->write($target, $compiled);
129	2	$this->fileManager->touch($target, $this->fileManager->lastModified($source));
130
131		// Go deeper in recursion
132	2	$this->processAsset($innerDependencies);
133	2	}
134	2	}
135
136		/**
137		* Create static assets.
138		*
139		* @param string[] $paths Collection of paths for gathering assets
140		*
141		* @return string[] Cached assets full paths collection
142		*/
143	2	public function manage(array $paths)
144		{
145		// Get assets list
146	2	$assets = $this->fileManager->scan($paths, self::TYPES, self::$excludeFolders);
147
148		// Iterate all assets for analyzing
149	2	foreach ($assets as $asset) {
150		// Build path to processed asset
151	2	$cachedAsset = $this->getAssetProcessedPath($asset);
152
153		// If cached assets was modified or new
154	2	if (!$this->isValid($asset, $cachedAsset)) {
155		// Recursively process asset and possible dependencies
156	2	$this->processAsset([$asset => []]);
157		// Store processed asset
158	2	$this->assets[pathinfo($cachedAsset, PATHINFO_EXTENSION)][] = $cachedAsset;
159	2	}
160	2	}
161
162	2	return $this->assets;
163		}
164
165		/**
166		* Get asset cached path with extension conversion.
167		*
168		* @param string $asset Asset full path
169		*
170		* @return string Full path to cached asset
171		*/
172	2	protected function getAssetProcessedPath($asset)
173		{
174		// Build asset project root relative path
175	2	$relativePath = str_replace(self::$projectRoot, '', $asset);
176
177		// Build full cached asset path
178	2	return dirname(self::$cacheRoot . $relativePath) . '/'
179	2	. pathinfo($asset, PATHINFO_FILENAME) . '.' . $this->convertType($asset);
180		}
181
182		/**
183		* Get asset final type.
184		*
185		* @param string $asset Full asset path
186		*
187		* @return string Asset final type
188		*/
189	2	public function convertType($asset)
190		{
191		// Convert input extension
192	2	$extension = pathinfo($asset, PATHINFO_EXTENSION);
193
194	2	return array_key_exists($extension, self::CONVERTER)
195	2	? self::CONVERTER[$extension]
196	2	: $extension;
197		}
198
199		/**
200		* Define if asset is not valid.
201		*
202		* @param string $asset Full path to asset
203		*
204		* @param string $cachedAsset Full path to cached asset
205		*
206		* @return bool True if cached asset is valid
207		*/
208	2	protected function isValid($asset, $cachedAsset)
209		{
210		// If cached asset does not exists or is invalid
211	2	return $this->fileManager->exists($cachedAsset) !== false
212	2	&& $this->fileManager->lastModified($cachedAsset) === $this->fileManager->lastModified($asset);
213		}
214		}
215

SamsonPHP / resource

Push — master ( 30530b...953066 )

ResourceManager::getAssetCachedPath() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like