FileActivator::setActiveByName() - Code Metrics - Inspection of "Merge pull request #790 from ryssbowh/activator" - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9620dc...f09c52 )

by Nicolas

created 2019-08-19 09:03 UTC

FileActivator::setActiveByName() A

↳ Parent: FileActivator

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes

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

<?php

namespace Nwidart\Modules\Activators;

use Illuminate\Cache\CacheManager;
use Illuminate\Config\Repository as Config;
use Illuminate\Container\Container;
use Illuminate\Filesystem\Filesystem;
use Nwidart\Modules\Contracts\ActivatorInterface;
use Nwidart\Modules\Module;

class FileActivator implements ActivatorInterface
{
	/**
	 * Laravel cache instance
	 * 
	 * @var CacheManager
	 */
	protected $cache;

	/**
	 * Laravel Filesystem instance
	 * 
	 * @var Filesystem
	 */
	protected $files;

	/**
	 * Laravel config instance
	 * 
	 * @var Config
	 */
	protected $config;

	/**
	 * @var string
	 */
	protected $cacheKey;

	/**
	 * @var string
	 */
	protected $cacheLifetime;

	/**
	 * Array of modules activation statuses
	 * 
	 * @var array
	 */
	protected $modulesStatuses;

	/**
	 * File used to store activation statuses
	 * 
	 * @var string
	 */
	protected $statusesFile;

	public function __construct(Container $app)
	{
		$this->cache = $app['cache'];
		$this->files = $app['files'];
		$this->config = $app['config'];
		$this->statusesFile = $this->config('statuses-file');
		$this->cacheKey = $this->config('cache-key');
		$this->cacheLifetime = $this->config('cache-lifetime');
		$this->modulesStatuses = $this->getModulesStatuses();
	}

	/**
	 * Get modules statuses, either from the cache or 
	 * from the json statuses file if the cache is disabled.
	 * 
	 * @return array
	 */
	private function getModulesStatuses()
	{
		if(!$this->config->get('modules.cache.enabled')) return $this->readJson();
		
		return $this->cache->remember($this->cacheKey, $this->cacheLifetime, function () {
            return $this->readJson();
        });
	}

	/**
	 * Flushes the modules activation statuses cache
	 */
	private function flushCache()
	{
		$this->cache->forget($this->cacheKey);
	}

	/**
	 * Reads a config parameter
	 * 
	 * @param  string $key     [description]
	 * @param  $default
	 * @return mixed
	 */
	private function config(string $key, $default = null)
    {
        return $this->config->get('modules.activators.file.' . $key, $default);
    }

	/**
	 * Reads the json file that contains the activation statuses.
	 * 
	 * @return array
	 */
	private function readJson()
	{
		if(!$this->files->exists($this->statusesFile)) return [];
		return json_decode($this->files->get($this->statusesFile), true);
	}

	/**
	 * Writes the activation statuses in a file, as json
	 */
	private function writeJson()
	{
		$this->files->put($this->statusesFile, json_encode($this->modulesStatuses, JSON_PRETTY_PRINT));
	}

	/**
	 * Get the path of the file where statuses are stored
	 * 
	 * @return string
	 */
	public function getStatusesFilePath()
	{
		return $this->statusesFile;
	}

	/**
	 * @inheritDoc
	 */
	public function reset()
	{
		if($this->files->exists($this->statusesFile)){
			$this->files->delete($this->statusesFile);
		}
		$this->modulesStatuses = [];
		$this->flushCache();
	}

	/**
     * @inheritDoc
     */
    public function enable(Module $module)
    {
    	$this->setActiveByName($module->getName(), true);

    }

    /**
     * @inheritDoc
     */
    public function disable(Module $module)
    {
		$this->setActiveByName($module->getName(), false);

    }

    /**
     * @inheritDoc
     */
    public function isStatus(Module $module, bool $status): bool
    {
    	if(!isset($this->modulesStatuses[$module->getName()])){

    		return $status === false;
    	}
    	return $this->modulesStatuses[$module->getName()] === $status;

    }

    /**
     * @inheritDoc
     */
    public function setActive(Module $module, bool $active)
    {
    	$this->setActiveByName($module->getName(), $active);

    }

    /**
     * @inheritDoc
     */
    public function setActiveByName(string $name, bool $status)
    {
    	$this->modulesStatuses[$name] = $status;
    	$this->writeJson();
    	$this->flushCache();
    }

    /**
     * @inheritDoc
     */
    public function delete(Module $module)
    {
    	if(!isset($this->modulesStatuses[$module->getName()])) return;

    	unset($this->modulesStatuses[$module->getName()]);
    	$this->writeJson();
    	$this->flushCache();
    }
}


1		<?php
2
3		namespace Nwidart\Modules\Activators;
4
5		use Illuminate\Cache\CacheManager;
6		use Illuminate\Config\Repository as Config;
7		use Illuminate\Container\Container;
8		use Illuminate\Filesystem\Filesystem;
9		use Nwidart\Modules\Contracts\ActivatorInterface;
10		use Nwidart\Modules\Module;
11
12		class FileActivator implements ActivatorInterface
13		{
14		/**
15		* Laravel cache instance
16		*
17		* @var CacheManager
18		*/
19		protected $cache;
20
21		/**
22		* Laravel Filesystem instance
23		*
24		* @var Filesystem
25		*/
26		protected $files;
27
28		/**
29		* Laravel config instance
30		*
31		* @var Config
32		*/
33		protected $config;
34
35		/**
36		* @var string
37		*/
38		protected $cacheKey;
39
40		/**
41		* @var string
42		*/
43		protected $cacheLifetime;
44
45		/**
46		* Array of modules activation statuses
47		*
48		* @var array
49		*/
50		protected $modulesStatuses;
51
52		/**
53		* File used to store activation statuses
54		*
55		* @var string
56		*/
57		protected $statusesFile;
58
59	191	public function __construct(Container $app)
60		{
61	191	$this->cache = $app['cache'];
62	191	$this->files = $app['files'];
63	191	$this->config = $app['config'];
64	191	$this->statusesFile = $this->config('statuses-file');
65	191	$this->cacheKey = $this->config('cache-key');
66	191	$this->cacheLifetime = $this->config('cache-lifetime');
67	191	$this->modulesStatuses = $this->getModulesStatuses();
68	191	}
69
70		/**
71		* Get modules statuses, either from the cache or
72		* from the json statuses file if the cache is disabled.
73		*
74		* @return array
75		*/
76	191	private function getModulesStatuses()
77		{
78	191	if(!$this->config->get('modules.cache.enabled')) return $this->readJson();
79
80		return $this->cache->remember($this->cacheKey, $this->cacheLifetime, function () {
81		return $this->readJson();
82		});
83		}
84
85		/**
86		* Flushes the modules activation statuses cache
87		*/
88	188	private function flushCache()
89		{
90	188	$this->cache->forget($this->cacheKey);
91	188	}
92
93		/**
94		* Reads a config parameter
95		*
96		* @param string $key [description]
97		* @param $default
98		* @return mixed
99		*/
100	191	private function config(string $key, $default = null)
101		{
102	191	return $this->config->get('modules.activators.file.' . $key, $default);
103		}
104
105		/**
106		* Reads the json file that contains the activation statuses.
107		*
108		* @return array
109		*/
110	191	private function readJson()
111		{
112	191	if(!$this->files->exists($this->statusesFile)) return [];
113	90	return json_decode($this->files->get($this->statusesFile), true);
114		}
115
116		/**
117		* Writes the activation statuses in a file, as json
118		*/
119	130	private function writeJson()
120		{
121	130	$this->files->put($this->statusesFile, json_encode($this->modulesStatuses, JSON_PRETTY_PRINT));
122	130	}
123
124		/**
125		* Get the path of the file where statuses are stored
126		*
127		* @return string
128		*/
129	2	public function getStatusesFilePath()
130		{
131	2	return $this->statusesFile;
132		}
133
134		/**
135		* @inheritDoc
136		*/
137	98	public function reset()
138		{
139	98	if($this->files->exists($this->statusesFile)){
140	41	$this->files->delete($this->statusesFile);
141		}
142	98	$this->modulesStatuses = [];
143	98	$this->flushCache();
144	98	}
145
146		/**
147		* @inheritDoc
148		*/
149	6	public function enable(Module $module)
150		{
151	6	$this->setActiveByName($module->getName(), true);
		0 ignored issues – show Bug introduced 2019-07-07 20:24 UTC by Report Bug Copy Issue Report Consider using `$module->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
152	6	}
153
154		/**
155		* @inheritDoc
156		*/
157	6	public function disable(Module $module)
158		{
159	6	$this->setActiveByName($module->getName(), false);
		0 ignored issues – show Bug introduced 2019-07-07 20:24 UTC by Report Bug Copy Issue Report Consider using `$module->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
160	6	}
161
162		/**
163		* @inheritDoc
164		*/
165	16	public function isStatus(Module $module, bool $status): bool
166		{
167	16	if(!isset($this->modulesStatuses[$module->getName()])){
		0 ignored issues – show Bug introduced 2019-07-09 18:40 UTC by Report Bug Copy Issue Report Consider using `$module->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
168	8	return $status === false;
169		}
170	8	return $this->modulesStatuses[$module->getName()] === $status;
		0 ignored issues – show Bug introduced 2019-07-09 18:40 UTC by Report Bug Copy Issue Report Consider using `$module->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
171		}
172
173		/**
174		* @inheritDoc
175		*/
176	4	public function setActive(Module $module, bool $active)
177		{
178	4	$this->setActiveByName($module->getName(), $active);
		0 ignored issues – show Bug introduced 2019-07-07 20:24 UTC by Report Bug Copy Issue Report Consider using `$module->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
179	4	}
180
181		/**
182		* @inheritDoc
183		*/
184	130	public function setActiveByName(string $name, bool $status)
185		{
186	130	$this->modulesStatuses[$name] = $status;
187	130	$this->writeJson();
188	130	$this->flushCache();
189	130	}
190
191		/**
192		* @inheritDoc
193		*/
194	2	public function delete(Module $module)
195		{
196	2	if(!isset($this->modulesStatuses[$module->getName()])) return;
		0 ignored issues – show Bug introduced 2019-07-09 18:40 UTC by Report Bug Copy Issue Report Consider using `$module->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
197	2	unset($this->modulesStatuses[$module->getName()]);
198	2	$this->writeJson();
199	2	$this->flushCache();
200	2	}
201		}
202

nWidart / laravel-modules

Push — master ( 9620dc...f09c52 )

FileActivator::setActiveByName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like