CL\PHPUnitExtensions\Constraint\ConstrainArray

Complexity

Total Complexity

18

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	21	4
B	matches()	0	18	6
A	count()	0	4	1
B	additionalFailureDescription()	0	18	6
A	toString()	0	4	1

<?php

namespace CL\PHPUnitExtensions\Constraint;

use PHPUnit_Framework_Constraint;
use PHPUnit_Util_InvalidArgumentHelper;

/**
 * @author    Ivan Kerin <ikerin@gmail.com>
 * @copyright 2014, Clippings Ltd.
 * @license   http://spdx.org/licenses/BSD-3-Clause
 */
class ConstrainArray extends PHPUnit_Framework_Constraint
{
    /**
     * @var PHPUnit_Framework_Constraint[]
     */
    protected $constraints = array();

    /**
     * @var boolean
     */
    protected $isStrict = true;

    /**
     * @param PHPUnit_Framework_Constraint[] $constraints
     */
    public function __construct(array $constraints, $isStrict = true)
    {
        parent::__construct();

        foreach ($constraints as $constraint) {
            if (! ($constraint instanceof PHPUnit_Framework_Constraint)) {

The class PHPUnit_Framework_Constraint does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json?

                throw PHPUnit_Util_InvalidArgumentHelper::factory(
                    1,
                    'array of PHPUnit_Framework_Constraint',
                    $constraint
                );
            }
        }

        if (! is_bool($isStrict)) {
            throw PHPUnit_Util_InvalidArgumentHelper::factory(2, 'bool', $isStrict);
        }

        $this->constraints = $constraints;
        $this->isStrict = $isStrict;
    }

    /**
     * Evaluates the constraint for parameter $other. Returns true if the
     * constraint is met, false otherwise.
     *
     * @param  mixed   $other
     * @return boolean
     */
    protected function matches($other)
    {
        foreach ($this->constraints as $key => $constraint) {
            if (! array_key_exists($key, $other)) {
                return false;
            }

            if (! $constraint->evaluate($other[$key], '', true)) {
                return false;
            }
        }

        if ($this->isStrict and array_diff_key($other, $this->constraints)) {
            return false;
        }

        return true;
    }

    public function count()
    {
        return count($this->constraints);
    }

    public function additionalFailureDescription($other)
    {
        $errors = array();

        foreach ($this->constraints as $key => $constraint) {
            if (! array_key_exists($key, $other)) {
                $errors []= sprintf("key '%s' does not exist", $key);
            } elseif (! $constraint->evaluate($other[$key], '', true)) {
                $errors []= sprintf("key %s: %s", $key, $constraint->failureDescription($other[$key]));
            }
        }

        if ($this->isStrict and ($diff = array_diff_key($other, $this->constraints))) {
            $errors []= sprintf("Unmached keys: %s", implode(', ', array_keys($diff)));
        }

        return "Errors:\n".implode("\n", $errors);
    }

    /**
     * @return string
     */
    public function toString()
    {
        return 'array matches constraints';
    }
}