RawResult::process() - Code Metrics - Inspection of "Query whether or not a header already exists befor..." - appserver-io/routlt - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#43)

by Tim

created 2017-09-13 20:18 UTC

RawResult::process() D

↳ Parent: RawResult

Complexity

Conditions	9
Paths	8

Size

Total Lines	34
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	34
rs	4.909
cc	9
eloc	14
nc	8
nop	2

<?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\ActionAware;
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
 */
class RawResult implements ResultInterface, ActionAware
{

    /**
     * Trait proving basic result functionality.
     *
     * @var \AppserverIo\Routlt\Results\ResultTrait
     */
    use ResultTrait;


    /**
     * 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);
    }
}


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\ActionAware;
24			use AppserverIo\Routlt\Util\EncodingAware;
25			use AppserverIo\Routlt\Util\ValidationAware;
26			use AppserverIo\Routlt\Util\DefaultHeadersAware;
27			use AppserverIo\Psr\Servlet\ServletRequestInterface;
28			use AppserverIo\Psr\Servlet\ServletResponseInterface;
29
30			/**
31			* Result implementation that supports action based default headers and encoding.
32			*
33			* @author Tim Wagner <[email protected]>
34			* @copyright 2015 TechDivision GmbH <[email protected]>
35			* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
36			* @link http://github.com/appserver-io/routlt
37			* @link http://www.appserver.io
38			*/
39			class RawResult implements ResultInterface, ActionAware
40			{
41
42			/**
43			* Trait proving basic result functionality.
44			*
45			* @var \AppserverIo\Routlt\Results\ResultTrait
46			*/
47			use ResultTrait;
			0 ignored issues – show Deprecated Code introduced 2016-01-23 14:30 UTC by Report Bug Copy Issue Report The trait `AppserverIo\Routlt\Results\ResultTrait` has been deprecated with message: Since 2.0.0-alpha5, use AppserverIo\Routlt\Results\RawResult instead This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
48
49			/**
50			* Processes an action result by dispatching the configured servlet.
51			*
52			* @param \AppserverIo\Psr\Servlet\ServletRequestInterface $servletRequest The request instance
53			* @param \AppserverIo\Psr\Servlet\ServletResponseInterface $servletResponse The response sent back to the client
54			*
55			* @return void
56			*/
57			public function process(ServletRequestInterface $servletRequest, ServletResponseInterface $servletResponse)
58			{
59
60			// load the action instance
61			$action = $this->getAction();
62
63			// add the actions default headers to the response
64			if ($action instanceof DefaultHeadersAware && $action->hasDefaultHeaders()) {
65			foreach ($action->getDefaultHeaders() as $name => $value) {
66			// query whether or not a header with the given name has already been set
67			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...
68			continue;
69			}
70
71			// if not, set the default header
72			$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...
73			}
74			}
75
76			// query whether the action contains errors or not
77			if ($action instanceof ValidationAware && $action->hasErrors()) {
78			$bodyContent = $action->getErrors();
79			} else {
80			$bodyContent = $action->getAttribute($this->getResult());
81			}
82
83			// query whether the action requires content encoding or not
84			if ($action instanceof EncodingAware && !empty($bodyContent)) {
85			$bodyContent = $action->encode($bodyContent);
86			}
87
88			// set the encoded body content
89			$servletResponse->appendBodyStream($bodyContent);
90			}
91			}
92

appserver-io / routlt

Pull Request — master (#43)

RawResult::process() D

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like