ModelCommand::generate() - Code Metrics - Inspection of "Updated REST template for new version" - bluzphp/bluzman - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#30)

by Anton

created 2017-09-26 10:26 UTC

ModelCommand::generate() A

↳ Parent: ModelCommand

Complexity

Conditions	3
Paths	4

Size

Total Lines	57
Code Lines	27

Duplication

Lines	30
Ratio	52.63 %

Code Coverage

Tests	24
CRAP Score	3.004

Importance

Changes

Metric	Value
dl	30
loc	57
ccs	24
cts	26
cp	0.9231
rs	9.6818
c	0
b	0
f	0
cc	3
eloc	27
nc	4
nop	2
crap	3.004

How to fix Long Method

<?php
/**
 * @copyright Bluz PHP Team
 * @link https://github.com/bluzphp/bluzman
 */

namespace Bluzman\Command\Generate;

use Bluz\Proxy\Db;
use Bluz\Validator\Validator as v;
use Bluzman\Input\InputArgument;
use Bluzman\Input\InputException;
use Bluzman\Generator;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;

/**
 * ModelCommand
 *
 * @package  Bluzman\Command\Generate
 */
class ModelCommand extends AbstractGenerateCommand
{
    /**
     * Command configuration
     */
    protected function configure()
    {
        $this
            // the name of the command (the part after "bin/bluzman")
            ->setName('generate:model')
            // the short description shown while running "php bin/bluzman list"
            ->setDescription('Generate a new model')
            // the full command description shown when running the command with
            // the "--help" option
            ->setHelp('This command allows you to generate models files')
        ;

        $this->addModelArgument();

        $table = new InputArgument('table', InputArgument::REQUIRED, 'Table name is required');
        $table->setValidator(
            v::create()->string()->alphaNumeric('_')->noWhitespace()
        );

        $this->getDefinition()->addArgument($table);
    }

    /**
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return void
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        try {
            $this->write("Running <info>generate:model</info> command");

            $model = $input->getArgument('model');
            $this->getDefinition()->getArgument('model')->validate($model);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

            $table = $input->getArgument('table');
            $this->getDefinition()->getArgument('table')->validate($table);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

            // generate directories and files
            $this->generate($input, $output);

            // verify it
            $this->verify($input, $output);

            $this->write("Model <info>{$model}</info> has been successfully created.");
        } catch (InputException $e) {
            $this->error("ERROR: {$e->getMessage()}");
        }
    }

    /**
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return void
     * @throws InputException
     */
    protected function generate(InputInterface $input, OutputInterface $output)

    {
        $modelName = ucfirst($input->getArgument('model'));
        $tableName = $input->getArgument('table');

        /*

        if ($this->getApplication()->isModelExists($modelName)) {
            $helper = $this->getHelperSet()->get("question");
            $question = new ConfirmationQuestion(
                "\n<question>Model $modelName would be overwritten. y/N?</question>:\n> ",
                false
            );

            if (!$helper->ask($input, $output, $question)) {
                return;
            }
        }
        */

        // generate table
        $tableFile = $this->getApplication()->getModelPath($modelName) . DS . 'Table.php';

        if (file_exists($tableFile)) {

            $this->comment("Table file <info>$modelName/Table.php</info> already exists");
        } else {
            $template = $this->getTemplate('TableTemplate');
            $template->setFilePath($tableFile);
            $template->setTemplateData([
                'model' => $modelName,
                'table' => $tableName,
                'primaryKey' => $this->getPrimaryKey($tableName)
            ]);

            $generator = new Generator\Generator($template);
            $generator->make();
        }

        // generate row
        $rowFile = $this->getApplication()->getModelPath($modelName) . DS . 'Row.php';

        if (file_exists($rowFile)) {

            $this->comment("Row file <info>$modelName/Row.php</info> already exists");
        } else {
            $template = $this->getTemplate('RowTemplate');
            $template->setFilePath($rowFile);
            $template->setTemplateData(
                [
                    'model' => $modelName,
                    'table' => $tableName,
                    'columns' => $this->getColumns($tableName)
                ]
            );

            $generator = new Generator\Generator($template);
            $generator->make();
        }
    }

    /**
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return void
     * @throws \Bluzman\Generator\GeneratorException
     */
    public function verify(InputInterface $input, OutputInterface $output)

    {
        $modelPath = $this->getApplication()->getModelPath($input->getArgument('model'));

        $paths = [
            $modelPath . DS . 'Table.php',
            $modelPath . DS . 'Row.php'
        ];

        foreach ($paths as $path) {
            if (!$this->getFs()->exists($path)) {
                throw new Generator\GeneratorException("File `$path` is not exists");
            }
        }
    }

    /**
     * @todo move it to DB class
     * @return array
     */
    protected function getPrimaryKey($table)
    {
        $connect = Db::getOption('connect');

        return Db::fetchColumn(
            '
            SELECT COLUMN_NAME
            FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE
            WHERE TABLE_SCHEMA = ?
              AND TABLE_NAME = ?
             AND CONSTRAINT_NAME = ?
            ',
            [$connect['name'], $table, 'PRIMARY']
        );
    }

    /**
     * @todo move it to DB class
     * @return array
     */
    protected function getColumns($table)
    {
        $connect = Db::getOption('connect');

        return Db::fetchAll(
            '
            SELECT 
              COLUMN_NAME as name,
              COLUMN_TYPE as type
            FROM INFORMATION_SCHEMA.COLUMNS
            WHERE TABLE_SCHEMA = ?
              AND TABLE_NAME = ?
            ',
            [$connect['name'], $table]
        );
    }
}


Pull Request — master (#30)

ModelCommand::generate() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

1			<?php
2			/**
3			* @copyright Bluz PHP Team
4			* @link https://github.com/bluzphp/bluzman
5			*/
6
7			namespace Bluzman\Command\Generate;
8
9			use Bluz\Proxy\Db;
10			use Bluz\Validator\Validator as v;
11			use Bluzman\Input\InputArgument;
12			use Bluzman\Input\InputException;
13			use Bluzman\Generator;
14			use Symfony\Component\Console\Input\InputInterface;
15			use Symfony\Component\Console\Output\OutputInterface;
16			use Symfony\Component\Console\Question\ConfirmationQuestion;
17
18			/**
19			* ModelCommand
20			*
21			* @package Bluzman\Command\Generate
22			*/
23			class ModelCommand extends AbstractGenerateCommand
24			{
25			/**
26			* Command configuration
27			*/
28	14		protected function configure()
29			{
30			$this
31			// the name of the command (the part after "bin/bluzman")
32	14		->setName('generate:model')
33			// the short description shown while running "php bin/bluzman list"
34	14		->setDescription('Generate a new model')
35			// the full command description shown when running the command with
36			// the "--help" option
37	14		->setHelp('This command allows you to generate models files')
38			;
39
40	14		$this->addModelArgument();
41
42	14		$table = new InputArgument('table', InputArgument::REQUIRED, 'Table name is required');
43	14		$table->setValidator(
44	14		v::create()->string()->alphaNumeric('_')->noWhitespace()
45			);
46
47	14		$this->getDefinition()->addArgument($table);
48	14		}
49
50			/**
51			* @param InputInterface $input
52			* @param OutputInterface $output
53			* @return void
54			*/
55	2		protected function execute(InputInterface $input, OutputInterface $output)
56			{
57			try {
58	2		$this->write("Running <info>generate:model</info> command");
59
60	2		$model = $input->getArgument('model');
61	2		$this->getDefinition()->getArgument('model')->validate($model);
			0 ignored issues – show Bug introduced 2017-04-04 11:29 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Console\Input\InputArgument` as the method `validate()` does only exist in the following sub-classes of `Symfony\Component\Console\Input\InputArgument`: `Bluzman\Input\InputArgument`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
62
63	1		$table = $input->getArgument('table');
64	1		$this->getDefinition()->getArgument('table')->validate($table);
			0 ignored issues – show Bug introduced 2017-04-04 11:29 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Console\Input\InputArgument` as the method `validate()` does only exist in the following sub-classes of `Symfony\Component\Console\Input\InputArgument`: `Bluzman\Input\InputArgument`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
65
66			// generate directories and files
67	1		$this->generate($input, $output);
68
69			// verify it
70	1		$this->verify($input, $output);
71
72	1		$this->write("Model <info>{$model}</info> has been successfully created.");
73	1		} catch (InputException $e) {
74	1		$this->error("ERROR: {$e->getMessage()}");
75			}
76	2		}
77
78			/**
79			* @param InputInterface $input
80			* @param OutputInterface $output
81			* @return void
82			* @throws InputException
83			*/
84	1		protected function generate(InputInterface $input, OutputInterface $output)
			0 ignored issues – show Unused Code introduced 2017-07-31 07:48 UTC by Report Bug Copy Issue Report The parameter `$output` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
85			{
86	1		$modelName = ucfirst($input->getArgument('model'));
87	1		$tableName = $input->getArgument('table');
88
89			/*
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-04-04 15:12 UTC by Report Bug Copy Issue Report `62%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
90			if ($this->getApplication()->isModelExists($modelName)) {
91			$helper = $this->getHelperSet()->get("question");
92			$question = new ConfirmationQuestion(
93			"\n<question>Model $modelName would be overwritten. y/N?</question>:\n> ",
94			false
95			);
96
97			if (!$helper->ask($input, $output, $question)) {
98			return;
99			}
100			}
101			*/
102
103			// generate table
104	1		$tableFile = $this->getApplication()->getModelPath($modelName) . DS . 'Table.php';
105
106	1	View Code Duplication	if (file_exists($tableFile)) {
			0 ignored issues – show Duplication introduced 2017-04-04 13:50 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...
107			$this->comment("Table file <info>$modelName/Table.php</info> already exists");
108			} else {
109	1		$template = $this->getTemplate('TableTemplate');
110	1		$template->setFilePath($tableFile);
111	1		$template->setTemplateData([
112	1		'model' => $modelName,
113	1		'table' => $tableName,
114	1		'primaryKey' => $this->getPrimaryKey($tableName)
115			]);
116
117	1		$generator = new Generator\Generator($template);
118	1		$generator->make();
119			}
120
121			// generate row
122	1		$rowFile = $this->getApplication()->getModelPath($modelName) . DS . 'Row.php';
123
124	1	View Code Duplication	if (file_exists($rowFile)) {
			0 ignored issues – show Duplication introduced 2017-04-04 13:50 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...
125			$this->comment("Row file <info>$modelName/Row.php</info> already exists");
126			} else {
127	1		$template = $this->getTemplate('RowTemplate');
128	1		$template->setFilePath($rowFile);
129	1		$template->setTemplateData(
130			[
131	1		'model' => $modelName,
132	1		'table' => $tableName,
133	1		'columns' => $this->getColumns($tableName)
134			]
135			);
136
137	1		$generator = new Generator\Generator($template);
138	1		$generator->make();
139			}
140	1		}
141
142			/**
143			* @param InputInterface $input
144			* @param OutputInterface $output
145			* @return void
146			* @throws \Bluzman\Generator\GeneratorException
147			*/
148	1	View Code Duplication	public function verify(InputInterface $input, OutputInterface $output)
			0 ignored issues – show Duplication introduced 2017-07-31 07:48 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...
149			{
150	1		$modelPath = $this->getApplication()->getModelPath($input->getArgument('model'));
151
152			$paths = [
153	1		$modelPath . DS . 'Table.php',
154	1		$modelPath . DS . 'Row.php'
155			];
156
157	1		foreach ($paths as $path) {
158	1		if (!$this->getFs()->exists($path)) {
159			throw new Generator\GeneratorException("File `$path` is not exists");
160			}
161			}
162	1		}
163
164			/**
165			* @todo move it to DB class
166			* @return array
167			*/
168			protected function getPrimaryKey($table)
169			{
170			$connect = Db::getOption('connect');
171
172			return Db::fetchColumn(
173			'
174			SELECT COLUMN_NAME
175			FROM INFORMATION_SCHEMA.KEY_COLUMN_USAGE
176			WHERE TABLE_SCHEMA = ?
177			AND TABLE_NAME = ?
178			AND CONSTRAINT_NAME = ?
179			',
180			[$connect['name'], $table, 'PRIMARY']
181			);
182			}
183
184			/**
185			* @todo move it to DB class
186			* @return array
187			*/
188			protected function getColumns($table)
189			{
190			$connect = Db::getOption('connect');
191
192			return Db::fetchAll(
193			'
194			SELECT
195			COLUMN_NAME as name,
196			COLUMN_TYPE as type
197			FROM INFORMATION_SCHEMA.COLUMNS
198			WHERE TABLE_SCHEMA = ?
199			AND TABLE_NAME = ?
200			',
201			[$connect['name'], $table]
202			);
203			}
204			}
205

bluzphp / bluzman

Pull Request — master (#30)

ModelCommand::generate() A

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like