SemverComparator::compare() - Code Metrics - Inspection of "Improve Semver comparator" - nikolaposa/version - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 235051...2cc243 )

by Nikola

created 2019-12-28 09:47 UTC

SemverComparator::compare() A

↳ Parent: SemverComparator

Complexity

Conditions	4
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	6
cts	6
cp	1
rs	9.8666
c	0
b	0
f	0
cc	4
nc	3
nop	2
crap	4

<?php

declare(strict_types=1);

namespace Version\Comparison;

use Version\Extension\PreRelease;
use Version\Version;

final class SemverComparator implements Comparator
{
    public function compare(Version $version1, Version $version2): int
    {
        if (0 !== ($numberComparisonResult = $this->compareNumbers($version1, $version2))) {
            return $numberComparisonResult;
        }

        if ($version1->isPreRelease() && $version2->isPreRelease()) {
            return $this->comparePreReleases($version1->getPreRelease(), $version2->getPreRelease());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
        }

        return $this->resolvePreReleasePrecedence($version1, $version2);
    }

    private function compareNumbers(Version $version1, Version $version2): int
    {
        return [$version1->getMajor(), $version1->getMinor(), $version1->getPatch()] <=> [$version2->getMajor(), $version2->getMinor(), $version2->getPatch()];
    }

    private function comparePreReleases(PreRelease $preRelease1, PreRelease $preRelease2): int
    {
        $preRelease1Ids = $preRelease1->getIdentifiers();
        $preRelease2Ids = $preRelease2->getIdentifiers();

        $preRelease1IdsCount = count($preRelease1Ids);
        $preRelease2IdsCount = count($preRelease2Ids);

        $limit = min($preRelease1IdsCount, $preRelease2IdsCount);

        for ($i = 0; $i < $limit; $i++) {
            if ($preRelease1Ids[$i] === $preRelease2Ids[$i]) {
                continue;
            }

            return $preRelease1Ids[$i] <=> $preRelease2Ids[$i];
        }

        return $preRelease1IdsCount - $preRelease2IdsCount;
    }

    private function resolvePreReleasePrecedence(Version $version1, Version $version2): int
    {
        //pre-release version has lower precedence than a normal version
        return -1 * ($version1->isPreRelease() <=> $version2->isPreRelease());
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Version\Comparison;
6
7		use Version\Extension\PreRelease;
8		use Version\Version;
9
10		final class SemverComparator implements Comparator
11		{
12	36	public function compare(Version $version1, Version $version2): int
13		{
14	36	if (0 !== ($numberComparisonResult = $this->compareNumbers($version1, $version2))) {
15	17	return $numberComparisonResult;
16		}
17
18	23	if ($version1->isPreRelease() && $version2->isPreRelease()) {
19	10	return $this->comparePreReleases($version1->getPreRelease(), $version2->getPreRelease());
		0 ignored issues – show Bug introduced 2019-12-28 09:48 UTC by Report Bug Copy Issue Report It seems like `$version1->getPreRelease()` can be `null`; however, `comparePreReleases()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null / function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history... Bug introduced 2019-12-28 09:48 UTC by Report Bug Copy Issue Report It seems like `$version2->getPreRelease()` can be `null`; however, `comparePreReleases()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /* @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
20		}
21
22	13	return $this->resolvePreReleasePrecedence($version1, $version2);
23		}
24
25	36	private function compareNumbers(Version $version1, Version $version2): int
26		{
27	36	return [$version1->getMajor(), $version1->getMinor(), $version1->getPatch()] <=> [$version2->getMajor(), $version2->getMinor(), $version2->getPatch()];
28		}
29
30	10	private function comparePreReleases(PreRelease $preRelease1, PreRelease $preRelease2): int
31		{
32	10	$preRelease1Ids = $preRelease1->getIdentifiers();
33	10	$preRelease2Ids = $preRelease2->getIdentifiers();
34
35	10	$preRelease1IdsCount = count($preRelease1Ids);
36	10	$preRelease2IdsCount = count($preRelease2Ids);
37
38	10	$limit = min($preRelease1IdsCount, $preRelease2IdsCount);
39
40	10	for ($i = 0; $i < $limit; $i++) {
41	10	if ($preRelease1Ids[$i] === $preRelease2Ids[$i]) {
42	5	continue;
43		}
44
45	7	return $preRelease1Ids[$i] <=> $preRelease2Ids[$i];
46		}
47
48	3	return $preRelease1IdsCount - $preRelease2IdsCount;
49		}
50
51	13	private function resolvePreReleasePrecedence(Version $version1, Version $version2): int
52		{
53		//pre-release version has lower precedence than a normal version
54	13	return -1 * ($version1->isPreRelease() <=> $version2->isPreRelease());
55		}
56		}
57

nikolaposa / version

Push — master ( 235051...2cc243 )

SemverComparator::compare() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like