NelsonMartell\Test\Helpers\ConstructorMethodTester

Complexity

Total Complexity

7

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
	getTargetClassName()	0	1	?
A	getTargetClassReflection()	0	16	4
A	getTargetClassInstance()	0	4	1
A	testConstructor()	0	4	1
A	testConstructorWithBadArguments()	0	4	1
	goodConstructorArgumentsProvider()	0	1	?
	badConstructorArgumentsProvider()	0	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 \ReflectionClass;
use \ReflectionException;
use \BadMethodCallException;
use \UnexpectedValueException;

/**
 * Provides test methods and helpers to test class constructors.
 *
 * @author Nelson Martell <nelson6e65@gmail.com>
 * */
trait ConstructorMethodTester
{
    /**
     * Gets the name of class target of this test-class.
     *
     * @return string
     */
    public abstract function getTargetClassName();

    protected $targetClassReflection = null;


    public function getTargetClassReflection()

The return type could not be reliably inferred; please add a @return annotation.

    {
        if ($this->targetClassReflection === null) {
            try {
                if (!is_string($this->getTargetClassName())) {
                    throw new UnexpectedValueException('``getTargetClassName()`` is not returning an string.');
                }

                $this->targetClassReflection = new ReflectionClass($this->getTargetClassName());
            } catch (ReflectionException $e) {
                throw new BadMethodCallException('``getTargetClassName()`` is not returning a valid class name.');
            }
        }

        return $this->targetClassReflection;
    }

    /**
     * Gets (dinamically) an instance of target class using its constructor with the (optional) arguments.
     * It uses the ``getTargetClassName`` return value to determinate the name of target class.
     *
     * @return mixed Instance of target class.
     * @throws UnexpectedValueException
     * @throws BadMethodCallException
     */
    public function getTargetClassInstance()
    {
        return $this->getTargetClassReflection()->newInstanceArgs(func_get_args());
    }

    /**
     * @testdox Creates new instances
     * @dataProvider goodConstructorArgumentsProvider
     */
    public function testConstructor()
    {
        $obj = call_user_func_array([$this, 'getTargetClassInstance'], func_get_args());

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

    }

    /**
     * @testdox Informs when error occurs on creating new instances
     * @dataProvider badConstructorArgumentsProvider
     * @expectedException \InvalidArgumentException
     */
    public function testConstructorWithBadArguments()
    {
        $obj = call_user_func_array([$this, 'getTargetClassInstance'], func_get_args());

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

    }

    /**
     * Must provide valid argument for constructor.
     *
     * @return array
     */
    public abstract function goodConstructorArgumentsProvider();

    /**
     * Must provide invalid argument for constructor.
     *
     * @return array
     */
    public abstract function badConstructorArgumentsProvider();
}

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