RequiredParameterAmountIncreased::compare() - Code Metrics - Inspection of "Verify method, function, property, constant and in..." - Roave/BackwardCompatibilityCheck - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#38)

by Marco

created 2018-04-16 22:55 UTC

RequiredParameterAmountIncreased::compare() A

↳ Parent: RequiredParameterAmountIncreased

Complexity

Conditions	2
Paths	2

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	18
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	12
nc	2
nop	2

<?php

declare(strict_types=1);

namespace Roave\ApiCompare\Comparator\BackwardsCompatibility\FunctionBased;

use Roave\ApiCompare\Change;
use Roave\ApiCompare\Changes;
use Roave\BetterReflection\Reflection\ReflectionFunctionAbstract;
use Roave\BetterReflection\Reflection\ReflectionMethod;

/**
 * When new parameters are added, they must be optional, or else the callers will provide an insufficient
 * amount of parameters to the function.
 */
final class RequiredParameterAmountIncreased implements FunctionBased
{
    public function compare(ReflectionFunctionAbstract $fromFunction, ReflectionFunctionAbstract $toFunction) : Changes
    {
        $fromRequiredParameters = $fromFunction->getNumberOfRequiredParameters();
        $toRequiredParameters   = $toFunction->getNumberOfRequiredParameters();

        if ($fromRequiredParameters >= $toRequiredParameters) {
            return Changes::new();
        }

        return Changes::fromArray([
            Change::changed(
                sprintf(
                    'The number of required arguments for %s increased from %d to %d',
                    $this->functionOrMethodName($fromFunction),
                    $fromRequiredParameters,
                    $toRequiredParameters
                ),
                true
            ),
        ]);
    }

    private function functionOrMethodName(ReflectionFunctionAbstract $function) : string
    {
        if ($function instanceof ReflectionMethod) {
            return $function->getDeclaringClass()->getName()
                . ($function->isStatic() ? '::' : '#')
                . $function->getName();
        }

        return $function->getName();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace Roave\ApiCompare\Comparator\BackwardsCompatibility\FunctionBased;
6
7			use Roave\ApiCompare\Change;
8			use Roave\ApiCompare\Changes;
9			use Roave\BetterReflection\Reflection\ReflectionFunctionAbstract;
10			use Roave\BetterReflection\Reflection\ReflectionMethod;
11
12			/**
13			* When new parameters are added, they must be optional, or else the callers will provide an insufficient
14			* amount of parameters to the function.
15			*/
16			final class RequiredParameterAmountIncreased implements FunctionBased
17			{
18			public function compare(ReflectionFunctionAbstract $fromFunction, ReflectionFunctionAbstract $toFunction) : Changes
19			{
20			$fromRequiredParameters = $fromFunction->getNumberOfRequiredParameters();
21			$toRequiredParameters = $toFunction->getNumberOfRequiredParameters();
22
23			if ($fromRequiredParameters >= $toRequiredParameters) {
24			return Changes::new();
25			}
26
27			return Changes::fromArray([
28			Change::changed(
29			sprintf(
30			'The number of required arguments for %s increased from %d to %d',
31			$this->functionOrMethodName($fromFunction),
32			$fromRequiredParameters,
33			$toRequiredParameters
34			),
35			true
36			),
37			]);
38			}
39
40			private function functionOrMethodName(ReflectionFunctionAbstract $function) : string
41			{
42			if ($function instanceof ReflectionMethod) {
43			return $function->getDeclaringClass()->getName()
44			. ($function->isStatic() ? '::' : '#')
45			. $function->getName();
46			}
47
48			return $function->getName();
49			}
50			}
51

Roave / BackwardCompatibilityCheck

Pull Request — master (#38)

RequiredParameterAmountIncreased::compare() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like