HasReadWriteProperties::testPropertiesWithFullAccessAreReadablesAndWritables() - Code Metrics - Inspection of "Improve `testReadonlyPropertiesAreReadables`test" - nelson6e65/php_nml - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d6446f...d11253 )

by Nelson

created 2017-10-20 01:57 UTC

testPropertiesWithFullAccessAreReadablesAndWritables() B

↳ Parent: HasReadWriteProperties

Complexity

Conditions	2
Paths	1

Size

Total Lines	30
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	19
nc	1
nop	4
dl	0
loc	30
rs	8.8571
c	0
b	0
f	0

<?php
/**
 * PHP: Nelson Martell Library file
 *
 * Content:
 * - Trait definition
 *
 * Copyright © 2016-2017 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-2017 Nelson Martell
 * @link      http://nelson6e65.github.io/php_nml/
 * @since     v0.7.0
 * @license   http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
 * */

namespace NelsonMartell\Test\Helpers;

use Cake\Utility\Inflector;
use NelsonMartell\Extensions\Text;
use NelsonMartell\IStrictPropertiesContainer;
use SebastianBergmann\Exporter\Exporter;

/**
 * Split of ImplementsIStrictPropertiesContainer, for classes implementing any read-only property
 *
 * @author Nelson Martell <[email protected]>
 * */
trait HasReadWriteProperties
{
    /**
     * @returns IStrictPropertiesContainer
     */
    public abstract function testImplementsIStrictPropertiesContainerInterface($obj);


    public abstract function readwritePropertiesProvider();



    /**
     * @depends testImplementsIStrictPropertiesContainerInterface
     * @dataProvider readwritePropertiesProvider
     */
    public function testPropertiesWithFullAccessAreReadablesAndWritables(
        IStrictPropertiesContainer $obj,
        $property,
        $value,
        $expected
    ) {
        $exporter = new Exporter();

        $var = get_class($obj);
        $var = Inflector::variable(substr(
            $var,
            strrpos($var, '\\') === false ? 0 : strrpos($var, '\\') + 1
        ));

        $obj->$property = $value;

        $actual = $obj->$property;

        $message = Text::format(
            '${var}->{property} = {value}; $actual = ${var}->{property}; // {actual}',
            [
                'var'      => $var,
                'property' => $property,
                'actual'   => $exporter->shortenedExport($actual),
                'value'    => $exporter->shortenedExport($value),
            ]
        );

        $this->assertEquals($expected, $actual, $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-2017 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-2017 Nelson Martell
15			* @link http://nelson6e65.github.io/php_nml/
16			* @since v0.7.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 Cake\Utility\Inflector;
23			use NelsonMartell\Extensions\Text;
24			use NelsonMartell\IStrictPropertiesContainer;
25			use SebastianBergmann\Exporter\Exporter;
26
27			/**
28			* Split of ImplementsIStrictPropertiesContainer, for classes implementing any read-only property
29			*
30			* @author Nelson Martell <[email protected]>
31			* */
32			trait HasReadWriteProperties
33			{
34			/**
35			* @returns IStrictPropertiesContainer
36			*/
37			public abstract function testImplementsIStrictPropertiesContainerInterface($obj);
			0 ignored issues – show Documentation introduced 2017-10-20 02:02 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...
38
39			public abstract function readwritePropertiesProvider();
			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...
40
41
42			/**
43			* @depends testImplementsIStrictPropertiesContainerInterface
44			* @dataProvider readwritePropertiesProvider
45			*/
46			public function testPropertiesWithFullAccessAreReadablesAndWritables(
47			IStrictPropertiesContainer $obj,
48			$property,
49			$value,
50			$expected
51			) {
52			$exporter = new Exporter();
53
54			$var = get_class($obj);
55			$var = Inflector::variable(substr(
56			$var,
57			strrpos($var, '\\') === false ? 0 : strrpos($var, '\\') + 1
58			));
59
60			$obj->$property = $value;
61
62			$actual = $obj->$property;
63
64			$message = Text::format(
65			'${var}->{property} = {value}; $actual = ${var}->{property}; // {actual}',
66			[
67			'var' => $var,
68			'property' => $property,
69			'actual' => $exporter->shortenedExport($actual),
70			'value' => $exporter->shortenedExport($value),
71			]
72			);
73
74			$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...
75			}
76			}
77

nelson6e65 / php_nml

Push — master ( d6446f...d11253 )

testPropertiesWithFullAccessAreReadablesAndWritables() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like