IComparerTester::testCompareMethod() - Code Metrics - Inspection of "Merge branch 'v0.6.x'" - nelson6e65/php_nml - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 446f2e...32b2c3 )

by Nelson

created 2016-10-04 16:37 UTC

IComparerTester::testCompareMethod() B

↳ Parent: IComparerTester

Complexity

Conditions	4
Paths	4

Size

Total Lines	37
Code Lines	25

Duplication

Lines	20
Ratio	54.05 %

Importance

Changes

Metric	Value
cc	4
eloc	25
nc	4
nop	3
dl	20
loc	37
rs	8.5806
c	0
b	0
f	0

<?php
/**
 * PHP: Nelson Martell Library file
 *
 * Content:
 * - Trait definition
 *
 * Copyright © 2016 Nelson Martell (http://nelson6e65.github.io)
 *
 * Licensed under The MIT License (MIT)
 * For full copyright and license information, please see the LICENSE
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright 2016 Nelson Martell
 * @link      http://nelson6e65.github.io/php_nml/
 * @since     v0.6.0
 * @license   http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
 * */

namespace NelsonMartell\Test\Helpers;

use NelsonMartell\Extensions\String;
use NelsonMartell\IComparer;

/**
 * Test helper for classes implementing ``NelsonMartell\IComparable`` interface.
 *
 * Note: Classes using this trait MUST use ConstructorMethodTester and ExporterPlugin traits too.
 *
 * @author Nelson Martell <[email protected]>
 * */
trait IComparerTester
{
    public abstract function getTargetClassName(); // use ConstructorMethodTester;

    public abstract function getTargetClassReflection(); // use ConstructorMethodTester;

    public abstract function export($obj, $depth = 2, $short = false); // use plugin/ExporterPlugin;


    /**
     * Datasets for ``testCompareMethod(integer|null $expected, mixed $left, mixed $right)``.
     *
     * @return array
     */
    public abstract function compareMethodArgumentsProvider();

    /**
     * Datasets for ``testCanUseCompareMethodInArraySorting(integer|null $expected, mixed $left, mixed $right)``.
     *
     * @return array
     */
    public abstract function compareMethodArraysProvider();


    /**
     * @testdox Can compare relative position of objects of different type
     * @dataProvider compareMethodArgumentsProvider
     */
    public function testCompareMethod($expected, $left, $right)
    {
        $class = $this->getTargetClassName();
$a = "a";
$ab = "ab";
$abc = "abc";
        $actual = $class::compare($left, $right);

        $message = String::format(
            '{class}::{method}({left}, {right}); // Returned: {actual}',
            [
                'class'  => $class,
                'method' => 'compare',
                'left'   => static::export($left),
                'right'  => static::export($right),
                'actual' => static::export($actual)
            ]
        );

        if ($expected === 0) {

            $this->assertInternalType('integer', $actual, $message);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->assertEquals(0, $actual, $message);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        } else {
            if ($expected === null) {
                $this->assertNull($actual, $message);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            } else {
                $major = $minor = 0;

                if ($expected < 0) {
                    $minor = $actual;
                } else {
                    $major = $actual;
                }

                $this->assertInternalType('integer', $actual, $message);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->assertGreaterThan($minor, $major, $message);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                $this->assertLessThan($major, $minor, $message);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        }
    }


    /**
     * @testdox Provides comparison function to array sorting
     * @dataProvider compareMethodArraysProvider
     */
    public function testCanUseCompareMethodInArraySorting(array $expected)
    {
        $actual = $expected;

        @shuffle($actual);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

        $message = String::format(
            'usort({actual}, [{class}, {method}]);',
            [
                'class'  => $this->getTargetClassName(),
                'method' => 'compare',
                'actual' => static::export($actual)
            ]
        );

        @usort($actual, [$this->getTargetClassName(), 'compare']);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

        $this->assertEquals($expected, $actual, $message);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * @testdox Is compliant with ``NelsonMartell\IComparer`` interface
     * @depends testCanUseCompareMethodInArraySorting
     */
    public function testIsCompliantWithIComparerIterface()

    {
        $message = String::format(
            '"{0}" do not implements "{1}" interface.',
            $this->getTargetClassName(),
            IComparer::class
        );

        $this->assertContains(IComparer::class, $this->getTargetClassReflection()->getInterfaceNames(), $message);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
}



1		<?php
2		/**
3		* PHP: Nelson Martell Library file
4		*
5		* Content:
6		* - Trait definition
7		*
8		* Copyright © 2016 Nelson Martell (http://nelson6e65.github.io)
9		*
10		* Licensed under The MIT License (MIT)
11		* For full copyright and license information, please see the LICENSE
12		* Redistributions of files must retain the above copyright notice.
13		*
14		* @copyright 2016 Nelson Martell
15		* @link http://nelson6e65.github.io/php_nml/
16		* @since v0.6.0
17		* @license http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
18		* */
19
20		namespace NelsonMartell\Test\Helpers;
21
22		use NelsonMartell\Extensions\String;
23		use NelsonMartell\IComparer;
24
25		/**
26		* Test helper for classes implementing ``NelsonMartell\IComparable`` interface.
27		*
28		* Note: Classes using this trait MUST use ConstructorMethodTester and ExporterPlugin traits too.
29		*
30		* @author Nelson Martell <[email protected]>
31		* */
32		trait IComparerTester
33		{
34		public abstract function getTargetClassName(); // use ConstructorMethodTester;
		0 ignored issues – show Documentation introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
35		public abstract function getTargetClassReflection(); // use ConstructorMethodTester;
		0 ignored issues – show Documentation introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
36		public abstract function export($obj, $depth = 2, $short = false); // use plugin/ExporterPlugin;
		0 ignored issues – show Documentation introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
37
38		/**
39		* Datasets for ``testCompareMethod(integer\|null $expected, mixed $left, mixed $right)``.
40		*
41		* @return array
42		*/
43		public abstract function compareMethodArgumentsProvider();
44
45		/**
46		* Datasets for ``testCanUseCompareMethodInArraySorting(integer\|null $expected, mixed $left, mixed $right)``.
47		*
48		* @return array
49		*/
50		public abstract function compareMethodArraysProvider();
51
52
53		/**
54		* @testdox Can compare relative position of objects of different type
55		* @dataProvider compareMethodArgumentsProvider
56		*/
57		public function testCompareMethod($expected, $left, $right)
58		{
59		$class = $this->getTargetClassName();
		0 ignored issues – show Coding Style introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
60		$actual = $class::compare($left, $right);
61
62		$message = String::format(
63		'{class}::{method}({left}, {right}); // Returned: {actual}',
64		[
65		'class' => $class,
66		'method' => 'compare',
67		'left' => static::export($left),
68		'right' => static::export($right),
69		'actual' => static::export($actual)
70		]
71		);
72
73	View Code Duplication	if ($expected === 0) {
		0 ignored issues – show Duplication introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
74		$this->assertInternalType('integer', $actual, $message);
		0 ignored issues – show Bug introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report It seems like `assertInternalType()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
75		$this->assertEquals(0, $actual, $message);
		0 ignored issues – show Bug introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report It seems like `assertEquals()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
76		} else {
77		if ($expected === null) {
78		$this->assertNull($actual, $message);
		0 ignored issues – show Bug introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report It seems like `assertNull()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
79		} else {
80		$major = $minor = 0;
81
82		if ($expected < 0) {
83		$minor = $actual;
84		} else {
85		$major = $actual;
86		}
87
88		$this->assertInternalType('integer', $actual, $message);
		0 ignored issues – show Bug introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report It seems like `assertInternalType()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
89		$this->assertGreaterThan($minor, $major, $message);
		0 ignored issues – show Bug introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report It seems like `assertGreaterThan()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
90		$this->assertLessThan($major, $minor, $message);
		0 ignored issues – show Bug introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report It seems like `assertLessThan()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
91		}
92		}
93		}
94
95
96		/**
97		* @testdox Provides comparison function to array sorting
98		* @dataProvider compareMethodArraysProvider
99		*/
100		public function testCanUseCompareMethodInArraySorting(array $expected)
101		{
102		$actual = $expected;
103
104		@shuffle($actual);
		0 ignored issues – show Security Best Practice introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
105
106		$message = String::format(
107		'usort({actual}, [{class}, {method}]);',
108		[
109		'class' => $this->getTargetClassName(),
110		'method' => 'compare',
111		'actual' => static::export($actual)
112		]
113		);
114
115		@usort($actual, [$this->getTargetClassName(), 'compare']);
		0 ignored issues – show Security Best Practice introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
116
117		$this->assertEquals($expected, $actual, $message);
		0 ignored issues – show Bug introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report It seems like `assertEquals()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
118		}
119
120		/**
121		* @testdox Is compliant with ``NelsonMartell\IComparer`` interface
122		* @depends testCanUseCompareMethodInArraySorting
123		*/
124	View Code Duplication	public function testIsCompliantWithIComparerIterface()
		0 ignored issues – show Duplication introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
125		{
126		$message = String::format(
127		'"{0}" do not implements "{1}" interface.',
128		$this->getTargetClassName(),
129		IComparer::class
130		);
131
132		$this->assertContains(IComparer::class, $this->getTargetClassReflection()->getInterfaceNames(), $message);
		0 ignored issues – show Bug introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report It seems like `assertContains()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
133		}
134		}
		0 ignored issues – show Coding Style introduced 2016-10-04 16:48 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
135

nelson6e65 / php_nml

Push — master ( 446f2e...32b2c3 )

IComparerTester::testCompareMethod() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like