LocalRepository - Code Metrics - Inspection of "Fix the LocalRepository::Set() function to also up..." - caffeinated/modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#187)

unknown

created 2016-05-05 01:32 UTC

LocalRepository A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	280
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	9
Bugs	1	Features	0

Metric	Value
wmc	22
c	9
b	1
f	0
lcom	1
cbo	3
dl	0
loc	280
rs	10

18 Methods

Rating	Name	Size	Complexity
B	optimize()	30	3
A	all()	4	1
A	slugs()	10	1
A	where()	4	1
A	sortBy()	6	1
A	sortByDesc()	6	1
A	exists()	4	1
A	count()	4	1
A	get()	8	1
B	set()	27	2
A	enabled()	4	1
A	disabled()	4	1
A	isEnabled()	7	1
A	isDisabled()	7	1
A	enable()	4	1
A	disable()	4	1
A	getCache()	16	2
A	getCachePath()	4	1

<?php
namespace Caffeinated\Modules\Repositories;

use Caffeinated\Modules\Repositories\Repository;

class LocalRepository extends Repository
{
	/**
	 * Update cached repository of module information.
	 *
	 * @return bool
	 */
	public function optimize()
	{
		$cachePath = $this->getCachePath();
        $cache     = $this->getCache();
        $basenames = $this->getAllBasenames();
		$modules   = collect();

		$basenames->each(function($module, $key) use ($modules, $cache) {

			$temp     = collect($cache->get($module));
			$manifest = collect($this->getManifest($module));

			$modules->put($module, $temp->merge($manifest));
		});

		$modules->each(function($module) {
			if (! $module->has('enabled')) {
				$module->put('enabled', config('modules.enabled', true));
			}

			if (! $module->has('order')) {
				$module->put('order', 9001);
			}

			return $module;
		});

        $content = json_encode($modules->all(), JSON_PRETTY_PRINT);

        return $this->files->put($cachePath, $content);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	/**
	* Get all modules.
	*
	* @return Collection
	*/
	public function all()
	{
		return $this->getCache()->sortBy('order');
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	/**
	* Get all module slugs.
	*
	* @return Collection
	*/
	public function slugs()
	{
		$slugs = collect();

		$this->all()->each(function($item, $key) use ($slugs) {

			$slugs->push($item['slug']);
		});

		return $slugs;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

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

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

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

		return $collection->sortBy($key);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

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

		return $collection->sortByDesc($key);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

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

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

	/**
	 * Get a module property value.
	 *
	 * @param  string $property
	 * @param  mixed  $default
	 * @return mixed
	 */
	public function get($property, $default = null)
	{
		list($slug, $key) = explode('::', $property);

		$module = $this->where('slug', $slug);

		return $module->get($key, $default);
	}

	/**
	* Set the given module property value.
	*
	* @param  string  $property
	* @param  mixed   $value
	* @return bool
	*/
	public function set($property, $value)
	{
		list($slug, $key) = explode('::', $property);

        $manifestPath = $this->getManifestPath($slug);
		$cachePath = $this->getCachePath();
		$cache     = $this->getCache();
		$module    = $this->where('slug', $slug);
		$moduleKey = $module->keys()->first();
		$values    = $module->first();

		if (isset($values[$key])) {
			unset($values[$key]);
		}

		$values[$key] = $value;

		$module = collect([$moduleKey => $values]);

        $moduleJson = json_encode($module->all(), JSON_PRETTY_PRINT);
        $this->files->put($manifestPath, $moduleJson);

        $merged  = $cache->merge($module);
        $content = json_encode($merged->all(), JSON_PRETTY_PRINT);

        return $this->files->put($cachePath, $content);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	/**
	 * Get all enabled modules.
	 *
	 * @return Collection
	 */
	public function enabled()
	{
		return $this->all()->where('enabled', true);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	/**
	 * Get all disabled modules.
	 *
	 * @return Collection
	 */
	public function disabled()
	{
        return $this->all()->where('enabled', false);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	/**
	 * Check if specified module is enabled.
	 *
	 * @param  string $slug
	 * @return bool
	 */
	public function isEnabled($slug)
	{
		$module = $this->where('slug', $slug)
			->first();

		return ($module['enabled'] === true);
	}

	/**
	 * Check if specified module is disabled.
	 *
	 * @param  string $slug
	 * @return bool
	 */
	public function isDisabled($slug)
	{
		$module = $this->where('slug', $slug)
			->first();

		return ($module['enabled'] === false);
	}

	/**
	 * Enables the specified module.
	 *
	 * @param  string $slug
	 * @return bool
	 */
	public function enable($slug)
	{
        return $this->set($slug.'::enabled', true);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

	/**
	 * Disables the specified module.
	 *
	 * @param  string $slug
	 * @return bool
	 */
	public function disable($slug)
	{
        return $this->set($slug.'::enabled', false);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
	}

    /**
     * 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()
    {
		$cachePath = $this->getCachePath();

        if (! $this->files->exists($cachePath)) {
            $content = json_encode(array(), JSON_PRETTY_PRINT);

            $this->files->put($cachePath, $content);

			$this->optimize();

            return collect(json_decode($content, true));
        }

        return collect(json_decode($this->files->get($cachePath), true));
    }

	/**
	 * Get the path to the cache file.
	 *
	 * @return string
	 */
	protected function getCachePath()
	{
		return storage_path('app/modules.json');
	}
}


1			<?php
2			namespace Caffeinated\Modules\Repositories;
3
4			use Caffeinated\Modules\Repositories\Repository;
5
6			class LocalRepository extends Repository
7			{
8			/**
9			* Update cached repository of module information.
10			*
11			* @return bool
12			*/
13			public function optimize()
14			{
15			$cachePath = $this->getCachePath();
16			$cache = $this->getCache();
17			$basenames = $this->getAllBasenames();
18			$modules = collect();
19
20			$basenames->each(function($module, $key) use ($modules, $cache) {
			0 ignored issues – show Unused Code introduced 2015-12-26 04:59 UTC by Report Bug Copy Issue Report The parameter `$key` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
21			$temp = collect($cache->get($module));
22			$manifest = collect($this->getManifest($module));
23
24			$modules->put($module, $temp->merge($manifest));
25			});
26
27			$modules->each(function($module) {
28			if (! $module->has('enabled')) {
29			$module->put('enabled', config('modules.enabled', true));
30			}
31
32			if (! $module->has('order')) {
33			$module->put('order', 9001);
34			}
35
36			return $module;
37			});
38
39			$content = json_encode($modules->all(), JSON_PRETTY_PRINT);

caffeinated / modules

GitHub Access Token became invalid

Pull Request — master (#187)

LocalRepository A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

18 Methods

Duplication Side-by-Side

Filter issues like