LaravelDatabaseRepository - Code Metrics - Inspection of "Add database management feature" - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1163)

unknown

created 2021-01-28 06:49 UTC

LaravelDatabaseRepository A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	266
Duplicated Lines	8.27 %

Coupling/Cohesion

Components	1
Dependencies	10

Importance

Changes

Metric	Value
dl	22
loc	266
rs	9.28
c	0
b	0
f	0
wmc	39
lcom	1
cbo	10

15 Methods

Rating	Name	Duplication	Size	Complexity
A	createModule()	0	4	1
A	getModel()	0	4	1
A	scan()	0	17	4
A	collections()	0	4	1
A	getModulePath()	0	9	2
A	getByStatus()	12	12	3
A	formatCached()	0	12	2
A	getCached()	0	6	1
A	all()	0	9	2
A	create()	0	18	2
A	getModuleType()	0	13	5
A	getUsedNow()	0	9	2
B	migrateFileToDatabase()	6	32	7
A	update()	4	23	4
A	validateAttributes()	0	10	2

How to fix Duplicated Code

<?php

namespace Nwidart\Modules\Laravel;

use Illuminate\Contracts\Filesystem\FileNotFoundException;
use Illuminate\Support\Facades\Schema;
use Illuminate\Support\Str;
use Nwidart\Modules\Collection;
use Nwidart\Modules\Contracts\ActivatorInterface;
use Nwidart\Modules\Contracts\DatabaseRepositoryInterface;
use Nwidart\Modules\Entities\ModuleEntity;
use Nwidart\Modules\Exceptions\ModuleNotFoundException;
use Nwidart\Modules\Generators\DatabaseModuleGenerator;
use Nwidart\Modules\Json;

class LaravelDatabaseRepository extends LaravelFileRepository implements DatabaseRepositoryInterface
{
    /**
     * Creates a new Module instance.
     *
     * @param mixed ...$args
     *
     * @return DatabaseModule
     */
    protected function createModule(...$args)
    {
        return new DatabaseModule(...$args);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @return ModuleEntity
     */
    public function getModel()
    {
        return new ModuleEntity();
    }

    /**
     * Scan & get all available modules.
     */
    public function scan()
    {
        /**
         * @var ModuleEntity[] $rows
         */
        $rows = $this->getModel()->get();
        $modules = [];
        if (!empty($rows)) {
            foreach ($rows as $row) {
                if (file_exists($row->path)) {
                    $modules[$row->name] = $this->createModule($this->app, $row->name, $row->path);
                }
            }
        }

        return $modules;
    }

    /**
     * Get all modules as laravel collection instance.
     *
     * @param $status
     *
     * @return Collection
     */
    public function collections($status = 1): Collection
    {
        return new Collection($this->getByStatus($status));
    }

    /**
     * Get module path for a specific module.
     *
     * @param $name
     *
     * @return string
     */
    public function getModulePath($name)
    {
        $module = $this->find($name);
        if ($module) {
            return $module->getPath() . '/';
        }

        return $this->getPath() . '/' . Str::studly($name) . '/';
    }

    /**
     * Get modules by status.
     *
     * @param $status
     *
     * @return array
     */
    public function getByStatus($status): array
    {
        $modules = [];

        foreach ($this->all() as $name => $module) {
            if ($module->isStatus($status) == $status) {
                $modules[$name] = $module;
            }
        }

        return $modules;
    }

    /**
     * Format the cached data as array of modules.
     *
     * @param array $cached
     *
     * @return array
     */
    protected function formatCached($cached)
    {
        $modules = [];

        foreach ($cached as $moduleEntity) {
            $module = $this->createModule($this->app, $moduleEntity['name'], $moduleEntity['path']);
            $module->setAttributes($moduleEntity->toArray());
            $modules[$moduleEntity['name']] = $module;
        }

        return $modules;
    }

    /**
     * Get cached modules from database.
     *
     * @return ModuleEntity[]
     */
    public function getCached()
    {
        return $this->app['cache']->remember($this->config('cache.key'), $this->config('cache.lifetime'), function () {
            return $this->getModel()->all();
        });
    }

    public function all(): array
    {
        // Do not load or register if there are no modules table yet.
        if (!Schema::hasTable('modules')) {
            return [];
        }

        return parent::all();
    }

    public function create($params, $force = true, $isApi = true, $isPlain = true)
    {
        $moduleType = $this->getModuleType($isApi, $isPlain); // Custom later.
        /** @var DatabaseModuleGenerator $generator */
        $generator = with(new DatabaseModuleGenerator($params['name']));
        $code = $generator
            ->setFilesystem(app('files'))
            ->setModule($this)
            ->setConfig(app('config'))
            ->setActivator(app(ActivatorInterface::class))
            ->setForce($force)
            ->setType($moduleType)
            ->setActive($params['is_active'])
            ->setSilentOutput(true) // Don't use console output
            ->generate();

        return $code ? $this->find($params['name']) : false;
    }

    /**
     * Get module type .
     *
     * @param bool $isApi
     * @param bool $isPlain
     *
     * @return string
     */
    public function getModuleType($isApi = true, $isPlain = true)
    {
        if ($isPlain && $isApi) {
            return 'web';
        }
        if ($isPlain) {
            return 'plain';
        } elseif ($isApi) {
            return 'api';
        } else {
            return 'web';
        }
    }

    /**
     * Get module used for cli session.
     * @return string
     * @throws ModuleNotFoundException|FileNotFoundException
     */
    public function getUsedNow(): string
    {
        $module = $this->getFiles()->get($this->getUsedStoragePath());
        if (!$module) {
            return '';
        }

        return $this->findOrFail($module);
    }

    public function migrateFileToDatabase()
    {
        $paths = $this->getScanPaths();
        $modules = [];

        foreach ($paths as $key => $path) {
            $manifests = $this->getFiles()->glob("{$path}/module.json");

            is_array($manifests) || $manifests = [];

            foreach ($manifests as $manifest) {
                $json = Json::make($manifest);
                $data = $json->getAttributes();
                $data['path'] = str_replace('module.json', '', $json->getPath());
                if (!isset($data['version'])) {
                    $data['version'] = '1.0.0';
                }
                $module = $this->find($data['name']);
                $data = $this->validateAttributes($data);
                if (!$module) {
                    $modules[] = $this->getModel()->create($data);
                } else {

                    // Check version, if version is higher then update module.json into database.
                    if (version_compare($module->getVersion(), $data['version'], '<')) {
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
                        $modules[] = $this->getModel()->where(['name' => $data['name']])->update($data);
                    }
                }
            }
        }

        return $modules;
    }

    public function update($name)
    {
        if ($this->config('database_management.update_file_to_database_when_updating')) {

            /** @var DatabaseModule $module */
            $module = $this->findOrFail($name);

            $json = Json::make($module->getPath() . '/' . 'module.json');
            $data = $json->getAttributes();

            if (!isset($data['version'])) {
                $data['version'] = '1.0.0';
            }

            // Check version, if version is higher then update module.json into database.
            if (version_compare($module->getVersion(), $data['version'], '<=')) {

                $data = $this->validateAttributes($data);
                $this->getModel()->where(['name' => $data['name']])->update($data);
            }
        }

        parent::update($name);
    }

    /**
     * Validate array attributes before insert/update into database.
     *
     * @param array $attributes
     * @param array $allows
     *
     * @return array
     */
    protected function validateAttributes(array $attributes, array $allows = [])
    {
        if (empty($allows)) {
            $allows = $this->getModel()->getFillable();
        }

        return array_filter($attributes, function ($k) use ($allows) {
            return in_array($k, $allows);
        }, ARRAY_FILTER_USE_KEY);
    }
}


1		<?php
2
3		namespace Nwidart\Modules\Laravel;
4
5		use Illuminate\Contracts\Filesystem\FileNotFoundException;
6		use Illuminate\Support\Facades\Schema;
7		use Illuminate\Support\Str;
8		use Nwidart\Modules\Collection;
9		use Nwidart\Modules\Contracts\ActivatorInterface;
10		use Nwidart\Modules\Contracts\DatabaseRepositoryInterface;
11		use Nwidart\Modules\Entities\ModuleEntity;
12		use Nwidart\Modules\Exceptions\ModuleNotFoundException;
13		use Nwidart\Modules\Generators\DatabaseModuleGenerator;
14		use Nwidart\Modules\Json;
15
16		class LaravelDatabaseRepository extends LaravelFileRepository implements DatabaseRepositoryInterface
17		{
18		/**
19		* Creates a new Module instance.
20		*
21		* @param mixed ...$args
22		*
23		* @return DatabaseModule
24		*/
25		protected function createModule(...$args)
26		{
27		return new DatabaseModule(...$args);
		0 ignored issues – show Bug introduced 2021-01-06 04:27 UTC by Report Bug Copy Issue Report The call to `DatabaseModule::__construct()` misses some required arguments starting with `$name`. Loading history... Documentation introduced 2021-01-06 07:38 UTC by Report Bug Copy Issue Report `$args` is of type `array<integer,*>`, but the function expects a `object<Illuminate\Container\Container>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
28		}
29
30		/**
31		* @return ModuleEntity
32		*/
33		public function getModel()
34		{
35		return new ModuleEntity();
36		}
37
38		/**
39		* Scan & get all available modules.
40		*/
41		public function scan()
42		{
43		/**
44		* @var ModuleEntity[] $rows
45		*/
46		$rows = $this->getModel()->get();
47		$modules = [];
48		if (!empty($rows)) {
49		foreach ($rows as $row) {
50		if (file_exists($row->path)) {
51		$modules[$row->name] = $this->createModule($this->app, $row->name, $row->path);
52		}
53		}
54		}
55
56		return $modules;
57		}
58
59		/**
60		* Get all modules as laravel collection instance.
61		*
62		* @param $status
63		*
64		* @return Collection
65		*/
66		public function collections($status = 1): Collection
67		{
68		return new Collection($this->getByStatus($status));
69		}
70
71		/**
72		* Get module path for a specific module.
73		*
74		* @param $name
75		*
76		* @return string
77		*/
78		public function getModulePath($name)
79		{
80		$module = $this->find($name);
81		if ($module) {
82		return $module->getPath() . '/';
83		}
84
85		return $this->getPath() . '/' . Str::studly($name) . '/';
86		}
87
88		/**
89		* Get modules by status.
90		*
91		* @param $status
92		*
93		* @return array
94		*/
95	View Code Duplication	public function getByStatus($status): array
96		{
97		$modules = [];
98
99		foreach ($this->all() as $name => $module) {
100		if ($module->isStatus($status) == $status) {
101		$modules[$name] = $module;
102		}
103		}
104
105		return $modules;
106		}
107
108		/**
109		* Format the cached data as array of modules.
110		*
111		* @param array $cached
112		*
113		* @return array
114		*/
115		protected function formatCached($cached)
116		{
117		$modules = [];
118
119		foreach ($cached as $moduleEntity) {
120		$module = $this->createModule($this->app, $moduleEntity['name'], $moduleEntity['path']);
121		$module->setAttributes($moduleEntity->toArray());
122		$modules[$moduleEntity['name']] = $module;
123		}
124
125		return $modules;
126		}
127
128		/**
129		* Get cached modules from database.
130		*
131		* @return ModuleEntity[]
132		*/
133		public function getCached()
134		{
135		return $this->app['cache']->remember($this->config('cache.key'), $this->config('cache.lifetime'), function () {
136		return $this->getModel()->all();
137		});
138		}
139
140		public function all(): array
141		{
142		// Do not load or register if there are no modules table yet.
143		if (!Schema::hasTable('modules')) {
144		return [];
145		}
146
147		return parent::all();
148		}
149
150		public function create($params, $force = true, $isApi = true, $isPlain = true)
151		{
152		$moduleType = $this->getModuleType($isApi, $isPlain); // Custom later.
153		/** @var DatabaseModuleGenerator $generator */
154		$generator = with(new DatabaseModuleGenerator($params['name']));
155		$code = $generator
156		->setFilesystem(app('files'))
157		->setModule($this)
158		->setConfig(app('config'))
159		->setActivator(app(ActivatorInterface::class))
160		->setForce($force)
161		->setType($moduleType)
162		->setActive($params['is_active'])
163		->setSilentOutput(true) // Don't use console output
164		->generate();
165
166		return $code ? $this->find($params['name']) : false;
167		}
168
169		/**
170		* Get module type .
171		*
172		* @param bool $isApi
173		* @param bool $isPlain
174		*
175		* @return string
176		*/
177		public function getModuleType($isApi = true, $isPlain = true)
178		{
179		if ($isPlain && $isApi) {
180		return 'web';
181		}
182		if ($isPlain) {
183		return 'plain';
184		} elseif ($isApi) {
185		return 'api';
186		} else {
187		return 'web';
188		}
189		}
190
191		/**
192		* Get module used for cli session.
193		* @return string
194		* @throws ModuleNotFoundException\|FileNotFoundException
195		*/
196		public function getUsedNow(): string
197		{
198		$module = $this->getFiles()->get($this->getUsedStoragePath());
199		if (!$module) {
200		return '';
201		}
202
203		return $this->findOrFail($module);
204		}
205
206		public function migrateFileToDatabase()
207		{
208		$paths = $this->getScanPaths();
209		$modules = [];
210
211		foreach ($paths as $key => $path) {
212		$manifests = $this->getFiles()->glob("{$path}/module.json");
213
214		is_array($manifests) \|\| $manifests = [];
215
216		foreach ($manifests as $manifest) {
217		$json = Json::make($manifest);
218		$data = $json->getAttributes();
219		$data['path'] = str_replace('module.json', '', $json->getPath());
220		if (!isset($data['version'])) {
221		$data['version'] = '1.0.0';
222		}
223		$module = $this->find($data['name']);
224		$data = $this->validateAttributes($data);
225		if (!$module) {
226		$modules[] = $this->getModel()->create($data);
227	View Code Duplication	} else {
		0 ignored issues – show Duplication introduced 2021-01-08 10:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
228		// Check version, if version is higher then update module.json into database.
229		if (version_compare($module->getVersion(), $data['version'], '<')) {
		0 ignored issues – show Documentation Bug introduced 2021-01-28 04:40 UTC by Report Bug Copy Issue Report The method `getVersion` does not exist on `object<Nwidart\Modules\Module>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
230		$modules[] = $this->getModel()->where(['name' => $data['name']])->update($data);
231		}
232		}
233		}
234		}
235
236		return $modules;
237		}
238
239		public function update($name)
240		{
241		if ($this->config('database_management.update_file_to_database_when_updating')) {
242
243		/** @var DatabaseModule $module */
244		$module = $this->findOrFail($name);
245
246		$json = Json::make($module->getPath() . '/' . 'module.json');
247		$data = $json->getAttributes();
248
249		if (!isset($data['version'])) {
250		$data['version'] = '1.0.0';
251		}
252
253		// Check version, if version is higher then update module.json into database.
254	View Code Duplication	if (version_compare($module->getVersion(), $data['version'], '<=')) {
		0 ignored issues – show Duplication introduced 2021-01-08 10:12 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
255		$data = $this->validateAttributes($data);
256		$this->getModel()->where(['name' => $data['name']])->update($data);
257		}
258		}
259
260		parent::update($name);
261		}
262
263		/**
264		* Validate array attributes before insert/update into database.
265		*
266		* @param array $attributes
267		* @param array $allows
268		*
269		* @return array
270		*/
271		protected function validateAttributes(array $attributes, array $allows = [])
272		{
273		if (empty($allows)) {
274		$allows = $this->getModel()->getFillable();
275		}
276
277		return array_filter($attributes, function ($k) use ($allows) {
278		return in_array($k, $allows);
279		}, ARRAY_FILTER_USE_KEY);
280		}
281		}
282

nWidart / laravel-modules

Pull Request — master (#1163)

LaravelDatabaseRepository A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

15 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like