Passed
Push — master ( ed2d15...6b842d )
by
unknown
17:49 queued 07:36
created

DataValuesTestBase   A

Complexity

Total Complexity 2

Size/Duplication

Total Lines 36
Duplicated Lines 0 %

Coupling/Cohesion

Components 0
Dependencies 1

Importance

Changes 0
Metric Value
wmc 2
lcom 0
cbo 1
dl 0
loc 36
rs 10
c 0
b 0
f 0

2 Methods

Rating   Name   Duplication   Size   Complexity  
A newInstance() 0 6 1
A instanceProvider() 0 13 1
1
<?php
2
3
namespace DataValues\Tests;
4
5
use PHPUnit\Framework\TestCase;
6
use ReflectionClass;
7
8
/**
9
 * Base for unit tests for DataValue implementing classes.
10
 *
11
 * @since 0.1
12
 *
13
 * @license GPL-2.0-or-later
14
 * @author Jeroen De Dauw < [email protected] >
15
 */
16
class DataValuesTestBase extends TestCase {
17
18
	/**
19
	 * Creates and returns a new instance of the concrete class.
20
	 *
21
	 * @since 0.1
22
	 *
23
	 * @return mixed
24
	 */
25
	public function newInstance() {
26
		$reflector = new ReflectionClass( $this->getClass() );
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class DataValues\Tests\DataValuesTestBase as the method getClass() does only exist in the following sub-classes of DataValues\Tests\DataValuesTestBase: DataValues\Tests\QuantityValueTest, DataValues\Tests\UnboundedQuantityValueTest. 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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
27
		$args = func_get_args();
28
		$instance = $reflector->newInstanceArgs( $args );
29
		return $instance;
30
	}
31
32
	/**
33
	 * @since 0.1
34
	 *
35
	 * @return array [instance, constructor args]
36
	 */
37
	public function instanceProvider() {
38
		$instanceBuilder = [ $this, 'newInstance' ];
39
40
		return array_map(
41
			function ( array $args ) use ( $instanceBuilder ) {
42
				return [
43
					call_user_func_array( $instanceBuilder, $args ),
44
					$args
45
				];
46
			},
47
			$this->validConstructorArgumentsProvider()
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class DataValues\Tests\DataValuesTestBase as the method validConstructorArgumentsProvider() does only exist in the following sub-classes of DataValues\Tests\DataValuesTestBase: DataValues\Tests\QuantityValueTest, DataValues\Tests\UnboundedQuantityValueTest. 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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. 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.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
48
		);
49
	}
50
51
}
52