ModuleController::humanizeName() - Code Metrics - Inspection of "add php 8.0 tests" - luyadev/luya - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b4d6a5...352f6d )

by Basil

created 2020-08-18 07:01 UTC

ModuleController::humanizeName() A

↳ Parent: ModuleController

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace luya\console\commands;

use Yii;
use yii\helpers\Console;
use luya\helpers\FileHelper;
use yii\helpers\Inflector;

/**
 * Command to create a new LUYA Module.
 *
 * @author Basil Suter <[email protected]>
 * @since 1.0.0
 */
class ModuleController extends \luya\console\Command
{
    /**
     * @inheritdoc
     */
    public $defaultAction = 'create';
    
    /**
     * Humanize the class name
     *
     * @return string The humanized name.
     */
    public function humanizeName($name)
    {
        return $name = Inflector::humanize(Inflector::camel2words($name));
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    }
    
    /**
     * Render the readme template.
     *
     * @param array $folders
     * @param string $name
     * @param string $ns
     * @return string
     */
    public function renderReadme($folders, $name, $ns)

    {
        return $this->view->render('@luya/console/commands/views/module/readme.php', [
            'folders' => $folders,
            'name' => $name,
            'humanName' => $this->humanizeName($name),
            'ns' => $ns,
            'luyaText' => $this->getGeneratorText('module/create'),
        ]);
    }
    
    /**
     * Render the admin template.
     *
     * @param array $folders
     * @param string $name
     * @param string $ns
     * @return string
     */
    public function renderAdmin($folders, $name, $ns)

    {
        return $this->view->render('@luya/console/commands/views/module/adminmodule.php', [
            'folders' => $folders,
            'name' => $this->humanizeName($name),
            'ns' => $ns,
            'luyaText' => $this->getGeneratorText('module/create'),
        ]);
    }
    
    /**
     * Render the frontend template.
     *
     * @param array $folders
     * @param string $name
     * @param string $ns
     * @return string
     */
    public function renderFrontend($folders, $name, $ns)

    {
        return $this->view->render('@luya/console/commands/views/module/frontendmodule.php', [
            'folders' => $folders,
            'name' => $this->humanizeName($name),
            'ns' => $ns,
            'luyaText' => $this->getGeneratorText('module/create'),
        ]);
    }
    
    /**
     * Create a new frontend/admin module.
     *
     * @return number
     */
    public function actionCreate()
    {
        Console::clearScreenBeforeCursor();
        
        $moduleName = $this->prompt("Enter the name of the module you like to generate:");

        $newName = preg_replace("/[^a-z]/", "", strtolower($moduleName));
        
        if ($newName !== $moduleName) {
            if (!$this->confirm("We have changed the name to '{$newName}'. Do you want to proceed with this name?")) {
$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
                return $this->outputError('Abort by user.');
            } else {
                $moduleName = $newName;
            }
        }
        
        $appModulesFolder = Yii::$app->basePath . DIRECTORY_SEPARATOR . 'modules';
        $moduleFolder = $appModulesFolder . DIRECTORY_SEPARATOR . $moduleName;
        
        if (file_exists($moduleFolder)) {
            return $this->outputError("The folder " . $moduleFolder . " exists already.");
        }
        
        $folders = [
            'basePath' => $moduleFolder,
            'adminPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'admin',
            'adminAwsPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'admin' . DIRECTORY_SEPARATOR . 'aws',
            'adminMigrationPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'admin' . DIRECTORY_SEPARATOR . 'migrations',
            'frontendPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'frontend',
            'frontendBlocksPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'frontend' . DIRECTORY_SEPARATOR . 'blocks',
            'frontendControllersPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'frontend' . DIRECTORY_SEPARATOR . 'controllers',
            'frontendViewsPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'frontend' . DIRECTORY_SEPARATOR . 'views',
            'modelsPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'models',
        ];

        $ns = 'app\\modules\\'.$moduleName;
        
        foreach ($folders as $folder) {
            FileHelper::createDirectory($folder);
        }
        
        $contents = [
            $moduleFolder. DIRECTORY_SEPARATOR . 'README.md' => $this->renderReadme($folders, $moduleName, $ns),
            $moduleFolder. DIRECTORY_SEPARATOR . 'admin/Module.php' => $this->renderAdmin($folders, $moduleName, $ns),
            $moduleFolder. DIRECTORY_SEPARATOR . 'frontend/Module.php' => $this->renderFrontend($folders, $moduleName, $ns),
        ];
        
        foreach ($contents as $fileName => $content) {
            FileHelper::writeFile($fileName, $content);
        }
        
        return $this->outputSuccess("Module files has been created successfully. Check the README file to understand how to add the module to your config.");
    }
}


1		<?php
2
3		namespace luya\console\commands;
4
5		use Yii;
6		use yii\helpers\Console;
7		use luya\helpers\FileHelper;
8		use yii\helpers\Inflector;
9
10		/**
11		* Command to create a new LUYA Module.
12		*
13		* @author Basil Suter <[email protected]>
14		* @since 1.0.0
15		*/
16		class ModuleController extends \luya\console\Command
17		{
18		/**
19		* @inheritdoc
20		*/
21		public $defaultAction = 'create';
22
23		/**
24		* Humanize the class name
25		*
26		* @return string The humanized name.
27		*/
28		public function humanizeName($name)
29		{
30		return $name = Inflector::humanize(Inflector::camel2words($name));
		0 ignored issues – show Unused Code introduced 2016-11-11 12:23 UTC by Report Bug Copy Issue Report `$name` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
31		}
32
33		/**
34		* Render the readme template.
35		*
36		* @param array $folders
37		* @param string $name
38		* @param string $ns
39		* @return string
40		*/
41	View Code Duplication	public function renderReadme($folders, $name, $ns)
		0 ignored issues – show Duplication introduced 2017-07-31 09:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
42		{
43		return $this->view->render('@luya/console/commands/views/module/readme.php', [
44		'folders' => $folders,
45		'name' => $name,
46		'humanName' => $this->humanizeName($name),
47		'ns' => $ns,
48		'luyaText' => $this->getGeneratorText('module/create'),
49		]);
50		}
51
52		/**
53		* Render the admin template.
54		*
55		* @param array $folders
56		* @param string $name
57		* @param string $ns
58		* @return string
59		*/
60	View Code Duplication	public function renderAdmin($folders, $name, $ns)
		0 ignored issues – show Duplication introduced 2017-07-31 09:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
61		{
62		return $this->view->render('@luya/console/commands/views/module/adminmodule.php', [
63		'folders' => $folders,
64		'name' => $this->humanizeName($name),
65		'ns' => $ns,
66		'luyaText' => $this->getGeneratorText('module/create'),
67		]);
68		}
69
70		/**
71		* Render the frontend template.
72		*
73		* @param array $folders
74		* @param string $name
75		* @param string $ns
76		* @return string
77		*/
78	View Code Duplication	public function renderFrontend($folders, $name, $ns)
		0 ignored issues – show Duplication introduced 2017-07-31 09:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
79		{
80		return $this->view->render('@luya/console/commands/views/module/frontendmodule.php', [
81		'folders' => $folders,
82		'name' => $this->humanizeName($name),
83		'ns' => $ns,
84		'luyaText' => $this->getGeneratorText('module/create'),
85		]);
86		}
87
88		/**
89		* Create a new frontend/admin module.
90		*
91		* @return number
92		*/
93		public function actionCreate()
94		{
95		Console::clearScreenBeforeCursor();
96
97		$moduleName = $this->prompt("Enter the name of the module you like to generate:");
98
99		$newName = preg_replace("/[^a-z]/", "", strtolower($moduleName));
100
101		if ($newName !== $moduleName) {
102		if (!$this->confirm("We have changed the name to '{$newName}'. Do you want to proceed with this name?")) {
		0 ignored issues – show Bug Best Practice introduced 2016-09-01 13:35 UTC by Report Bug Copy Issue Report The expression `$this->confirm("We have ...oceed with this name?")` of type `boolean\|null` is loosely compared to `false`; this is ambiguous if the boolean can be false. You might want to explicitly use `!== null` instead. If an expression can have both `false`, and `null` as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values. $a = canBeFalseAndNull(); // Instead of if ( ! $a) { } // Better use one of the explicit versions: if ($a !== null) { } if ($a !== false) { } if ($a !== null && $a !== false) { } Loading history...
103		return $this->outputError('Abort by user.');
104		} else {
105		$moduleName = $newName;
106		}
107		}
108
109		$appModulesFolder = Yii::$app->basePath . DIRECTORY_SEPARATOR . 'modules';
110		$moduleFolder = $appModulesFolder . DIRECTORY_SEPARATOR . $moduleName;
111
112		if (file_exists($moduleFolder)) {
113		return $this->outputError("The folder " . $moduleFolder . " exists already.");
114		}
115
116		$folders = [
117		'basePath' => $moduleFolder,
118		'adminPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'admin',
119		'adminAwsPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'admin' . DIRECTORY_SEPARATOR . 'aws',
120		'adminMigrationPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'admin' . DIRECTORY_SEPARATOR . 'migrations',
121		'frontendPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'frontend',
122		'frontendBlocksPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'frontend' . DIRECTORY_SEPARATOR . 'blocks',
123		'frontendControllersPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'frontend' . DIRECTORY_SEPARATOR . 'controllers',
124		'frontendViewsPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'frontend' . DIRECTORY_SEPARATOR . 'views',
125		'modelsPath' => $moduleFolder . DIRECTORY_SEPARATOR . 'models',
126		];
127
128		$ns = 'app\\modules\\'.$moduleName;
129
130		foreach ($folders as $folder) {
131		FileHelper::createDirectory($folder);
132		}
133
134		$contents = [
135		$moduleFolder. DIRECTORY_SEPARATOR . 'README.md' => $this->renderReadme($folders, $moduleName, $ns),
136		$moduleFolder. DIRECTORY_SEPARATOR . 'admin/Module.php' => $this->renderAdmin($folders, $moduleName, $ns),
137		$moduleFolder. DIRECTORY_SEPARATOR . 'frontend/Module.php' => $this->renderFrontend($folders, $moduleName, $ns),
138		];
139
140		foreach ($contents as $fileName => $content) {
141		FileHelper::writeFile($fileName, $content);
142		}
143
144		return $this->outputSuccess("Module files has been created successfully. Check the README file to understand how to add the module to your config.");
145		}
146		}
147

luyadev / luya

Push — master ( b4d6a5...352f6d )

ModuleController::humanizeName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like