VarDumper::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

VarDumper::supports() A

↳ Parent: VarDumper

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	6
Ratio	100 %

Importance

Changes

Metric	Value
dl	6
loc	6
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	3
nc	2
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 VarDumper 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'] = $body;
        }

        SfDumper::dump($dump);
    }

    public function supports(MessageInterface $message): bool
    {
        return class_exists(SfDumper::class)
            && $message instanceof ResponseInterface
        ;
    }
}


Pull Request — master (#46)

VarDumper::supports() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

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	View Code Duplication	final class VarDumper implements Dumper
		0 ignored issues – show Duplication introduced 2018-04-08 21:54 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
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'] = $body;
36		}
37
38		SfDumper::dump($dump);
39		}
40
41		public function supports(MessageInterface $message): bool
42		{
43		return class_exists(SfDumper::class)
44		&& $message instanceof ResponseInterface
45		;
46		}
47		}
48

Taluu / Behapi

Pull Request — master (#46)

VarDumper::supports() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like