GenerateResponseCommand - Code Metrics - Inspection of "New generators for relationships" - keeko/tools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( da62ab...2e0a22 )

by Thomas

created 2016-02-13 19:59 UTC

GenerateResponseCommand C

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	200
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	20

Test Coverage

Coverage

74.55%

Importance

Changes	11
Bugs	0	Features	0

Metric	Value
wmc	28
c	11
b	0
f	0
lcom	2
cbo	20
dl	0
loc	200
ccs	82
cts	110
cp	0.7455
rs	6.4705

5 Methods

Rating	Name	Size	Complexity
B	configure()	31	1
A	preCheck()	6	3
B	interact()	47	6
A	execute()	21	3
D	generateResponse()	79	15

<?php
namespace keeko\tools\command;

use gossi\codegen\model\PhpClass;
use keeko\tools\generator\GeneratorFactory;
use keeko\tools\generator\response\base\ModelResponseTraitGenerator;
use keeko\tools\generator\response\BlankHtmlResponseGenerator;
use keeko\tools\generator\response\BlankJsonResponseGenerator;
use keeko\tools\generator\response\TwigHtmlResponseGenerator;
use keeko\tools\helpers\QuestionHelperTrait;
use phootwork\collection\Set;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;
use Symfony\Component\Console\Question\Question;
use phootwork\file\File;
use keeko\tools\generator\response\DumpJsonResponseGenerator;

class GenerateResponseCommand extends AbstractGenerateCommand {

	use QuestionHelperTrait;
	
	protected $traits;
	
	protected function configure() {
		$this->traits = new Set();
		
		$this
			->setName('generate:response')
			->setDescription('Generates code for a response')
			->addArgument(
				'name',
				InputArgument::OPTIONAL,
				'The name of the action, which should be generated. Typically in the form %nomen%-%verb% (e.g. user-create)'
			)
			->addOption(
				'format',
				'',
				InputOption::VALUE_OPTIONAL,
				'The response format to create',
				'json'
			)
			->addOption(
				'template',
				'',
				InputOption::VALUE_OPTIONAL,
				'The template for the body method (blank or twig)',
				'blank'
			)
		;
		
		$this->configureGenerateOptions();

		parent::configure();
	}

	/**
	 * Checks whether actions can be generated at all by reading composer.json and verify
	 * all required information are available
	 */
	private function preCheck() {
		$module = $this->packageService->getModule();
		if ($module === null || count($module->getActionNames()) == 0) {
			throw new \DomainException('No action definition found in composer.json - please run `keeko generate:action`.');
		}
	}

	protected function interact(InputInterface $input, OutputInterface $output) {
		$this->preCheck();
		
		// check if the dialog can be skipped
		$name = $input->getArgument('name');
$a = "a";
$ab = "ab";
$abc = "abc";
		$specificAction = false;
		
		if ($name === null) {
			$specificQuestion = new ConfirmationQuestion('Do you want to generate a response for a specific action?');
			$specificAction = $this->askConfirmation($specificQuestion);
$a = "a";
$ab = "ab";
$abc = "abc";
		}
		
		// ask which action
		if ($specificAction) {
			$names = [];
$a = "a";
$ab = "ab";
$abc = "abc";
			$module = $this->packageService->getModule();
			foreach ($module->getActionNames() as $name) {
				$names[] = $name;
			}
			
			$actionQuestion = new Question('Which action');
			$actionQuestion->setAutocompleterValues($names);
			$name = $this->askQuestion($actionQuestion);
			$input->setArgument('name', $name);
		} 
		
		
		// ask which format
		$formatQuestion = new Question('Which format', 'json');
		$formatQuestion->setAutocompleterValues(['json', 'html']);
		$format = $this->askQuestion($formatQuestion);
		$input->setOption('format', $format);
		
		// ask which template
		$templates = [
			'html' => ['twig', 'blank'],
			'json' => ['dump', 'blank']
		];
		
		$suggestions = isset($templates[$format]) ? $templates[$format] : [];
$a = "a";
$ab = "ab";
$abc = "abc";
		$default = count($suggestions) ? $suggestions[0] : '';
$a = "a";
$ab = "ab";
$abc = "abc";
		$templateQuestion = new Question('Which template', $default);
		$templateQuestion->setAutocompleterValues($suggestions);
		$template = $this->askQuestion($templateQuestion);
		$input->setOption('template', $template);
		
	}

	protected function execute(InputInterface $input, OutputInterface $output) {
		$this->preCheck();
		
		$name = $input->getArgument('name');

		// only a specific action
		if ($name) {
			$this->generateResponse($name);
		}
		
		// anyway all actions
		else {
			$actions = $this->packageService->getModule()->getActionNames();
			
			foreach ($actions as $name) {
				$this->generateResponse($name);
			}
		}
		
		$this->packageService->savePackage();
	}
	
	private function generateResponse($actionName) {
		$this->logger->info('Generate Response: ' . $actionName);
		$module = $this->packageService->getModule();
		
		if (!$module->hasAction($actionName)) {
			throw new \RuntimeException(sprintf('action (%s) not found', $actionName));
		}
		
		$input = $this->io->getInput();
$a = "a";
$ab = "ab";
$abc = "abc";
		$action = $module->getAction($actionName);
$a = "a";
$ab = "ab";
$abc = "abc";
		$modelName = $this->modelService->getModelNameByAction($action);
		$format = $input->getOption('format');
$a = "a";
$ab = "ab";
$abc = "abc";
		$template = $input->getOption('template');
$a = "a";
$ab = "ab";
$abc = "abc";

		if (!$action->hasResponse($format)) {
			$action->setResponse($format, str_replace(['Action', 'action'], [ucwords($format) . 'Response', 'response'], $action->getClass()));
		}

		// find generator
		$overwrite = false;
		$generator = null;
		$type = $this->packageService->getActionType($actionName, $modelName);
$a = "a";
$ab = "ab";
$abc = "abc";
		$isModel = $type && $this->modelService->isModelAction($action); 
$a = "a";
$ab = "ab";
$abc = "abc";

		// model given and format is json
		if ($isModel && $format === 'json') {
			$generator = GeneratorFactory::createJsonResponseGenerator($type, $this->service);
		}
		
		// json + dump
		else if ($format === 'json' && $template == 'dump') {
			$generator = new DumpJsonResponseGenerator($this->service);
		}
		
		// blank json
		else if ($format === 'json') {
			$generator = new BlankJsonResponseGenerator($this->service);
		}
		
		// html + twig
		else if ($format === 'html' && $template == 'twig') {
			$generator = new TwigHtmlResponseGenerator($this->service);
		}
		
		// blank html as default
		else if ($format == 'html') {
			$generator = new BlankHtmlResponseGenerator($this->service);
		}
		
		// run generation, if generator was chosen
		if ($generator !== null) {
			/* @var $class PhpClass */
			$class = $generator->generate($action);
			
			// generate json trait

// 			if ($isModel && $format === 'json') {
// 				$generator = new ModelResponseTraitGenerator($this->service);
// 				$trait = $generator->generate($action);
				
// 				if (!$class->hasTrait($trait)) {

// 					$class->addTrait($trait);
// 					$overwrite = true;
// 				}
				
// 				if (!$this->traits->contains($trait->getName())) {

// 					$this->codegenService->dumpStruct($trait, true);
// 					$this->traits->add($trait->getName());
// 				}
// 			}

			// write to file
			$file = new File($this->codegenService->getFilename($class));
			if (!$file->exists()) {
				$overwrite = true;
			}
			$overwrite = $overwrite || $input->getOption('force');
			$this->codegenService->dumpStruct($class, $overwrite);
		}
	}

}


1		<?php
2		namespace keeko\tools\command;
3
4		use gossi\codegen\model\PhpClass;
5		use keeko\tools\generator\GeneratorFactory;
6		use keeko\tools\generator\response\base\ModelResponseTraitGenerator;
7		use keeko\tools\generator\response\BlankHtmlResponseGenerator;
8		use keeko\tools\generator\response\BlankJsonResponseGenerator;
9		use keeko\tools\generator\response\TwigHtmlResponseGenerator;
10		use keeko\tools\helpers\QuestionHelperTrait;
11		use phootwork\collection\Set;
12		use Symfony\Component\Console\Input\InputArgument;
13		use Symfony\Component\Console\Input\InputInterface;
14		use Symfony\Component\Console\Input\InputOption;
15		use Symfony\Component\Console\Output\OutputInterface;
16		use Symfony\Component\Console\Question\ConfirmationQuestion;
17		use Symfony\Component\Console\Question\Question;
18		use phootwork\file\File;
19		use keeko\tools\generator\response\DumpJsonResponseGenerator;
20
21		class GenerateResponseCommand extends AbstractGenerateCommand {
22
23		use QuestionHelperTrait;
24	20
25	20	protected $traits;
26	20
27	20	protected function configure() {
28	20	$this->traits = new Set();
29	20
30	20	$this
31		->setName('generate:response')
32	20	->setDescription('Generates code for a response')
33	20	->addArgument(
34	20	'name',
35	20	InputArgument::OPTIONAL,
36	20	'The name of the action, which should be generated. Typically in the form %nomen%-%verb% (e.g. user-create)'
37	20	)
38		->addOption(
39	20	'format',
40	20	'',
41	20	InputOption::VALUE_OPTIONAL,
42	20	'The response format to create',
43	20	'json'
44	20	)
45	1	->addOption(
46	20	'template',
47		'',
48		InputOption::VALUE_OPTIONAL,
49	20	'The template for the body method (blank or twig)',
50		'blank'
51	20	)
52	20	;
53
54		$this->configureGenerateOptions();
55
56		parent::configure();
57		}
58	7
59	7	/**
60	7	* Checks whether actions can be generated at all by reading composer.json and verify
61	1	* all required information are available
62		*/
63	6	private function preCheck() {
64		$module = $this->packageService->getModule();
65		if ($module === null \|\| count($module->getActionNames()) == 0) {
66		throw new \DomainException('No action definition found in composer.json - please run `keeko generate:action`.');
67		}
68		}
69
70		protected function interact(InputInterface $input, OutputInterface $output) {
71		$this->preCheck();
72
73		// check if the dialog can be skipped
74		$name = $input->getArgument('name');
		0 ignored issues – show Coding Style introduced 2015-11-25 17:44 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 11 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
75		$specificAction = false;
76
77		if ($name === null) {
78		$specificQuestion = new ConfirmationQuestion('Do you want to generate a response for a specific action?');
79		$specificAction = $this->askConfirmation($specificQuestion);
		0 ignored issues – show Coding Style introduced 2015-11-25 17:44 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
80		}
81
82		// ask which action
83		if ($specificAction) {
84		$names = [];
		0 ignored issues – show Coding Style introduced 2016-01-02 14:55 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
85		$module = $this->packageService->getModule();
86		foreach ($module->getActionNames() as $name) {
87		$names[] = $name;
88		}
89
90		$actionQuestion = new Question('Which action');
91		$actionQuestion->setAutocompleterValues($names);
92		$name = $this->askQuestion($actionQuestion);
93		$input->setArgument('name', $name);
94		}
95
96
97		// ask which format
98		$formatQuestion = new Question('Which format', 'json');
99		$formatQuestion->setAutocompleterValues(['json', 'html']);
100		$format = $this->askQuestion($formatQuestion);
101		$input->setOption('format', $format);
102
103		// ask which template
104		$templates = [
105	7	'html' => ['twig', 'blank'],
106	7	'json' => ['dump', 'blank']
107		];
108	6
109		$suggestions = isset($templates[$format]) ? $templates[$format] : [];
		0 ignored issues – show Coding Style introduced 2016-01-02 14:55 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
110		$default = count($suggestions) ? $suggestions[0] : '';
		0 ignored issues – show Coding Style introduced 2016-01-02 14:55 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 10 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
111	6	$templateQuestion = new Question('Which template', $default);
112	5	$templateQuestion->setAutocompleterValues($suggestions);
113	4	$template = $this->askQuestion($templateQuestion);
114		$input->setOption('template', $template);
115
116		}
117	1
118		protected function execute(InputInterface $input, OutputInterface $output) {
119	1	$this->preCheck();
120	1
121	1	$name = $input->getArgument('name');
122
123		// only a specific action
124	5	if ($name) {
125	5	$this->generateResponse($name);
126		}
127	6
128	6	// anyway all actions
129		else {
130	6	$actions = $this->packageService->getModule()->getActionNames();
131	1
132		foreach ($actions as $name) {
133		$this->generateResponse($name);
134	5	}
135	5	}
136	5
137	5	$this->packageService->savePackage();
138	5	}
139
140	5	private function generateResponse($actionName) {
141	5	$this->logger->info('Generate Response: ' . $actionName);
142	5	$module = $this->packageService->getModule();
143
144		if (!$module->hasAction($actionName)) {
145	5	throw new \RuntimeException(sprintf('action (%s) not found', $actionName));
146	5	}
147	5
148		$input = $this->io->getInput();
		0 ignored issues – show Coding Style introduced 2015-11-27 14:02 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
149		$action = $module->getAction($actionName);
		0 ignored issues – show Coding Style introduced 2015-11-27 14:02 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
150	5	$modelName = $this->modelService->getModelNameByAction($action);
151	2	$format = $input->getOption('format');
		0 ignored issues – show Coding Style introduced 2015-11-27 14:02 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 4 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
152	2	$template = $input->getOption('template');
		0 ignored issues – show Coding Style introduced 2015-11-27 14:02 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
153
154		if (!$action->hasResponse($format)) {
155	4	$action->setResponse($format, str_replace(['Action', 'action'], [ucwords($format) . 'Response', 'response'], $action->getClass()));
156	2	}
157	2
158		// find generator
159		$overwrite = false;
160	2	$generator = null;
161	1	$type = $this->packageService->getActionType($actionName, $modelName);
		0 ignored issues – show Coding Style introduced 2015-11-25 17:44 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
162	1	$isModel = $type && $this->modelService->isModelAction($action);
		0 ignored issues – show Coding Style introduced 2015-11-25 17:44 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
163
164		// model given and format is json
165	1	if ($isModel && $format === 'json') {
166	1	$generator = GeneratorFactory::createJsonResponseGenerator($type, $this->service);
167	1	}
168
169		// json + dump
170	5	else if ($format === 'json' && $template == 'dump') {
171		$generator = new DumpJsonResponseGenerator($this->service);
172	5	}
173
174		// blank json
175	5	else if ($format === 'json') {
176	2	$generator = new BlankJsonResponseGenerator($this->service);
177	2	}
178	2
179		// html + twig
180	2	else if ($format === 'html' && $template == 'twig') {
181	2	$generator = new TwigHtmlResponseGenerator($this->service);
182	2	}
183	2
184	2	// blank html as default
185		else if ($format == 'html') {
186		$generator = new BlankHtmlResponseGenerator($this->service);
187	5	}
188	5
189	5	// run generation, if generator was chosen
190		if ($generator !== null) {
191		/* @var $class PhpClass */
192		$class = $generator->generate($action);
193
194		// generate json trait
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-13 20:08 UTC by Report Bug Copy Issue Report `46%` 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...
195		// if ($isModel && $format === 'json') {
196		// $generator = new ModelResponseTraitGenerator($this->service);
197		// $trait = $generator->generate($action);
198
199		// if (!$class->hasTrait($trait)) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-13 20:08 UTC by Report Bug Copy Issue Report `59%` 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...
200		// $class->addTrait($trait);
201		// $overwrite = true;
202		// }
203
204		// if (!$this->traits->contains($trait->getName())) {
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-02-13 20:08 UTC by Report Bug Copy Issue Report `64%` 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...
205		// $this->codegenService->dumpStruct($trait, true);
206		// $this->traits->add($trait->getName());
207		// }
208		// }
209
210		// write to file
211		$file = new File($this->codegenService->getFilename($class));
212		if (!$file->exists()) {
213		$overwrite = true;
214		}
215		$overwrite = $overwrite \|\| $input->getOption('force');
216		$this->codegenService->dumpStruct($class, $overwrite);
217		}
218		}
219
220		}
221

keeko / tools

Push — master ( da62ab...2e0a22 )

GenerateResponseCommand C

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like