ModuleManager::unsatisfiedDependencies() - Code Metrics - Inspection of "[UPDATE] reorganize files to system module" - x-systems/epesi-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e4e152...8fde47 )

by Georgi

created 2019-11-02 18:58 UTC

ModuleManager::unsatisfiedDependencies() A

↳ Parent: ModuleManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	1
dl	0
loc	2
rs	10

<?php

namespace Epesi\Core\System\Integration\Modules;

use Illuminate\Support\Facades\Schema;
use Epesi\Core\System\Database\Models\Module;
use Illuminate\Support\Facades\Cache;

class ModuleManager
{
	use Concerns\HasPackageManifest;
	
	/**
	 * @var \Illuminate\Support\Collection
	 */
	private static $installed;
	private static $processing;

	public static function isInstalled($classOrAlias)
	{
		return self::getClass($classOrAlias)? 1: 0;
	}
	
	public static function isAvalable($classOrAlias)
	{
		return class_exists(self::getClass($classOrAlias));
	}

	/**
	 * Get the module core class from class or alias
	 * 
	 * @param string $classOrAlias
	 * @return string;
	 */
	public static function getClass($classOrAlias, $installed = false) {
		$allModules = $installed? self::getInstalled(): self::getAll();
		
		if (collect($allModules)->contains($classOrAlias)) return $classOrAlias;
		
		return $allModules[$classOrAlias]?? null;
	}
	
	/**
	 * Get a collection of installed modules in alias -> class pairs
	 * 
	 * @return Illuminate\Support\Collection;

	 */
	public static function getInstalled()
	{
		return self::$installed = self::$installed?? self::getCached('epesi-modules-installed', function() {

			$installedModules = Schema::hasTable('modules')? Module::pluck('class', 'alias'): collect();
			
			// if epesi is not installed fake having the system module to enable its functionality
			if ($installedModules->isEmpty()) {
				$installedModules['system'] = \Epesi\Core\System\SystemCore::class;
			}
			
			return $installedModules;
		});
	}
	
	/**
	 * Get a collection of all manifested modules in alias -> class pairs
	 * 
	 * @return Illuminate\Support\Collection;
	 */
	public static function getAll()
	{
		return self::getCached('epesi-modules-available', function () {
			$modules = collect();
			foreach (array_merge(config('epesi.modules'), self::packageManifest()->modules()) as $moduleClass) {
				$modules->add(['alias' => $moduleClass::alias(), 'class' => $moduleClass]);
			}

			return $modules->pluck('class', 'alias');
		});
	}
	
	/**
	 * Common method to use for caching of data within module manager
	 * 
	 * @param string $key
	 * @param \Closure $default
	 * @return mixed
	 */
	protected static function getCached($key, \Closure $default)
	{
		if (! Cache::has($key)) {
			Cache::forever($key, $default());
		}

		return Cache::get($key);
	}
	
	/**
	 * Clear module manager cache
	 */
	public static function clearCache()
	{
		Cache::forget('epesi-modules-installed');
		Cache::forget('epesi-modules-available');
	}
	
	/**
	 * Collect array of results from $method in all installed module core classes
	 *
	 * @param string $method
	 * @return array
	 */
	public static function collect($method, $args = [])
	{
		$args = is_array($args)? $args: [$args];
		
		$ret = [];
		foreach (self::getInstalled() as $module) {
			if (! $list = $module::$method(...$args)) continue;
			
			$ret = array_merge($ret, is_array($list)? $list: [$list]);
		}
		
		return $ret;
	}

	/**
	 * Install the module class provided as argument
	 * 
	 * @param string $classOrAlias
	 */
	public static function install($classOrAlias)
	{
		if (self::isInstalled($classOrAlias)) {
			print ('Module "' . $classOrAlias . '" already installed!');
			
			return true;
		}
		
		if (! $moduleClass = self::getClass($classOrAlias)) {			
			throw new \Exception('Module "' . $classOrAlias . '" could not be identified');
		}
		
		/**
		 * @var ModuleCore $module
		 */
		$module = new $moduleClass();
		
		self::satisfyDependencies($moduleClass);

		$module->migrate();
		
		try {
			$module->install();
		} catch (\Exception $e) {
			$module->rollback();
			
			throw $e;
		}
		
		$module->publishAssets();
		
		// update database
		Module::create([
				'class' => $moduleClass,
				'alias' => $module->alias()
		]);
		
		self::clearCache();
		
		print ('Module ' . $classOrAlias . ' successfully installed!');
		
		return true;
	}
	
	/**
	 * Install modules that $moduleClass requires
	 * Performs operation recursively for all required modules
	 * 
	 * @param string $moduleClass
	 * @throws \Exception
	 * @return boolean
	 */
	protected static function satisfyDependencies($moduleClass) {
		self::$processing[$moduleClass] = true;
		
		try {
			while ($unsatisfiedDependencies = self::unsatisfiedDependencies($moduleClass)) {
				$parentModule = $unsatisfiedDependencies[0];
				
				if (self::$processing[$moduleClass]?? false) {
					throw new \Exception('Cross dependency: '. $moduleClass);
				}
				
				if (! self::isAvalable($parentModule)) {
					throw new \Exception('Module not found: "' . $parentModule . '"');
				}
	
				print("\n\r");
				print('Installing required module: "' . $parentModule . '" by "' . $moduleClass . '"');

				self::install($parentModule);
			}
		} catch (\Exception $e) {
			print("\n\r");
			print ($e->getMessage());			
			
			return false;
		}
		unset(self::$processing[$moduleClass]);
		
		return true;
	}
	
	protected static function unsatisfiedDependencies($moduleClass) {
		return array_diff($moduleClass::requires(), self::getInstalled());
		return array_diff($moduleClass::requires(), /** @scrutinizer ignore-type */ self::getInstalled());
	}	
}


x-systems / epesi-core

Push — master ( e4e152...8fde47 )

ModuleManager::unsatisfiedDependencies() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like