ModuleGenerator::getReplacement() - Code Metrics - Inspection of "Fixing docblocks. Minor code changes." - nWidart/laravel-modules - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8844c6...a7acd5 )

by Nicolas

created 2016-06-29 17:57 UTC

ModuleGenerator::getReplacement() B

↳ Parent: ModuleGenerator

Complexity

Conditions	4
Paths	4

Size

Total Lines	22
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	4.0119

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	22
ccs	10
cts	11
cp	0.9091
rs	8.9197
cc	4
eloc	12
nc	4
nop	1
crap	4.0119

<?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 Pingpong\Support\Stub;
use Nwidart\Modules\Repository;

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->generateFiles();

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

        $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 Stub
     */
    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;
    }

    /**
     * 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 Pingpong\Support\Stub;
10		use Nwidart\Modules\Repository;
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	21	public function __construct(
73		$name,
74		Repository $module = null,
75		Config $config = null,
76		Filesystem $filesystem = null,
77		Console $console = null
78		) {
79	21	$this->name = $name;
80	21	$this->config = $config;
81	21	$this->filesystem = $filesystem;
82	21	$this->console = $console;
83	21	$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	21	}
85
86		/**
87		* Set plain flag.
88		*
89		* @param bool $plain
90		*
91		* @return $this
92		*/
93	21	public function setPlain($plain)
94		{
95	21	$this->plain = $plain;
96
97	21	return $this;
98		}
99
100		/**
101		* Get the name of module will created. By default in studly case.
102		*
103		* @return string
104		*/
105	21	public function getName()
106		{
107	21	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	21	public function setConfig($config)
128		{
129	21	$this->config = $config;
130
131	21	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	21	public function setFilesystem($filesystem)
152		{
153	21	$this->filesystem = $filesystem;
154
155	21	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	21	public function setConsole($console)
176		{
177	21	$this->console = $console;
178
179	21	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	21	public function setModule($module)
200		{
201	21	$this->module = $module;
202
203	21	return $this;
204		}
205
206		/**
207		* Get the list of folders will created.
208		*
209		* @return array
210		*/
211	21	public function getFolders()
212		{
213	21	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	21	public function getFiles()
222		{
223	21	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	21	public function setForce($force)
234		{
235	21	$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	21	return $this;
238		}
239
240		/**
241		* Generate the module.
242		*/
243	21	public function generate()
244		{
245	21	$name = $this->getName();
246
247	21	if ($this->module->has($name)) {
248		if ($this->force) {
249		$this->module->delete($name);
250		} else {
251		$this->console->error("Module [{$name}] already exist!");
252
253		return;
254		}
255		}
256
257	21	$this->generateFolders();
258
259	21	$this->generateFiles();
260
261	21	if (!$this->plain) {
262	21	$this->generateResources();
263		}
264
265	21	$this->console->info("Module [{$name}] created successfully.");
266	21	}
267
268		/**
269		* Generate the folders.
270		*/
271	21	public function generateFolders()
272		{
273	21	foreach ($this->getFolders() as $folder) {
274	21	$path = $this->module->getModulePath($this->getName()).'/'.$folder;
275
276	21	$this->filesystem->makeDirectory($path, 0755, true);
277
278	21	$this->generateGitKeep($path);
279		}
280	21	}
281
282		/**
283		* Generate git keep to the specified path.
284		*
285		* @param string $path
286		*/
287	21	public function generateGitKeep($path)
288		{
289	21	$this->filesystem->put($path.'/.gitkeep', '');
290	21	}
291
292		/**
293		* Generate the files.
294		*/
295	21	public function generateFiles()
296		{
297	21	foreach ($this->getFiles() as $stub => $file) {
298	21	$path = $this->module->getModulePath($this->getName()).$file;
299
300	21	if (!$this->filesystem->isDirectory($dir = dirname($path))) {
301	21	$this->filesystem->makeDirectory($dir, 0775, true);
302		}
303
304	21	$this->filesystem->put($path, $this->getStubContents($stub));
305
306	21	$this->console->info("Created : {$path}");
307		}
308	21	}
309
310		/**
311		* Generate some resources.
312		*/
313	21	public function generateResources()
314		{
315	21	$this->console->call('module:make-seed', [
316	21	'name' => $this->getName(),
317	21	'module' => $this->getName(),
318		'--master' => true,
319		]);
320
321	21	$this->console->call('module:make-provider', [
322	21	'name' => $this->getName().'ServiceProvider',
323	21	'module' => $this->getName(),
324		'--master' => true,
325		]);
326
327	21	$this->console->call('module:make-controller', [
328	21	'controller' => $this->getName().'Controller',
329	21	'module' => $this->getName(),
330		]);
331	21	}
332
333		/**
334		* Get the contents of the specified stub file by given stub name.
335		*
336		* @param $stub
337		*
338		* @return Stub
339		*/
340	21	protected function getStubContents($stub)
341		{
342	21	return (new Stub(
343	21	'/'.$stub.'.stub',
344	21	$this->getReplacement($stub))
345	21	)->render();
346		}
347
348		/**
349		* get the list for the replacements.
350		*/
351		public function getReplacements()
352		{
353		return $this->module->config('stubs.replacements');
354		}
355
356		/**
357		* Get array replacement for the specified stub.
358		*
359		* @param $stub
360		*
361		* @return array
362		*/
363	21	protected function getReplacement($stub)
364		{
365	21	$replacements = $this->module->config('stubs.replacements');
366
367	21	if (!isset($replacements[$stub])) {
368		return [];
369		}
370
371	21	$keys = $replacements[$stub];
372
373	21	$replaces = [];
374
375	21	foreach ($keys as $key) {
376	21	if (method_exists($this, $method = 'get'.ucfirst(studly_case(strtolower($key))).'Replacement')) {
377	21	$replaces[$key] = call_user_func([$this, $method]);
378		} else {
379	21	$replaces[$key] = null;
380		}
381		}
382
383	21	return $replaces;
384		}
385
386		/**
387		* Get the module name in lower case.
388		*
389		* @return string
390		*/
391	21	protected function getLowerNameReplacement()
392		{
393	21	return strtolower($this->getName());
394		}
395
396		/**
397		* Get the module name in studly case.
398		*
399		* @return string
400		*/
401	21	protected function getStudlyNameReplacement()
402		{
403	21	return $this->getName();
404		}
405
406		/**
407		* Get replacement for $VENDOR$.
408		*
409		* @return string
410		*/
411	21	protected function getVendorReplacement()
412		{
413	21	return $this->module->config('composer.vendor');
414		}
415
416		/**
417		* Get replacement for $MODULE_NAMESPACE$.
418		*
419		* @return string
420		*/
421	21	protected function getModuleNamespaceReplacement()
422		{
423	21	return str_replace('\\', '\\\\', $this->module->config('namespace'));
424		}
425
426		/**
427		* Get replacement for $AUTHOR_NAME$.
428		*
429		* @return string
430		*/
431	21	protected function getAuthorNameReplacement()
432		{
433	21	return $this->module->config('composer.author.name');
434		}
435
436		/**
437		* Get replacement for $AUTHOR_EMAIL$.
438		*
439		* @return string
440		*/
441	21	protected function getAuthorEmailReplacement()
442		{
443	21	return $this->module->config('composer.author.email');
444		}
445		}
446

nWidart / laravel-modules

Push — master ( 8844c6...a7acd5 )

ModuleGenerator::getReplacement() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like