ErrorAction - Code Metrics - Inspection of "Added basic error response" - apparat/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b86495...3c5021 )

by Joschi

created 2016-07-02 19:16 UTC

ErrorAction A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	26
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	4

Test Coverage

Coverage

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
wmc	1
c	2
b	0
f	1
lcom	0
cbo	4
dl	0
loc	26
ccs	0
cts	3
cp	0
rs	10

1 Method

Rating	Name	Duplication	Size	Complexity
A	__invoke()	0	5	1

<?php

/**
 * apparat-server
 *
 * @category    Apparat
 * @package     Apparat\Server
 * @subpackage  Apparat\Server\Ports\Action
 * @author      Joschi Kuphal <[email protected]> / @jkphl
 * @copyright   Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Apparat\Server\Infrastructure\Action;

use Apparat\Server\Infrastructure\Responder\ErrorResponder;
use Apparat\Server\Infrastructure\Service\ErrorService;
use Apparat\Server\Ports\Action\AbstractAction;
use Psr\Http\Message\ResponseInterface;

/**
 * Object action
 *
 * @package Apparat\Server
 * @subpackage Apparat\Server\Ports
 */
class ErrorAction extends AbstractAction
{
    /**
     * Domain service
     *
     * @var ErrorService
     */
    protected $domain;
    /**
     * Responder
     *
     * @var ErrorResponder
     */
    protected $responder;

    /**
     * Run the action
     *
     * @return ResponseInterface Response
     */
    public function __invoke()
    {
        $payload = $this->domain->explain($this->request->getAttributes());
        return $this->responder->__invoke($payload);
/** @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);
    }
}
    }
}


1			<?php
2
3			/**
4			* apparat-server
5			*
6			* @category Apparat
7			* @package Apparat\Server
8			* @subpackage Apparat\Server\Ports\Action
9			* @author Joschi Kuphal <[email protected]> / @jkphl
10			* @copyright Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
11			* @license http://opensource.org/licenses/MIT The MIT License (MIT)
12			*/
13
14			/***********************************************************************************
15			* The MIT License (MIT)
16			*
17			* Copyright © 2016 Joschi Kuphal <[email protected]> / @jkphl
18			*
19			* Permission is hereby granted, free of charge, to any person obtaining a copy of
20			* this software and associated documentation files (the "Software"), to deal in
21			* the Software without restriction, including without limitation the rights to
22			* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23			* the Software, and to permit persons to whom the Software is furnished to do so,
24			* subject to the following conditions:
25			*
26			* The above copyright notice and this permission notice shall be included in all
27			* copies or substantial portions of the Software.
28			*
29			* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30			* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31			* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32			* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33			* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34			* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35			***********************************************************************************/
36
37			namespace Apparat\Server\Infrastructure\Action;
38
39			use Apparat\Server\Infrastructure\Responder\ErrorResponder;
40			use Apparat\Server\Infrastructure\Service\ErrorService;
41			use Apparat\Server\Ports\Action\AbstractAction;
42			use Psr\Http\Message\ResponseInterface;
43
44			/**
45			* Object action
46			*
47			* @package Apparat\Server
48			* @subpackage Apparat\Server\Ports
49			*/
50			class ErrorAction extends AbstractAction
51			{
52			/**
53			* Domain service
54			*
55			* @var ErrorService
56			*/
57			protected $domain;
58			/**
59			* Responder
60			*
61			* @var ErrorResponder
62			*/
63			protected $responder;
64
65			/**
66			* Run the action
67			*
68			* @return ResponseInterface Response
69			*/
70			public function __invoke()
71			{
72			$payload = $this->domain->explain($this->request->getAttributes());
73			return $this->responder->__invoke($payload);
			0 ignored issues – show Bug introduced 2016-07-02 19:29 UTC by Report Bug Copy Issue Report It seems like `$payload` defined by `$this->domain->explain($...quest->getAttributes())` on line `72` can be `null`; however, `Apparat\Server\Infrastru...orResponder::__invoke()` 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...
74			}
75			}
76

apparat / server

Push — master ( b86495...3c5021 )

ErrorAction A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

1 Method

Duplication Side-by-Side

Filter issues like