Key::getAddress() - Code Metrics - Inspection of "Remove Key::getAddress()" - Bit-Wasp/bitcoin-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 0.0.35 (#657)

by thomas

created 2018-02-26 18:52 UTC

Key::getAddress() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
ccs	2
cts	2
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

namespace BitWasp\Bitcoin\Crypto\EcAdapter\Key;

use BitWasp\Bitcoin\Crypto\EcAdapter\Serializer\Key\PublicKeySerializerInterface;
use BitWasp\Bitcoin\Crypto\Hash;
use BitWasp\Bitcoin\Serializable;
use BitWasp\Buffertools\BufferInterface;

abstract class Key extends Serializable implements KeyInterface
{
    /**
     * @var BufferInterface
     */
    protected $pubKeyHash;

    /**
     * @return bool
     */
    public function isPrivate()
    {
        return $this instanceof PrivateKeyInterface;
    }

    /**
     * @param PublicKeySerializerInterface|null $serializer
     * @return \BitWasp\Buffertools\BufferInterface
     */
    public function getPubKeyHash(PublicKeySerializerInterface $serializer = null)
    {
        if ($this instanceof PrivateKeyInterface) {
            $publicKey = $this->getPublicKey();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        } else {
            $publicKey = $this;
        }

        if (null === $this->pubKeyHash) {
            $this->pubKeyHash = Hash::sha256ripe160($serializer ? $serializer->serialize($publicKey) : $publicKey->getBuffer());
        }

        return $this->pubKeyHash;
    }
}


1		<?php
2
3		namespace BitWasp\Bitcoin\Crypto\EcAdapter\Key;
4
5		use BitWasp\Bitcoin\Crypto\EcAdapter\Serializer\Key\PublicKeySerializerInterface;
6		use BitWasp\Bitcoin\Crypto\Hash;
7		use BitWasp\Bitcoin\Serializable;
8		use BitWasp\Buffertools\BufferInterface;
9
10		abstract class Key extends Serializable implements KeyInterface
11		{
12		/**
13		* @var BufferInterface
14		*/
15		protected $pubKeyHash;
16
17		/**
18		* @return bool
19		*/
20		public function isPrivate()
21	50	{
22		return $this instanceof PrivateKeyInterface;
23	50	}
24
25		/**
26		* @param PublicKeySerializerInterface\|null $serializer
27		* @return \BitWasp\Buffertools\BufferInterface
28		*/
29		public function getPubKeyHash(PublicKeySerializerInterface $serializer = null)
30	98	{
31		if ($this instanceof PrivateKeyInterface) {
32	98	$publicKey = $this->getPublicKey();
		0 ignored issues – show Bug introduced 2015-11-21 03:53 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `BitWasp\Bitcoin\Crypto\EcAdapter\Key\Key` as the method `getPublicKey()` does only exist in the following sub-classes of `BitWasp\Bitcoin\Crypto\EcAdapter\Key\Key`: `BitWasp\Bitcoin\Crypto\E...l\PhpEcc\Key\PrivateKey`, `BitWasp\Bitcoin\Crypto\E...ecp256k1\Key\PrivateKey`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
33	8	} else {
34		$publicKey = $this;
35	96	}
36
37		if (null === $this->pubKeyHash) {
38	98	$this->pubKeyHash = Hash::sha256ripe160($serializer ? $serializer->serialize($publicKey) : $publicKey->getBuffer());
39	98	}
40
41		return $this->pubKeyHash;
42	98	}
43		}
44

Bit-Wasp / bitcoin-php

Pull Request — 0.0.35 (#657)

Key::getAddress() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like