ReadableStreamHash - Code Metrics - Inspection of "Emit also with the hash event" - WyriHaximus/reactphp-stream-hash - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 80e1a2...dbc788 )

by Cees-Jan

created 2017-07-07 06:09 UTC

ReadableStreamHash A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

64%

Importance

Changes

Metric	Value
wmc	6
lcom	1
cbo	4
dl	0
loc	61
ccs	16
cts	25
cp	0.64
rs	10
c	0
b	0
f	0

6 Methods

Rating	Name	Size	Complexity
A	__construct()	17	1
A	isReadable()	4	1
A	pause()	4	1
A	resume()	4	1
A	pipe()	4	1
A	close()	4	1

<?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 int                     $options
     * @param string                  $key
     */
    public function __construct(ReadableStreamInterface $stream, string $algo, int $options = 0, string $key = '')
    {
        $this->stream = $stream;

        $this->context = hash_init($algo, $options, $key);
        $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');
            $this->emit('hash', [
                hash_final($this->context),
                $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 int $options
26		* @param string $key
27		*/
28	184	public function __construct(ReadableStreamInterface $stream, string $algo, int $options = 0, string $key = '')
29		{
30	184	$this->stream = $stream;
		0 ignored issues – show Documentation Bug introduced 2017-07-06 20:30 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...
31	184	$this->context = hash_init($algo, $options, $key);
32		$this->stream->on('data', function ($data) {
33	184	hash_update($this->context, $data);
34	184	$this->emit('data', [$data]);
35	184	});
36	184	$this->stream->once('close', function () use ($algo) {
37	184	$this->emit('close');
38	184	$this->emit('hash', [
39	184	hash_final($this->context),
40	184	$algo,
41		]);
42	184	});
43	184	Util::forwardEvents($stream, $this, ['error', 'end']);
44	184	}
45
46	184	public function isReadable()
47		{
48	184	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...
49		}
50
51		public function pause()
52		{
53		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...
54		}
55
56		public function resume()
57		{
58		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...
59		}
60
61		public function pipe(WritableStreamInterface $dest, array $options = [])
62		{
63		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...
64		}
65
66		public function close()
67		{
68		$this->stream->close();
69		}
70		}
71

WyriHaximus / reactphp-stream-hash

GitHub Access Token became invalid

Push — master ( 80e1a2...dbc788 )

ReadableStreamHash A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like