VarDumperJson::supports() - Code Metrics - Inspection of "Notion of dumpers for debug" - Taluu/Behapi - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#46)

by Baptiste

created 2018-04-08 21:43 UTC

VarDumperJson::supports() A

↳ Parent: VarDumperJson

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	14
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	7
nc	3
nop	1

<?php declare(strict_types=1);
namespace Behapi\Debug\Dumper\Response;

use Psr\Http\Message\MessageInterface;
use Psr\Http\Message\ResponseInterface;

use Symfony\Component\VarDumper\VarDumper as SfDumper;

use Behapi\Debug\Dumper;
use Behapi\Debug\Dumper\UnsupportedMessage;

final class VarDumperJson implements Dumper
{
    public function dump(MessageInterface $message, array $headers): void
    {
        if (!$this->supports($message)) {
            throw new UnsupportedMessage($message, ResponseInterface::class);
        }

        // mandatory, clearing the line
        // todo : check how to clear without this echo...
        echo "\n";

        $dump = [
            'Response Status' => "{$message->getStatusCode()} {$message->getReasonPhrase()}",
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.
    }
}
        ];

        foreach ($headers as $header) {
            $dump["Response {$header}"] = $message->getHeaderLine($header);
        }

        $body = (string) $message->getBody();

        if (!empty($body)) {
            $dump['Response Body'] = json_decode($body);
        }

        SfDumper::dump($dump);
    }

    public function supports(MessageInterface $message): bool
    {
        if (!class_exists(SfDumper::class)) {
            return false;
        }

        if (!$message instanceof ResponseInterface) {
            return false;
        }

        [$contentType,] = explode(';', $message->getHeaderLine('Content-Type'), 2);


        return 'application/json' === $contentType;
    }
}


1			<?php declare(strict_types=1);
2			namespace Behapi\Debug\Dumper\Response;
3
4			use Psr\Http\Message\MessageInterface;
5			use Psr\Http\Message\ResponseInterface;
6
7			use Symfony\Component\VarDumper\VarDumper as SfDumper;
8
9			use Behapi\Debug\Dumper;
10			use Behapi\Debug\Dumper\UnsupportedMessage;
11
12			final class VarDumperJson implements Dumper
13			{
14			public function dump(MessageInterface $message, array $headers): void
15			{
16			if (!$this->supports($message)) {
17			throw new UnsupportedMessage($message, ResponseInterface::class);
18			}
19
20			// mandatory, clearing the line
21			// todo : check how to clear without this echo...
22			echo "\n";
23
24			$dump = [
25			'Response Status' => "{$message->getStatusCode()} {$message->getReasonPhrase()}",
			0 ignored issues – show Bug introduced 2018-04-08 21:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Http\Message\MessageInterface` as the method `getStatusCode()` does only exist in the following implementations of said interface: `Nyholm\Psr7\Response`. 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... Bug introduced 2018-04-08 21:54 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Psr\Http\Message\MessageInterface` as the method `getReasonPhrase()` does only exist in the following implementations of said interface: `Nyholm\Psr7\Response`. 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...
26			];
27
28			foreach ($headers as $header) {
29			$dump["Response {$header}"] = $message->getHeaderLine($header);
30			}
31
32			$body = (string) $message->getBody();
33
34			if (!empty($body)) {
35			$dump['Response Body'] = json_decode($body);
36			}
37
38			SfDumper::dump($dump);
39			}
40
41			public function supports(MessageInterface $message): bool
42			{
43			if (!class_exists(SfDumper::class)) {
44			return false;
45			}
46
47			if (!$message instanceof ResponseInterface) {
48			return false;
49			}
50
51			[$contentType,] = explode(';', $message->getHeaderLine('Content-Type'), 2);
			0 ignored issues – show Bug introduced 2018-04-08 21:54 UTC by Report Bug Copy Issue Report The variable `$contentType` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
52
53			return 'application/json' === $contentType;
54			}
55			}
56

Taluu / Behapi

Pull Request — master (#46)

VarDumperJson::supports() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like