NelsonMartell\Test\Helpers\IStrictPropertiesContainerTester

Complexity

Total Complexity

14

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
	readonlyPropertiesProvider()	0	1	?
	writeonlyPropertiesProvider()	0	1	?
	readwritePropertiesProvider()	0	1	?
	unaccesiblePropertiesProvider()	0	1	?
	objectInstanceProvider()	0	1	?
B	testReadonlyPropertiesAreReadables()	0	30	3
A	testReadonlyPropertiesAreNotWritables()	0	7	1
A	testWriteonlyPropertiesAreWritables()	0	11	2
A	testWriteonlyPropertiesAreNotReadables()	0	8	1
B	testPropertiesWithFullAccessAreReadablesAndWritables()	0	34	3
A	testUnaccessiblePropertiesThrowsCatchableError()	0	17	3
A	testIsUnableToCreateDirectAttributesOutsideOfClassDefinition()	0	4	1

<?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 Cake\Utility\Inflector;
use NelsonMartell\Extensions\String;
use NelsonMartell\IStrictPropertiesContainer;
use SebastianBergmann\Exporter\Exporter;

/**
 * Test helper for classes implementing ``NelsonMartell\IStrictPropertiesContainer`` interface and
 * ``NelsonMartell\PropertiesHandler`` trait.
 *
 * You can pass an empty in some providers to skip test. For example, if a class has not 'write-only' properties)
 *
 * @author Nelson Martell <nelson6e65@gmail.com>
 * */
trait IStrictPropertiesContainerTester
{
    public abstract function readonlyPropertiesProvider();

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.

    public abstract function writeonlyPropertiesProvider();

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.

    public abstract function readwritePropertiesProvider();

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.

    public abstract function unaccesiblePropertiesProvider();

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.

    public abstract function objectInstanceProvider();

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.

    /**
     * Optional if provider returns an empty array.
     *
     * @dataProvider readonlyPropertiesProvider
     */
    public function testReadonlyPropertiesAreReadables(
        IStrictPropertiesContainer $obj = null,
        $property = null,
        $expected = null
    ) {
        if ($obj === null) {
            $this->markTestSkipped('Target class has not read-only properties.');

It seems like markTestSkipped() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        $exporter = new Exporter();

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

        $actual = $obj->$property;

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

        $this->assertEquals($expected, $actual, $message);

It seems like assertEquals() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @depends testReadonlyPropertiesAreReadables
     * @dataProvider readonlyPropertiesProvider
     * @expectedException \BadMethodCallException
     */
    public function testReadonlyPropertiesAreNotWritables(
        IStrictPropertiesContainer $obj = null,
        $property = null,
        $value = null
    ) {
        $obj->$property = $value;
    }

    /**
     * @dataProvider writeonlyPropertiesProvider
     */
    public function testWriteonlyPropertiesAreWritables(
        IStrictPropertiesContainer $obj = null,
        $property = null,
        $value = null
    ) {
        if ($obj === null) {
            $this->markTestSkipped('Target class has not write-only properties to test.');

It seems like markTestSkipped() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        $obj->$property = $value;
    }

    /**
     * @depends testWriteonlyPropertiesAreWritables
     * @dataProvider writeonlyPropertiesProvider
     * @expectedException \BadMethodCallException
     */
    public function testWriteonlyPropertiesAreNotReadables(
        IStrictPropertiesContainer $obj = null,
        $property = null,
        $value = null
    ) {
        $obj->$property = $value;
        $actual = $obj->$property;

$actual is not used, you could remove the assignment.

Equals sign not aligned with surrounding assignments; expected 9 spaces but found 1 space

    }

    /**
     * @dataProvider readwritePropertiesProvider
     */
    public function testPropertiesWithFullAccessAreReadablesAndWritables(
        IStrictPropertiesContainer $obj = null,
        $property = null,
        $value = null,
        $expected = null
    ) {
        if ($obj === null) {
            $this->markTestSkipped('Target class has not read-write properties to test.');

It seems like markTestSkipped() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        $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 = String::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);

It seems like assertEquals() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * @dataProvider unaccesiblePropertiesProvider
     * @expectedException \BadMethodCallException
     */
    public function testUnaccessiblePropertiesThrowsCatchableError(
        IStrictPropertiesContainer $obj = null,
        $property = null,
        $value = null
    ) {
        if ($obj === null) {
            $this->markTestSkipped('Target class has not unaccesible properties to test.');

It seems like markTestSkipped() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        if ($value === null) {
            // Getter exception
            $actual = $obj->$property;

$actual is not used, you could remove the assignment.

        } else {
            // Setter exception
            $obj->$property = $value;
        }
    }

    /**
     * @dataProvider objectInstanceProvider
     * @expectedException \BadMethodCallException
     */
    public function testIsUnableToCreateDirectAttributesOutsideOfClassDefinition(IStrictPropertiesContainer $obj)
    {
        $obj->thisPropertyNameIsMaybeImposibleThatExistsInClassToBeUsedAsNameOfPropertyOfAnyClassGiven = 'No way';

Accessing thisPropertyNameIsMaybeImposibleThatExistsInClassToBeUsedAsNameOfPropertyOfAnyClassGiven on the interface NelsonMartell\IStrictPropertiesContainer suggest that you code against a concrete implementation. How about adding an instanceof check?

    }
}

As per coding style, files should not end with a newline character.