Caffeinated\Modules\Modules

Complexity

Total Complexity

31

Size/Duplication

Total Lines	339
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

7.14%

Importance

Changes	31
Bugs	6	Features	6

28 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	register()	0	10	1
A	registerServiceProvider()	0	8	1
A	autoloadFiles()	0	11	3
A	all()	0	4	1
A	slugs()	0	4	1
A	where()	0	4	1
A	sortBy()	0	4	1
A	sortByDesc()	0	4	1
A	exists()	0	4	1
A	count()	0	4	1
A	getPath()	0	4	1
A	setPath()	0	4	1
A	getModulePath()	0	4	1
A	getNamespace()	0	4	1
A	getProperties()	0	4	1
A	getProperty()	0	4	1
A	setProperty()	0	4	1
A	enabled()	0	4	1
A	disabled()	0	4	1
A	isEnabled()	0	4	1
A	isDisabled()	0	4	1
A	enable()	0	4	1
A	disable()	0	4	1
A	cache()	0	4	1
A	getCache()	0	4	1
A	setCache()	0	4	1
A	resolveNamespace()	0	7	2

<?php
namespace Caffeinated\Modules;

use Caffeinated\Modules\Contracts\RepositoryInterface;
use Illuminate\Foundation\Application;

class Modules implements RepositoryInterface
{
	/**
	 * @var Application
	 */
	protected $app;

	/**
	 * @var RepositoryInterface
	 */
	protected $repository;

	/**
	 * Create a new Modules instance.
	 *
	 * @param Application  $app
	 * @param RepositoryInterface  $repository
	 */
	public function __construct(Application $app, RepositoryInterface $repository)
	{
		$this->app        = $app;
		$this->repository = $repository;
	}

	/**
	 * Register the module service provider file from all modules.
	 *
	 * @return mixed
	 */
	public function register()
	{
		$modules = $this->repository->enabled();

		$modules->each(function($properties, $slug) {

The parameter $slug is not used and could be removed.

			$this->registerServiceProvider($properties);

			$this->autoloadFiles($properties);
		});
	}

	/**
	 * Register the module service provider.
	 *
	 * @param  string $properties
	 * @return string
	 * @throws \Caffeinated\Modules\Exception\FileMissingException
	 */
	protected function registerServiceProvider($properties)
	{
		$namespace       = $this->resolveNamespace($properties);

$properties is of type string, but the function expects a array.

		$file            = $this->repository->getPath()."/{$namespace}/Providers/{$namespace}ServiceProvider.php";

$file is not used, you could remove the assignment.

		$serviceProvider = $this->repository->getNamespace()."\\".$namespace."\\Providers\\{$namespace}ServiceProvider";

		$this->app->register($serviceProvider);
	}

	/**
	 * Autoload custom module files.
	 *
	 * @param array  $properties
	 * @return void
	 */
	protected function autoloadFiles($properties)
	{
		if (isset($properties['autoload'])) {
			$namespace = $this->resolveNamespace($properties);
			$path      = $this->repository->getPath()."/{$namespace}/";

			foreach ($properties['autoload'] as $file) {
				include($path.$file);
			}
		}
	}

	/**
	 * Get all modules.
	 *
	 * @return Collection
	 */
	public function all()
	{
		return $this->repository->all();
	}

	/**
	 * Get all module slugs.
	 *
	 * @return array
	 */
	public function slugs()
	{
		return $this->repository->slugs();
	}

	/**
	 * Get modules based on where clause.
	 *
	 * @param  string  $key
	 * @param  mixed   $value
	 * @return Collection
	 */
	public function where($key, $value)
	{
		return $this->repository->where($key, $value);
	}

	/**
	 * Sort modules by given key in ascending order.
	 *
	 * @param  string  $key
	 * @return Collection
	 */
	public function sortBy($key)
	{
		return $this->repository->sortBy($key);
	}

	/**
	 * Sort modules by given key in ascending order.
	 *
	 * @param  string  $key
	 * @return Collection
	 */
	public function sortByDesc($key)
	{
		return $this->repository->sortByDesc($key);
	}

	/**
	 * Check if the given module exists.
	 *
	 * @param  string  $slug
	 * @return bool
	 */
	public function exists($slug)
	{
		return $this->repository->exists($slug);
	}

	/**
	 * Returns count of all modules.
	 *
	 * @return int
	 */
	public function count()
	{
		return $this->repository->count();
	}

	/**
	 * Get modules path.
	 *
	 * @return string
	 */
	public function getPath()
	{
		return $this->repository->getPath();
	}

	/**
	 * Set modules path in "RunTime" mode.
	 *
	 * @param  string $path
	 * @return object $this
	 */
	public function setPath($path)
	{
		return $this->repository->setPath($path);
	}

	/**
	* Get path for the specified module.
	*
	* @param  string $slug
	* @return string
	*/
	public function getModulePath($slug)
	{
		return $this->repository->getModulePath($slug);
	}

	/**
	* Get modules namespace.
	*
	* @return string
	*/
	public function getNamespace()
	{
		return $this->repository->getNamespace();
	}

	/**
	 * Get a module's properties.
	 *
	 * @param  string $slug
	 * @return mixed
	 */
	public function getProperties($slug)
	{
		return $this->repository->getProperties($slug);
	}

	/**
	 * Get a module property value.
	 *
	 * @param  string $property
	 * @param  mixed  $default
	 * @return mixed
	 */
	public function getProperty($property, $default = null)
	{
		return $this->repository->getProperty($property, $default);
	}

	/**
	 * Set a module property value.
	 *
	 * @param  string $property
	 * @param  mixed  $value
	 * @return bool
	 */
	public function setProperty($property, $value)
	{
		return $this->repository->setProperty($property, $value);
	}

	/**
	 * Gets all enabled modules.
	 *
	 * @return array
	 */
	public function enabled()
	{
		return $this->repository->enabled();
	}

	/**
	 * Gets all disabled modules.
	 *
	 * @return array
	 */
	public function disabled()
	{
		return $this->repository->disabled();
	}

	/**
	 * Check if specified module is enabled.
	 *
	 * @param  string $slug
	 * @return bool
	 */
	public function isEnabled($slug)
	{
		return $this->repository->isEnabled($slug);
	}

	/**
	 * Check if specified module is disabled.
	 *
	 * @param  string $slug
	 * @return bool
	 */
	public function isDisabled($slug)
	{
		return $this->repository->isDisabled($slug);
	}

	/**
	 * Enables the specified module.
	 *
	 * @param  string $slug
	 * @return bool
	 */
	public function enable($slug)
	{
		return $this->repository->enable($slug);
	}

	/**
	 * Disables the specified module.
	 *
	 * @param  string $slug
	 * @return bool
	 */
	public function disable($slug)
	{
		return $this->repository->disable($slug);
	}

	/**
     * Refresh the cache with any newly found modules.
     *
     * @return bool
     */
    public function cache()
    {
        return $this->repository->cache();
    }

	/**
     * Get the contents of the cache file.
     *
     * The cache file lists all module slugs and their
     * enabled or disabled status. This can be used to
     * filter out modules depending on their status.
     *
     * @return Collection
     */
    public function getCache()
	{
		return $this->repository->getCache();
	}

	/**
     * Set the given cache key value.
     *
     * @param  string  $key
     * @param  mixed  $value
     * @return int
     */
    public function setCache($key, $value)
	{
		return $this->repository->setCache($key, $value);
	}

	/**
	 * Resolve the correct module namespace.
	 *
	 * @param array  $properties
	 */
	private function resolveNamespace($properties)
	{
		return (isset($properties['namespace'])
			? $properties['namespace']
			: studly_case($properties['slug'])
		);
	}
}