LocalRepository - Code Metrics - Inspection of "Moved list of enabled modules to app storage direc..." - caffeinated/modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 560752...2363e1 )

by Shea

created 2016-01-02 07:40 UTC

LocalRepository A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	316
Duplicated Lines	7.59 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
wmc	25
c	2
b	0
f	0
lcom	1
cbo	3
dl	24
loc	316
rs	10

19 Methods

Rating	Name	Duplication	Size	Complexity
A	all()	0	11	1
A	slugs()	0	10	1
A	where()	0	6	1
A	sortBy()	0	6	1
A	sortByDesc()	0	6	1
A	exists()	0	4	1
A	count()	0	4	1
A	getProperties()	0	17	3
A	getProperty()	0	6	1
A	setProperty()	0	16	2
A	enabled()	12	12	1
A	disabled()	12	12	1
A	isEnabled()	0	6	1
A	isDisabled()	0	6	1
A	enable()	0	4	1
A	disable()	0	4	1
A	cache()	0	18	2
A	getCacheFile()	0	21	3
A	setCacheFile()	0	11	1

How to fix Duplicated Code

<?php
namespace Caffeinated\Modules\Repositories;

use Caffeinated\Modules\Repositories\Repository;

class LocalRepository extends Repository
{
	/**
	* Get all modules.
	*
	* @return Collection
	*/
	public function all()
	{
		$basenames = $this->getAllBasenames();
		$modules   = collect();

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

			$modules->put($module, $this->getProperties($module));
		});

		return $modules->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)
	{
		$collection = $this->all();

		return $collection->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's properties.
	 *
	 * @param  string $slug
	 * @return Collection|null
	 */
	public function getProperties($slug)
	{
		if (! is_null($slug)) {
			$module     = studly_case($slug);
			$path       = $this->getManifestPath($module);
			$contents   = $this->files->get($path);
			$collection = collect(json_decode($contents, true));

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

			return $collection;
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());
}
		}

		return null;
	}

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

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

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

		$module  = strtolower($module);
		$content = $this->getProperties($module);

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

		$content[$key] = $value;
		$content       = json_encode($content, JSON_PRETTY_PRINT);

		return $this->files->put($this->getManifestPath($module), $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()

	{
        $moduleCache = $this->getCacheFile();

        $modules = $this->all()->map(function($item, $key) use ($moduleCache) {

            $item['enabled'] = $moduleCache->get($item['slug']);

            return $item;
        });

		return $modules->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()

	{
        $moduleCache = $this->getCacheFile();

        $modules = $this->all()->map(function($item, $key) use ($moduleCache) {

            $item['enabled'] = $moduleCache->get($item['slug']);

            return $item;
        });

		return $modules->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)
	{
        $moduleCache = $this->getCacheFile();

        return $moduleCache->get($slug) === true;
	}

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

        return $moduleCache->get($slug) === false;
	}

	/**
	 * Enables the specified module.
	 *
	 * @param  string $slug
	 * @return bool
	 */
	public function enable($slug)
	{
        return $this->setCacheFile($slug, 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->setCacheFile($slug, 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());
}
	}

    /**
     * Refresh the cache with any newly found modules.
     *
     * @return bool
     */
    public function cache()
    {
        $cacheFile = storage_path('app/modules.json');
        $cache     = $this->getCacheFile();
        $modules   = $this->all();

        $collection = collect([]);

        foreach ($modules as $module) {
            $collection->put($module['slug'], true);
        }

        $keys    = $collection->keys()->toArray();
        $merged  = $collection->merge($cache)->only($keys);
        $content = json_encode($merged->all(), JSON_PRETTY_PRINT);

        return $this->files->put($cacheFile, $content);
    }

    /**
     * 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
     */
    protected function getCacheFile()
    {
        $cacheFile = storage_path('app/modules.json');

        if (! $this->files->exists($cacheFile)) {
            $modules = $this->all();
            $content = [];

            foreach ($modules as $module) {
                $content[$module['slug']] = true;
            }

            $content = json_encode($content, JSON_PRETTY_PRINT);

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

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

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

    /**
    * Set the given cache key value.
    *
    * @param  string  $key
    * @param  mixed  $value
    * @return int
    */
    protected function setCacheFile($key, $value)
    {
        $cacheFile = storage_path('app/modules.json');
        $content   = $this->getCacheFile();

        $content->put($key, $value);

        $content = json_encode($content, JSON_PRETTY_PRINT);

        return $this->files->put($cacheFile, $content);
    }
}


1			<?php
2			namespace Caffeinated\Modules\Repositories;
3
4			use Caffeinated\Modules\Repositories\Repository;
5
6			class LocalRepository extends Repository
7			{
8			/**
9			* Get all modules.
10			*
11			* @return Collection
12			*/
13			public function all()
14			{
15			$basenames = $this->getAllBasenames();
16			$modules = collect();
17
18			$basenames->each(function($module, $key) use ($modules) {
			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...
19			$modules->put($module, $this->getProperties($module));
20			});
21
22			return $modules->sortBy('order');
			0 ignored issues – show Bug Best Practice introduced 2015-12-26 04:59 UTC by Report Bug Copy Issue Report The return type of `return $modules->sortBy('order');` (`Illuminate\Support\Collection`) is incompatible with the return type declared by the interface `Caffeinated\Modules\Cont...epositoryInterface::all` of type `Caffeinated\Modules\Contracts\Collection`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: 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()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
23			}
24
25			/**
26			* Get all module slugs.
27			*
28			* @return Collection
29			*/
30			public function slugs()
31			{
32			$slugs = collect();
33
34			$this->all()->each(function($item, $key) use ($slugs) {
			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...
35			$slugs->push($item['slug']);
36			});
37

caffeinated / modules

GitHub Access Token became invalid

Push — master ( 560752...2363e1 )

LocalRepository A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

19 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like