Collecting::fill_includes_internal() - Code Metrics - Inspection of "Functions re-ordering and small simplification" - nazar-pc/CleverStyle-Framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0f36f7...67c76e )

by Nazar

created 2016-09-23 11:30 UTC

Collecting::fill_includes_internal() A

↳ Parent: Collecting

Complexity

Conditions	2
Paths	2

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	2

Importance

Changes

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

<?php
/**
 * @package   CleverStyle Framework
 * @author    Nazar Mokrynskyi <[email protected]>
 * @copyright Copyright (c) 2014-2016, Nazar Mokrynskyi
 * @license   MIT License, see license.txt
 */
namespace cs\Page\Includes;
use
	cs\Config,
	cs\Event;

trait Collecting {
	/**
	 * Get dependencies of components between each other (only that contains some HTML, JS and CSS files) and mapping HTML, JS and CSS files to URL paths
	 *
	 * @param Config $Config
	 *
	 * @return array[] [$dependencies, $includes_map]
	 */
	protected function get_includes_dependencies_and_map ($Config) {
		$installed_modules = array_filter(
			$Config->components['modules'],
			function ($module_data) {
				return $module_data['active'] != Config\Module_Properties::UNINSTALLED;
			}
		);
		/**
		 * Get all includes
		 */
		$all_includes = $this->get_includes_list(array_keys($installed_modules));
		$includes_map = [];
		/**
		 * Array [package => [list of packages it depends on]]
		 */
		$dependencies    = [];
		$functionalities = [];
		/**
		 * According to components's maps some files should be included only on specific pages.
		 * Here we read this rules, and remove from whole includes list such items, that should be included only on specific pages.
		 * Also collect dependencies.
		 */
		foreach ($installed_modules as $module => $module_data) {
			$this->process_meta(MODULES."/$module", $dependencies, $functionalities, $module_data['active'] != Config\Module_Properties::ENABLED);
			$this->process_map(MODULES."/$module", $includes_map, $all_includes);
		}
		unset($module, $module_data);
		/**
		 * For consistency
		 */
		$includes_map['System'] = $all_includes;
		Event::instance()->fire(
			'System/Page/includes_dependencies_and_map',
			[
				'dependencies' => &$dependencies,
				'includes_map' => &$includes_map
			]
		);
		$includes_map = $this->webcomponents_support_filter($includes_map, (bool)$Config->core['disable_webcomponents']);
		$dependencies = $this->normalize_dependencies($dependencies, $functionalities);
		$includes_map = $this->clean_includes_arrays_without_files($dependencies, $includes_map);
		$dependencies = array_map('array_values', $dependencies);
		$dependencies = array_filter($dependencies);
		return [$dependencies, $includes_map];
	}
	/**
	 * Getting of HTML, JS and CSS files list to be included
	 *
	 * @param string[] $modules
	 *
	 * @return string[][]
	 */
	protected function get_includes_list ($modules) {
		$includes = [];
		/**
		 * Get includes of system and theme
		 */
		$this->fill_includes(DIR.'/includes', $includes);
		$this->fill_includes(THEMES."/$this->theme", $includes);
		foreach ($modules as $module) {
			$this->fill_includes(MODULES."/$module/includes", $includes);
		}
		return [
			'html' => array_merge(...$includes['html']),
			'js'   => array_merge(...$includes['js']),
			'css'  => array_merge(...$includes['css'])
		];
	}
	/**
	 * @param string     $base_dir
	 * @param string[][] $includes
	 */
	protected function fill_includes ($base_dir, &$includes) {
		$includes['html'][] = $this->fill_includes_internal($base_dir, 'html');
		$includes['js'][]   = $this->fill_includes_internal($base_dir, 'js');
		$includes['css'][]  = $this->fill_includes_internal($base_dir, 'css');
	}
	/**
	 * @param string $base_dir
	 * @param string $ext
	 *
	 * @return array
	 */
	protected function fill_includes_internal ($base_dir, $ext) {
		return get_files_list("$base_dir/$ext", "/.*\\.$ext\$/i", 'f', true, true, 'name', '!include') ?: [];
	}
	/**
	 * Process meta information and corresponding entries to dependencies and functionalities
	 *
	 * @param string $base_dir
	 * @param array  $dependencies
	 * @param array  $functionalities
	 * @param bool   $skip_functionalities
	 */
	protected function process_meta ($base_dir, &$dependencies, &$functionalities, $skip_functionalities = false) {
		if (!file_exists("$base_dir/meta.json")) {
			return;
		}
		$meta = file_get_json("$base_dir/meta.json");
		$meta += [
			'require'  => [],
			'optional' => [],
			'provide'  => []
		];
		$package = $meta['package'];
		foreach ((array)$meta['require'] as $r) {
			/**
			 * Get only name of package or functionality
			 */
			$r                        = preg_split('/[=<>]/', $r, 2)[0];
			$dependencies[$package][] = $r;
		}
		foreach ((array)$meta['optional'] as $o) {
			/**
			 * Get only name of package or functionality
			 */
			$o                        = preg_split('/[=<>]/', $o, 2)[0];
			$dependencies[$package][] = $o;
		}
		if ($skip_functionalities) {
			return;
		}
		foreach ((array)$meta['provide'] as $p) {
			/**
			 * If provides sub-functionality for other component (for instance, `Blog/post_patch`) - inverse "providing" to "dependency"
			 * Otherwise it is just functionality alias to package name
			 */
			if (strpos($p, '/') !== false) {
				/**
				 * Get name of package or functionality
				 */
				$p                  = explode('/', $p)[0];
				$dependencies[$p][] = $package;
			} else {
				$functionalities[$p] = $package;
			}
		}
	}
	/**
	 * Process map structure, fill includes map and remove files from list of all includes (remaining files will be included on all pages)
	 *
	 * @param string $base_dir
	 * @param array  $includes_map
	 * @param array  $all_includes
	 */
	protected function process_map ($base_dir, &$includes_map, &$all_includes) {
		if (!file_exists("$base_dir/includes/map.json")) {
			return;
		}
		$this->process_map_internal(file_get_json("$base_dir/includes/map.json"), "$base_dir/includes", $includes_map, $all_includes);
	}
	/**
	 * Process map structure, fill includes map and remove files from list of all includes (remaining files will be included on all pages)
	 *
	 * @param array  $map
	 * @param string $includes_dir
	 * @param array  $includes_map
	 * @param array  $all_includes
	 */
	protected function process_map_internal ($map, $includes_dir, &$includes_map, &$all_includes) {
		foreach ($map as $path => $files) {
			foreach ((array)$files as $file) {
				$extension = file_extension($file);
				if (in_array($extension, ['css', 'js', 'html'])) {
					$file                              = "$includes_dir/$extension/$file";
					$includes_map[$path][$extension][] = $file;
					$all_includes[$extension]          = array_diff($all_includes[$extension], [$file]);
				} else {
					$file = rtrim($file, '*');
					/**
					 * Wildcard support, it is possible to specify just path prefix and all files with this prefix will be included
					 */
					$found_files = array_filter(
						get_files_list($includes_dir, '/.*\.(css|js|html)$/i', 'f', '', true, 'name', '!include') ?: [],
						function ($f) use ($file) {
							// We need only files with specified mask and only those located in directory that corresponds to file's extension
							return preg_match("#^(css|js|html)/$file.*\\1$#i", $f);
						}
					);
					// Drop first level directory
					$found_files = _preg_replace('#^[^/]+/(.*)#', '$1', $found_files);
					$this->process_map_internal([$path => $found_files], $includes_dir, $includes_map, $all_includes);
				}
			}
		}
	}
	/**
	 * Replace functionalities by real packages names, take into account recursive dependencies
	 *
	 * @param array $dependencies
	 * @param array $functionalities
	 *
	 * @return array
	 */
	protected function normalize_dependencies ($dependencies, $functionalities) {
		/**
		 * First of all remove packages without any dependencies
		 */
		$dependencies = array_filter($dependencies);
		/**
		 * First round, process aliases among keys
		 */
		foreach (array_keys($dependencies) as $d) {
			if (isset($functionalities[$d])) {
				$package = $functionalities[$d];
				/**
				 * Add dependencies to existing package dependencies
				 */
				foreach ($dependencies[$d] as $dependency) {
					$dependencies[$package][] = $dependency;
				}
				/**
				 * Drop alias
				 */
				unset($dependencies[$d]);
			}
		}
		unset($d, $dependency);
		/**
		 * Second round, process aliases among dependencies
		 */
		foreach ($dependencies as &$depends_on) {
			foreach ($depends_on as &$dependency) {
				if (isset($functionalities[$dependency])) {
					$dependency = $functionalities[$dependency];
				}
			}
			unset($dependency);
		}
		unset($depends_on);
		/**
		 * Third round, build dependencies tree using references to corresponding recursive dependencies
		 */
		foreach ($dependencies as &$depends_on) {
			foreach ($depends_on as &$dependency) {
				if ($dependency != 'System' && isset($dependencies[$dependency])) {
					$dependency = [&$dependencies[$dependency], $dependency];
				}
			}
			unset($dependency);
		}
		unset($depends_on);
		$dependencies = array_map([$this, 'array_flatten'], $dependencies);
		return array_map('array_unique', $dependencies);
	}
	/**
	 * Convert array of arbitrary nested structure into flat array
	 *
	 * @param array $array
	 *
	 * @return string[]
	 */
	protected function array_flatten ($array) {
		foreach ($array as &$a) {
			if (is_array($a)) {
				$a = $this->array_flatten($a);
			}
		}
		return array_merge(..._array($array));
	}
	/**
	 * If system is configured to not use Web Components - all HTML imports and Polymer-related JS code will be removed from includes map
	 *
	 * @param array[] $includes_map
	 * @param bool    $disable_webcomponents
	 *
	 * @return array[]
	 */
	protected function webcomponents_support_filter ($includes_map, $disable_webcomponents) {
		if ($this->theme != Config::SYSTEM_THEME && $disable_webcomponents) {
			foreach ($includes_map as &$includes) {
				unset($includes['html']);
			}
			unset($includes);
			$prefix    = DIR.'/includes/js/Polymer';
			$system_js = &$includes_map[Config::SYSTEM_MODULE]['js'];
			foreach ($system_js as $index => $file) {
				if (strpos($file, $prefix) === 0) {
					unset($system_js[$index]);
				}
			}
			$system_js = array_values($system_js);
		}
		return $includes_map;
	}
	/**
	 * Includes array is composed from dependencies and sometimes dependencies doesn't have any files, so we'll clean that
	 *
	 * @param array $dependencies
	 * @param array $includes_map
	 *
	 * @return array
	 */
	protected function clean_includes_arrays_without_files ($dependencies, $includes_map) {
		foreach ($dependencies as &$depends_on) {
			foreach ($depends_on as $index => &$dependency) {
				if (!isset($includes_map[$dependency])) {
					unset($depends_on[$index]);
				}
			}
			unset($dependency);
		}
		return $includes_map;
	}
}


1		<?php
2		/**
3		* @package CleverStyle Framework
4		* @author Nazar Mokrynskyi <[email protected]>
5		* @copyright Copyright (c) 2014-2016, Nazar Mokrynskyi
6		* @license MIT License, see license.txt
7		*/
8		namespace cs\Page\Includes;
9		use
10		cs\Config,
11		cs\Event;
12
13		trait Collecting {
14		/**
15		* Get dependencies of components between each other (only that contains some HTML, JS and CSS files) and mapping HTML, JS and CSS files to URL paths
16		*
17		* @param Config $Config
18		*
19		* @return array[] [$dependencies, $includes_map]
20		*/
21	4	protected function get_includes_dependencies_and_map ($Config) {
22	4	$installed_modules = array_filter(
23	4	$Config->components['modules'],
24		function ($module_data) {
25	4	return $module_data['active'] != Config\Module_Properties::UNINSTALLED;
26	4	}
27		);
28		/**
29		* Get all includes
30		*/
31	4	$all_includes = $this->get_includes_list(array_keys($installed_modules));
32	4	$includes_map = [];
33		/**
34		* Array [package => [list of packages it depends on]]
35		*/
36	4	$dependencies = [];
37	4	$functionalities = [];
38		/**
39		* According to components's maps some files should be included only on specific pages.
40		* Here we read this rules, and remove from whole includes list such items, that should be included only on specific pages.
41		* Also collect dependencies.
42		*/
43	4	foreach ($installed_modules as $module => $module_data) {
44	4	$this->process_meta(MODULES."/$module", $dependencies, $functionalities, $module_data['active'] != Config\Module_Properties::ENABLED);
45	4	$this->process_map(MODULES."/$module", $includes_map, $all_includes);
46		}
47	4	unset($module, $module_data);
48		/**
49		* For consistency
50		*/
51	4	$includes_map['System'] = $all_includes;
52	4	Event::instance()->fire(
53	4	'System/Page/includes_dependencies_and_map',
54		[
55	4	'dependencies' => &$dependencies,
56	4	'includes_map' => &$includes_map
57		]
58		);
59	4	$includes_map = $this->webcomponents_support_filter($includes_map, (bool)$Config->core['disable_webcomponents']);
60	4	$dependencies = $this->normalize_dependencies($dependencies, $functionalities);
61	4	$includes_map = $this->clean_includes_arrays_without_files($dependencies, $includes_map);
62	4	$dependencies = array_map('array_values', $dependencies);
63	4	$dependencies = array_filter($dependencies);
64	4	return [$dependencies, $includes_map];
65		}
66		/**
67		* Getting of HTML, JS and CSS files list to be included
68		*
69		* @param string[] $modules
70		*
71		* @return string[][]
72		*/
73	4	protected function get_includes_list ($modules) {
74	4	$includes = [];
75		/**
76		* Get includes of system and theme
77		*/
78	4	$this->fill_includes(DIR.'/includes', $includes);
79	4	$this->fill_includes(THEMES."/$this->theme", $includes);
80	4	foreach ($modules as $module) {
81	4	$this->fill_includes(MODULES."/$module/includes", $includes);
82		}
83		return [
84	4	'html' => array_merge(...$includes['html']),
85	4	'js' => array_merge(...$includes['js']),
86	4	'css' => array_merge(...$includes['css'])
87		];
88		}
89		/**
90		* @param string $base_dir
91		* @param string[][] $includes
92		*/
93	4	protected function fill_includes ($base_dir, &$includes) {
94	4	$includes['html'][] = $this->fill_includes_internal($base_dir, 'html');
95	4	$includes['js'][] = $this->fill_includes_internal($base_dir, 'js');
96	4	$includes['css'][] = $this->fill_includes_internal($base_dir, 'css');
97	4	}
98		/**
99		* @param string $base_dir
100		* @param string $ext
101		*
102		* @return array
103		*/
104	4	protected function fill_includes_internal ($base_dir, $ext) {
105	4	return get_files_list("$base_dir/$ext", "/.*\\.$ext\$/i", 'f', true, true, 'name', '!include') ?: [];
106		}
107		/**
108		* Process meta information and corresponding entries to dependencies and functionalities
109		*
110		* @param string $base_dir
111		* @param array $dependencies
112		* @param array $functionalities
113		* @param bool $skip_functionalities
114		*/
115	4	protected function process_meta ($base_dir, &$dependencies, &$functionalities, $skip_functionalities = false) {
116	4	if (!file_exists("$base_dir/meta.json")) {
117		return;
118		}
119	4	$meta = file_get_json("$base_dir/meta.json");
120		$meta += [
121	4	'require' => [],
122		'optional' => [],
123		'provide' => []
124		];
125	4	$package = $meta['package'];
126	4	foreach ((array)$meta['require'] as $r) {
127		/**
128		* Get only name of package or functionality
129		*/
130		$r = preg_split('/[=<>]/', $r, 2)[0];
131		$dependencies[$package][] = $r;
132		}
133	4	foreach ((array)$meta['optional'] as $o) {
134		/**
135		* Get only name of package or functionality
136		*/
137	4	$o = preg_split('/[=<>]/', $o, 2)[0];
138	4	$dependencies[$package][] = $o;
139		}
140	4	if ($skip_functionalities) {
141		return;
142		}
143	4	foreach ((array)$meta['provide'] as $p) {
144		/**
145		* If provides sub-functionality for other component (for instance, `Blog/post_patch`) - inverse "providing" to "dependency"
146		* Otherwise it is just functionality alias to package name
147		*/
148	4	if (strpos($p, '/') !== false) {
149		/**
150		* Get name of package or functionality
151		*/
152		$p = explode('/', $p)[0];
153		$dependencies[$p][] = $package;
154		} else {
155	4	$functionalities[$p] = $package;
156		}
157		}
158	4	}
159		/**
160		* Process map structure, fill includes map and remove files from list of all includes (remaining files will be included on all pages)
161		*
162		* @param string $base_dir
163		* @param array $includes_map
164		* @param array $all_includes
165		*/
166	4	protected function process_map ($base_dir, &$includes_map, &$all_includes) {
167	4	if (!file_exists("$base_dir/includes/map.json")) {
168		return;
169		}
170	4	$this->process_map_internal(file_get_json("$base_dir/includes/map.json"), "$base_dir/includes", $includes_map, $all_includes);
171	4	}
172		/**
173		* Process map structure, fill includes map and remove files from list of all includes (remaining files will be included on all pages)
174		*
175		* @param array $map
176		* @param string $includes_dir
177		* @param array $includes_map
178		* @param array $all_includes
179		*/
180	4	protected function process_map_internal ($map, $includes_dir, &$includes_map, &$all_includes) {
181	4	foreach ($map as $path => $files) {
182	4	foreach ((array)$files as $file) {
183	4	$extension = file_extension($file);
184	4	if (in_array($extension, ['css', 'js', 'html'])) {
185	4	$file = "$includes_dir/$extension/$file";
186	4	$includes_map[$path][$extension][] = $file;
187	4	$all_includes[$extension] = array_diff($all_includes[$extension], [$file]);
188		} else {
189	4	$file = rtrim($file, '*');
190		/**
191		* Wildcard support, it is possible to specify just path prefix and all files with this prefix will be included
192		*/
193	4	$found_files = array_filter(
194	4	get_files_list($includes_dir, '/.*\.(css\|js\|html)$/i', 'f', '', true, 'name', '!include') ?: [],
195	4	function ($f) use ($file) {
196		// We need only files with specified mask and only those located in directory that corresponds to file's extension
197	4	return preg_match("#^(css\|js\|html)/$file.*\\1$#i", $f);
198	4	}
199		);
200		// Drop first level directory
201	4	$found_files = _preg_replace('#^[^/]+/(.*)#', '$1', $found_files);
202	4	$this->process_map_internal([$path => $found_files], $includes_dir, $includes_map, $all_includes);
203		}
204		}
205		}
206	4	}
207		/**
208		* Replace functionalities by real packages names, take into account recursive dependencies
209		*
210		* @param array $dependencies
211		* @param array $functionalities
212		*
213		* @return array
214		*/
215	4	protected function normalize_dependencies ($dependencies, $functionalities) {
216		/**
217		* First of all remove packages without any dependencies
218		*/
219	4	$dependencies = array_filter($dependencies);
220		/**
221		* First round, process aliases among keys
222		*/
223	4	foreach (array_keys($dependencies) as $d) {
224	4	if (isset($functionalities[$d])) {
225		$package = $functionalities[$d];
226		/**
227		* Add dependencies to existing package dependencies
228		*/
229		foreach ($dependencies[$d] as $dependency) {
230		$dependencies[$package][] = $dependency;
231		}
232		/**
233		* Drop alias
234		*/
235	4	unset($dependencies[$d]);
236		}
237		}
238	4	unset($d, $dependency);
239		/**
240		* Second round, process aliases among dependencies
241		*/
242	4	foreach ($dependencies as &$depends_on) {
243	4	foreach ($depends_on as &$dependency) {
244	4	if (isset($functionalities[$dependency])) {
245	4	$dependency = $functionalities[$dependency];
246		}
247		}
248	4	unset($dependency);
249		}
250	4	unset($depends_on);
251		/**
252		* Third round, build dependencies tree using references to corresponding recursive dependencies
253		*/
254	4	foreach ($dependencies as &$depends_on) {
255	4	foreach ($depends_on as &$dependency) {
256	4	if ($dependency != 'System' && isset($dependencies[$dependency])) {
257	4	$dependency = [&$dependencies[$dependency], $dependency];
258		}
259		}
260	4	unset($dependency);
261		}
262	4	unset($depends_on);
263	4	$dependencies = array_map([$this, 'array_flatten'], $dependencies);
264	4	return array_map('array_unique', $dependencies);
265		}
266		/**
267		* Convert array of arbitrary nested structure into flat array
268		*
269		* @param array $array
270		*
271		* @return string[]
272		*/
273	4	protected function array_flatten ($array) {
274	4	foreach ($array as &$a) {
275	4	if (is_array($a)) {
276	4	$a = $this->array_flatten($a);
277		}
278		}
279	4	return array_merge(..._array($array));
280		}
281		/**
282		* If system is configured to not use Web Components - all HTML imports and Polymer-related JS code will be removed from includes map
283		*
284		* @param array[] $includes_map
285		* @param bool $disable_webcomponents
286		*
287		* @return array[]
288		*/
289	4	protected function webcomponents_support_filter ($includes_map, $disable_webcomponents) {
290	4	if ($this->theme != Config::SYSTEM_THEME && $disable_webcomponents) {
291		foreach ($includes_map as &$includes) {
292		unset($includes['html']);
293		}
294		unset($includes);
295		$prefix = DIR.'/includes/js/Polymer';
296		$system_js = &$includes_map[Config::SYSTEM_MODULE]['js'];
297		foreach ($system_js as $index => $file) {
298		if (strpos($file, $prefix) === 0) {
299		unset($system_js[$index]);
300		}
301		}
302		$system_js = array_values($system_js);
303		}
304	4	return $includes_map;
305		}
306		/**
307		* Includes array is composed from dependencies and sometimes dependencies doesn't have any files, so we'll clean that
308		*
309		* @param array $dependencies
310		* @param array $includes_map
311		*
312		* @return array
313		*/
314	4	protected function clean_includes_arrays_without_files ($dependencies, $includes_map) {
315	4	foreach ($dependencies as &$depends_on) {
316	4	foreach ($depends_on as $index => &$dependency) {
317	4	if (!isset($includes_map[$dependency])) {
318	4	unset($depends_on[$index]);
319		}
320		}
321	4	unset($dependency);
322		}
323	4	return $includes_map;
324		}
325		}
326

nazar-pc / CleverStyle-Framework

Push — master ( 0f36f7...67c76e )

Collecting::fill_includes_internal() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like