ReadableStreamHash - Code Metrics - Inspection of "Emit raw hash when there are listeners" - WyriHaximus/reactphp-stream-hash - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( dbc788...185fc6 )

by Cees-Jan

created 2017-07-08 17:23 UTC

ReadableStreamHash A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	74
Duplicated Lines	27.03 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

74.29%

Importance

Changes

Metric	Value
wmc	10
lcom	1
cbo	4
dl	20
loc	74
ccs	26
cts	35
cp	0.7429
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	20	31	5
A	isReadable()	0	4	1
A	pause()	0	4	1
A	resume()	0	4	1
A	pipe()	0	4	1
A	close()	0	4	1

How to fix Duplicated Code

<?php declare(strict_types=1);

namespace WyriHaximus\React\Stream\Hash;

use Evenement\EventEmitter;
use React\Stream\ReadableStreamInterface;
use React\Stream\Util;
use React\Stream\WritableStreamInterface;

final class ReadableStreamHash extends EventEmitter implements ReadableStreamInterface
{
    /**
     * @var WritableStreamInterface
     */
    private $stream;

    /**
     * @var resource
     */
    private $context;

    /**
     * @param ReadableStreamInterface $stream
     * @param string                  $algo
     * @param string|null             $key
     */
    public function __construct(ReadableStreamInterface $stream, string $algo, string $key = null)
    {
        $this->stream = $stream;

        $options = [$algo];
        if ($key !== null && strlen($key) > 0) {

            $options[] = HASH_HMAC;
            $options[] = $key;
        }
        $this->context = hash_init(...$options);
        $this->stream->on('data', function ($data) {
            hash_update($this->context, $data);
            $this->emit('data', [$data]);
        });
        $this->stream->once('close', function () use ($algo) {

            $this->emit('close');
            $hash = hash_final($this->context, true);
            if (count($this->listeners('hash')) > 0) {
                $this->emit('hash', [
                    bin2hex($hash),
                    $algo,
                ]);
            }
            if (count($this->listeners('hash_raw')) > 0) {
                $this->emit('hash_raw', [
                    $hash,
                    $algo,
                ]);
            }
        });
        Util::forwardEvents($stream, $this, ['error', 'end']);
    }

    public function isReadable()
    {
        return $this->stream->isReadable();
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.
    }
}
    }

    public function pause()
    {
        return $this->stream->pause();
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.
    }
}
    }

    public function resume()
    {
        return $this->stream->resume();
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.
    }
}
    }

    public function pipe(WritableStreamInterface $dest, array $options = [])
    {
        return $this->stream->pipe($dest, $options);
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.
    }
}
    }

    public function close()
    {
        $this->stream->close();
    }
}


1			<?php declare(strict_types=1);
2
3			namespace WyriHaximus\React\Stream\Hash;
4
5			use Evenement\EventEmitter;
6			use React\Stream\ReadableStreamInterface;
7			use React\Stream\Util;
8			use React\Stream\WritableStreamInterface;
9
10			final class ReadableStreamHash extends EventEmitter implements ReadableStreamInterface
11			{
12			/**
13			* @var WritableStreamInterface
14			*/
15			private $stream;
16
17			/**
18			* @var resource
19			*/
20			private $context;
21
22			/**
23			* @param ReadableStreamInterface $stream
24			* @param string $algo
25			* @param string\|null $key
26			*/
27	368		public function __construct(ReadableStreamInterface $stream, string $algo, string $key = null)
28			{
29	368		$this->stream = $stream;
			0 ignored issues – show Documentation Bug introduced 2017-07-08 17:25 UTC by Report Bug Copy Issue Report It seems like `$stream` of type `object<React\Stream\ReadableStreamInterface>` is incompatible with the declared type `object<React\Stream\WritableStreamInterface>` of property `$stream`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
30	368		$options = [$algo];
31	368	View Code Duplication	if ($key !== null && strlen($key) > 0) {
			0 ignored issues – show Duplication introduced 2017-07-08 17:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
32	184		$options[] = HASH_HMAC;
33	184		$options[] = $key;
34			}
35	368		$this->context = hash_init(...$options);
36			$this->stream->on('data', function ($data) {
37	368		hash_update($this->context, $data);
38	368		$this->emit('data', [$data]);
39	368		});
40	368	View Code Duplication	$this->stream->once('close', function () use ($algo) {
			0 ignored issues – show Duplication introduced 2017-07-08 17:25 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
41	368		$this->emit('close');
42	368		$hash = hash_final($this->context, true);
43	368		if (count($this->listeners('hash')) > 0) {
44	368		$this->emit('hash', [
45	368		bin2hex($hash),
46	368		$algo,
47			]);
48			}
49	368		if (count($this->listeners('hash_raw')) > 0) {
50	368		$this->emit('hash_raw', [
51	368		$hash,
52	368		$algo,
53			]);
54			}
55	368		});
56	368		Util::forwardEvents($stream, $this, ['error', 'end']);
57	368		}
58
59	368		public function isReadable()
60			{
61	368		return $this->stream->isReadable();
			0 ignored issues – show Bug introduced 2017-07-06 20:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Stream\WritableStreamInterface` as the method `isReadable()` does only exist in the following implementations of said interface: `React\Stream\CompositeStream`, `React\Stream\DuplexResourceStream`, `React\Stream\ThroughStream`. 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			}
63
64			public function pause()
65			{
66			return $this->stream->pause();
			0 ignored issues – show Bug introduced 2017-07-06 20:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Stream\WritableStreamInterface` as the method `pause()` does only exist in the following implementations of said interface: `React\Stream\CompositeStream`, `React\Stream\DuplexResourceStream`, `React\Stream\ThroughStream`. 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			}
68
69			public function resume()
70			{
71			return $this->stream->resume();
			0 ignored issues – show Bug introduced 2017-07-06 20:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Stream\WritableStreamInterface` as the method `resume()` does only exist in the following implementations of said interface: `React\Stream\CompositeStream`, `React\Stream\DuplexResourceStream`, `React\Stream\ThroughStream`. 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...
72			}
73
74			public function pipe(WritableStreamInterface $dest, array $options = [])
75			{
76			return $this->stream->pipe($dest, $options);
			0 ignored issues – show Bug introduced 2017-07-06 20:30 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `React\Stream\WritableStreamInterface` as the method `pipe()` does only exist in the following implementations of said interface: `React\Stream\CompositeStream`, `React\Stream\DuplexResourceStream`, `React\Stream\ThroughStream`. 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...
77			}
78
79			public function close()
80			{
81			$this->stream->close();
82			}
83			}
84

WyriHaximus / reactphp-stream-hash

GitHub Access Token became invalid

Push — master ( dbc788...185fc6 )

ReadableStreamHash A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like