MyTestCase::assertInternalType() - Code Metrics - Inspection of "Fix upload of code coverage" - cmfcmf/OpenWeatherMap-PHP-API - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — main (#165)

by Christian

created 2021-04-05 10:34 UTC

MyTestCase::assertInternalType() A

↳ Parent: MyTestCase

Complexity

Conditions	5
Paths	5

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	9.2888
c	0
b	0
f	0
cc	5
nc	5
nop	3

<?php

/*
 * OpenWeatherMap-PHP-API — A PHP API to parse weather data from https://OpenWeatherMap.org.
 *
 * @license MIT
 *
 * Please see the LICENSE file distributed with this source code for further
 * information regarding copyright and licensing.
 *
 * Please visit the following links to read about the usage policies and the license of
 * OpenWeatherMap data before using this library:
 *
 * @see https://OpenWeatherMap.org/price
 * @see https://OpenWeatherMap.org/terms
 * @see https://OpenWeatherMap.org/appid
 */

namespace Cmfcmf\OpenWeatherMap\Tests;

abstract class MyTestCase extends \PHPUnit\Framework\TestCase
{
    public static function assertInternalType(string $expected, $actual, string $message = ''): void

    {
        if (version_compare(phpversion(), '7.2', '>=')) {
            switch ($expected) {
            case 'string':
                static::assertIsString($actual);
                break;
            case 'object':
                static::assertIsObject($actual);
                break;
            case 'float':
                static::assertIsFloat($actual);
                break;
            default:
                throw new Error();
            }
        } else {
            \PHPUnit\Framework\TestCase::assertInternalType($expected, $actual, $message = '');
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.
    }
}
        }
    }
}


1			<?php
2
3			/*
4			* OpenWeatherMap-PHP-API — A PHP API to parse weather data from https://OpenWeatherMap.org.
5			*
6			* @license MIT
7			*
8			* Please see the LICENSE file distributed with this source code for further
9			* information regarding copyright and licensing.
10			*
11			* Please visit the following links to read about the usage policies and the license of
12			* OpenWeatherMap data before using this library:
13			*
14			* @see https://OpenWeatherMap.org/price
15			* @see https://OpenWeatherMap.org/terms
16			* @see https://OpenWeatherMap.org/appid
17			*/
18
19			namespace Cmfcmf\OpenWeatherMap\Tests;
20
21			abstract class MyTestCase extends \PHPUnit\Framework\TestCase
22			{
23			public static function assertInternalType(string $expected, $actual, string $message = ''): void
			0 ignored issues – show Unused Code introduced 2021-04-05 10:31 UTC by Report Bug Copy Issue Report The parameter `$message` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
24			{
25			if (version_compare(phpversion(), '7.2', '>=')) {
26			switch ($expected) {
27			case 'string':
28			static::assertIsString($actual);
29			break;
30			case 'object':
31			static::assertIsObject($actual);
32			break;
33			case 'float':
34			static::assertIsFloat($actual);
35			break;
36			default:
37			throw new Error();
38			}
39			} else {
40			\PHPUnit\Framework\TestCase::assertInternalType($expected, $actual, $message = '');
			0 ignored issues – show Bug introduced 2021-04-05 10:31 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `PHPUnit\Framework\TestCase` as the method `assertInternalType()` does only exist in the following sub-classes of `PHPUnit\Framework\TestCase`: `Cmfcmf\OpenWeatherMap\Tests\MyTestCase`, `Cmfcmf\OpenWeatherMap\Tests\OpenWeatherMapTest`, `Cmfcmf\OpenWeatherMap\Te...CurrentWeatherGroupTest`, `Cmfcmf\OpenWeatherMap\Te...Map\WeatherForecastTest`, `Cmfcmf\OpenWeatherMap\Tests\Util\TemperatureTest`. 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...
41			}
42			}
43			}
44

cmfcmf / OpenWeatherMap-PHP-API

Pull Request — main (#165)

MyTestCase::assertInternalType() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like