ModuleGenerator::setFilesystem() - Code Metrics - Inspection of "Fix coverage runs, use a used php version" - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 419c88...940d42 )

by Nicolas

created 2019-05-12 15:09 UTC

ModuleGenerator::setFilesystem() A

↳ Parent: ModuleGenerator

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?php

namespace Nwidart\Modules\Generators;

use Illuminate\Config\Repository as Config;
use Illuminate\Console\Command as Console;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Str;
use Nwidart\Modules\FileRepository;
use Nwidart\Modules\Support\Config\GenerateConfigReader;
use Nwidart\Modules\Support\Stub;

class ModuleGenerator extends Generator
{
    /**
     * The module name will created.
     *
     * @var string
     */
    protected $name;

    /**
     * The laravel config instance.
     *
     * @var Config
     */
    protected $config;

    /**
     * The laravel filesystem instance.
     *
     * @var Filesystem
     */
    protected $filesystem;

    /**
     * The laravel console instance.
     *
     * @var Console
     */
    protected $console;

    /**
     * The pingpong module instance.
     *
     * @var \Nwidart\Modules\Module
     */
    protected $module;

    /**
     * Force status.
     *
     * @var bool
     */
    protected $force = false;

    /**
     * Generate a plain module.
     *
     * @var bool
     */
    protected $plain = false;

    /**
     * The constructor.
     * @param $name
     * @param FileRepository $module
     * @param Config     $config
     * @param Filesystem $filesystem
     * @param Console    $console
     */
    public function __construct(
        $name,
        FileRepository $module = null,
        Config $config = null,
        Filesystem $filesystem = null,
        Console $console = null
    ) {
        $this->name = $name;
        $this->config = $config;
        $this->filesystem = $filesystem;
        $this->console = $console;
        $this->module = $module;
    }

    /**
     * Set plain flag.
     *
     * @param bool $plain
     *
     * @return $this
     */
    public function setPlain($plain)
    {
        $this->plain = $plain;

        return $this;
    }

    /**
     * Get the name of module will created. By default in studly case.
     *
     * @return string
     */
    public function getName()
    {
        return Str::studly($this->name);
    }

    /**
     * Get the laravel config instance.
     *
     * @return Config
     */
    public function getConfig()
    {
        return $this->config;
    }

    /**
     * Set the laravel config instance.
     *
     * @param Config $config
     *
     * @return $this
     */
    public function setConfig($config)
    {
        $this->config = $config;

        return $this;
    }

    /**
     * Get the laravel filesystem instance.
     *
     * @return Filesystem
     */
    public function getFilesystem()
    {
        return $this->filesystem;
    }

    /**
     * Set the laravel filesystem instance.
     *
     * @param Filesystem $filesystem
     *
     * @return $this
     */
    public function setFilesystem($filesystem)
    {
        $this->filesystem = $filesystem;

        return $this;
    }

    /**
     * Get the laravel console instance.
     *
     * @return Console
     */
    public function getConsole()
    {
        return $this->console;
    }

    /**
     * Set the laravel console instance.
     *
     * @param Console $console
     *
     * @return $this
     */
    public function setConsole($console)
    {
        $this->console = $console;

        return $this;
    }

    /**
     * Get the module instance.
     *
     * @return \Nwidart\Modules\Module
     */
    public function getModule()
    {
        return $this->module;
    }

    /**
     * Set the pingpong module instance.
     *
     * @param mixed $module
     *
     * @return $this
     */
    public function setModule($module)
    {
        $this->module = $module;

        return $this;
    }

    /**
     * Get the list of folders will created.
     *
     * @return array
     */
    public function getFolders()
    {
        return $this->module->config('paths.generator');
    }

    /**
     * Get the list of files will created.
     *
     * @return array
     */
    public function getFiles()
    {
        return $this->module->config('stubs.files');
    }

    /**
     * Set force status.
     *
     * @param bool|int $force
     *
     * @return $this
     */
    public function setForce($force)
    {
        $this->force = $force;
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}

        return $this;
    }

    /**
     * Generate the module.
     */
    public function generate()
    {
        $name = $this->getName();

        if ($this->module->has($name)) {
            if ($this->force) {
                $this->module->delete($name);
            } else {
                $this->console->error("Module [{$name}] already exist!");

                return;
            }
        }

        $this->generateFolders();

        $this->generateModuleJsonFile();

        if ($this->plain !== true) {
            $this->generateFiles();
            $this->generateResources();
        }

        if ($this->plain === true) {
            $this->cleanModuleJsonFile();
        }

        $this->console->info("Module [{$name}] created successfully.");
    }

    /**
     * Generate the folders.
     */
    public function generateFolders()
    {
        foreach ($this->getFolders() as $key => $folder) {
            $folder = GenerateConfigReader::read($key);

            if ($folder->generate() === false) {
                continue;
            }

            $path = $this->module->getModulePath($this->getName()) . '/' . $folder->getPath();

            $this->filesystem->makeDirectory($path, 0755, true);
            if (config('modules.stubs.gitkeep')) {
                $this->generateGitKeep($path);
            }
        }
    }

    /**
     * Generate git keep to the specified path.
     *
     * @param string $path
     */
    public function generateGitKeep($path)
    {
        $this->filesystem->put($path . '/.gitkeep', '');
    }

    /**
     * Generate the files.
     */
    public function generateFiles()
    {
        foreach ($this->getFiles() as $stub => $file) {
            $path = $this->module->getModulePath($this->getName()) . $file;

            if (!$this->filesystem->isDirectory($dir = dirname($path))) {

                $this->filesystem->makeDirectory($dir, 0775, true);
            }

            $this->filesystem->put($path, $this->getStubContents($stub));

            $this->console->info("Created : {$path}");
        }
    }

    /**
     * Generate some resources.
     */
    public function generateResources()
    {
        $this->console->call('module:make-seed', [
            'name' => $this->getName(),
            'module' => $this->getName(),
            '--master' => true,
        ]);

        $this->console->call('module:make-provider', [
            'name' => $this->getName() . 'ServiceProvider',
            'module' => $this->getName(),
            '--master' => true,
        ]);

        $this->console->call('module:route-provider', [
            'module' => $this->getName(),
        ]);

        $this->console->call('module:make-controller', [
            'controller' => $this->getName() . 'Controller',
            'module' => $this->getName(),
        ]);
    }

    /**
     * Get the contents of the specified stub file by given stub name.
     *
     * @param $stub
     *
     * @return string
     */
    protected function getStubContents($stub)
    {
        return (new Stub(
            '/' . $stub . '.stub',
            $this->getReplacement($stub)
        )
        )->render();
    }

    /**
     * get the list for the replacements.
     */
    public function getReplacements()
    {
        return $this->module->config('stubs.replacements');
    }

    /**
     * Get array replacement for the specified stub.
     *
     * @param $stub
     *
     * @return array
     */
    protected function getReplacement($stub)
    {
        $replacements = $this->module->config('stubs.replacements');

        if (!isset($replacements[$stub])) {
            return [];
        }

        $keys = $replacements[$stub];

        $replaces = [];

        foreach ($keys as $key) {
            if (method_exists($this, $method = 'get' . ucfirst(Str::studly(strtolower($key))) . 'Replacement')) {
                $replaces[$key] = $this->$method();
            } else {
                $replaces[$key] = null;
            }
        }

        return $replaces;
    }

    /**
     * Generate the module.json file
     */
    private function generateModuleJsonFile()
    {
        $path = $this->module->getModulePath($this->getName()) . 'module.json';

        if (!$this->filesystem->isDirectory($dir = dirname($path))) {

            $this->filesystem->makeDirectory($dir, 0775, true);
        }

        $this->filesystem->put($path, $this->getStubContents('json'));

        $this->console->info("Created : {$path}");
    }

    /**
     * Remove the default service provider that was added in the module.json file
     * This is needed when a --plain module was created
     */
    private function cleanModuleJsonFile()
    {
        $path = $this->module->getModulePath($this->getName()) . 'module.json';

        $content = $this->filesystem->get($path);
        $namespace = $this->getModuleNamespaceReplacement();
        $studlyName = $this->getStudlyNameReplacement();

        $provider = '"' . $namespace . '\\\\' . $studlyName . '\\\\Providers\\\\' . $studlyName . 'ServiceProvider"';

        $content = str_replace($provider, '', $content);

        $this->filesystem->put($path, $content);
    }

    /**
     * Get the module name in lower case.
     *
     * @return string
     */
    protected function getLowerNameReplacement()
    {
        return strtolower($this->getName());
    }

    /**
     * Get the module name in studly case.
     *
     * @return string
     */
    protected function getStudlyNameReplacement()
    {
        return $this->getName();
    }

    /**
     * Get replacement for $VENDOR$.
     *
     * @return string
     */
    protected function getVendorReplacement()
    {
        return $this->module->config('composer.vendor');
    }

    /**
     * Get replacement for $MODULE_NAMESPACE$.
     *
     * @return string
     */
    protected function getModuleNamespaceReplacement()
    {
        return str_replace('\\', '\\\\', $this->module->config('namespace'));
    }

    /**
     * Get replacement for $AUTHOR_NAME$.
     *
     * @return string
     */
    protected function getAuthorNameReplacement()
    {
        return $this->module->config('composer.author.name');
    }

    /**
     * Get replacement for $AUTHOR_EMAIL$.
     *
     * @return string
     */
    protected function getAuthorEmailReplacement()
    {
        return $this->module->config('composer.author.email');
    }
}


1			<?php
2
3			namespace Nwidart\Modules\Generators;
4
5			use Illuminate\Config\Repository as Config;
6			use Illuminate\Console\Command as Console;
7			use Illuminate\Filesystem\Filesystem;
8			use Illuminate\Support\Str;
9			use Nwidart\Modules\FileRepository;
10			use Nwidart\Modules\Support\Config\GenerateConfigReader;
11			use Nwidart\Modules\Support\Stub;
12
13			class ModuleGenerator extends Generator
14			{
15			/**
16			* The module name will created.
17			*
18			* @var string
19			*/
20			protected $name;
21
22			/**
23			* The laravel config instance.
24			*
25			* @var Config
26			*/
27			protected $config;
28
29			/**
30			* The laravel filesystem instance.
31			*
32			* @var Filesystem
33			*/
34			protected $filesystem;
35
36			/**
37			* The laravel console instance.
38			*
39			* @var Console
40			*/
41			protected $console;
42
43			/**
44			* The pingpong module instance.
45			*
46			* @var \Nwidart\Modules\Module
47			*/
48			protected $module;
49
50			/**
51			* Force status.
52			*
53			* @var bool
54			*/
55			protected $force = false;
56
57			/**
58			* Generate a plain module.
59			*
60			* @var bool
61			*/
62			protected $plain = false;
63
64			/**
65			* The constructor.
66			* @param $name
67			* @param FileRepository $module
68			* @param Config $config
69			* @param Filesystem $filesystem
70			* @param Console $console
71			*/
72	99		public function __construct(
73			$name,
74			FileRepository $module = null,
75			Config $config = null,
76			Filesystem $filesystem = null,
77			Console $console = null
78			) {
79	99		$this->name = $name;
80	99		$this->config = $config;
81	99		$this->filesystem = $filesystem;
82	99		$this->console = $console;
83	99		$this->module = $module;
84	99		}
85
86			/**
87			* Set plain flag.
88			*
89			* @param bool $plain
90			*
91			* @return $this
92			*/
93	99		public function setPlain($plain)
94			{
95	99		$this->plain = $plain;
96
97	99		return $this;
98			}
99
100			/**
101			* Get the name of module will created. By default in studly case.
102			*
103			* @return string
104			*/
105	99		public function getName()
106			{
107	99		return Str::studly($this->name);
108			}
109
110			/**
111			* Get the laravel config instance.
112			*
113			* @return Config
114			*/
115			public function getConfig()
116			{
117			return $this->config;
118			}
119
120			/**
121			* Set the laravel config instance.
122			*
123			* @param Config $config
124			*
125			* @return $this
126			*/
127	99		public function setConfig($config)
128			{
129	99		$this->config = $config;
130
131	99		return $this;
132			}
133
134			/**
135			* Get the laravel filesystem instance.
136			*
137			* @return Filesystem
138			*/
139			public function getFilesystem()
140			{
141			return $this->filesystem;
142			}
143
144			/**
145			* Set the laravel filesystem instance.
146			*
147			* @param Filesystem $filesystem
148			*
149			* @return $this
150			*/
151	99		public function setFilesystem($filesystem)
152			{
153	99		$this->filesystem = $filesystem;
154
155	99		return $this;
156			}
157
158			/**
159			* Get the laravel console instance.
160			*
161			* @return Console
162			*/
163			public function getConsole()
164			{
165			return $this->console;
166			}
167
168			/**
169			* Set the laravel console instance.
170			*
171			* @param Console $console
172			*
173			* @return $this
174			*/
175	99		public function setConsole($console)
176			{
177	99		$this->console = $console;
178
179	99		return $this;
180			}
181
182			/**
183			* Get the module instance.
184			*
185			* @return \Nwidart\Modules\Module
186			*/
187			public function getModule()
188			{
189			return $this->module;
190			}
191
192			/**
193			* Set the pingpong module instance.
194			*
195			* @param mixed $module
196			*
197			* @return $this
198			*/
199	99		public function setModule($module)
200			{
201	99		$this->module = $module;
202
203	99		return $this;
204			}
205
206			/**
207			* Get the list of folders will created.
208			*
209			* @return array
210			*/
211	99		public function getFolders()
212			{
213	99		return $this->module->config('paths.generator');
214			}
215
216			/**
217			* Get the list of files will created.
218			*
219			* @return array
220			*/
221	91		public function getFiles()
222			{
223	91		return $this->module->config('stubs.files');
224			}
225
226			/**
227			* Set force status.
228			*
229			* @param bool\|int $force
230			*
231			* @return $this
232			*/
233	99		public function setForce($force)
234			{
235	99		$this->force = $force;
			0 ignored issues – show Documentation Bug introduced 2016-06-28 11:31 UTC by Report Bug Copy Issue Report It seems like `$force` can also be of type `integer`. However, the property `$force` is declared as type `boolean`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
236
237	99		return $this;
238			}
239
240			/**
241			* Generate the module.
242			*/
243	99		public function generate()
244			{
245	99		$name = $this->getName();
246
247	99		if ($this->module->has($name)) {
248	2		if ($this->force) {
249	1		$this->module->delete($name);
250			} else {
251	1		$this->console->error("Module [{$name}] already exist!");
252
253	1		return;
254			}
255			}
256
257	99		$this->generateFolders();
258
259	99		$this->generateModuleJsonFile();
260
261	99		if ($this->plain !== true) {
262	91		$this->generateFiles();
263	91		$this->generateResources();
264			}
265
266	99		if ($this->plain === true) {
267	8		$this->cleanModuleJsonFile();
268			}
269
270	99		$this->console->info("Module [{$name}] created successfully.");
271	99		}
272
273			/**
274			* Generate the folders.
275			*/
276	99		public function generateFolders()
277			{
278	99		foreach ($this->getFolders() as $key => $folder) {
279	99		$folder = GenerateConfigReader::read($key);
280
281	99		if ($folder->generate() === false) {
282	3		continue;
283			}
284
285	99		$path = $this->module->getModulePath($this->getName()) . '/' . $folder->getPath();
286
287	99		$this->filesystem->makeDirectory($path, 0755, true);
288	99		if (config('modules.stubs.gitkeep')) {
289	99		$this->generateGitKeep($path);
290			}
291			}
292	99		}
293
294			/**
295			* Generate git keep to the specified path.
296			*
297			* @param string $path
298			*/
299	99		public function generateGitKeep($path)
300			{
301	99		$this->filesystem->put($path . '/.gitkeep', '');
302	99		}
303
304			/**
305			* Generate the files.
306			*/
307	91		public function generateFiles()
308			{
309	91		foreach ($this->getFiles() as $stub => $file) {
310	91		$path = $this->module->getModulePath($this->getName()) . $file;
311
312	91	View Code Duplication	if (!$this->filesystem->isDirectory($dir = dirname($path))) {
			0 ignored issues – show Duplication introduced 2017-05-21 16:39 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...
313	91		$this->filesystem->makeDirectory($dir, 0775, true);
314			}
315
316	91		$this->filesystem->put($path, $this->getStubContents($stub));
317
318	91		$this->console->info("Created : {$path}");
319			}
320	91		}
321
322			/**
323			* Generate some resources.
324			*/
325	91		public function generateResources()
326			{
327	91		$this->console->call('module:make-seed', [
328	91		'name' => $this->getName(),
329	91		'module' => $this->getName(),
330			'--master' => true,
331			]);
332
333	91		$this->console->call('module:make-provider', [
334	91		'name' => $this->getName() . 'ServiceProvider',
335	91		'module' => $this->getName(),
336			'--master' => true,
337			]);
338
339	91		$this->console->call('module:route-provider', [
340	91		'module' => $this->getName(),
341			]);
342
343	91		$this->console->call('module:make-controller', [
344	91		'controller' => $this->getName() . 'Controller',
345	91		'module' => $this->getName(),
346			]);
347	91		}
348
349			/**
350			* Get the contents of the specified stub file by given stub name.
351			*
352			* @param $stub
353			*
354			* @return string
355			*/
356	99		protected function getStubContents($stub)
357			{
358	99		return (new Stub(
359	99		'/' . $stub . '.stub',
360	99		$this->getReplacement($stub)
361			)
362	99		)->render();
363			}
364
365			/**
366			* get the list for the replacements.
367			*/
368			public function getReplacements()
369			{
370			return $this->module->config('stubs.replacements');
371			}
372
373			/**
374			* Get array replacement for the specified stub.
375			*
376			* @param $stub
377			*
378			* @return array
379			*/
380	99		protected function getReplacement($stub)
381			{
382	99		$replacements = $this->module->config('stubs.replacements');
383
384	99		if (!isset($replacements[$stub])) {
385	91		return [];
386			}
387
388	99		$keys = $replacements[$stub];
389
390	99		$replaces = [];
391
392	99		foreach ($keys as $key) {
393	99		if (method_exists($this, $method = 'get' . ucfirst(Str::studly(strtolower($key))) . 'Replacement')) {
394	99		$replaces[$key] = $this->$method();
395			} else {
396			$replaces[$key] = null;
397			}
398			}
399
400	99		return $replaces;
401			}
402
403			/**
404			* Generate the module.json file
405			*/
406	99		private function generateModuleJsonFile()
407			{
408	99		$path = $this->module->getModulePath($this->getName()) . 'module.json';
409
410	99	View Code Duplication	if (!$this->filesystem->isDirectory($dir = dirname($path))) {
			0 ignored issues – show Duplication introduced 2017-05-21 16:39 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...
411			$this->filesystem->makeDirectory($dir, 0775, true);
412			}
413
414	99		$this->filesystem->put($path, $this->getStubContents('json'));
415
416	99		$this->console->info("Created : {$path}");
417	99		}
418
419			/**
420			* Remove the default service provider that was added in the module.json file
421			* This is needed when a --plain module was created
422			*/
423	8		private function cleanModuleJsonFile()
424			{
425	8		$path = $this->module->getModulePath($this->getName()) . 'module.json';
426
427	8		$content = $this->filesystem->get($path);
428	8		$namespace = $this->getModuleNamespaceReplacement();
429	8		$studlyName = $this->getStudlyNameReplacement();
430
431	8		$provider = '"' . $namespace . '\\\\' . $studlyName . '\\\\Providers\\\\' . $studlyName . 'ServiceProvider"';
432
433	8		$content = str_replace($provider, '', $content);
434
435	8		$this->filesystem->put($path, $content);
436	8		}
437
438			/**
439			* Get the module name in lower case.
440			*
441			* @return string
442			*/
443	99		protected function getLowerNameReplacement()
444			{
445	99		return strtolower($this->getName());
446			}
447
448			/**
449			* Get the module name in studly case.
450			*
451			* @return string
452			*/
453	99		protected function getStudlyNameReplacement()
454			{
455	99		return $this->getName();
456			}
457
458			/**
459			* Get replacement for $VENDOR$.
460			*
461			* @return string
462			*/
463	91		protected function getVendorReplacement()
464			{
465	91		return $this->module->config('composer.vendor');
466			}
467
468			/**
469			* Get replacement for $MODULE_NAMESPACE$.
470			*
471			* @return string
472			*/
473	99		protected function getModuleNamespaceReplacement()
474			{
475	99		return str_replace('\\', '\\\\', $this->module->config('namespace'));
476			}
477
478			/**
479			* Get replacement for $AUTHOR_NAME$.
480			*
481			* @return string
482			*/
483	91		protected function getAuthorNameReplacement()
484			{
485	91		return $this->module->config('composer.author.name');
486			}
487
488			/**
489			* Get replacement for $AUTHOR_EMAIL$.
490			*
491			* @return string
492			*/
493	91		protected function getAuthorEmailReplacement()
494			{
495	91		return $this->module->config('composer.author.email');
496			}
497			}
498

nWidart / laravel-modules

Push — master ( 419c88...940d42 )

ModuleGenerator::setFilesystem() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like