ModelUpdateJsonResponderGenerator - Code Metrics - Inspection of "New responder generator and partially ddd generati..." - keeko/tools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2fb143...d99a08 )

by Thomas

created 2016-04-13 17:04 UTC

ModelUpdateJsonResponderGenerator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	2
c	1
b	0
f	0
lcom	1
cbo	5
dl	0
loc	33
rs	10

1 Method

Rating	Name	Duplication	Size	Complexity
B	addMethods()	0	30	2

<?php
namespace keeko\tools\generator\responder;

use gossi\codegen\model\PhpClass;
use keeko\framework\schema\ActionSchema;

class ModelUpdateJsonResponderGenerator extends AbstractModelJsonResponderGenerator {

	protected function addMethods(PhpClass $class, ActionSchema $action) {
		$this->generateGetPayloadMethods($class, $this->twig->render('getPayloadMethods-update.twig'));
		$this->generateNotFound($class);
		$this->generateNotValid($class);
		
		// method: updated(Request $request, PayloadInterface $payload)

		$modelName = $this->modelService->getModelNameByAction($action);
		$model = $this->modelService->getModel($modelName);

		$fields = $this->getModelFields($model);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		foreach ($fields as $field) {
			$class->addUseStatement($field->getNamespace() . '\\' . $field->getPhpName());
		}
		
		$updated = $this->generatePayloadMethod('updated', $this->twig->render('model-read.twig', [
			'class' => $model->getPhpName(),
			'includes' => $this->codegenService->arrayToCode($this->getRelationshipIncludes($model)),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			'fields' => $this->getFieldsCode($fields)
		]));
		
		$class->setMethod($updated);
		$class->addUseStatement('Tobscure\\JsonApi\\Document');
		$class->addUseStatement('Tobscure\\JsonApi\\Resource');
		$class->addUseStatement('Tobscure\\JsonApi\\Parameters');
		$class->addUseStatement($model->getNamespace() . '\\' . $model->getPhpName());
		
		// method: notUpdated(Request $request, PayloadInterface $payload)

		$notUpdated = $this->generatePayloadMethod('notUpdated', $this->twig->render('model-notUpdated.twig'));
		$class->setMethod($notUpdated);
	}
}

1			<?php
2			namespace keeko\tools\generator\responder;
3
4			use gossi\codegen\model\PhpClass;
5			use keeko\framework\schema\ActionSchema;
6
7			class ModelUpdateJsonResponderGenerator extends AbstractModelJsonResponderGenerator {
8
9			protected function addMethods(PhpClass $class, ActionSchema $action) {
10			$this->generateGetPayloadMethods($class, $this->twig->render('getPayloadMethods-update.twig'));
11			$this->generateNotFound($class);
12			$this->generateNotValid($class);
13
14			// method: updated(Request $request, PayloadInterface $payload)
			1 ignored issue – show Unused Code Comprehensibility introduced 2016-02-13 20:08 UTC by Report Bug Copy Issue Report `36%` 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...
15			$modelName = $this->modelService->getModelNameByAction($action);
16			$model = $this->modelService->getModel($modelName);
17
18			$fields = $this->getModelFields($model);
			1 ignored issue – show Bug introduced 2016-04-13 17:14 UTC by Report Bug Copy Issue Report It seems like `$model` defined by `$this->modelService->getModel($modelName)` on line `16` can be `null`; however, `keeko\tools\generator\re...rator::getModelFields()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
19			foreach ($fields as $field) {
20			$class->addUseStatement($field->getNamespace() . '\\' . $field->getPhpName());
21			}
22
23			$updated = $this->generatePayloadMethod('updated', $this->twig->render('model-read.twig', [
24			'class' => $model->getPhpName(),
25			'includes' => $this->codegenService->arrayToCode($this->getRelationshipIncludes($model)),
			1 ignored issue – show Bug introduced 2016-04-13 17:14 UTC by Report Bug Copy Issue Report It seems like `$model` defined by `$this->modelService->getModel($modelName)` on line `16` can be `null`; however, `keeko\tools\generator\re...tRelationshipIncludes()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
26			'fields' => $this->getFieldsCode($fields)
27			]));
28
29			$class->setMethod($updated);
30			$class->addUseStatement('Tobscure\\JsonApi\\Document');
31			$class->addUseStatement('Tobscure\\JsonApi\\Resource');
32			$class->addUseStatement('Tobscure\\JsonApi\\Parameters');
33			$class->addUseStatement($model->getNamespace() . '\\' . $model->getPhpName());
34
35			// method: notUpdated(Request $request, PayloadInterface $payload)
			1 ignored issue – show Unused Code Comprehensibility introduced 2016-04-13 17:14 UTC by Report Bug Copy Issue Report `36%` 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...
36			$notUpdated = $this->generatePayloadMethod('notUpdated', $this->twig->render('model-notUpdated.twig'));
37			$class->setMethod($notUpdated);
38			}
39			}

keeko / tools

Push — master ( 2fb143...d99a08 )

ModelUpdateJsonResponderGenerator A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

1 Method

Duplication Side-by-Side

Filter issues like