ModuleGenerator::generateModuleJsonFile() - Code Metrics - Inspection of "Adding extra tip" - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d33c24...eca1e1 )

by Nicolas

created 2017-07-24 16:03 UTC

ModuleGenerator::generateModuleJsonFile() A

↳ Parent: ModuleGenerator

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	6

Duplication

Lines	3
Ratio	25 %

Code Coverage

Tests	6
CRAP Score	2.0625

Importance

Changes

Metric	Value
cc	2
eloc	6
nc	2
nop	0
dl	3
loc	12
ccs	6
cts	8
cp	0.75
crap	2.0625
rs	9.4285
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\Repository;
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 Module
     */
    protected $module;

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

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

    /**
     * The constructor.
     *
     * @param $name
     * @param Repository $module
     * @param Config     $config
     * @param Filesystem $filesystem
     * @param Console    $console
     */
    public function __construct(
        $name,
        Repository $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;
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;
}
    }

    /**
     * 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 pingpong module instance.
     *
     * @return 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 array_values($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 $folder) {
            $path = $this->module->getModulePath($this->getName()) . '/' . $folder;

            $this->filesystem->makeDirectory($path, 0755, true);

            $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: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(studly_case(strtolower($key))) . 'Replacement')) {
                $replaces[$key] = call_user_func([$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\Repository;
10			use Nwidart\Modules\Support\Stub;
11
12			class ModuleGenerator extends Generator
13			{
14			/**
15			* The module name will created.
16			*
17			* @var string
18			*/
19			protected $name;
20
21			/**
22			* The laravel config instance.
23			*
24			* @var Config
25			*/
26			protected $config;
27
28			/**
29			* The laravel filesystem instance.
30			*
31			* @var Filesystem
32			*/
33			protected $filesystem;
34
35			/**
36			* The laravel console instance.
37			*
38			* @var Console
39			*/
40			protected $console;
41
42			/**
43			* The pingpong module instance.
44			*
45			* @var Module
46			*/
47			protected $module;
48
49			/**
50			* Force status.
51			*
52			* @var bool
53			*/
54			protected $force = false;
55
56			/**
57			* Generate a plain module.
58			*
59			* @var bool
60			*/
61			protected $plain = false;
62
63			/**
64			* The constructor.
65			*
66			* @param $name
67			* @param Repository $module
68			* @param Config $config
69			* @param Filesystem $filesystem
70			* @param Console $console
71			*/
72	56		public function __construct(
73			$name,
74			Repository $module = null,
75			Config $config = null,
76			Filesystem $filesystem = null,
77			Console $console = null
78			) {
79	56		$this->name = $name;
80	56		$this->config = $config;
81	56		$this->filesystem = $filesystem;
82	56		$this->console = $console;
83	56		$this->module = $module;
			0 ignored issues – show Documentation Bug introduced 2016-06-28 11:31 UTC by Report Bug Copy Issue Report It seems like `$module` can also be of type `object<Nwidart\Modules\Repository>`. However, the property `$module` is declared as type `object<Nwidart\Modules\Generators\Module>`. 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...
84	56		}
85
86			/**
87			* Set plain flag.
88			*
89			* @param bool $plain
90			*
91			* @return $this
92			*/
93	56		public function setPlain($plain)
94			{
95	56		$this->plain = $plain;
96
97	56		return $this;
98			}
99
100			/**
101			* Get the name of module will created. By default in studly case.
102			*
103			* @return string
104			*/
105	56		public function getName()
106			{
107	56		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	56		public function setConfig($config)
128			{
129	56		$this->config = $config;
130
131	56		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	56		public function setFilesystem($filesystem)
152			{
153	56		$this->filesystem = $filesystem;
154
155	56		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	56		public function setConsole($console)
176			{
177	56		$this->console = $console;
178
179	56		return $this;
180			}
181
182			/**
183			* Get the pingpong module instance.
184			*
185			* @return 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	56		public function setModule($module)
200			{
201	56		$this->module = $module;
202
203	56		return $this;
204			}
205
206			/**
207			* Get the list of folders will created.
208			*
209			* @return array
210			*/
211	56		public function getFolders()
212			{
213	56		return array_values($this->module->config('paths.generator'));
214			}
215
216			/**
217			* Get the list of files will created.
218			*
219			* @return array
220			*/
221	50		public function getFiles()
222			{
223	50		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	56		public function setForce($force)
234			{
235	56		$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	56		return $this;
238			}
239
240			/**
241			* Generate the module.
242			*/
243	56		public function generate()
244			{
245	56		$name = $this->getName();
246
247	56		if ($this->module->has($name)) {
248	2		if ($this->force) {
249	1		$this->module->delete($name);
250	1		} else {
251	1		$this->console->error("Module [{$name}] already exist!");
252
253	1		return;
254			}
255	1		}
256
257	56		$this->generateFolders();
258
259	56		$this->generateModuleJsonFile();
260
261	56		if ($this->plain !== true) {
262	50		$this->generateFiles();
263	50		$this->generateResources();
264	50		}
265
266	56		if ($this->plain === true) {
267	6		$this->cleanModuleJsonFile();
268	6		}
269
270	56		$this->console->info("Module [{$name}] created successfully.");
271	56		}
272
273			/**
274			* Generate the folders.
275			*/
276	56		public function generateFolders()
277			{
278	56		foreach ($this->getFolders() as $folder) {
279	56		$path = $this->module->getModulePath($this->getName()) . '/' . $folder;
280
281	56		$this->filesystem->makeDirectory($path, 0755, true);
282
283	56		$this->generateGitKeep($path);
284	56		}
285	56		}
286
287			/**
288			* Generate git keep to the specified path.
289			*
290			* @param string $path
291			*/
292	56		public function generateGitKeep($path)
293			{
294	56		$this->filesystem->put($path . '/.gitkeep', '');
295	56		}
296
297			/**
298			* Generate the files.
299			*/
300	50		public function generateFiles()
301			{
302	50		foreach ($this->getFiles() as $stub => $file) {
303	50		$path = $this->module->getModulePath($this->getName()) . $file;
304
305	50	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...
306	50		$this->filesystem->makeDirectory($dir, 0775, true);
307	50		}
308
309	50		$this->filesystem->put($path, $this->getStubContents($stub));
310
311	50		$this->console->info("Created : {$path}");
312	50		}
313	50		}
314
315			/**
316			* Generate some resources.
317			*/
318	50		public function generateResources()
319			{
320	50		$this->console->call('module:make-seed', [
321	50		'name' => $this->getName(),
322	50		'module' => $this->getName(),
323	50		'--master' => true,
324	50		]);
325
326	50		$this->console->call('module:make-provider', [
327	50		'name' => $this->getName() . 'ServiceProvider',
328	50		'module' => $this->getName(),
329	50		'--master' => true,
330	50		]);
331
332	50		$this->console->call('module:make-controller', [
333	50		'controller' => $this->getName() . 'Controller',
334	50		'module' => $this->getName(),
335	50		]);
336	50		}
337
338			/**
339			* Get the contents of the specified stub file by given stub name.
340			*
341			* @param $stub
342			*
343			* @return string
344			*/
345	56		protected function getStubContents($stub)
346			{
347	56		return (new Stub(
348	56		'/' . $stub . '.stub',
349	56		$this->getReplacement($stub))
350	56		)->render();
351			}
352
353			/**
354			* get the list for the replacements.
355			*/
356			public function getReplacements()
357			{
358			return $this->module->config('stubs.replacements');
359			}
360
361			/**
362			* Get array replacement for the specified stub.
363			*
364			* @param $stub
365			*
366			* @return array
367			*/
368	56		protected function getReplacement($stub)
369			{
370	56		$replacements = $this->module->config('stubs.replacements');
371
372	56		if (!isset($replacements[$stub])) {
373			return [];
374			}
375
376	56		$keys = $replacements[$stub];
377
378	56		$replaces = [];
379
380	56		foreach ($keys as $key) {
381	56		if (method_exists($this, $method = 'get' . ucfirst(studly_case(strtolower($key))) . 'Replacement')) {
382	56		$replaces[$key] = call_user_func([$this, $method]);
383	56		} else {
384			$replaces[$key] = null;
385			}
386	56		}
387
388	56		return $replaces;
389			}
390
391			/**
392			* Generate the module.json file
393			*/
394	56		private function generateModuleJsonFile()
395			{
396	56		$path = $this->module->getModulePath($this->getName()) . 'module.json';
397
398	56	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...
399			$this->filesystem->makeDirectory($dir, 0775, true);
400			}
401
402	56		$this->filesystem->put($path, $this->getStubContents('json'));
403
404	56		$this->console->info("Created : {$path}");
405	56		}
406
407			/**
408			* Remove the default service provider that was added in the module.json file
409			* This is needed when a --plain module was created
410			*/
411	6		private function cleanModuleJsonFile()
412			{
413	6		$path = $this->module->getModulePath($this->getName()) . 'module.json';
414
415	6		$content = $this->filesystem->get($path);
416	6		$namespace = $this->getModuleNamespaceReplacement();
417	6		$studlyName = $this->getStudlyNameReplacement();
418
419	6		$provider = '"' . $namespace . '\\\\' . $studlyName . '\\\\Providers\\\\' . $studlyName . 'ServiceProvider"';
420
421	6		$content = str_replace($provider, '', $content);
422
423	6		$this->filesystem->put($path, $content);
424	6		}
425
426			/**
427			* Get the module name in lower case.
428			*
429			* @return string
430			*/
431	56		protected function getLowerNameReplacement()
432			{
433	56		return strtolower($this->getName());
434			}
435
436			/**
437			* Get the module name in studly case.
438			*
439			* @return string
440			*/
441	56		protected function getStudlyNameReplacement()
442			{
443	56		return $this->getName();
444			}
445
446			/**
447			* Get replacement for $VENDOR$.
448			*
449			* @return string
450			*/
451	50		protected function getVendorReplacement()
452			{
453	50		return $this->module->config('composer.vendor');
454			}
455
456			/**
457			* Get replacement for $MODULE_NAMESPACE$.
458			*
459			* @return string
460			*/
461	56		protected function getModuleNamespaceReplacement()
462			{
463	56		return str_replace('\\', '\\\\', $this->module->config('namespace'));
464			}
465
466			/**
467			* Get replacement for $AUTHOR_NAME$.
468			*
469			* @return string
470			*/
471	50		protected function getAuthorNameReplacement()
472			{
473	50		return $this->module->config('composer.author.name');
474			}
475
476			/**
477			* Get replacement for $AUTHOR_EMAIL$.
478			*
479			* @return string
480			*/
481	50		protected function getAuthorEmailReplacement()
482			{
483	50		return $this->module->config('composer.author.email');
484			}
485			}
486

nWidart / laravel-modules

Push — master ( d33c24...eca1e1 )

ModuleGenerator::generateModuleJsonFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like