Expectation::throwAsNecessary() - Code Metrics - Inspection of "Allow throwing throwables" - padraic/mockery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#679)

by Dave

created 2017-01-23 12:29 UTC

Expectation::throwAsNecessary() A

↳ Parent: Expectation

Complexity

Conditions	4
Paths	5

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	4.0218

Importance

Changes

Metric	Value
dl	0
loc	16
ccs	8
cts	9
cp	0.8889
rs	9.2
c	0
b	0
f	0
cc	4
eloc	9
nc	5
nop	1
crap	4.0218

<?php
/**
 * Mockery
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://github.com/padraic/mockery/blob/master/LICENSE
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to [email protected] so we can send you a copy immediately.
 *
 * @category   Mockery
 * @package    Mockery
 * @copyright  Copyright (c) 2010 Pádraic Brady (http://blog.astrumfutura.com)
 * @license    http://github.com/padraic/mockery/blob/master/LICENSE New BSD License
 */

namespace Mockery;

use Closure;
use Mockery\Matcher\MultiArgumentClosure;

class Expectation implements ExpectationInterface
{
    /**
     * Mock object to which this expectation belongs
     *
     * @var object
     */
    protected $_mock = null;

    /**
     * Method name
     *
     * @var string
     */
    protected $_name = null;

    /**
     * Arguments expected by this expectation
     *
     * @var array
     */
    protected $_expectedArgs = array();

    /**
     * Count validator store
     *
     * @var array
     */
    protected $_countValidators = array();

    /**
     * The count validator class to use
     *
     * @var string
     */
    protected $_countValidatorClass = 'Mockery\CountValidator\Exact';

    /**
     * Actual count of calls to this expectation
     *
     * @var int
     */
    protected $_actualCount = 0;

    /**
     * Value to return from this expectation
     *
     * @var mixed
     */
    protected $_returnValue = null;

    /**
     * Array of return values as a queue for multiple return sequence
     *
     * @var array
     */
    protected $_returnQueue = array();

    /**
     * Array of closures executed with given arguments to generate a result
     * to be returned
     *
     * @var array
     */
    protected $_closureQueue = array();

    /**
     * Array of values to be set when this expectation matches
     *
     * @var array
     */
    protected $_setQueue = array();

    /**
     * Integer representing the call order of this expectation
     *
     * @var int
     */
    protected $_orderNumber = null;

    /**
     * Integer representing the call order of this expectation on a global basis
     *
     * @var int
     */
    protected $_globalOrderNumber = null;

    /**
     * Flag indicating that an exception is expected to be throw (not returned)
     *
     * @var bool
     */
    protected $_throw = false;

    /**
     * Flag indicating whether the order of calling is determined locally or
     * globally
     *
     * @var bool
     */
    protected $_globally = false;

    /**
     * Flag indicating we expect no arguments
     *
     * @var bool
     */
    protected $_noArgsExpectation = false;

    /**
     * Flag indicating if the return value should be obtained from the original
     * class method instead of returning predefined values from the return queue
     *
     * @var bool
     */
    protected $_passthru = false;

    /**
     * Constructor
     *
     * @param \Mockery\MockInterface $mock
     * @param string $name
     */
    public function __construct(\Mockery\MockInterface $mock, $name)
    {
        $this->_mock = $mock;
        $this->_name = $name;
    }

    /**
     * Return a string with the method name and arguments formatted
     *
     * @param string $name Name of the expected method
     * @param array $args List of arguments to the method
     * @return string
     */
    public function __toString()
    {
        return \Mockery::formatArgs($this->_name, $this->_expectedArgs);
    }

    /**
     * Verify the current call, i.e. that the given arguments match those
     * of this expectation
     *
     * @param array $args
     * @return mixed
     */
    public function verifyCall(array $args)
    {
        $this->validateOrder();
        $this->_actualCount++;
        if (true === $this->_passthru) {
            return $this->_mock->mockery_callSubjectMethod($this->_name, $args);
        }

        $return = $this->_getReturnValue($args);
        $this->throwAsNecessary($return);
        $this->_setValues();

        return $return;
    }

    /**
     * Throws an exception if the expectation has been configured to do so
     *
     * @throws \Exception|\Throwable
     * @return void
     */
    private function throwAsNecessary($return)
    {
        if (!$this->_throw) {
            return;
        }

        $type = version_compare(PHP_VERSION, '7.0.0') >= 0
            ? "\Throwable"
            : "\Exception";

        if ($return instanceof $type) {
            throw $return;
        }

        return;

    }

    /**
     * Sets public properties with queued values to the mock object
     *
     * @param array $args
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return mixed
     */
    protected function _setValues()
    {
        foreach ($this->_setQueue as $name => &$values) {
            if (count($values) > 0) {
                $value = array_shift($values);
                $this->_mock->{$name} = $value;
            }
        }
    }

    /**
     * Fetch the return value for the matching args
     *
     * @param array $args
     * @return mixed
     */
    protected function _getReturnValue(array $args)
    {
        if (count($this->_closureQueue) > 1) {
            return call_user_func_array(array_shift($this->_closureQueue), $args);
        } elseif (count($this->_closureQueue) > 0) {
            return call_user_func_array(current($this->_closureQueue), $args);
        } elseif (count($this->_returnQueue) > 1) {
            return array_shift($this->_returnQueue);
        } elseif (count($this->_returnQueue) > 0) {
            return current($this->_returnQueue);
        }

        return $this->_mock->mockery_returnValueForMethod($this->_name);
    }

    /**
     * Checks if this expectation is eligible for additional calls
     *
     * @return bool
     */
    public function isEligible()
    {
        foreach ($this->_countValidators as $validator) {
            if (!$validator->isEligible($this->_actualCount)) {
                return false;
            }
        }
        return true;
    }

    /**
     * Check if there is a constraint on call count
     *
     * @return bool
     */
    public function isCallCountConstrained()
    {
        return (count($this->_countValidators) > 0);
    }

    /**
     * Verify call order
     *
     * @return void
     */
    public function validateOrder()
    {
        if ($this->_orderNumber) {
            $this->_mock->mockery_validateOrder((string) $this, $this->_orderNumber, $this->_mock);
        }
        if ($this->_globalOrderNumber) {
            $this->_mock->mockery_getContainer()
                ->mockery_validateOrder((string) $this, $this->_globalOrderNumber, $this->_mock);
        }
    }

    /**
     * Verify this expectation
     *
     * @return bool
     */
    public function verify()
    {
        foreach ($this->_countValidators as $validator) {
            $validator->validate($this->_actualCount);
        }
    }

    /**
     * Check if the registered expectation is a MultiArgumentClosureExpectation.
     * @return bool
     */
    private function isMultiArgumentClosureExpectation()
    {
        return (count($this->_expectedArgs) === 1 && ($this->_expectedArgs[0] instanceof \Mockery\Matcher\MultiArgumentClosure));
    }

    /**
     * Check if passed arguments match an argument expectation
     *
     * @param array $args
     * @return bool
     */
    public function matchArgs(array $args)
    {
        if (empty($this->_expectedArgs) && !$this->_noArgsExpectation) {
            return true;
        }
        if ($this->isMultiArgumentClosureExpectation()) {
            return $this->_matchArg($this->_expectedArgs[0], $args);
        }
        $argCount = count($args);
        if ($argCount !== count($this->_expectedArgs)) {
            return false;
        }
        for ($i=0; $i<$argCount; $i++) {
            $param =& $args[$i];
            if (!$this->_matchArg($this->_expectedArgs[$i], $param)) {
                return false;
            }
        }

        return true;
    }

    /**
     * Check if passed argument matches an argument expectation
     *
     * @param mixed $expected
     * @param mixed &$actual
     * @return bool
     */
    protected function _matchArg($expected, &$actual)
    {
        if ($expected === $actual) {
            return true;
        }
        if (!is_object($expected) && !is_object($actual) && $expected == $actual) {
            return true;
        }
        if (is_string($expected) && !is_array($actual) && !is_object($actual)) {
            # push/pop an error handler here to to make sure no error/exception thrown if $expected is not a regex
            set_error_handler(function () {
            });
            $result = preg_match($expected, (string) $actual);
            restore_error_handler();

            if ($result) {
                return true;
            }
        }
        if (is_string($expected) && is_object($actual)) {
            $result = $actual instanceof $expected;
            if ($result) {
                return true;
            }
        }
        if ($expected instanceof \Mockery\Matcher\MatcherAbstract) {
            return $expected->match($actual);
        }
        if ($expected instanceof \Hamcrest\Matcher || $expected instanceof \Hamcrest_Matcher) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return $expected->matches($actual);
        }
        return false;
    }

    /**
     * Expected argument setter for the expectation
     *
     * @param mixed ...
     * @return self
     */
    public function with()
    {
        return $this->withArgs(func_get_args());
    }

    /**
     * Expected arguments for the expectation passed as an array
     *
     * @param array $arguments
     * @return self
     */
    private function withArgsInArray(array $arguments)
    {
        if (empty($arguments)) {
            return $this->withNoArgs();
        }
        $this->_expectedArgs = $arguments;
        $this->_noArgsExpectation = false;
        return $this;
    }

    /**
     * Expected arguments have to be matched by the given closure.
     *
     * @param Closure $closure
     * @return self
     */
    private function withArgsMatchedByClosure(Closure $closure)
    {
        $this->_expectedArgs = [new MultiArgumentClosure($closure)];
        $this->_noArgsExpectation = false;
        return $this;
    }

    /**
     * Expected arguments for the expectation passed as an array or a closure that matches each passed argument on
     * each function call.
     *
     * @param array|Closure $argsOrClosure
     * @return self
     */
    public function withArgs($argsOrClosure)
    {
        if (is_array($argsOrClosure)) {
            $this->withArgsInArray($argsOrClosure);
        } elseif ($argsOrClosure instanceof Closure) {
            $this->withArgsMatchedByClosure($argsOrClosure);
        } else {
            throw new \InvalidArgumentException(sprintf('Call to %s with an invalid argument (%s), only array and '.
                'closure are allowed', __METHOD__, $argsOrClosure));
        }
        return $this;
    }

    /**
     * Set with() as no arguments expected
     *
     * @return self
     */
    public function withNoArgs()
    {
        $this->_noArgsExpectation = true;
        $this->_expectedArgs = [];
        return $this;
    }

    /**
     * Set expectation that any arguments are acceptable
     *
     * @return self
     */
    public function withAnyArgs()
    {
        $this->_expectedArgs = array();
        return $this;
    }

    /**
     * Set a return value, or sequential queue of return values
     *
     * @param mixed ...
     * @return self
     */
    public function andReturn()
    {
        $this->_returnQueue = func_get_args();
        return $this;
    }

    /**
     * Return this mock, like a fluent interface
     *
     * @return self
     */
    public function andReturnSelf()
    {
        return $this->andReturn($this->_mock);
    }

    /**
     * Set a sequential queue of return values with an array
     *
     * @param array $values
     * @return self
     */
    public function andReturnValues(array $values)
    {
        call_user_func_array(array($this, 'andReturn'), $values);
        return $this;
    }

    /**
     * Set a closure or sequence of closures with which to generate return
     * values. The arguments passed to the expected method are passed to the
     * closures as parameters.
     *
     * @param callable ...
     * @return self
     */
    public function andReturnUsing()
    {
        $this->_closureQueue = func_get_args();
        return $this;
    }

    /**
     * Return a self-returning black hole object.
     *
     * @return self
     */
    public function andReturnUndefined()
    {
        $this->andReturn(new \Mockery\Undefined);
        return $this;
    }

    /**
     * Return null. This is merely a language construct for Mock describing.
     *
     * @return self
     */
    public function andReturnNull()
    {
        return $this;
    }

    public function andReturnFalse()
    {
        return $this->andReturn(false);
    }

    public function andReturnTrue()
    {
        return $this->andReturn(true);
    }

    /**
     * Set Exception class and arguments to that class to be thrown
     *
     * @param string|\Exception $exception
     * @param string $message
     * @param int $code
     * @param \Exception $previous
     * @return self
     */
    public function andThrow($exception, $message = '', $code = 0, \Exception $previous = null)
    {
        $this->_throw = true;
        if (is_object($exception)) {
            $this->andReturn($exception);
        } else {
            $this->andReturn(new $exception($message, $code, $previous));
        }
        return $this;
    }

    /**
     * Set Exception classes to be thrown
     *
     * @param array $exceptions
     * @return self
     */
    public function andThrowExceptions(array $exceptions)
    {
        $this->_throw = true;
        foreach ($exceptions as $exception) {
            if (!is_object($exception)) {
                throw new Exception('You must pass an array of exception objects to andThrowExceptions');
            }
        }
        return $this->andReturnValues($exceptions);
    }

    /**
     * Register values to be set to a public property each time this expectation occurs
     *
     * @param string $name
     * @param mixed $value
     * @return self
     */
    public function andSet($name, $value)
    {
        $values = func_get_args();
        array_shift($values);
        $this->_setQueue[$name] = $values;
        return $this;
    }

    /**
     * Alias to andSet(). Allows the natural English construct
     * - set('foo', 'bar')->andReturn('bar')
     *
     * @param string $name
     * @param mixed $value
     * @return self
     */
    public function set($name, $value)
    {
        return call_user_func_array(array($this, 'andSet'), func_get_args());
    }

    /**
     * Indicates this expectation should occur zero or more times
     *
     * @return self
     */
    public function zeroOrMoreTimes()
    {
        $this->atLeast()->never();
    }

    /**
     * Indicates the number of times this expectation should occur
     *
     * @param int $limit
     * @throws InvalidArgumentException
     * @return self
     */
    public function times($limit = null)
    {
        if (is_null($limit)) {
            return $this;
        }
        if (!is_int($limit)) {
            throw new \InvalidArgumentException('The passed Times limit should be an integer value');
        }
        $this->_countValidators[] = new $this->_countValidatorClass($this, $limit);
        $this->_countValidatorClass = 'Mockery\CountValidator\Exact';
        return $this;
    }

    /**
     * Indicates that this expectation is never expected to be called
     *
     * @return self
     */
    public function never()
    {
        return $this->times(0);
    }

    /**
     * Indicates that this expectation is expected exactly once
     *
     * @return self
     */
    public function once()
    {
        return $this->times(1);
    }

    /**
     * Indicates that this expectation is expected exactly twice
     *
     * @return self
     */
    public function twice()
    {
        return $this->times(2);
    }

    /**
     * Sets next count validator to the AtLeast instance
     *
     * @return self
     */
    public function atLeast()
    {
        $this->_countValidatorClass = 'Mockery\CountValidator\AtLeast';
        return $this;
    }

    /**
     * Sets next count validator to the AtMost instance
     *
     * @return self
     */
    public function atMost()
    {
        $this->_countValidatorClass = 'Mockery\CountValidator\AtMost';
        return $this;
    }

    /**
     * Shorthand for setting minimum and maximum constraints on call counts
     *
     * @param int $minimum
     * @param int $maximum
     */
    public function between($minimum, $maximum)
    {
        return $this->atLeast()->times($minimum)->atMost()->times($maximum);
    }

    /**
     * Indicates that this expectation must be called in a specific given order
     *
     * @param string $group Name of the ordered group
     * @return self
     */
    public function ordered($group = null)
    {
        if ($this->_globally) {
            $this->_globalOrderNumber = $this->_defineOrdered($group, $this->_mock->mockery_getContainer());
        } else {
            $this->_orderNumber = $this->_defineOrdered($group, $this->_mock);
        }
        $this->_globally = false;
        return $this;
    }

    /**
     * Indicates call order should apply globally
     *
     * @return self
     */
    public function globally()
    {
        $this->_globally = true;
        return $this;
    }

    /**
     * Setup the ordering tracking on the mock or mock container
     *
     * @param string $group
     * @param object $ordering
     * @return int
     */
    protected function _defineOrdered($group, $ordering)
    {
        $groups = $ordering->mockery_getGroups();
        if (is_null($group)) {
            $result = $ordering->mockery_allocateOrder();
        } elseif (isset($groups[$group])) {
            $result = $groups[$group];
        } else {
            $result = $ordering->mockery_allocateOrder();
            $ordering->mockery_setGroup($group, $result);
        }
        return $result;
    }

    /**
     * Return order number
     *
     * @return int
     */
    public function getOrderNumber()
    {
        return $this->_orderNumber;
    }

    /**
     * Mark this expectation as being a default
     *
     * @return self
     */
    public function byDefault()
    {
        $director = $this->_mock->mockery_getExpectationsFor($this->_name);
        if (!empty($director)) {
            $director->makeExpectationDefault($this);
        }
        return $this;
    }

    /**
     * Return the parent mock of the expectation
     *
     * @return \Mockery\MockInterface
     */
    public function getMock()
    {
        return $this->_mock;
    }

    /**
     * Flag this expectation as calling the original class method with the
     * any provided arguments instead of using a return value queue.
     *
     * @return self
     */
    public function passthru()
    {
        if ($this->_mock instanceof Mock) {
            throw new Exception(
                'Mock Objects not created from a loaded/existing class are '
                . 'incapable of passing method calls through to a parent class'
            );
        }
        $this->_passthru = true;
        return $this;
    }

    /**
     * Cloning logic
     *
     */
    public function __clone()
    {
        $newValidators = array();
        $countValidators = $this->_countValidators;
        foreach ($countValidators as $validator) {
            $newValidators[] = clone $validator;
        }
        $this->_countValidators = $newValidators;
    }

    public function getName()
    {
        return $this->_name;
    }
}


Pull Request — master (#679)

Expectation::throwAsNecessary() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1		<?php
2		/**
3		* Mockery
4		*
5		* LICENSE
6		*
7		* This source file is subject to the new BSD license that is bundled
8		* with this package in the file LICENSE.txt.
9		* It is also available through the world-wide-web at this URL:
10		* http://github.com/padraic/mockery/blob/master/LICENSE
11		* If you did not receive a copy of the license and are unable to
12		* obtain it through the world-wide-web, please send an email
13		* to [email protected] so we can send you a copy immediately.
14		*
15		* @category Mockery
16		* @package Mockery
17		* @copyright Copyright (c) 2010 Pádraic Brady (http://blog.astrumfutura.com)
18		* @license http://github.com/padraic/mockery/blob/master/LICENSE New BSD License
19		*/
20
21		namespace Mockery;
22
23		use Closure;
24		use Mockery\Matcher\MultiArgumentClosure;
25
26		class Expectation implements ExpectationInterface
27		{
28		/**
29		* Mock object to which this expectation belongs
30		*
31		* @var object
32		*/
33		protected $_mock = null;
34
35		/**
36		* Method name
37		*
38		* @var string
39		*/
40		protected $_name = null;
41
42		/**
43		* Arguments expected by this expectation
44		*
45		* @var array
46		*/
47		protected $_expectedArgs = array();
48
49		/**
50		* Count validator store
51		*
52		* @var array
53		*/
54		protected $_countValidators = array();
55
56		/**
57		* The count validator class to use
58		*
59		* @var string
60		*/
61		protected $_countValidatorClass = 'Mockery\CountValidator\Exact';
62
63		/**
64		* Actual count of calls to this expectation
65		*
66		* @var int
67		*/
68		protected $_actualCount = 0;
69
70		/**
71		* Value to return from this expectation
72		*
73		* @var mixed
74		*/
75		protected $_returnValue = null;
76
77		/**
78		* Array of return values as a queue for multiple return sequence
79		*
80		* @var array
81		*/
82		protected $_returnQueue = array();
83
84		/**
85		* Array of closures executed with given arguments to generate a result
86		* to be returned
87		*
88		* @var array
89		*/
90		protected $_closureQueue = array();
91
92		/**
93		* Array of values to be set when this expectation matches
94		*
95		* @var array
96		*/
97		protected $_setQueue = array();
98
99		/**
100		* Integer representing the call order of this expectation
101		*
102		* @var int
103		*/
104		protected $_orderNumber = null;
105
106		/**
107		* Integer representing the call order of this expectation on a global basis
108		*
109		* @var int
110		*/
111		protected $_globalOrderNumber = null;
112
113		/**
114		* Flag indicating that an exception is expected to be throw (not returned)
115		*
116		* @var bool
117		*/
118		protected $_throw = false;
119
120		/**
121		* Flag indicating whether the order of calling is determined locally or
122		* globally
123		*
124		* @var bool
125		*/
126		protected $_globally = false;
127
128		/**
129		* Flag indicating we expect no arguments
130		*
131		* @var bool
132		*/
133		protected $_noArgsExpectation = false;
134
135		/**
136		* Flag indicating if the return value should be obtained from the original
137		* class method instead of returning predefined values from the return queue
138		*
139		* @var bool
140		*/
141		protected $_passthru = false;
142
143		/**
144		* Constructor
145		*
146		* @param \Mockery\MockInterface $mock
147		* @param string $name
148		*/
149	299	public function __construct(\Mockery\MockInterface $mock, $name)
150		{
151	299	$this->_mock = $mock;
152	299	$this->_name = $name;
153	299	}
154
155		/**
156		* Return a string with the method name and arguments formatted
157		*
158		* @param string $name Name of the expected method
159		* @param array $args List of arguments to the method
160		* @return string
161		*/
162	43	public function __toString()
163		{
164	43	return \Mockery::formatArgs($this->_name, $this->_expectedArgs);
165		}
166
167		/**
168		* Verify the current call, i.e. that the given arguments match those
169		* of this expectation
170		*
171		* @param array $args
172		* @return mixed
173		*/
174	229	public function verifyCall(array $args)
175		{
176	229	$this->validateOrder();
177	229	$this->_actualCount++;
178	229	if (true === $this->_passthru) {
179	3	return $this->_mock->mockery_callSubjectMethod($this->_name, $args);
180		}
181
182	227	$return = $this->_getReturnValue($args);
183	227	$this->throwAsNecessary($return);
184	221	$this->_setValues();
185
186	221	return $return;
187		}
188
189		/**
190		* Throws an exception if the expectation has been configured to do so
191		*
192		* @throws \Exception\|\Throwable
193		* @return void
194		*/
195	227	private function throwAsNecessary($return)
196		{
197	227	if (!$this->_throw) {
198	221	return;
199		}
200
201	7	$type = version_compare(PHP_VERSION, '7.0.0') >= 0
202	7	? "\Throwable"
203	7	: "\Exception";
204
205	7	if ($return instanceof $type) {
206	7	throw $return;
207		}
208
209		return;
		0 ignored issues – show Coding Style introduced 2017-01-23 12:16 UTC by Report Bug Copy Issue Report Empty return statement not required here Loading history...
210		}
211
212		/**
213		* Sets public properties with queued values to the mock object
214		*
215		* @param array $args
		0 ignored issues – show Bug introduced 2017-01-23 12:16 UTC by Report Bug Copy Issue Report There is no parameter named `$args`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
216		* @return mixed
217		*/
218	221	protected function _setValues()
219		{
220	221	foreach ($this->_setQueue as $name => &$values) {
221	8	if (count($values) > 0) {
222	8	$value = array_shift($values);
223	8	$this->_mock->{$name} = $value;
224	8	}
225	221	}
226	221	}
227
228		/**
229		* Fetch the return value for the matching args
230		*
231		* @param array $args
232		* @return mixed
233		*/
234	227	protected function _getReturnValue(array $args)
235		{
236	227	if (count($this->_closureQueue) > 1) {
237		return call_user_func_array(array_shift($this->_closureQueue), $args);
238	227	} elseif (count($this->_closureQueue) > 0) {
239	1	return call_user_func_array(current($this->_closureQueue), $args);
240	226	} elseif (count($this->_returnQueue) > 1) {
241	5	return array_shift($this->_returnQueue);
242	225	} elseif (count($this->_returnQueue) > 0) {
243	88	return current($this->_returnQueue);
244		}
245
246	138	return $this->_mock->mockery_returnValueForMethod($this->_name);
247		}
248
249		/**
250		* Checks if this expectation is eligible for additional calls
251		*
252		* @return bool
253		*/
254	267	public function isEligible()
255		{
256	267	foreach ($this->_countValidators as $validator) {
257	138	if (!$validator->isEligible($this->_actualCount)) {
258	22	return false;
259		}
260	264	}
261	264	return true;
262		}
263
264		/**
265		* Check if there is a constraint on call count
266		*
267		* @return bool
268		*/
269		public function isCallCountConstrained()
270		{
271		return (count($this->_countValidators) > 0);
272		}
273
274		/**
275		* Verify call order
276		*
277		* @return void
278		*/
279	229	public function validateOrder()
280		{
281	229	if ($this->_orderNumber) {
282	15	$this->_mock->mockery_validateOrder((string) $this, $this->_orderNumber, $this->_mock);
283	15	}
284	229	if ($this->_globalOrderNumber) {
285	1	$this->_mock->mockery_getContainer()
286	1	->mockery_validateOrder((string) $this, $this->_globalOrderNumber, $this->_mock);
287	1	}
288	229	}
289
290		/**
291		* Verify this expectation
292		*
293		* @return bool
294		*/
295	141	public function verify()
296		{
297	141	foreach ($this->_countValidators as $validator) {
298	119	$validator->validate($this->_actualCount);
299	126	}
300	124	}
301
302		/**
303		* Check if the registered expectation is a MultiArgumentClosureExpectation.
304		* @return bool
305		*/
306	114	private function isMultiArgumentClosureExpectation()
307		{
308	114	return (count($this->_expectedArgs) === 1 && ($this->_expectedArgs[0] instanceof \Mockery\Matcher\MultiArgumentClosure));
309		}
310
311		/**
312		* Check if passed arguments match an argument expectation
313		*
314		* @param array $args
315		* @return bool
316		*/
317	273	public function matchArgs(array $args)
318		{
319	273	if (empty($this->_expectedArgs) && !$this->_noArgsExpectation) {
320	163	return true;
321		}
322	114	if ($this->isMultiArgumentClosureExpectation()) {
323	6	return $this->_matchArg($this->_expectedArgs[0], $args);
324		}
325	108	$argCount = count($args);
326	108	if ($argCount !== count($this->_expectedArgs)) {
327	8	return false;
328		}
329	102	for ($i=0; $i<$argCount; $i++) {
330	100	$param =& $args[$i];
331	100	if (!$this->_matchArg($this->_expectedArgs[$i], $param)) {
332	45	return false;
333		}
334	64	}
335
336	66	return true;
337		}
338
339		/**
340		* Check if passed argument matches an argument expectation
341		*
342		* @param mixed $expected
343		* @param mixed &$actual
344		* @return bool
345		*/
346	106	protected function _matchArg($expected, &$actual)
347		{
348	106	if ($expected === $actual) {
349	28	return true;
350		}
351	90	if (!is_object($expected) && !is_object($actual) && $expected == $actual) {
352		return true;
353		}
354	90	if (is_string($expected) && !is_array($actual) && !is_object($actual)) {
355		# push/pop an error handler here to to make sure no error/exception thrown if $expected is not a regex
356	6	set_error_handler(function () {
357	6	});
358	6	$result = preg_match($expected, (string) $actual);
359	6	restore_error_handler();
360
361	6	if ($result) {
362	3	return true;
363		}
364	3	}
365	89	if (is_string($expected) && is_object($actual)) {
366	1	$result = $actual instanceof $expected;
367	1	if ($result) {
368	1	return true;
369		}
370		}
371	88	if ($expected instanceof \Mockery\Matcher\MatcherAbstract) {
372	67	return $expected->match($actual);
373		}
374	21	if ($expected instanceof \Hamcrest\Matcher \|\| $expected instanceof \Hamcrest_Matcher) {
		0 ignored issues – show Bug introduced 2016-02-02 11:18 UTC by Report Bug Copy Issue Report The class `Hamcrest_Matcher` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
375	3	return $expected->matches($actual);
376		}
377	18	return false;
378		}
379
380		/**
381		* Expected argument setter for the expectation
382		*
383		* @param mixed ...
384		* @return self
385		*/
386	130	public function with()
387		{
388	130	return $this->withArgs(func_get_args());
389		}
390
391		/**
392		* Expected arguments for the expectation passed as an array
393		*
394		* @param array $arguments
395		* @return self
396		*/
397	135	private function withArgsInArray(array $arguments)
398		{
399	135	if (empty($arguments)) {
400	2	return $this->withNoArgs();
401		}
402	133	$this->_expectedArgs = $arguments;
403	133	$this->_noArgsExpectation = false;
404	133	return $this;
405		}
406
407		/**
408		* Expected arguments have to be matched by the given closure.
409		*
410		* @param Closure $closure
411		* @return self
412		*/
413	6	private function withArgsMatchedByClosure(Closure $closure)
414		{
415	6	$this->_expectedArgs = [new MultiArgumentClosure($closure)];
416	6	$this->_noArgsExpectation = false;
417	6	return $this;
418		}
419
420		/**
421		* Expected arguments for the expectation passed as an array or a closure that matches each passed argument on
422		* each function call.
423		*
424		* @param array\|Closure $argsOrClosure
425		* @return self
426		*/
427	142	public function withArgs($argsOrClosure)
428		{
429	142	if (is_array($argsOrClosure)) {
430	135	$this->withArgsInArray($argsOrClosure);
431	142	} elseif ($argsOrClosure instanceof Closure) {
432	6	$this->withArgsMatchedByClosure($argsOrClosure);
433	6	} else {
434	1	throw new \InvalidArgumentException(sprintf('Call to %s with an invalid argument (%s), only array and '.
435	1	'closure are allowed', __METHOD__, $argsOrClosure));
436		}
437	141	return $this;
438		}
439
440		/**
441		* Set with() as no arguments expected
442		*
443		* @return self
444		*/
445	6	public function withNoArgs()
446		{
447	6	$this->_noArgsExpectation = true;
448	6	$this->_expectedArgs = [];
449	6	return $this;
450		}
451
452		/**
453		* Set expectation that any arguments are acceptable
454		*
455		* @return self
456		*/
457	2	public function withAnyArgs()
458		{
459	2	$this->_expectedArgs = array();
460	2	return $this;
461		}
462
463		/**
464		* Set a return value, or sequential queue of return values
465		*
466		* @param mixed ...
467		* @return self
468		*/
469	101	public function andReturn()
470		{
471	101	$this->_returnQueue = func_get_args();
472	101	return $this;
473		}
474
475		/**
476		* Return this mock, like a fluent interface
477		*
478		* @return self
479		*/
480	1	public function andReturnSelf()
481		{
482	1	return $this->andReturn($this->_mock);
483		}
484
485		/**
486		* Set a sequential queue of return values with an array
487		*
488		* @param array $values
489		* @return self
490		*/
491	2	public function andReturnValues(array $values)
492		{
493	2	call_user_func_array(array($this, 'andReturn'), $values);
494	2	return $this;
495		}
496
497		/**
498		* Set a closure or sequence of closures with which to generate return
499		* values. The arguments passed to the expected method are passed to the
500		* closures as parameters.
501		*
502		* @param callable ...
503		* @return self
504		*/
505	1	public function andReturnUsing()
506		{
507	1	$this->_closureQueue = func_get_args();
508	1	return $this;
509		}
510
511		/**
512		* Return a self-returning black hole object.
513		*
514		* @return self
515		*/
516	1	public function andReturnUndefined()
517		{
518	1	$this->andReturn(new \Mockery\Undefined);
519	1	return $this;
520		}
521
522		/**
523		* Return null. This is merely a language construct for Mock describing.
524		*
525		* @return self
526		*/
527	1	public function andReturnNull()
528		{
529	1	return $this;
530		}
531
532	1	public function andReturnFalse()
533		{
534	1	return $this->andReturn(false);
535		}
536
537	1	public function andReturnTrue()
538		{
539	1	return $this->andReturn(true);
540		}
541
542		/**
543		* Set Exception class and arguments to that class to be thrown
544		*
545		* @param string\|\Exception $exception
546		* @param string $message
547		* @param int $code
548		* @param \Exception $previous
549		* @return self
550		*/
551	6	public function andThrow($exception, $message = '', $code = 0, \Exception $previous = null)
552		{
553	6	$this->_throw = true;
554	6	if (is_object($exception)) {
555	2	$this->andReturn($exception);
556	2	} else {
557	4	$this->andReturn(new $exception($message, $code, $previous));
558		}
559	6	return $this;
560		}
561
562		/**
563		* Set Exception classes to be thrown
564		*
565		* @param array $exceptions
566		* @return self
567		*/
568	2	public function andThrowExceptions(array $exceptions)
569		{
570	2	$this->_throw = true;
571	2	foreach ($exceptions as $exception) {
572	2	if (!is_object($exception)) {
573	1	throw new Exception('You must pass an array of exception objects to andThrowExceptions');
574		}
575	1	}
576	1	return $this->andReturnValues($exceptions);
577		}
578
579		/**
580		* Register values to be set to a public property each time this expectation occurs
581		*
582		* @param string $name
583		* @param mixed $value
584		* @return self
585		*/
586	8	public function andSet($name, $value)
587		{
588	8	$values = func_get_args();
589	8	array_shift($values);
590	8	$this->_setQueue[$name] = $values;
591	8	return $this;
592		}
593
594		/**
595		* Alias to andSet(). Allows the natural English construct
596		* - set('foo', 'bar')->andReturn('bar')
597		*
598		* @param string $name
599		* @param mixed $value
600		* @return self
601		*/
602	3	public function set($name, $value)
603		{
604	3	return call_user_func_array(array($this, 'andSet'), func_get_args());
605		}
606
607		/**
608		* Indicates this expectation should occur zero or more times
609		*
610		* @return self
611		*/
612	2	public function zeroOrMoreTimes()
613		{
614	2	$this->atLeast()->never();
615	2	}
616
617		/**
618		* Indicates the number of times this expectation should occur
619		*
620		* @param int $limit
621		* @throws InvalidArgumentException
622		* @return self
623		*/
624	156	public function times($limit = null)
625		{
626	156	if (is_null($limit)) {
627		return $this;
628		}
629	156	if (!is_int($limit)) {
630	1	throw new \InvalidArgumentException('The passed Times limit should be an integer value');
631		}
632	155	$this->_countValidators[] = new $this->_countValidatorClass($this, $limit);
633	155	$this->_countValidatorClass = 'Mockery\CountValidator\Exact';
634	155	return $this;
635		}
636
637		/**
638		* Indicates that this expectation is never expected to be called
639		*
640		* @return self
641		*/
642	38	public function never()
643		{
644	38	return $this->times(0);
645		}
646
647		/**
648		* Indicates that this expectation is expected exactly once
649		*
650		* @return self
651		*/
652	106	public function once()
653		{
654	106	return $this->times(1);
655		}
656
657		/**
658		* Indicates that this expectation is expected exactly twice
659		*
660		* @return self
661		*/
662	18	public function twice()
663		{
664	18	return $this->times(2);
665		}
666
667		/**
668		* Sets next count validator to the AtLeast instance
669		*
670		* @return self
671		*/
672	14	public function atLeast()
673		{
674	14	$this->_countValidatorClass = 'Mockery\CountValidator\AtLeast';
675	14	return $this;
676		}
677
678		/**
679		* Sets next count validator to the AtMost instance
680		*
681		* @return self
682		*/
683	7	public function atMost()
684		{
685	7	$this->_countValidatorClass = 'Mockery\CountValidator\AtMost';
686	7	return $this;
687		}
688
689		/**
690		* Shorthand for setting minimum and maximum constraints on call counts
691		*
692		* @param int $minimum
693		* @param int $maximum
694		*/
695		public function between($minimum, $maximum)
696		{
697		return $this->atLeast()->times($minimum)->atMost()->times($maximum);
698		}
699
700		/**
701		* Indicates that this expectation must be called in a specific given order
702		*
703		* @param string $group Name of the ordered group
704		* @return self
705		*/
706	17	public function ordered($group = null)
707		{
708	17	if ($this->_globally) {
709	1	$this->_globalOrderNumber = $this->_defineOrdered($group, $this->_mock->mockery_getContainer());
710	1	} else {
711	16	$this->_orderNumber = $this->_defineOrdered($group, $this->_mock);
712		}
713	17	$this->_globally = false;
714	17	return $this;
715		}
716
717		/**
718		* Indicates call order should apply globally
719		*
720		* @return self
721		*/
722	1	public function globally()
723		{
724	1	$this->_globally = true;
725	1	return $this;
726		}
727
728		/**
729		* Setup the ordering tracking on the mock or mock container
730		*
731		* @param string $group
732		* @param object $ordering
733		* @return int
734		*/
735	17	protected function _defineOrdered($group, $ordering)
736		{
737	17	$groups = $ordering->mockery_getGroups();
738	17	if (is_null($group)) {
739	16	$result = $ordering->mockery_allocateOrder();
740	17	} elseif (isset($groups[$group])) {
741	2	$result = $groups[$group];
742	2	} else {
743	4	$result = $ordering->mockery_allocateOrder();
744	4	$ordering->mockery_setGroup($group, $result);
745		}
746	17	return $result;
747		}
748
749		/**
750		* Return order number
751		*
752		* @return int
753		*/
754	1	public function getOrderNumber()
755		{
756	1	return $this->_orderNumber;
757		}
758
759		/**
760		* Mark this expectation as being a default
761		*
762		* @return self
763		*/
764	25	public function byDefault()
765		{
766	25	$director = $this->_mock->mockery_getExpectationsFor($this->_name);
767	25	if (!empty($director)) {
768	25	$director->makeExpectationDefault($this);
769	24	}
770	24	return $this;
771		}
772
773		/**
774		* Return the parent mock of the expectation
775		*
776		* @return \Mockery\MockInterface
777		*/
778	27	public function getMock()
779		{
780	27	return $this->_mock;
781		}
782
783		/**
784		* Flag this expectation as calling the original class method with the
785		* any provided arguments instead of using a return value queue.
786		*
787		* @return self
788		*/
789	3	public function passthru()
790		{
791	3	if ($this->_mock instanceof Mock) {
792		throw new Exception(
793		'Mock Objects not created from a loaded/existing class are '
794		. 'incapable of passing method calls through to a parent class'
795		);
796		}
797	3	$this->_passthru = true;
798	3	return $this;
799		}
800
801		/**
802		* Cloning logic
803		*
804		*/
805	9	public function __clone()
806		{
807	9	$newValidators = array();
808	9	$countValidators = $this->_countValidators;
809	9	foreach ($countValidators as $validator) {
810	6	$newValidators[] = clone $validator;
811	9	}
812	9	$this->_countValidators = $newValidators;
813	9	}
814
815	6	public function getName()
816		{
817	6	return $this->_name;
818		}
819		}
820

padraic / mockery

Pull Request — master (#679)

Expectation::throwAsNecessary() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like