DataValuesTestBase::instanceProvider() - Code Metrics - Inspection of "update phpunit to 8.5 (#130)" - wmde/Number - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( ed2d15...6b842d )

unknown

created 2020-10-28 13:25 UTC

DataValuesTestBase::instanceProvider() A

↳ Parent: DataValuesTestBase

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	13
rs	9.8333
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace DataValues\Tests;

use PHPUnit\Framework\TestCase;
use ReflectionClass;

/**
 * Base for unit tests for DataValue implementing classes.
 *
 * @since 0.1
 *
 * @license GPL-2.0-or-later
 * @author Jeroen De Dauw < [email protected] >
 */
class DataValuesTestBase extends TestCase {

	/**
	 * Creates and returns a new instance of the concrete class.
	 *
	 * @since 0.1
	 *
	 * @return mixed
	 */
	public function newInstance() {
		$reflector = new ReflectionClass( $this->getClass() );
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.
    }
}
		$args = func_get_args();
		$instance = $reflector->newInstanceArgs( $args );
		return $instance;
	}

	/**
	 * @since 0.1
	 *
	 * @return array [instance, constructor args]
	 */
	public function instanceProvider() {
		$instanceBuilder = [ $this, 'newInstance' ];

		return array_map(
			function ( array $args ) use ( $instanceBuilder ) {
				return [
					call_user_func_array( $instanceBuilder, $args ),
					$args
				];
			},
			$this->validConstructorArgumentsProvider()
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.
    }
}
		);
	}

}


Push — master ( ed2d15...6b842d )

DataValuesTestBase::instanceProvider() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

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 2020-10-23 14:54 UTC by Report Bug Copy Issue Report 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 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...
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 2020-10-23 14:54 UTC by Report Bug Copy Issue Report 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 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...
48			);
49			}
50
51			}
52

wmde / Number

Push — master ( ed2d15...6b842d )

DataValuesTestBase::instanceProvider() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like