RawResult::process() - Code Metrics - Inspection of "Merge pull request #50 from wagnert/master" - appserver-io/routlt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 688c46...b38950 )

by Tim

created 2018-04-23 19:36 UTC

RawResult::process() D

↳ Parent: RawResult

Complexity

Conditions	9
Paths	8

Size

Total Lines	34
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	17
CRAP Score	9.0139

Importance

Changes

Metric	Value
dl	0
loc	34
ccs	17
cts	18
cp	0.9444
rs	4.909
c	0
b	0
f	0
cc	9
eloc	14
nc	8
nop	2
crap	9.0139

<?php

/**
 * AppserverIo\Routlt\Results\RawResult
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author     Tim Wagner <[email protected]>
 * @copyright  2015 TechDivision GmbH <[email protected]>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       http://github.com/appserver-io/routlt
 * @link       http://www.appserver.io
 */

namespace AppserverIo\Routlt\Results;

use AppserverIo\Routlt\Util\EncodingAware;
use AppserverIo\Routlt\Util\ValidationAware;
use AppserverIo\Routlt\Util\DefaultHeadersAware;
use AppserverIo\Psr\Servlet\ServletRequestInterface;
use AppserverIo\Psr\Servlet\ServletResponseInterface;

/**
 * Result implementation that supports action based default headers and encoding.
 *
 * @author     Tim Wagner <[email protected]>
 * @copyright  2015 TechDivision GmbH <[email protected]>
 * @license    http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link       http://github.com/appserver-io/routlt
 * @link       http://www.appserver.io
 *
 * @Result(shared=false)
 */
class RawResult extends AbstractResult
{

    /**
     * Processes an action result by dispatching the configured servlet.
     *
     * @param \AppserverIo\Psr\Servlet\ServletRequestInterface  $servletRequest  The request instance
     * @param \AppserverIo\Psr\Servlet\ServletResponseInterface $servletResponse The response sent back to the client
     *
     * @return void
     */
    public function process(ServletRequestInterface $servletRequest, ServletResponseInterface $servletResponse)
    {

        // load the action instance
        $action = $this->getAction();

        // add the actions default headers to the response
        if ($action instanceof DefaultHeadersAware && $action->hasDefaultHeaders()) {
            foreach ($action->getDefaultHeaders() as $name => $value) {
                // query whether or not a header with the given name has already been set
                if ($servletResponse->hasHeader($name)) {
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
                    continue;
                }

                // if not, set the default header
                $servletResponse->addHeader($name, $value);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
            }
        }

        // query whether the action contains errors or not
        if ($action instanceof ValidationAware && $action->hasErrors()) {
            $bodyContent = $action->getErrors();
        } else {
            $bodyContent = $action->getAttribute($this->getResult());
        }

        // query whether the action requires content encoding or not
        if ($action instanceof EncodingAware && !empty($bodyContent)) {
            $bodyContent = $action->encode($bodyContent);
        }

        // set the encoded body content
        $servletResponse->appendBodyStream($bodyContent);
    }
}


Push — master ( 688c46...b38950 )

RawResult::process() D

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1		<?php
2
3		/**
4		* AppserverIo\Routlt\Results\RawResult
5		*
6		* NOTICE OF LICENSE
7		*
8		* This source file is subject to the Open Software License (OSL 3.0)
9		* that is available through the world-wide-web at this URL:
10		* http://opensource.org/licenses/osl-3.0.php
11		*
12		* PHP version 5
13		*
14		* @author Tim Wagner <[email protected]>
15		* @copyright 2015 TechDivision GmbH <[email protected]>
16		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17		* @link http://github.com/appserver-io/routlt
18		* @link http://www.appserver.io
19		*/
20
21		namespace AppserverIo\Routlt\Results;
22
23		use AppserverIo\Routlt\Util\EncodingAware;
24		use AppserverIo\Routlt\Util\ValidationAware;
25		use AppserverIo\Routlt\Util\DefaultHeadersAware;
26		use AppserverIo\Psr\Servlet\ServletRequestInterface;
27		use AppserverIo\Psr\Servlet\ServletResponseInterface;
28
29		/**
30		* Result implementation that supports action based default headers and encoding.
31		*
32		* @author Tim Wagner <[email protected]>
33		* @copyright 2015 TechDivision GmbH <[email protected]>
34		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
35		* @link http://github.com/appserver-io/routlt
36		* @link http://www.appserver.io
37		*
38		* @Result(shared=false)
39		*/
40		class RawResult extends AbstractResult
41		{
42
43		/**
44		* Processes an action result by dispatching the configured servlet.
45		*
46		* @param \AppserverIo\Psr\Servlet\ServletRequestInterface $servletRequest The request instance
47		* @param \AppserverIo\Psr\Servlet\ServletResponseInterface $servletResponse The response sent back to the client
48		*
49		* @return void
50		*/
51	3	public function process(ServletRequestInterface $servletRequest, ServletResponseInterface $servletResponse)
52		{
53
54		// load the action instance
55	3	$action = $this->getAction();
56
57		// add the actions default headers to the response
58	3	if ($action instanceof DefaultHeadersAware && $action->hasDefaultHeaders()) {
59	3	foreach ($action->getDefaultHeaders() as $name => $value) {
60		// query whether or not a header with the given name has already been set
61	3	if ($servletResponse->hasHeader($name)) {
		0 ignored issues – show Bug introduced 2017-09-13 19:29 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `AppserverIo\Psr\Servlet\ServletResponseInterface` as the method `hasHeader()` does only exist in the following implementations of said interface: `AppserverIo\Psr\Servlet\...pServletResponseWrapper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
62		continue;
63		}
64
65		// if not, set the default header
66	3	$servletResponse->addHeader($name, $value);
		0 ignored issues – show Bug introduced 2016-12-01 18:36 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `AppserverIo\Psr\Servlet\ServletResponseInterface` as the method `addHeader()` does only exist in the following implementations of said interface: `AppserverIo\Psr\Servlet\...pServletResponseWrapper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
67	3	}
68	3	}
69
70		// query whether the action contains errors or not
71	3	if ($action instanceof ValidationAware && $action->hasErrors()) {
72	1	$bodyContent = $action->getErrors();
73	1	} else {
74	2	$bodyContent = $action->getAttribute($this->getResult());
75		}
76
77		// query whether the action requires content encoding or not
78	3	if ($action instanceof EncodingAware && !empty($bodyContent)) {
79	2	$bodyContent = $action->encode($bodyContent);
80	2	}
81
82		// set the encoded body content
83	3	$servletResponse->appendBodyStream($bodyContent);
84	3	}
85		}
86

appserver-io / routlt

Push — master ( 688c46...b38950 )

RawResult::process() D

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like