ApiCrudOperationGenerator::generateInvalidResponse() - Code Metrics - Inspection of "Refactored generate:api command" - keeko/tools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( bbdfc2...ebac7c )

by Thomas

created 2016-07-01 12:10 UTC

generateInvalidResponse() A

↳ Parent: ApiCrudOperationGenerator

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	4
nc	1
nop	1

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

use keeko\tools\generator\AbstractGenerator;
use keeko\framework\utils\NameUtils;
use keeko\tools\generator\Types;
use gossi\swagger\collections\Paths;
use gossi\swagger\collections\Responses;
use gossi\swagger\collections\Parameters;
use Propel\Generator\Model\Table;

class ApiCrudOperationGenerator extends AbstractGenerator {

	public function generate(Paths $paths, $actionName) {
		$action = $this->packageService->getAction($actionName);
		$modelName = $this->modelService->getModelNameByAction($action);
/** @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);
    }
}
		$model = $this->modelService->getModel($modelName);

		if ($model === null) {
			return;
		}

		$generatorDefinition = $this->project->getGeneratorDefinition();
		if ($generatorDefinition->getExcludedApi()->contains($modelName)) {
			return;
		}

		$type = $this->packageService->getActionType($actionName, $modelName);
		if (!Types::isModelType($type)) {
			throw new \RuntimeException(sprintf('Unknown type (%s).', $type));
		}

		$modelPluralName = NameUtils::pluralize($modelName);

		// find path branch
		switch ($type) {
			case Types::PAGINATE:
			case Types::CREATE:
				$endpoint = '/' . NameUtils::dasherize($modelPluralName);
				break;

			case Types::READ:
			case Types::UPDATE:
			case Types::DELETE:
				$endpoint = '/' . NameUtils::dasherize($modelPluralName) . '/{id}';
				break;
		}

		$path = $paths->get($endpoint);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
		$method = $this->getMethod($type);
		$operation = $path->getOperation($method);
		$operation->setDescription($action->getTitle());
		$operation->setOperationId($action->getName());
// 		$operation->getTags()->clear();

// 		$operation->getTags()->add(new Tag($this->package->getKeeko()->getModule()->getSlug()));

		$this->generateParams($operation->getParameters(), $model);
		$this->generateResponses($operation->getResponses(), $model);
	}

	private function getMethod($type) {
		$methods = [
			Types::PAGINATE => 'get',
			Types::CREATE => 'post',
			Types::READ => 'get',
			Types::UPDATE => 'patch',
			Types::DELETE => 'delete',
			Types::ADD => 'post',
			Types::REMOVE => 'delete'
		];

		return $methods[$type];
	}

	protected function generateParams(Parameters $params, Table $model) {
		// Overwrite this method in a subclass to provide functionality
	}

	protected function generateResponses(Responses $responses, Table $model) {
		// Overwrite this method in a subclass to provide functionality
	}

	protected function generateIdParam(Parameters $params, Table $model) {
		$id = $params->getByName('id');
		$id->setIn('path');
		$id->setDescription(sprintf('The %s id', $model->getOriginCommonName()));
		$id->setRequired(true);
		$id->setType('integer');
	}

	protected function generateInvalidResponse(Responses $responses) {
		$invalid = $responses->get('400');
		$invalid->setDescription('Invalid ID supplied');
		$invalid->getSchema()->setRef('#/definitions/Errors');
	}

	protected function generateNotFoundResponse(Responses $responses, Table $model) {
		$notfound = $responses->get('404');
		$notfound->setDescription(sprintf('No %s found', $model->getOriginCommonName()));
		$notfound->getSchema()->setRef('#/definitions/Errors');
	}
}

1			<?php
2			namespace keeko\tools\generator\api;
3
4			use keeko\tools\generator\AbstractGenerator;
5			use keeko\framework\utils\NameUtils;
6			use keeko\tools\generator\Types;
7			use gossi\swagger\collections\Paths;
8			use gossi\swagger\collections\Responses;
9			use gossi\swagger\collections\Parameters;
10			use Propel\Generator\Model\Table;
11
12			class ApiCrudOperationGenerator extends AbstractGenerator {
13
14			public function generate(Paths $paths, $actionName) {
15			$action = $this->packageService->getAction($actionName);
16			$modelName = $this->modelService->getModelNameByAction($action);
			0 ignored issues – show Bug introduced 2016-07-01 12:15 UTC by Report Bug Copy Issue Report It seems like `$action` defined by `$this->packageService->getAction($actionName)` on line `15` can be `null`; however, `keeko\tools\services\Mod...:getModelNameByAction()` 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...
17			$model = $this->modelService->getModel($modelName);
18
19			if ($model === null) {
20			return;
21			}
22
23			$generatorDefinition = $this->project->getGeneratorDefinition();
24			if ($generatorDefinition->getExcludedApi()->contains($modelName)) {
25			return;
26			}
27
28			$type = $this->packageService->getActionType($actionName, $modelName);
29			if (!Types::isModelType($type)) {
30			throw new \RuntimeException(sprintf('Unknown type (%s).', $type));
31			}
32
33			$modelPluralName = NameUtils::pluralize($modelName);
34
35			// find path branch
36			switch ($type) {
37			case Types::PAGINATE:
38			case Types::CREATE:
39			$endpoint = '/' . NameUtils::dasherize($modelPluralName);
40			break;
41
42			case Types::READ:
43			case Types::UPDATE:
44			case Types::DELETE:
45			$endpoint = '/' . NameUtils::dasherize($modelPluralName) . '/{id}';
46			break;
47			}
48
49			$path = $paths->get($endpoint);
			0 ignored issues – show Bug introduced 2016-07-01 12:15 UTC by Report Bug Copy Issue Report The variable `$endpoint` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
50			$method = $this->getMethod($type);
51			$operation = $path->getOperation($method);
52			$operation->setDescription($action->getTitle());
53			$operation->setOperationId($action->getName());
54			// $operation->getTags()->clear();
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-07-01 12:15 UTC by Report Bug Copy Issue Report `70%` 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...
55			// $operation->getTags()->add(new Tag($this->package->getKeeko()->getModule()->getSlug()));
56
57			$this->generateParams($operation->getParameters(), $model);
58			$this->generateResponses($operation->getResponses(), $model);
59			}
60
61			private function getMethod($type) {
62			$methods = [
63			Types::PAGINATE => 'get',
64			Types::CREATE => 'post',
65			Types::READ => 'get',
66			Types::UPDATE => 'patch',
67			Types::DELETE => 'delete',
68			Types::ADD => 'post',
69			Types::REMOVE => 'delete'
70			];
71
72			return $methods[$type];
73			}
74
75			protected function generateParams(Parameters $params, Table $model) {
76			// Overwrite this method in a subclass to provide functionality
77			}
78
79			protected function generateResponses(Responses $responses, Table $model) {
80			// Overwrite this method in a subclass to provide functionality
81			}
82
83			protected function generateIdParam(Parameters $params, Table $model) {
84			$id = $params->getByName('id');
85			$id->setIn('path');
86			$id->setDescription(sprintf('The %s id', $model->getOriginCommonName()));
87			$id->setRequired(true);
88			$id->setType('integer');
89			}
90
91			protected function generateInvalidResponse(Responses $responses) {
92			$invalid = $responses->get('400');
93			$invalid->setDescription('Invalid ID supplied');
94			$invalid->getSchema()->setRef('#/definitions/Errors');
95			}
96
97			protected function generateNotFoundResponse(Responses $responses, Table $model) {
98			$notfound = $responses->get('404');
99			$notfound->setDescription(sprintf('No %s found', $model->getOriginCommonName()));
100			$notfound->getSchema()->setRef('#/definitions/Errors');
101			}
102			}

keeko / tools

Push — master ( bbdfc2...ebac7c )

generateInvalidResponse() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like